Class: Twilio::REST::Messaging::V1::TollfreeVerificationInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb

Instance Method Summary collapse

Constructor Details

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

Initialize the TollfreeVerificationInstance

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

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

    The SID of the Call resource to fetch.



414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 414

def initialize(version, payload , sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'sid' => payload['sid'],
        'account_sid' => payload['account_sid'],
        'customer_profile_sid' => payload['customer_profile_sid'],
        'trust_product_sid' => payload['trust_product_sid'],
        'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
        'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
        'regulated_item_sid' => payload['regulated_item_sid'],
        'business_name' => payload['business_name'],
        'business_street_address' => payload['business_street_address'],
        'business_street_address2' => payload['business_street_address2'],
        'business_city' => payload['business_city'],
        'business_state_province_region' => payload['business_state_province_region'],
        'business_postal_code' => payload['business_postal_code'],
        'business_country' => payload['business_country'],
        'business_website' => payload['business_website'],
        'business_contact_first_name' => payload['business_contact_first_name'],
        'business_contact_last_name' => payload['business_contact_last_name'],
        'business_contact_email' => payload['business_contact_email'],
        'business_contact_phone' => payload['business_contact_phone'],
        'notification_email' => payload['notification_email'],
        'use_case_categories' => payload['use_case_categories'],
        'use_case_summary' => payload['use_case_summary'],
        'production_message_sample' => payload['production_message_sample'],
        'opt_in_image_urls' => payload['opt_in_image_urls'],
        'opt_in_type' => payload['opt_in_type'],
        'message_volume' => payload['message_volume'],
        'additional_information' => payload['additional_information'],
        'tollfree_phone_number_sid' => payload['tollfree_phone_number_sid'],
        'status' => payload['status'],
        'url' => payload['url'],
        'rejection_reason' => payload['rejection_reason'],
        'error_code' => payload['error_code'] == nil ? payload['error_code'] : payload['error_code'].to_i,
        'edit_expiration' => Twilio.deserialize_iso8601_datetime(payload['edit_expiration']),
        'edit_allowed' => payload['edit_allowed'],
        'rejection_reasons' => payload['rejection_reasons'],
        'resource_links' => payload['resource_links'],
        'external_reference_id' => payload['external_reference_id'],
    }

    # 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 Tollfree Verification resource.

Returns:



482
483
484
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 482

def 
    @properties['account_sid']
end

#additional_information ⇒ String

Returns Additional information to be provided for verification.

Returns:

  • (String) —

    Additional information to be provided for verification.



632
633
634
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 632

def additional_information
    @properties['additional_information']
end

#business_city ⇒ String

Returns The city of the business or organization using the Tollfree number.

Returns:

  • (String) —

    The city of the business or organization using the Tollfree number.



536
537
538
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 536

def business_city
    @properties['business_city']
end

#business_contact_email ⇒ String

Returns The email address of the contact for the business or organization using the Tollfree number.

Returns:

  • (String) —

    The email address of the contact for the business or organization using the Tollfree number.



578
579
580
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 578

def business_contact_email
    @properties['business_contact_email']
end

#business_contact_first_name ⇒ String

Returns The first name of the contact for the business or organization using the Tollfree number.

Returns:

  • (String) —

    The first name of the contact for the business or organization using the Tollfree number.



566
567
568
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 566

def business_contact_first_name
    @properties['business_contact_first_name']
end

#business_contact_last_name ⇒ String

Returns The last name of the contact for the business or organization using the Tollfree number.

Returns:

  • (String) —

    The last name of the contact for the business or organization using the Tollfree number.



572
573
574
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 572

def business_contact_last_name
    @properties['business_contact_last_name']
end

#business_contact_phone ⇒ String

Returns The E.164 formatted phone number of the contact for the business or organization using the Tollfree number.

Returns:

  • (String) —

    The E.164 formatted phone number of the contact for the business or organization using the Tollfree number.



584
585
586
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 584

def business_contact_phone
    @properties['business_contact_phone']
end

#business_country ⇒ String

Returns The country of the business or organization using the Tollfree number.

Returns:

  • (String) —

    The country of the business or organization using the Tollfree number.



554
555
556
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 554

def business_country
    @properties['business_country']
end

#business_name ⇒ String

Returns The name of the business or organization using the Tollfree number.

Returns:

  • (String) —

    The name of the business or organization using the Tollfree number.



518
519
520
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 518

def business_name
    @properties['business_name']
end

#business_postal_code ⇒ String

Returns The postal code of the business or organization using the Tollfree number.

Returns:

  • (String) —

    The postal code of the business or organization using the Tollfree number.



548
549
550
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 548

def business_postal_code
    @properties['business_postal_code']
end

#business_state_province_region ⇒ String

Returns The state/province/region of the business or organization using the Tollfree number.

Returns:

  • (String) —

    The state/province/region of the business or organization using the Tollfree number.



542
543
544
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 542

def business_state_province_region
    @properties['business_state_province_region']
end

#business_street_address ⇒ String

Returns The address of the business or organization using the Tollfree number.

Returns:

  • (String) —

    The address of the business or organization using the Tollfree number.



524
525
526
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 524

def business_street_address
    @properties['business_street_address']
end

#business_street_address2 ⇒ String

Returns The address of the business or organization using the Tollfree number.

Returns:

  • (String) —

    The address of the business or organization using the Tollfree number.



530
531
532
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 530

def business_street_address2
    @properties['business_street_address2']
end

#business_website ⇒ String

Returns The website of the business or organization using the Tollfree number.

Returns:

  • (String) —

    The website of the business or organization using the Tollfree number.



560
561
562
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 560

def business_website
    @properties['business_website']
end

#context ⇒ TollfreeVerificationContext

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

Returns:



467
468
469
470
471
472
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 467

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

#customer_profile_sid ⇒ String

Returns Customer’s Profile Bundle BundleSid.

Returns:

  • (String) —

    Customer’s Profile Bundle BundleSid.



488
489
490
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 488

def customer_profile_sid
    @properties['customer_profile_sid']
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:



500
501
502
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 500

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:



506
507
508
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 506

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the TollfreeVerificationInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



699
700
701
702
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 699

def delete

    context.delete
end

#edit_allowed ⇒ Boolean

Returns If a rejected verification is allowed to be edited/resubmitted. Some rejection reasons allow editing and some do not.

Returns:

  • (Boolean) —

    If a rejected verification is allowed to be edited/resubmitted. Some rejection reasons allow editing and some do not.



674
675
676
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 674

def edit_allowed
    @properties['edit_allowed']
end

#edit_expiration ⇒ Time

Returns The date and time when the ability to edit a rejected verification expires.

Returns:

  • (Time) —

    The date and time when the ability to edit a rejected verification expires.



668
669
670
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 668

def edit_expiration
    @properties['edit_expiration']
end

#error_code ⇒ String

Returns The error code given when a Tollfree Verification has been rejected.

Returns:

  • (String) —

    The error code given when a Tollfree Verification has been rejected.



662
663
664
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 662

def error_code
    @properties['error_code']
end

#external_reference_id ⇒ String

Returns An optional external reference ID supplied by customer and echoed back on status retrieval.

Returns:

  • (String) —

    An optional external reference ID supplied by customer and echoed back on status retrieval.



692
693
694
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 692

def external_reference_id
    @properties['external_reference_id']
end

#fetch ⇒ TollfreeVerificationInstance

Fetch the TollfreeVerificationInstance

Returns:



707
708
709
710
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 707

def fetch

    context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



794
795
796
797
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 794

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

#message_volume ⇒ String

Returns Estimate monthly volume of messages from the Tollfree Number.

Returns:

  • (String) —

    Estimate monthly volume of messages from the Tollfree Number.



626
627
628
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 626

def message_volume
    @properties['message_volume']
end

#notification_email ⇒ String

Returns The email address to receive the notification about the verification result. .

Returns:

  • (String) —

    The email address to receive the notification about the verification result. .



590
591
592
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 590

def notification_email
    @properties['notification_email']
end

#opt_in_image_urls ⇒ Array<String>

Returns Link to an image that shows the opt-in workflow. Multiple images allowed and must be a publicly hosted URL.

Returns:

  • (Array<String>) —

    Link to an image that shows the opt-in workflow. Multiple images allowed and must be a publicly hosted URL.



614
615
616
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 614

def opt_in_image_urls
    @properties['opt_in_image_urls']
end

#opt_in_type ⇒ OptInType

Returns:

  • (OptInType) 


620
621
622
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 620

def opt_in_type
    @properties['opt_in_type']
end

#production_message_sample ⇒ String

Returns An example of message content, i.e. a sample message.

Returns:

  • (String) —

    An example of message content, i.e. a sample message.



608
609
610
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 608

def production_message_sample
    @properties['production_message_sample']
end

#regulated_item_sid ⇒ String

Returns The SID of the Regulated Item.

Returns:

  • (String) —

    The SID of the Regulated Item.



512
513
514
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 512

def regulated_item_sid
    @properties['regulated_item_sid']
end

#rejection_reason ⇒ String

Returns The rejection reason given when a Tollfree Verification has been rejected.

Returns:

  • (String) —

    The rejection reason given when a Tollfree Verification has been rejected.



656
657
658
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 656

def rejection_reason
    @properties['rejection_reason']
end

#rejection_reasons ⇒ Array<Hash>

Returns A list of rejection reasons and codes describing why a Tollfree Verification has been rejected.

Returns:

  • (Array<Hash>) —

    A list of rejection reasons and codes describing why a Tollfree Verification has been rejected.



680
681
682
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 680

def rejection_reasons
    @properties['rejection_reasons']
end

#resource_links ⇒ Hash

Returns The URLs of the documents associated with the Tollfree Verification resource.

Returns:

  • (Hash) —

    The URLs of the documents associated with the Tollfree Verification resource.



686
687
688
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 686

def resource_links
    @properties['resource_links']
end

#sid ⇒ String

Returns The unique string to identify Tollfree Verification.

Returns:

  • (String) —

    The unique string to identify Tollfree Verification.



476
477
478
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 476

def sid
    @properties['sid']
end

#status ⇒ Status

Returns:

  • (Status) 


644
645
646
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 644

def status
    @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



787
788
789
790
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 787

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

#tollfree_phone_number_sid ⇒ String

Returns The SID of the Phone Number associated with the Tollfree Verification.

Returns:

  • (String) —

    The SID of the Phone Number associated with the Tollfree Verification.



638
639
640
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 638

def tollfree_phone_number_sid
    @properties['tollfree_phone_number_sid']
end

#trust_product_sid ⇒ String

Returns Tollfree TrustProduct Bundle BundleSid.

Returns:

  • (String) —

    Tollfree TrustProduct Bundle BundleSid.



494
495
496
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 494

def trust_product_sid
    @properties['trust_product_sid']
end

#update(business_name: :unset, business_website: :unset, notification_email: :unset, use_case_categories: :unset, use_case_summary: :unset, production_message_sample: :unset, opt_in_image_urls: :unset, opt_in_type: :unset, message_volume: :unset, business_street_address: :unset, business_street_address2: :unset, business_city: :unset, business_state_province_region: :unset, business_postal_code: :unset, business_country: :unset, additional_information: :unset, business_contact_first_name: :unset, business_contact_last_name: :unset, business_contact_email: :unset, business_contact_phone: :unset, edit_reason: :unset) ⇒ TollfreeVerificationInstance

Update the TollfreeVerificationInstance

Parameters:

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

    The name of the business or organization using the Tollfree number.

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

    The website of the business or organization using the Tollfree number.

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

    The email address to receive the notification about the verification result. .

  • use_case_categories (Array[String]) (defaults to: :unset) —

    The category of the use case for the Tollfree Number. List as many are applicable..

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

    Use this to further explain how messaging is used by the business or organization.

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

    An example of message content, i.e. a sample message.

  • opt_in_image_urls (Array[String]) (defaults to: :unset) —

    Link to an image that shows the opt-in workflow. Multiple images allowed and must be a publicly hosted URL.

  • opt_in_type (OptInType) (defaults to: :unset)
  • message_volume (String) (defaults to: :unset) —

    Estimate monthly volume of messages from the Tollfree Number.

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

    The address of the business or organization using the Tollfree number.

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

    The address of the business or organization using the Tollfree number.

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

    The city of the business or organization using the Tollfree number.

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

    The state/province/region of the business or organization using the Tollfree number.

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

    The postal code of the business or organization using the Tollfree number.

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

    The country of the business or organization using the Tollfree number.

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

    Additional information to be provided for verification.

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

    The first name of the contact for the business or organization using the Tollfree number.

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

    The last name of the contact for the business or organization using the Tollfree number.

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

    The email address of the contact for the business or organization using the Tollfree number.

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

    The E.164 formatted phone number of the contact for the business or organization using the Tollfree number.

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

    Describe why the verification is being edited. If the verification was rejected because of a technical issue, such as the website being down, and the issue has been resolved this parameter should be set to something similar to ‘Website fixed’.

Returns:



736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 736

def update(
    business_name: :unset, 
    business_website: :unset, 
    notification_email: :unset, 
    use_case_categories: :unset, 
    use_case_summary: :unset, 
    production_message_sample: :unset, 
    opt_in_image_urls: :unset, 
    opt_in_type: :unset, 
    message_volume: :unset, 
    business_street_address: :unset, 
    business_street_address2: :unset, 
    business_city: :unset, 
    business_state_province_region: :unset, 
    business_postal_code: :unset, 
    business_country: :unset, 
    additional_information: :unset, 
    business_contact_first_name: :unset, 
    business_contact_last_name: :unset, 
    business_contact_email: :unset, 
    business_contact_phone: :unset, 
    edit_reason: :unset
)

    context.update(
        business_name: business_name, 
        business_website: business_website, 
        notification_email: notification_email, 
        use_case_categories: use_case_categories, 
        use_case_summary: use_case_summary, 
        production_message_sample: production_message_sample, 
        opt_in_image_urls: opt_in_image_urls, 
        opt_in_type: opt_in_type, 
        message_volume: message_volume, 
        business_street_address: business_street_address, 
        business_street_address2: business_street_address2, 
        business_city: business_city, 
        business_state_province_region: business_state_province_region, 
        business_postal_code: business_postal_code, 
        business_country: business_country, 
        additional_information: additional_information, 
        business_contact_first_name: business_contact_first_name, 
        business_contact_last_name: business_contact_last_name, 
        business_contact_email: business_contact_email, 
        business_contact_phone: business_contact_phone, 
        edit_reason: edit_reason, 
    )
end

#url ⇒ String

Returns The absolute URL of the Tollfree Verification resource.

Returns:

  • (String) —

    The absolute URL of the Tollfree Verification resource.



650
651
652
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 650

def url
    @properties['url']
end

#use_case_categories ⇒ Array<String>

Returns The category of the use case for the Tollfree Number. List as many are applicable..

Returns:

  • (Array<String>) —

    The category of the use case for the Tollfree Number. List as many are applicable..



596
597
598
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 596

def use_case_categories
    @properties['use_case_categories']
end

#use_case_summary ⇒ String

Returns Use this to further explain how messaging is used by the business or organization.

Returns:

  • (String) —

    Use this to further explain how messaging is used by the business or organization.



602
603
604
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 602

def use_case_summary
    @properties['use_case_summary']
end