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 that contains the resource

  • payload that contains response from Twilio

  • The SID of the Account that created this SupportingDocument resource.

  • (defaults to: nil)

    The SID of the Call resource to fetch.



541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document.rb', line 541

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:



585
586
587
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document.rb', line 585

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:

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



627
628
629
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document.rb', line 627

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:

  • CallContext for this CallInstance



570
571
572
573
574
575
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document.rb', line 570

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:



633
634
635
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document.rb', line 633

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:



639
640
641
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document.rb', line 639

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the SupportingDocumentInstance

Returns:

  • True if delete succeeds, false otherwise



652
653
654
655
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document.rb', line 652

def delete

    context.delete
end

#errors ⇒ Array<Hash>

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

Returns:

  • A list of errors that occurred during the registering RC Bundle



615
616
617
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document.rb', line 615

def errors
    @properties['errors']
end

#failure_reason ⇒ String

Returns The failure reason of the Supporting Document Resource.

Returns:

  • The failure reason of the Supporting Document Resource.



609
610
611
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document.rb', line 609

def failure_reason
    @properties['failure_reason']
end

#fetch ⇒ SupportingDocumentInstance

Fetch the SupportingDocumentInstance

Returns:

  • Fetched SupportingDocumentInstance



660
661
662
663
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document.rb', line 660

def fetch

    context.fetch
end

#friendly_name ⇒ String

Returns The string that you assigned to describe the resource.

Returns:

  • The string that you assigned to describe the resource.



591
592
593
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document.rb', line 591

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



690
691
692
693
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document.rb', line 690

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:

  • The image type uploaded in the Supporting Document container.



597
598
599
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document.rb', line 597

def mime_type
    @properties['mime_type']
end

#sid ⇒ String

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

Returns:

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



579
580
581
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document.rb', line 579

def sid
    @properties['sid']
end

#status ⇒ Status

Returns:



603
604
605
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document.rb', line 603

def status
    @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



683
684
685
686
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document.rb', line 683

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:

  • The type of the Supporting Document.



621
622
623
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document.rb', line 621

def type
    @properties['type']
end

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

Update the SupportingDocumentInstance

Parameters:

  • (defaults to: :unset)

    The string that you assigned to describe the resource.

  • (defaults to: :unset)

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

Returns:

  • Updated SupportingDocumentInstance



670
671
672
673
674
675
676
677
678
679
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document.rb', line 670

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:

  • The absolute URL of the Supporting Document resource.



645
646
647
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document.rb', line 645

def url
    @properties['url']
end