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 SID of the Account that created this AddOnResult resource.

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

    The SID of the Call resource to fetch.



257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/add_on_result.rb', line 257

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  || @properties['reference_sid']  ,'sid' => sid  || @properties['sid']  , }
end

Instance Method Details

#account_sid ⇒ String

Returns The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the Recording AddOnResult resource.

Returns:



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

def 
    @properties['account_sid']
end

#add_on_configuration_sid ⇒ String

Returns The SID of the Add-on configuration.

Returns:

  • (String) —

    The SID of the Add-on configuration.



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

def add_on_configuration_sid
    @properties['add_on_configuration_sid']
end

#add_on_sid ⇒ String

Returns The SID of the Add-on to which the result belongs.

Returns:

  • (String) —

    The SID of the Add-on to which the result belongs.



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

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:



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

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 and time in GMT that the result was completed specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.

Returns:



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

def date_completed
    @properties['date_completed']
end

#date_created ⇒ Time

Returns The date and time in GMT that the resource was created specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.

Returns:



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

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns The date and time in GMT that the resource was last updated specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.

Returns:



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

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the AddOnResultInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



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

def delete

    context.delete
end

#fetch ⇒ AddOnResultInstance

Fetch the AddOnResultInstance

Returns:



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

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 The SID of the recording to which the AddOnResult resource belongs.

Returns:

  • (String) —

    The SID of the recording to which the AddOnResult resource belongs.



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

def reference_sid
    @properties['reference_sid']
end

#sid ⇒ String

Returns The unique string that that we created to identify the Recording AddOnResult resource.

Returns:

  • (String) —

    The unique string that that we created to identify the Recording AddOnResult resource.



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

def sid
    @properties['sid']
end

#status ⇒ Status

Returns:

  • (Status) 


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

def status
    @properties['status']
end

#subresource_uris ⇒ Hash

Returns A list of related resources identified by their relative URIs.

Returns:

  • (Hash) —

    A list of related resources identified by their relative URIs.



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

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