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



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

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



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 A string that uniquely identifies the Add-on configuration.

Returns:

  • (String) —

    A string that uniquely identifies 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 A string that uniquely identifies the Add-on.

Returns:

  • (String) —

    A string that uniquely identifies the Add-on.



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:



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

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.



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 this resource was created.

Returns:

  • (Time) —

    The date this resource was created



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 this resource was last updated.

Returns:

  • (Time) —

    The date this resource was last updated



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

Deletes the AddOnResultInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



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

def delete
  context.delete
end

#fetch ⇒ AddOnResultInstance

Fetch a AddOnResultInstance

Returns:



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

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#payloads ⇒ payloads

Access the payloads

Returns:



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

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.



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 A string that uniquely identifies this result.

Returns:

  • (String) —

    A string that uniquely identifies this result



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

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.



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 ⇒ String

Returns The subresource_uris.

Returns:

  • (String) —

    The subresource_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



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

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