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.



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
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 510

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'],
        'tollfree_phone_number' => payload['tollfree_phone_number'],
        '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'],
        'business_registration_number' => payload['business_registration_number'],
        'business_registration_authority' => payload['business_registration_authority'],
        'business_registration_country' => payload['business_registration_country'],
        'business_type' => payload['business_type'],
        'business_registration_phone_number' => payload['business_registration_phone_number'],
        'doing_business_as' => payload['doing_business_as'],
        'opt_in_confirmation_message' => payload['opt_in_confirmation_message'],
        'help_message_sample' => payload['help_message_sample'],
        'privacy_policy_url' => payload['privacy_policy_url'],
        'terms_and_conditions_url' => payload['terms_and_conditions_url'],
        'age_gated_content' => payload['age_gated_content'],
        'opt_in_keywords' => payload['opt_in_keywords'],
        '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:



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

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.



741
742
743
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 741

def additional_information
    @properties['additional_information']
end

#age_gated_content ⇒ Boolean

Returns Indicates if the content is age gated.

Returns:

  • (Boolean) —

    Indicates if the content is age gated.



855
856
857
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 855

def age_gated_content
    @properties['age_gated_content']
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.



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

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.



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

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.



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

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.



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

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.



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

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.



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

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.



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

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.



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

def business_postal_code
    @properties['business_postal_code']
end

#business_registration_authority ⇒ String

Returns The organizational authority for business registrations.

Returns:

  • (String) —

    The organizational authority for business registrations



801
802
803
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 801

def business_registration_authority
    @properties['business_registration_authority']
end

#business_registration_country ⇒ String

Returns Country business is registered in.

Returns:

  • (String) —

    Country business is registered in



807
808
809
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 807

def business_registration_country
    @properties['business_registration_country']
end

#business_registration_number ⇒ String

Returns A legally recognized business registration number.

Returns:

  • (String) —

    A legally recognized business registration number



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

def business_registration_number
    @properties['business_registration_number']
end

#business_registration_phone_number ⇒ String

Returns The E.164 formatted number associated with the business.

Returns:

  • (String) —

    The E.164 formatted number associated with the business.



819
820
821
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 819

def business_registration_phone_number
    @properties['business_registration_phone_number']
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.



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

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.



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

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.



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

def business_street_address2
    @properties['business_street_address2']
end

#business_type ⇒ String

Returns The type of business, valid values are PRIVATE_PROFIT, PUBLIC_PROFIT, NON_PROFIT, SOLE_PROPRIETOR, GOVERNMENT.

Returns:

  • (String) —

    The type of business, valid values are PRIVATE_PROFIT, PUBLIC_PROFIT, NON_PROFIT, SOLE_PROPRIETOR, GOVERNMENT



813
814
815
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 813

def business_type
    @properties['business_type']
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.



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

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:



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

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.



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

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:



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

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:



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

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the TollfreeVerificationInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



886
887
888
889
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 886

def delete

    context.delete
end

#doing_business_as ⇒ String

Returns Trade name, sub entity, or downstream business name of business being submitted for verification.

Returns:

  • (String) —

    Trade name, sub entity, or downstream business name of business being submitted for verification



825
826
827
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 825

def doing_business_as
    @properties['doing_business_as']
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.



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

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.



783
784
785
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 783

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.



777
778
779
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 777

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.



879
880
881
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 879

def external_reference_id
    @properties['external_reference_id']
end

#fetch ⇒ TollfreeVerificationInstance

Fetch the TollfreeVerificationInstance

Returns:



894
895
896
897
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 894

def fetch

    context.fetch
end

#help_message_sample ⇒ String

Returns A sample help message provided to users.

Returns:

  • (String) —

    A sample help message provided to users.



837
838
839
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 837

def help_message_sample
    @properties['help_message_sample']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



1017
1018
1019
1020
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 1017

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.



735
736
737
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 735

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



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

def notification_email
    @properties['notification_email']
end

#opt_in_confirmation_message ⇒ String

Returns The confirmation message sent to users when they opt in to receive messages.

Returns:

  • (String) —

    The confirmation message sent to users when they opt in to receive messages.



831
832
833
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 831

def opt_in_confirmation_message
    @properties['opt_in_confirmation_message']
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.



723
724
725
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 723

def opt_in_image_urls
    @properties['opt_in_image_urls']
end

#opt_in_keywords ⇒ Array<String>

Returns List of keywords that users can send to opt in or out of messages.

Returns:

  • (Array<String>) —

    List of keywords that users can send to opt in or out of messages.



861
862
863
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 861

def opt_in_keywords
    @properties['opt_in_keywords']
end

#opt_in_type ⇒ OptInType

Returns:

  • (OptInType) 


729
730
731
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 729

def opt_in_type
    @properties['opt_in_type']
end

#privacy_policy_url ⇒ String

Returns The URL to the privacy policy for the business or organization.

Returns:

  • (String) —

    The URL to the privacy policy for the business or organization.



843
844
845
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 843

def privacy_policy_url
    @properties['privacy_policy_url']
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.



717
718
719
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 717

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.



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

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.



771
772
773
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 771

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.



867
868
869
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 867

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.



873
874
875
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 873

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.



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

def sid
    @properties['sid']
end

#status ⇒ Status

Returns:

  • (Status) 


759
760
761
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 759

def status
    @properties['status']
end

#terms_and_conditions_url ⇒ String

Returns The URL of the terms and conditions for the business or organization.

Returns:

  • (String) —

    The URL of the terms and conditions for the business or organization.



849
850
851
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 849

def terms_and_conditions_url
    @properties['terms_and_conditions_url']
end

#to_s ⇒ Object

Provide a user friendly representation



1010
1011
1012
1013
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 1010

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

#tollfree_phone_number ⇒ String

Returns The E.164 formatted toll-free phone number associated with the verification.

Returns:

  • (String) —

    The E.164 formatted toll-free phone number associated with the verification.



753
754
755
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 753

def tollfree_phone_number
    @properties['tollfree_phone_number']
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.



747
748
749
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 747

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.



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

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, business_registration_number: :unset, business_registration_authority: :unset, business_registration_country: :unset, business_type: :unset, business_registration_phone_number: :unset, doing_business_as: :unset, opt_in_confirmation_message: :unset, help_message_sample: :unset, privacy_policy_url: :unset, terms_and_conditions_url: :unset, age_gated_content: :unset, opt_in_keywords: :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’.

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

    A legaly recognized business registration number

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

    The organizational authority for business registrations

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

    Country business is registered in

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

    The type of business, valid values are PRIVATE_PROFIT, PUBLIC_PROFIT, NON_PROFIT, SOLE_PROPRIETOR, GOVERNMENT

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

    The E.164 formatted number associated with the business.

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

    Trade name, sub entity, or downstream business name of business being submitted for verification

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

    The confirmation message sent to users when they opt in to receive messages.

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

    A sample help message provided to users.

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

    The URL to the privacy policy for the business or organization.

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

    The URL to the terms and conditions for the business or organization.

  • age_gated_content (Boolean) (defaults to: :unset) —

    Indicates if the content is age gated.

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

    List of keywords that users can text in to opt in to receive messages.

Returns:



935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 935

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, 
    business_registration_number: :unset, 
    business_registration_authority: :unset, 
    business_registration_country: :unset, 
    business_type: :unset, 
    business_registration_phone_number: :unset, 
    doing_business_as: :unset, 
    opt_in_confirmation_message: :unset, 
    help_message_sample: :unset, 
    privacy_policy_url: :unset, 
    terms_and_conditions_url: :unset, 
    age_gated_content: :unset, 
    opt_in_keywords: :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, 
        business_registration_number: business_registration_number, 
        business_registration_authority: business_registration_authority, 
        business_registration_country: business_registration_country, 
        business_type: business_type, 
        business_registration_phone_number: business_registration_phone_number, 
        doing_business_as: doing_business_as, 
        opt_in_confirmation_message: opt_in_confirmation_message, 
        help_message_sample: help_message_sample, 
        privacy_policy_url: privacy_policy_url, 
        terms_and_conditions_url: terms_and_conditions_url, 
        age_gated_content: age_gated_content, 
        opt_in_keywords: opt_in_keywords, 
    )
end

#url ⇒ String

Returns The absolute URL of the Tollfree Verification resource.

Returns:

  • (String) —

    The absolute URL of the Tollfree Verification resource.



765
766
767
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 765

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



705
706
707
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 705

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.



711
712
713
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 711

def use_case_summary
    @properties['use_case_summary']
end