Class: Twilio::REST::Voice::V2::TranscriptionContext

Inherits:
InstanceContext show all
Defined in:
lib/twilio-ruby/rest/voice/v2/transcription.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, id_or_unique_name) ⇒ TranscriptionContext

Initialize the TranscriptionContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • id_or_unique_name (String) 


148
149
150
151
152
153
154
155
156
157
 
# File 'lib/twilio-ruby/rest/voice/v2/transcription.rb', line 148

def initialize(version, id_or_unique_name)
    super(version)
    

    # Path Solution
    @solution = { id_or_unique_name: id_or_unique_name,  }
    @uri = "/Configurations/Transcription/#{@solution[:id_or_unique_name]}"

    
end

Instance Method Details

#delete ⇒ Boolean

Delete the TranscriptionInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



161
162
163
164
165
166
167
168
169
 
# File 'lib/twilio-ruby/rest/voice/v2/transcription.rb', line 161

def delete

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    

    @version.delete('DELETE', @uri, headers: headers)
end

#delete_with_metadata ⇒ Boolean

Delete the TranscriptionInstanceMetadata

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/twilio-ruby/rest/voice/v2/transcription.rb', line 174

def delete_with_metadata

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
      response = @version.delete_with_metadata('DELETE', @uri, headers: headers)
      transcription_instance = TranscriptionInstance.new(
          @version,
          response.body,
          account_sid: @solution[:account_sid],
          sid: @solution[:sid],
      )
      TranscriptionInstanceMetadata.new(@version, transcription_instance, response.headers, response.status_code)
end

#fetch ⇒ TranscriptionInstance

Fetch the TranscriptionInstance

Returns:



193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/twilio-ruby/rest/voice/v2/transcription.rb', line 193

def fetch

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.fetch('GET', @uri, headers: headers)
    TranscriptionInstance.new(
        @version,
        payload,
        id_or_unique_name: @solution[:id_or_unique_name],
    )
end

#fetch_with_metadata ⇒ TranscriptionInstance

Fetch the TranscriptionInstanceMetadata

Returns:



212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/twilio-ruby/rest/voice/v2/transcription.rb', line 212

def fetch_with_metadata

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.fetch_with_metadata('GET', @uri, headers: headers)
    transcription_instance = TranscriptionInstance.new(
        @version,
        response.body,
        id_or_unique_name: @solution[:id_or_unique_name],
    )
    TranscriptionInstanceMetadata.new(
        @version,
        transcription_instance,
        response.headers,
        response.status_code
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



292
293
294
295
 
# File 'lib/twilio-ruby/rest/voice/v2/transcription.rb', line 292

def inspect
    context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
    "#<Twilio.Voice.V2.TranscriptionContext #{context}>"
end

#to_s ⇒ Object

Provide a user friendly representation



285
286
287
288
 
# File 'lib/twilio-ruby/rest/voice/v2/transcription.rb', line 285

def to_s
    context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
    "#<Twilio.Voice.V2.TranscriptionContext #{context}>"
end

#update(voice_v2_configuration_transcription_request: :unset) ⇒ TranscriptionInstance

Update the TranscriptionInstance

Parameters:

  • voice_v2_configuration_transcription_request (VoiceV2ConfigurationTranscriptionRequest) (defaults to: :unset)

Returns:



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/twilio-ruby/rest/voice/v2/transcription.rb', line 238

def update(voice_v2_configuration_transcription_request: :unset
)

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    headers['Content-Type'] = 'application/json'
    
    
    
    
    payload = @version.update('PUT', @uri, headers: headers, data: voice_v2_configuration_transcription_request.to_json)
    TranscriptionInstance.new(
        @version,
        payload,
        id_or_unique_name: @solution[:id_or_unique_name],
    )
end

#update_with_metadata(voice_v2_configuration_transcription_request: :unset) ⇒ TranscriptionInstance

Update the TranscriptionInstanceMetadata

Parameters:

  • voice_v2_configuration_transcription_request (VoiceV2ConfigurationTranscriptionRequest) (defaults to: :unset)

Returns:



259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/twilio-ruby/rest/voice/v2/transcription.rb', line 259

def update_with_metadata(voice_v2_configuration_transcription_request: :unset
)

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    headers['Content-Type'] = 'application/json'
    
    
    
    
    response = @version.update_with_metadata('PUT', @uri, headers: headers, data: voice_v2_configuration_transcription_request.to_json)
    transcription_instance = TranscriptionInstance.new(
        @version,
        response.body,
        id_or_unique_name: @solution[:id_or_unique_name],
    )
    TranscriptionInstanceMetadata.new(
        @version,
        transcription_instance,
        response.headers,
        response.status_code
    )
end