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 the Recording AddOnResult resource.

  • reference_sid (String) (defaults to: nil)

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

  • sid (String) (defaults to: nil)

    The Twilio-provided string that uniquely identifies the Recording AddOnResult resource to fetch.


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

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_sidString

Returns The SID of the Account that created the resource.

Returns:

  • (String)

    The SID of the Account that created the resource


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

def 
  @properties['account_sid']
end

#add_on_configuration_sidString

Returns The SID of the Add-on configuration.

Returns:

  • (String)

    The SID of the Add-on configuration


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

def add_on_configuration_sid
  @properties['add_on_configuration_sid']
end

#add_on_sidString

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


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

def add_on_sid
  @properties['add_on_sid']
end

#contextAddOnResultContext

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

Returns:


286
287
288
289
290
291
292
293
294
295
296
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/add_on_result.rb', line 286

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

#date_completedTime

Returns The date and time in GMT that the result was completed.

Returns:

  • (Time)

    The date and time in GMT that the result was completed


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

def date_completed
  @properties['date_completed']
end

#date_createdTime

Returns The RFC 2822 date and time in GMT that the resource was created.

Returns:

  • (Time)

    The RFC 2822 date and time in GMT that the resource was created


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

def date_created
  @properties['date_created']
end

#date_updatedTime

Returns The RFC 2822 date and time in GMT that the resource was last updated.

Returns:

  • (Time)

    The RFC 2822 date and time in GMT that the resource was last updated


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

def date_updated
  @properties['date_updated']
end

#deleteBoolean

Delete the AddOnResultInstance

Returns:

  • (Boolean)

    true if delete succeeds, false otherwise


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

def delete
  context.delete
end

#fetchAddOnResultInstance

Fetch the AddOnResultInstance

Returns:


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

def fetch
  context.fetch
end

#inspectObject

Provide a detailed, user friendly representation


388
389
390
391
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/add_on_result.rb', line 388

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

#payloadspayloads

Access the payloads

Returns:


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

def payloads
  context.payloads
end

#reference_sidString

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


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

def reference_sid
  @properties['reference_sid']
end

#sidString

Returns The unique string that identifies the resource.

Returns:

  • (String)

    The unique string that identifies the resource


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

def sid
  @properties['sid']
end

#statusadd_on_result.Status

Returns The status of the result.

Returns:

  • (add_on_result.Status)

    The status of the result


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

def status
  @properties['status']
end

#subresource_urisString

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

Returns:

  • (String)

    A list of related resources identified by their relative URIs


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

def subresource_uris
  @properties['subresource_uris']
end

#to_sObject

Provide a user friendly representation


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

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