Class: Infrawrench::ExpiringSettingsNamespace

Inherits:
Object
  • Object
show all
Defined in:
lib/infrawrench/client.rb,
sig/infrawrench/sdk.rbs

Overview

client.expiring.settings

Instance Method Summary collapse

Constructor Details

#initialize(transport) ⇒ ExpiringSettingsNamespace

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of ExpiringSettingsNamespace.

Parameters:



3364
3365
3366
 
# File 'lib/infrawrench/client.rb', line 3364

def initialize(transport)
  @transport = transport
end

Instance Method Details

#get(org_id: nil, request_options: nil) ⇒ Hash

Get the organization's expiry alert settings

The lead time feeds both the feed's upcoming bucket and the poller's daily alert scan. An organization that never saved reads the shipped defaults (enabled, 60 days).

Requires permission: org:settings:write.

GET /api/org/orgId/expiring/settings

Parameters:

  • org_id (String, nil) (defaults to: nil) —

    Organization id. Defaults to the org_id the client was constructed with.

  • request_options (Hash, nil) (defaults to: nil) —

    Per-call :headers, :timeout and :open_timeout.

  • org_id: (String, nil) (defaults to: nil)
  • request_options: (Hash[Symbol, untyped], nil) (defaults to: nil)

Returns:

  • (Hash) —

    Parsed JSON, shaped as ExpiryAlertSettings — see sig/infrawrench/sdk.rbs.

Raises:



3384
3385
3386
3387
3388
3389
3390
3391
 
# File 'lib/infrawrench/client.rb', line 3384

def get(org_id: nil, request_options: nil)
  @transport.request(
    http_method: "GET",
    path: "/api/org/{orgId}/expiring/settings",
    path_params: { "orgId" => org_id },
    request_options: request_options
  )
end

#update(org_id: nil, body: nil, request_options: nil) ⇒ Hash

Update the expiry alert settings

Every field is optional so a single toggle can be saved on its own. leadDays must be a whole number from 1 to 365. Saving never resets the alert cooldown.

Requires permission: org:settings:write.

PUT /api/org/orgId/expiring/settings

Raises on 400: Bad request

Parameters:

  • org_id (String, nil) (defaults to: nil) —

    Organization id. Defaults to the org_id the client was constructed with.

  • body (Hash, nil) (defaults to: nil) —

    Request body, shaped as ExpiryAlertSettingsUpdate.

  • request_options (Hash, nil) (defaults to: nil) —

    Per-call :headers, :timeout and :open_timeout.

  • org_id: (String, nil) (defaults to: nil)
  • body: (expiry_alert_settings_update, nil) (defaults to: nil)
  • request_options: (Hash[Symbol, untyped], nil) (defaults to: nil)

Returns:

  • (Hash) —

    Parsed JSON, shaped as ExpiryAlertSettings — see sig/infrawrench/sdk.rbs.

Raises:



3412
3413
3414
3415
3416
3417
3418
3419
3420
 
# File 'lib/infrawrench/client.rb', line 3412

def update(org_id: nil, body: nil, request_options: nil)
  @transport.request(
    http_method: "PUT",
    path: "/api/org/{orgId}/expiring/settings",
    path_params: { "orgId" => org_id },
    body: body,
    request_options: request_options
  )
end