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



240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/add_on_result/payload.rb', line 240

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_sidString

Returns The unique sid that identifies this account.

Returns:

  • (String)

    The unique sid that identifies this account



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

def 
  @properties['account_sid']
end

#add_on_configuration_sidString

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

Returns:

  • (String)

    A string that uniquely identifies the Add-on configuration.



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

def add_on_configuration_sid
  @properties['add_on_configuration_sid']
end

#add_on_result_sidString

Returns A string that uniquely identifies the result.

Returns:

  • (String)

    A string that uniquely identifies the result



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

def add_on_result_sid
  @properties['add_on_result_sid']
end

#add_on_sidString

Returns A string that uniquely identifies the Add-on.

Returns:

  • (String)

    A string that uniquely identifies the Add-on.



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

def add_on_sid
  @properties['add_on_sid']
end

#content_typeString

Returns The MIME type of the payload.

Returns:

  • (String)

    The MIME type of the payload.



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

def content_type
  @properties['content_type']
end

#contextPayloadContext

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

Returns:



272
273
274
275
276
277
278
279
280
281
282
283
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/add_on_result/payload.rb', line 272

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_createdTime

Returns The date this resource was created.

Returns:

  • (Time)

    The date this resource was created



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

def date_created
  @properties['date_created']
end

#date_updatedTime

Returns The date this resource was last updated.

Returns:

  • (Time)

    The date this resource was last updated



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

def date_updated
  @properties['date_updated']
end

#deleteBoolean

Deletes the PayloadInstance

Returns:

  • (Boolean)

    true if delete succeeds, true otherwise



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

def delete
  context.delete
end

#fetchPayloadInstance

Fetch a PayloadInstance

Returns:



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

def fetch
  context.fetch
end

#inspectObject

Provide a detailed, user friendly representation



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

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

#labelString

Returns A string that describes the payload.

Returns:

  • (String)

    A string that describes the payload.



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

def label
  @properties['label']
end

#reference_sidString

Returns A string that uniquely identifies the recording.

Returns:

  • (String)

    A string that uniquely identifies the recording.



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

def reference_sid
  @properties['reference_sid']
end

#sidString

Returns A string that uniquely identifies this payload.

Returns:

  • (String)

    A string that uniquely identifies this payload



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

def sid
  @properties['sid']
end

#subresource_urisString

Returns The subresource_uris.

Returns:

  • (String)

    The subresource_uris



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

def subresource_uris
  @properties['subresource_uris']
end

#to_sObject

Provide a user friendly representation



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

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