Class: Telnyx::Resources::RecordingTranscriptions

Inherits:
Object
  • Object
show all
Defined in:
lib/telnyx/resources/recording_transcriptions.rb

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ RecordingTranscriptions

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

Parameters:



67
68
69
 
# File 'lib/telnyx/resources/recording_transcriptions.rb', line 67

def initialize(client:)
  @client = client
end

Instance Method Details

#delete(recording_transcription_id, request_options: {}) ⇒ Telnyx::Models::RecordingTranscriptionDeleteResponse

Permanently deletes a recording transcription.

Parameters:

  • recording_transcription_id (String) —

    Uniquely identifies the recording transcription by id.

  • request_options (Telnyx::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



55
56
57
58
59
60
61
62
 
# File 'lib/telnyx/resources/recording_transcriptions.rb', line 55

def delete(recording_transcription_id, params = {})
  @client.request(
    method: :delete,
    path: ["recording_transcriptions/%1$s", recording_transcription_id],
    model: Telnyx::Models::RecordingTranscriptionDeleteResponse,
    options: params[:request_options]
  )
end

#list(request_options: {}) ⇒ Telnyx::Models::RecordingTranscriptionListResponse

Returns a list of your recording transcriptions.

Parameters:

Returns:

See Also:



35
36
37
38
39
40
41
42
 
# File 'lib/telnyx/resources/recording_transcriptions.rb', line 35

def list(params = {})
  @client.request(
    method: :get,
    path: "recording_transcriptions",
    model: Telnyx::Models::RecordingTranscriptionListResponse,
    options: params[:request_options]
  )
end

#retrieve(recording_transcription_id, request_options: {}) ⇒ Telnyx::Models::RecordingTranscriptionRetrieveResponse

Retrieves the details of an existing recording transcription.

Parameters:

  • recording_transcription_id (String) —

    Uniquely identifies the recording transcription by id.

  • request_options (Telnyx::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



17
18
19
20
21
22
23
24
 
# File 'lib/telnyx/resources/recording_transcriptions.rb', line 17

def retrieve(recording_transcription_id, params = {})
  @client.request(
    method: :get,
    path: ["recording_transcriptions/%1$s", recording_transcription_id],
    model: Telnyx::Models::RecordingTranscriptionRetrieveResponse,
    options: params[:request_options]
  )
end