Class: Telnyx::Resources::RecordingTranscriptions

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

Overview

Call Recordings operations.

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:



78
79
80
 
# File 'lib/telnyx/resources/recording_transcriptions.rb', line 78

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:



66
67
68
69
70
71
72
73
 
# File 'lib/telnyx/resources/recording_transcriptions.rb', line 66

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(filter: nil, page_number: nil, page_size: nil, request_options: {}) ⇒ Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::RecordingTranscription>

Returns a list of your recording transcriptions.

Parameters:

Returns:

See Also:



42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/telnyx/resources/recording_transcriptions.rb', line 42

def list(params = {})
  parsed, options = Telnyx::RecordingTranscriptionListParams.dump_request(params)
  query = Telnyx::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "recording_transcriptions",
    query: query.transform_keys(page_number: "page[number]", page_size: "page[size]"),
    page: Telnyx::Internal::DefaultFlatPagination,
    model: Telnyx::RecordingTranscription,
    options: 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:



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

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