Class: Twilio::REST::Numbers::V2::RegulatoryComplianceList::SupportingDocumentInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, sid: nil) ⇒ SupportingDocumentInstance

Initialize the SupportingDocumentInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • account_sid (String) —

    The SID of the Account that created this SupportingDocument resource.

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

    The SID of the Call resource to fetch.



292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document.rb', line 292

def initialize(version, payload , sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'sid' => payload['sid'],
        'account_sid' => payload['account_sid'],
        'friendly_name' => payload['friendly_name'],
        'mime_type' => payload['mime_type'],
        'status' => payload['status'],
        'failure_reason' => payload['failure_reason'],
        'errors' => payload['errors'],
        'type' => payload['type'],
        'attributes' => payload['attributes'],
        'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
        'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
        'url' => payload['url'],
    }

    # Context
    @instance_context = nil
    @params = { '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 Document resource.

Returns:



335
336
337
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document.rb', line 335

def 
    @properties['account_sid']
end

#attributes ⇒ Hash

Returns The set of parameters that are the attributes of the Supporting Documents resource which are listed in the Supporting Document Types.

Returns:

  • (Hash) —

    The set of parameters that are the attributes of the Supporting Documents resource which are listed in the Supporting Document Types.



377
378
379
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document.rb', line 377

def attributes
    @properties['attributes']
end

#context ⇒ SupportingDocumentContext

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

Returns:



320
321
322
323
324
325
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document.rb', line 320

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

#date_created ⇒ Time

Returns The date and time in GMT when the resource was created specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:



383
384
385
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document.rb', line 383

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns The date and time in GMT when the resource was last updated specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:



389
390
391
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document.rb', line 389

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the SupportingDocumentInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



402
403
404
405
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document.rb', line 402

def delete

    context.delete
end

#errors ⇒ Array<Hash>

Returns A list of errors that occurred during the registering RC Bundle.

Returns:

  • (Array<Hash>) —

    A list of errors that occurred during the registering RC Bundle



365
366
367
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document.rb', line 365

def errors
    @properties['errors']
end

#failure_reason ⇒ String

Returns The failure reason of the Supporting Document Resource.

Returns:

  • (String) —

    The failure reason of the Supporting Document Resource.



359
360
361
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document.rb', line 359

def failure_reason
    @properties['failure_reason']
end

#fetch ⇒ SupportingDocumentInstance

Fetch the SupportingDocumentInstance

Returns:



410
411
412
413
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document.rb', line 410

def fetch

    context.fetch
end

#friendly_name ⇒ String

Returns The string that you assigned to describe the resource.

Returns:

  • (String) —

    The string that you assigned to describe the resource.



341
342
343
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document.rb', line 341

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



440
441
442
443
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document.rb', line 440

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

#mime_type ⇒ String

Returns The image type uploaded in the Supporting Document container.

Returns:

  • (String) —

    The image type uploaded in the Supporting Document container.



347
348
349
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document.rb', line 347

def mime_type
    @properties['mime_type']
end

#sid ⇒ String

Returns The unique string created by Twilio to identify the Supporting Document resource.

Returns:

  • (String) —

    The unique string created by Twilio to identify the Supporting Document resource.



329
330
331
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document.rb', line 329

def sid
    @properties['sid']
end

#status ⇒ Status

Returns:

  • (Status) 


353
354
355
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document.rb', line 353

def status
    @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



433
434
435
436
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document.rb', line 433

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

#type ⇒ String

Returns The type of the Supporting Document.

Returns:

  • (String) —

    The type of the Supporting Document.



371
372
373
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document.rb', line 371

def type
    @properties['type']
end

#update(friendly_name: :unset, attributes: :unset) ⇒ SupportingDocumentInstance

Update the SupportingDocumentInstance

Parameters:

  • friendly_name (String) (defaults to: :unset) —

    The string that you assigned to describe the resource.

  • attributes (Object) (defaults to: :unset) —

    The set of parameters that are the attributes of the Supporting Document resource which are derived Supporting Document Types.

Returns:



420
421
422
423
424
425
426
427
428
429
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document.rb', line 420

def update(
    friendly_name: :unset, 
    attributes: :unset
)

    context.update(
        friendly_name: friendly_name, 
        attributes: attributes, 
    )
end

#url ⇒ String

Returns The absolute URL of the Supporting Document resource.

Returns:

  • (String) —

    The absolute URL of the Supporting Document resource.



395
396
397
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document.rb', line 395

def url
    @properties['url']
end