Class: Twilio::REST::Numbers::V2::ApplicationInstance

Inherits:
InstanceResource show all
Defined in:
lib/twilio-ruby/rest/numbers/v2/application.rb

Instance Method Summary collapse

Constructor Details

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

Initialize the ApplicationInstance

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 Application resource.

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

    The SID of the Call resource to fetch.



518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
 
# File 'lib/twilio-ruby/rest/numbers/v2/application.rb', line 518

def initialize(version, payload , sid: nil)
    super(version)
    
    
    # Marshaled Properties
    @properties = { 
        'sid' => payload['sid'],
        'application_requirements_sid' => payload['application_requirements_sid'],
        'application_requirements_version' => payload['application_requirements_version'] == nil ? payload['application_requirements_version'] : payload['application_requirements_version'].to_i,
        'account_sid' => payload['account_sid'],
        'bundle_sid' => payload['bundle_sid'],
        'reviewer' => payload['reviewer'],
        'zendesk_ticket_id' => payload['zendesk_ticket_id'],
        'friendly_name' => payload['friendly_name'],
        'notification_emails' => payload['notification_emails'],
        'iso_country' => payload['iso_country'],
        'state' => payload['state'],
        'setup' => payload['setup'],
        'business_information' => payload['business_information'],
        'user_sign_up' => payload['user_sign_up'],
        'compliance_keywords' => payload['compliance_keywords'],
        'content_examples' => payload['content_examples'],
        'sms_campaign_details' => payload['sms_campaign_details'],
        'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
        'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
        'created_by' => payload['created_by'],
        'updated_by' => payload['updated_by'],
    }

    # Context
    @instance_context = nil
    @params = { 'sid' => sid  || @properties['sid']  , }
end

Instance Method Details

#account_sid ⇒ String

Returns The Account SID associated with the application.

Returns:

  • (String) —

    The Account SID associated with the application.



583
584
585
 
# File 'lib/twilio-ruby/rest/numbers/v2/application.rb', line 583

def 
    @properties['account_sid']
end

#application_requirements_sid ⇒ String

Returns The Application Requirements SID.

Returns:

  • (String) —

    The Application Requirements SID.



571
572
573
 
# File 'lib/twilio-ruby/rest/numbers/v2/application.rb', line 571

def application_requirements_sid
    @properties['application_requirements_sid']
end

#application_requirements_version ⇒ String

Returns The version of the application requirements.

Returns:

  • (String) —

    The version of the application requirements.



577
578
579
 
# File 'lib/twilio-ruby/rest/numbers/v2/application.rb', line 577

def application_requirements_version
    @properties['application_requirements_version']
end

#bundle_sid ⇒ String

Returns The Bundle SID for regulatory compliance.

Returns:

  • (String) —

    The Bundle SID for regulatory compliance.



589
590
591
 
# File 'lib/twilio-ruby/rest/numbers/v2/application.rb', line 589

def bundle_sid
    @properties['bundle_sid']
end

#business_information ⇒ CreateShortCodeApplicationResponseBusinessInformation

Returns:

  • (CreateShortCodeApplicationResponseBusinessInformation) 


637
638
639
 
# File 'lib/twilio-ruby/rest/numbers/v2/application.rb', line 637

def business_information
    @properties['business_information']
end

#compliance_keywords ⇒ CreateShortCodeApplicationResponseComplianceKeywords

Returns:

  • (CreateShortCodeApplicationResponseComplianceKeywords) 


649
650
651
 
# File 'lib/twilio-ruby/rest/numbers/v2/application.rb', line 649

def compliance_keywords
    @properties['compliance_keywords']
end

#content_examples ⇒ CreateShortCodeApplicationResponseContentExamples

Returns:

  • (CreateShortCodeApplicationResponseContentExamples) 


655
656
657
 
# File 'lib/twilio-ruby/rest/numbers/v2/application.rb', line 655

def content_examples
    @properties['content_examples']
end

#context ⇒ ApplicationContext

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

Returns:



556
557
558
559
560
561
 
# File 'lib/twilio-ruby/rest/numbers/v2/application.rb', line 556

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

#created_by ⇒ String

Returns The identity of the user who created the application.

Returns:

  • (String) —

    The identity of the user who created the application.



679
680
681
 
# File 'lib/twilio-ruby/rest/numbers/v2/application.rb', line 679

def created_by
    @properties['created_by']
end

#date_created ⇒ Time

Returns The date and time the application was created.

Returns:

  • (Time) —

    The date and time the application was created.



667
668
669
 
# File 'lib/twilio-ruby/rest/numbers/v2/application.rb', line 667

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns The date and time the application was last updated.

Returns:

  • (Time) —

    The date and time the application was last updated.



673
674
675
 
# File 'lib/twilio-ruby/rest/numbers/v2/application.rb', line 673

def date_updated
    @properties['date_updated']
end

#fetch ⇒ ApplicationInstance

Fetch the ApplicationInstance

Returns:



692
693
694
695
 
# File 'lib/twilio-ruby/rest/numbers/v2/application.rb', line 692

def fetch

    context.fetch
end

#friendly_name ⇒ String

Returns The friendly name of the application.

Returns:

  • (String) —

    The friendly name of the application.



607
608
609
 
# File 'lib/twilio-ruby/rest/numbers/v2/application.rb', line 607

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



706
707
708
709
 
# File 'lib/twilio-ruby/rest/numbers/v2/application.rb', line 706

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

#iso_country ⇒ String

Returns The ISO country code.

Returns:

  • (String) —

    The ISO country code.



619
620
621
 
# File 'lib/twilio-ruby/rest/numbers/v2/application.rb', line 619

def iso_country
    @properties['iso_country']
end

#notification_emails ⇒ Array<String>

Returns The notification emails for the application.

Returns:

  • (Array<String>) —

    The notification emails for the application.



613
614
615
 
# File 'lib/twilio-ruby/rest/numbers/v2/application.rb', line 613

def notification_emails
    @properties['notification_emails']
end

#reviewer ⇒ String

Returns The reviewer of the application.

Returns:

  • (String) —

    The reviewer of the application.



595
596
597
 
# File 'lib/twilio-ruby/rest/numbers/v2/application.rb', line 595

def reviewer
    @properties['reviewer']
end

#setup ⇒ CreateShortCodeApplicationResponseSetup

Returns:

  • (CreateShortCodeApplicationResponseSetup) 


631
632
633
 
# File 'lib/twilio-ruby/rest/numbers/v2/application.rb', line 631

def setup
    @properties['setup']
end

#sid ⇒ String

Returns The unique identifier of the Short Code Application.

Returns:

  • (String) —

    The unique identifier of the Short Code Application.



565
566
567
 
# File 'lib/twilio-ruby/rest/numbers/v2/application.rb', line 565

def sid
    @properties['sid']
end

#sms_campaign_details ⇒ CreateShortCodeApplicationResponseSmsCampaignDetails

Returns:

  • (CreateShortCodeApplicationResponseSmsCampaignDetails) 


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

def sms_campaign_details
    @properties['sms_campaign_details']
end

#state ⇒ String

Returns The state of the application.

Returns:

  • (String) —

    The state of the application.



625
626
627
 
# File 'lib/twilio-ruby/rest/numbers/v2/application.rb', line 625

def state
    @properties['state']
end

#to_s ⇒ Object

Provide a user friendly representation



699
700
701
702
 
# File 'lib/twilio-ruby/rest/numbers/v2/application.rb', line 699

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

#updated_by ⇒ String

Returns The identity of the user who last updated the application.

Returns:

  • (String) —

    The identity of the user who last updated the application.



685
686
687
 
# File 'lib/twilio-ruby/rest/numbers/v2/application.rb', line 685

def updated_by
    @properties['updated_by']
end

#user_sign_up ⇒ CreateShortCodeApplicationResponseUserSignUp

Returns:

  • (CreateShortCodeApplicationResponseUserSignUp) 


643
644
645
 
# File 'lib/twilio-ruby/rest/numbers/v2/application.rb', line 643

def 
    @properties['user_sign_up']
end

#zendesk_ticket_id ⇒ String

Returns The Zendesk ticket ID associated with the application.

Returns:

  • (String) —

    The Zendesk ticket ID associated with the application.



601
602
603
 
# File 'lib/twilio-ruby/rest/numbers/v2/application.rb', line 601

def zendesk_ticket_id
    @properties['zendesk_ticket_id']
end