Class: Twilio::REST::Voice::V3::TranscriptionList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/voice/v3/transcription.rb

Defined Under Namespace

Classes: CreateV3TranscriptionsRequest, VoiceV3TranscriptionParticipant, VoiceV3TranscriptionResolvedConfiguration, VoiceV3TranscriptionResolvedConfigurationParticipantDefaults, VoiceV3TranscriptionTranscriptionStatusCallback

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ TranscriptionList

Initialize the TranscriptionList

Parameters:

  • version (Version) —

    Version that contains the resource



140
141
142
143
144
145
146
147
148
 
# File 'lib/twilio-ruby/rest/voice/v3/transcription.rb', line 140

def initialize(version)
    
    apiV1Version = ApiV1Version.new version.domain, version
    super(apiV1Version)
    # Path Solution
    @solution = {  }
    @uri = "/Transcriptions"
    
end

Instance Method Details

#create(idempotency_key: :unset, create_v3_transcriptions_request: nil) ⇒ TranscriptionInstance

Create the TranscriptionInstance

Parameters:

  • idempotency_key (String) (defaults to: :unset) —

    A unique key to ensure idempotency. We recommend using UUID v7. Requests with the same key within the idempotency window return the original response.

  • create_v3_transcriptions_request (CreateV3TranscriptionsRequest) (defaults to: nil)

Returns:



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/twilio-ruby/rest/voice/v3/transcription.rb', line 154

def create(
  idempotency_key: :unset,
  create_v3_transcriptions_request: nil
)

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', 'Idempotency-Key' => idempotency_key, })
    headers['Content-Type'] = 'application/json'
    
    
    
    
    payload = @version.create('POST', @uri, headers: headers, data: create_v3_transcriptions_request.to_json)
    TranscriptionInstance.new(
        @version,
        payload,
    )
end

#create_with_metadata(idempotency_key: :unset, create_v3_transcriptions_request: nil) ⇒ TranscriptionInstance

Create the TranscriptionInstanceMetadata

Parameters:

  • idempotency_key (String) (defaults to: :unset) —

    A unique key to ensure idempotency. We recommend using UUID v7. Requests with the same key within the idempotency window return the original response.

  • create_v3_transcriptions_request (CreateV3TranscriptionsRequest) (defaults to: nil)

Returns:



177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/twilio-ruby/rest/voice/v3/transcription.rb', line 177

def create_with_metadata(
  idempotency_key: :unset,
create_v3_transcriptions_request: nil
)

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', 'Idempotency-Key' => idempotency_key, })
    headers['Content-Type'] = 'application/json'
    
    
    
    
    response = @version.create_with_metadata('POST', @uri, headers: headers, data: create_v3_transcriptions_request.to_json)
    transcription_instance = TranscriptionInstance.new(
        @version,
        response.body,
    )
    TranscriptionInstanceMetadata.new(
        @version,
        transcription_instance,
        response.headers,
        response.status_code
    )
end

#to_s ⇒ Object

Provide a user friendly representation



205
206
207
 
# File 'lib/twilio-ruby/rest/voice/v3/transcription.rb', line 205

def to_s
    '#<Twilio.Voice.V3.TranscriptionList>'
end