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/api/rest/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.



170
171
172
173
174
175
176
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/transcription.rb', line 170

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

Deletes the TranscriptionInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



202
203
204
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/transcription.rb', line 202

def delete
  @version.delete('delete', @uri)
end

#fetch ⇒ TranscriptionInstance

Fetch a TranscriptionInstance

Returns:



181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/transcription.rb', line 181

def fetch
  params = Twilio::Values.of({})

  payload = @version.fetch(
      'GET',
      @uri,
      params,
  )

  TranscriptionInstance.new(
      @version,
      payload,
      account_sid: @solution[:account_sid],
      recording_sid: @solution[:recording_sid],
      sid: @solution[:sid],
  )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



215
216
217
218
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/transcription.rb', line 215

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

#to_s ⇒ Object

Provide a user friendly representation



208
209
210
211
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/transcription.rb', line 208

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