Class: Ghostcrawl::RecordingsClient

Inherits:
Object
  • Object
show all
Defined in:
lib/ghostcrawl/client.rb

Overview

Manage session recordings — /v1/recordings.

Instance Method Summary collapse

Constructor Details

#initialize(v1, adapter = nil) ⇒ RecordingsClient

Returns a new instance of RecordingsClient.



841
842
843
844
 
# File 'lib/ghostcrawl/client.rb', line 841

def initialize(v1, adapter = nil)
  @v1 = v1
  @adapter = adapter
end

Instance Method Details

#delete(recording_id) ⇒ Object

Delete a recording. Delegates to DELETE /v1/recordings/id. Same void-DELETE defect as webhooks (generated builder passes a nil factory → adapter raises before sending), so we route through Ghostcrawl::ResponseHelper.void_request!.



863
864
865
 
# File 'lib/ghostcrawl/client.rb', line 863

def delete(recording_id)
  ResponseHelper.void_request!(@adapter, @v1.recordings.by_recording_id(recording_id).to_delete_request_information(nil))
end

#get(recording_id) ⇒ Object

Get a recording by ID. Delegates to GET /v1/recordings/id via the generated builder. (The generated accessor is by_recording_id, single underscore.)



855
856
857
 
# File 'lib/ghostcrawl/client.rb', line 855

def get(recording_id)
  ResponseHelper.to_hash(@v1.recordings.by_recording_id(recording_id).get)
end

#list ⇒ Object

List all recordings. Delegates to GET /v1/recordings via the generated RecordingsRequestBuilder.



848
849
850
 
# File 'lib/ghostcrawl/client.rb', line 848

def list
  ResponseHelper.to_hash(@v1.recordings.get)
end