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.



510
511
512
513
514
515
516
517
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
 
# File 'lib/twilio-ruby/rest/numbers/v2/application.rb', line 510

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.



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

def 
    @properties['account_sid']
end

#application_requirements_sid ⇒ String

Returns The Application Requirements SID.

Returns:

  • (String) —

    The Application Requirements SID.



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

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.



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

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.



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

def bundle_sid
    @properties['bundle_sid']
end

#business_information ⇒ CreateShortCodeApplicationResponseBusinessInformation

Returns:

  • (CreateShortCodeApplicationResponseBusinessInformation) 


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

def business_information
    @properties['business_information']
end

#compliance_keywords ⇒ CreateShortCodeApplicationResponseComplianceKeywords

Returns:

  • (CreateShortCodeApplicationResponseComplianceKeywords) 


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

def compliance_keywords
    @properties['compliance_keywords']
end

#content_examples ⇒ CreateShortCodeApplicationResponseContentExamples

Returns:

  • (CreateShortCodeApplicationResponseContentExamples) 


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

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:



548
549
550
551
552
553
 
# File 'lib/twilio-ruby/rest/numbers/v2/application.rb', line 548

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.



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

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.



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

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.



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

def date_updated
    @properties['date_updated']
end

#fetch ⇒ ApplicationInstance

Fetch the ApplicationInstance

Returns:



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

def fetch

    context.fetch
end

#friendly_name ⇒ String

Returns The friendly name of the application.

Returns:

  • (String) —

    The friendly name of the application.



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

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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.



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

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.



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

def notification_emails
    @properties['notification_emails']
end

#reviewer ⇒ String

Returns The reviewer of the application.

Returns:

  • (String) —

    The reviewer of the application.



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

def reviewer
    @properties['reviewer']
end

#setup ⇒ CreateShortCodeApplicationResponseSetup

Returns:

  • (CreateShortCodeApplicationResponseSetup) 


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

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.



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

def sid
    @properties['sid']
end

#sms_campaign_details ⇒ CreateShortCodeApplicationResponseSmsCampaignDetails

Returns:

  • (CreateShortCodeApplicationResponseSmsCampaignDetails) 


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

def sms_campaign_details
    @properties['sms_campaign_details']
end

#state ⇒ String

Returns The state of the application.

Returns:

  • (String) —

    The state of the application.



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

def state
    @properties['state']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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.



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

def updated_by
    @properties['updated_by']
end

#user_sign_up ⇒ CreateShortCodeApplicationResponseUserSignUp

Returns:

  • (CreateShortCodeApplicationResponseUserSignUp) 


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

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.



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

def zendesk_ticket_id
    @properties['zendesk_ticket_id']
end