Class: Twilio::REST::Api::V2010::AccountContext::RecordingContext::TranscriptionContext

Inherits:
InstanceContext
  • Object
show all
Defined in:
lib/twilio-ruby/rest/api/v2010/account/recording/transcription.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, account_sid, recording_sid, sid) ⇒ TranscriptionContext

Initialize the TranscriptionContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • account_sid (String) —

    The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the Transcription resource to fetch.

  • recording_sid (String) —

    The SID of the [Recording](www.twilio.com/docs/voice/api/recording) that created the transcription to fetch.

  • sid (String) —

    The Twilio-provided string that uniquely identifies the Transcription resource to fetch.



172
173
174
175
176
177
178
179
180
181
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/transcription.rb', line 172

def initialize(version, , recording_sid, sid)
    super(version)
    

    # Path Solution
    @solution = { account_sid: , recording_sid: recording_sid, sid: sid,  }
    @uri = "/Accounts/#{@solution[:account_sid]}/Recordings/#{@solution[:recording_sid]}/Transcriptions/#{@solution[:sid]}.json"

    
end

Instance Method Details

#delete ⇒ Boolean

Delete the TranscriptionInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



185
186
187
188
189
190
191
192
193
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/transcription.rb', line 185

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



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/transcription.rb', line 198

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:



217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/transcription.rb', line 217

def fetch

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

#fetch_with_metadata ⇒ TranscriptionInstance

Fetch the TranscriptionInstanceMetadata

Returns:



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/transcription.rb', line 238

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,
        account_sid: @solution[:account_sid],
        recording_sid: @solution[:recording_sid],
        sid: @solution[:sid],
    )
    TranscriptionInstanceMetadata.new(
        @version,
        transcription_instance,
        response.headers,
        response.status_code
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



272
273
274
275
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/transcription.rb', line 272

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

#to_s ⇒ Object

Provide a user friendly representation



265
266
267
268
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/transcription.rb', line 265

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