Class: Twilio::REST::Api::V2010::AccountContext::RecordingContext::AddOnResultContext::PayloadInstance

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

Instance Method Summary collapse

Constructor Details

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

Initialize the PayloadInstance

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 the recording.

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

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

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

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

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

    The paylod Sid that uniquely identifies this resource



233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/add_on_result/payload.rb', line 233

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

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

  # Context
  @instance_context = nil
  @params = {
      'account_sid' => ,
      'reference_sid' => reference_sid,
      'add_on_result_sid' => add_on_result_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



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

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.



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

def add_on_configuration_sid
  @properties['add_on_configuration_sid']
end

#add_on_result_sid ⇒ String

Returns A string that uniquely identifies the result.

Returns:

  • (String) —

    A string that uniquely identifies the result



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

def add_on_result_sid
  @properties['add_on_result_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.



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

def add_on_sid
  @properties['add_on_sid']
end

#content_type ⇒ String

Returns The MIME type of the payload.

Returns:

  • (String) —

    The MIME type of the payload.



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

def content_type
  @properties['content_type']
end

#context ⇒ PayloadContext

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

Returns:



265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/add_on_result/payload.rb', line 265

def context
  unless @instance_context
    @instance_context = PayloadContext.new(
        @version,
        @params['account_sid'],
        @params['reference_sid'],
        @params['add_on_result_sid'],
        @params['sid'],
    )
  end
  @instance_context
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/payload.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/payload.rb', line 328

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the PayloadInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



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

def delete
  context.delete
end

#fetch ⇒ PayloadInstance

Fetch a PayloadInstance

Returns:



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

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#label ⇒ String

Returns A string that describes the payload.

Returns:

  • (String) —

    A string that describes the payload.



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

def label
  @properties['label']
end

#reference_sid ⇒ String

Returns A string that uniquely identifies the recording.

Returns:

  • (String) —

    A string that uniquely identifies the recording.



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

def reference_sid
  @properties['reference_sid']
end

#sid ⇒ String

Returns A string that uniquely identifies this payload.

Returns:

  • (String) —

    A string that uniquely identifies this payload



280
281
282
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/add_on_result/payload.rb', line 280

def sid
  @properties['sid']
end

#subresource_uris ⇒ String

Returns The subresource_uris.

Returns:

  • (String) —

    The subresource_uris



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

def subresource_uris
  @properties['subresource_uris']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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