Class: Infrawrench::SessionRecordingsSettingsNamespace

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

Overview

client.session_recordings.settings

Instance Method Summary collapse

Constructor Details

#initialize(transport) ⇒ SessionRecordingsSettingsNamespace

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 SessionRecordingsSettingsNamespace.

Parameters:



12268
12269
12270
 
# File 'lib/infrawrench/client.rb', line 12268

def initialize(transport)
  @transport = transport
end

Instance Method Details

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

Get the recording policy

The organization's recording policy plus what it currently stores. Usage rides along with the policy because the only question anyone asks about retention is what it costs.

Requires permission: session-recordings:read.

GET /api/org/orgId/session-recordings/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 SessionRecordingSettings — see sig/infrawrench/sdk.rbs.

Raises:



12288
12289
12290
12291
12292
12293
12294
12295
 
# File 'lib/infrawrench/client.rb', line 12288

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

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

Update the recording policy

Partial update — omitted fields keep their current value. Recording is opt-in and off by default. Audit-logged with the before/after policy.

Requires permission: session-recordings:write.

PUT /api/org/orgId/session-recordings/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 SessionRecordingSettingsUpdate.

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

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

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

Returns:

  • (Hash) —

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

Raises:



12315
12316
12317
12318
12319
12320
12321
12322
12323
 
# File 'lib/infrawrench/client.rb', line 12315

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