class Twilio::REST::Api::V2010::AccountContext::TranscriptionInstance
Public Class Methods
Initialize the TranscriptionInstance
@param [Version] version Version
that contains the resource @param [Hash] payload payload that contains response from Twilio
@param [String] account_sid
The SID of the
{Account}[https://www.twilio.com/docs/iam/api/account] that created the Transcription resource.
@param [String] sid The Twilio-provided string that uniquely identifies the
Transcription resource to fetch.
@return [TranscriptionInstance] TranscriptionInstance
Twilio::REST::InstanceResource::new
# File lib/twilio-ruby/rest/api/v2010/account/transcription.rb 211 def initialize(version, payload, account_sid: nil, sid: nil) 212 super(version) 213 214 # Marshaled Properties 215 @properties = { 216 'account_sid' => payload['account_sid'], 217 'api_version' => payload['api_version'], 218 'date_created' => Twilio.deserialize_rfc2822(payload['date_created']), 219 'date_updated' => Twilio.deserialize_rfc2822(payload['date_updated']), 220 'duration' => payload['duration'], 221 'price' => payload['price'].to_f, 222 'price_unit' => payload['price_unit'], 223 'recording_sid' => payload['recording_sid'], 224 'sid' => payload['sid'], 225 'status' => payload['status'], 226 'transcription_text' => payload['transcription_text'], 227 'type' => payload['type'], 228 'uri' => payload['uri'], 229 } 230 231 # Context 232 @instance_context = nil 233 @params = {'account_sid' => account_sid, 'sid' => sid || @properties['sid'], } 234 end
Public Instance Methods
@return [String] The SID of the Account that created the resource
# File lib/twilio-ruby/rest/api/v2010/account/transcription.rb 249 def account_sid 250 @properties['account_sid'] 251 end
@return [String] The API version used to create the transcription
# File lib/twilio-ruby/rest/api/v2010/account/transcription.rb 255 def api_version 256 @properties['api_version'] 257 end
Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context @return [TranscriptionContext] TranscriptionContext
for this TranscriptionInstance
# File lib/twilio-ruby/rest/api/v2010/account/transcription.rb 240 def context 241 unless @instance_context 242 @instance_context = TranscriptionContext.new(@version, @params['account_sid'], @params['sid'], ) 243 end 244 @instance_context 245 end
@return [Time] The RFC 2822 date and time in GMT that the resource was created
# File lib/twilio-ruby/rest/api/v2010/account/transcription.rb 261 def date_created 262 @properties['date_created'] 263 end
@return [Time] The RFC 2822 date and time in GMT that the resource was last updated
# File lib/twilio-ruby/rest/api/v2010/account/transcription.rb 267 def date_updated 268 @properties['date_updated'] 269 end
Delete the TranscriptionInstance
@return [Boolean] true if delete succeeds, false otherwise
# File lib/twilio-ruby/rest/api/v2010/account/transcription.rb 335 def delete 336 context.delete 337 end
@return [String] The duration of the transcribed audio in seconds.
# File lib/twilio-ruby/rest/api/v2010/account/transcription.rb 273 def duration 274 @properties['duration'] 275 end
Fetch the TranscriptionInstance
@return [TranscriptionInstance] Fetched TranscriptionInstance
# File lib/twilio-ruby/rest/api/v2010/account/transcription.rb 328 def fetch 329 context.fetch 330 end
Provide a detailed, user friendly representation
# File lib/twilio-ruby/rest/api/v2010/account/transcription.rb 348 def inspect 349 values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ") 350 "<Twilio.Api.V2010.TranscriptionInstance #{values}>" 351 end
@return [String] The charge for the transcription
# File lib/twilio-ruby/rest/api/v2010/account/transcription.rb 279 def price 280 @properties['price'] 281 end
@return [String] The currency in which price is measured
# File lib/twilio-ruby/rest/api/v2010/account/transcription.rb 285 def price_unit 286 @properties['price_unit'] 287 end
@return [String] The SID that identifies the transcription's recording
# File lib/twilio-ruby/rest/api/v2010/account/transcription.rb 291 def recording_sid 292 @properties['recording_sid'] 293 end
@return [String] The unique string that identifies the resource
# File lib/twilio-ruby/rest/api/v2010/account/transcription.rb 297 def sid 298 @properties['sid'] 299 end
@return [transcription.Status] The status of the transcription
# File lib/twilio-ruby/rest/api/v2010/account/transcription.rb 303 def status 304 @properties['status'] 305 end
Provide a user friendly representation
# File lib/twilio-ruby/rest/api/v2010/account/transcription.rb 341 def to_s 342 values = @params.map{|k, v| "#{k}: #{v}"}.join(" ") 343 "<Twilio.Api.V2010.TranscriptionInstance #{values}>" 344 end
@return [String] The text content of the transcription.
# File lib/twilio-ruby/rest/api/v2010/account/transcription.rb 309 def transcription_text 310 @properties['transcription_text'] 311 end
@return [String] The transcription type
# File lib/twilio-ruby/rest/api/v2010/account/transcription.rb 315 def type 316 @properties['type'] 317 end
@return [String] The URI of the resource, relative to `api.twilio.com`
# File lib/twilio-ruby/rest/api/v2010/account/transcription.rb 321 def uri 322 @properties['uri'] 323 end