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

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

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, account_sid: nil, reference_sid: nil, sid: nil) ⇒ AddOnResultInstance

Initialize the AddOnResultInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • account_sid (String) (defaults to: nil) —

    The unique id of the Account responsible for this recording.

  • reference_sid (String) (defaults to: nil) —

    A 34 character string that uniquely identifies the recording to which this result belongs.

  • sid (String) (defaults to: nil) —

    The result Sid that uniquely identifies this resource



250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/add_on_result.rb', line 250

def initialize(version, payload, account_sid: nil, reference_sid: nil, sid: nil)
  super(version)

  # Marshaled Properties
  @properties = {
      'sid' => payload['sid'],
      'account_sid' => payload['account_sid'],
      'status' => payload['status'],
      'add_on_sid' => payload['add_on_sid'],
      'add_on_configuration_sid' => payload['add_on_configuration_sid'],
      'date_created' => Twilio.deserialize_rfc2822(payload['date_created']),
      'date_updated' => Twilio.deserialize_rfc2822(payload['date_updated']),
      'date_completed' => Twilio.deserialize_rfc2822(payload['date_completed']),
      'reference_sid' => payload['reference_sid'],
      'subresource_uris' => payload['subresource_uris'],
  }

  # Context
  @instance_context = nil
  @params = {
      'account_sid' => ,
      'reference_sid' => reference_sid,
      'sid' => sid || @properties['sid'],
  }
end

Instance Method Details

#account_sid ⇒ String

Returns The unique sid that identifies this account.

Returns:

  • (String) —

    The unique sid that identifies this account



300
301
302
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/add_on_result.rb', line 300

def 
  @properties['account_sid']
end

#add_on_configuration_sid ⇒ String

Returns A string that uniquely identifies the Add-on configuration.

Returns:

  • (String) —

    A string that uniquely identifies the Add-on configuration.



318
319
320
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/add_on_result.rb', line 318

def add_on_configuration_sid
  @properties['add_on_configuration_sid']
end

#add_on_sid ⇒ String

Returns A string that uniquely identifies the Add-on.

Returns:

  • (String) —

    A string that uniquely identifies the Add-on.



312
313
314
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/add_on_result.rb', line 312

def add_on_sid
  @properties['add_on_sid']
end

#context ⇒ AddOnResultContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context

Returns:



280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/add_on_result.rb', line 280

def context
  unless @instance_context
    @instance_context = AddOnResultContext.new(
        @version,
        @params['account_sid'],
        @params['reference_sid'],
        @params['sid'],
    )
  end
  @instance_context
end

#date_completed ⇒ Time

Returns The date this result was completed.

Returns:

  • (Time) —

    The date this result was completed.



336
337
338
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/add_on_result.rb', line 336

def date_completed
  @properties['date_completed']
end

#date_created ⇒ Time

Returns The date this resource was created.

Returns:

  • (Time) —

    The date this resource was created



324
325
326
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/add_on_result.rb', line 324

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date this resource was last updated.

Returns:

  • (Time) —

    The date this resource was last updated



330
331
332
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/add_on_result.rb', line 330

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the AddOnResultInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



362
363
364
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/add_on_result.rb', line 362

def delete
  context.delete
end

#fetch ⇒ AddOnResultInstance

Fetch a AddOnResultInstance

Returns:



355
356
357
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/add_on_result.rb', line 355

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



382
383
384
385
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/add_on_result.rb', line 382

def inspect
  values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
  "<Twilio.Api.V2010.AddOnResultInstance #{values}>"
end

#payloads ⇒ payloads

Access the payloads

Returns:



369
370
371
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/add_on_result.rb', line 369

def payloads
  context.payloads
end

#reference_sid ⇒ String

Returns A string that uniquely identifies the recording.

Returns:

  • (String) —

    A string that uniquely identifies the recording.



342
343
344
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/add_on_result.rb', line 342

def reference_sid
  @properties['reference_sid']
end

#sid ⇒ String

Returns A string that uniquely identifies this result.

Returns:

  • (String) —

    A string that uniquely identifies this result



294
295
296
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/add_on_result.rb', line 294

def sid
  @properties['sid']
end

#status ⇒ add_on_result.Status

Returns The status of this result.

Returns:

  • (add_on_result.Status) —

    The status of this result.



306
307
308
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/add_on_result.rb', line 306

def status
  @properties['status']
end

#subresource_uris ⇒ String

Returns A dictionary of URIs for related resources.

Returns:

  • (String) —

    A dictionary of URIs for related resources



348
349
350
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/add_on_result.rb', line 348

def subresource_uris
  @properties['subresource_uris']
end

#to_s ⇒ Object

Provide a user friendly representation



375
376
377
378
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/add_on_result.rb', line 375

def to_s
  values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
  "<Twilio.Api.V2010.AddOnResultInstance #{values}>"
end