Class: Twilio::REST::Messaging::V1::TollfreeVerificationInstance
- Inherits:
-
InstanceResource
- Object
- InstanceResource
- Twilio::REST::Messaging::V1::TollfreeVerificationInstance
- Defined in:
- lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb
Instance Method Summary collapse
-
#account_sid ⇒ String
The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the Tollfree Verification resource.
-
#additional_information ⇒ String
Additional information to be provided for verification.
-
#business_city ⇒ String
The city of the business or organization using the Tollfree number.
-
#business_contact_email ⇒ String
The email address of the contact for the business or organization using the Tollfree number.
-
#business_contact_first_name ⇒ String
The first name of the contact for the business or organization using the Tollfree number.
-
#business_contact_last_name ⇒ String
The last name of the contact for the business or organization using the Tollfree number.
-
#business_contact_phone ⇒ String
The phone number of the contact for the business or organization using the Tollfree number.
-
#business_country ⇒ String
The country of the business or organization using the Tollfree number.
-
#business_name ⇒ String
The name of the business or organization using the Tollfree number.
-
#business_postal_code ⇒ String
The postal code of the business or organization using the Tollfree number.
-
#business_state_province_region ⇒ String
The state/province/region of the business or organization using the Tollfree number.
-
#business_street_address ⇒ String
The address of the business or organization using the Tollfree number.
-
#business_street_address2 ⇒ String
The address of the business or organization using the Tollfree number.
-
#business_website ⇒ String
The website of the business or organization using the Tollfree number.
-
#context ⇒ TollfreeVerificationContext
Generate an instance context for the instance, the context is capable of performing various actions.
-
#customer_profile_sid ⇒ String
Customer’s Profile Bundle BundleSid.
-
#date_created ⇒ Time
The date and time in GMT when the resource was created specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.
-
#date_updated ⇒ Time
The date and time in GMT when the resource was last updated specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.
-
#edit_expiration ⇒ Time
The date and time when the ability to edit a rejected verification expires.
-
#error_code ⇒ String
The error code given when a Tollfree Verification has been rejected.
-
#external_reference_id ⇒ String
An optional external reference ID supplied by customer and echoed back on status retrieval.
-
#fetch ⇒ TollfreeVerificationInstance
Fetch the TollfreeVerificationInstance.
-
#initialize(version, payload, sid: nil) ⇒ TollfreeVerificationInstance
constructor
Initialize the TollfreeVerificationInstance.
-
#inspect ⇒ Object
Provide a detailed, user friendly representation.
-
#message_volume ⇒ String
Estimate monthly volume of messages from the Tollfree Number.
-
#notification_email ⇒ String
The email address to receive the notification about the verification result.
-
#opt_in_image_urls ⇒ Array<String>
Link to an image that shows the opt-in workflow.
- #opt_in_type ⇒ OptInType
-
#production_message_sample ⇒ String
An example of message content, i.e.
-
#regulated_item_sid ⇒ String
The SID of the Regulated Item.
-
#rejection_reason ⇒ String
The rejection reason given when a Tollfree Verification has been rejected.
-
#resource_links ⇒ Hash
The URLs of the documents associated with the Tollfree Verification resource.
-
#sid ⇒ String
The unique string to identify Tollfree Verification.
- #status ⇒ Status
-
#to_s ⇒ Object
Provide a user friendly representation.
-
#tollfree_phone_number_sid ⇒ String
The SID of the Phone Number associated with the Tollfree Verification.
-
#trust_product_sid ⇒ String
Tollfree TrustProduct Bundle BundleSid.
-
#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) ⇒ TollfreeVerificationInstance
Update the TollfreeVerificationInstance.
-
#url ⇒ String
The absolute URL of the Tollfree Verification resource.
-
#use_case_categories ⇒ Array<String>
The category of the use case for the Tollfree Number.
-
#use_case_summary ⇒ String
Use this to further explain how messaging is used by the business or organization.
Constructor Details
#initialize(version, payload, sid: nil) ⇒ TollfreeVerificationInstance
Initialize the TollfreeVerificationInstance
384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 |
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 384 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']), '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.
450 451 452 |
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 450 def account_sid @properties['account_sid'] end |
#additional_information ⇒ String
Returns Additional information to be provided for verification.
600 601 602 |
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 600 def additional_information @properties['additional_information'] end |
#business_city ⇒ String
Returns The city of the business or organization using the Tollfree number.
504 505 506 |
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 504 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.
546 547 548 |
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 546 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.
534 535 536 |
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 534 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.
540 541 542 |
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 540 def business_contact_last_name @properties['business_contact_last_name'] end |
#business_contact_phone ⇒ String
Returns The phone number of the contact for the business or organization using the Tollfree number.
552 553 554 |
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 552 def business_contact_phone @properties['business_contact_phone'] end |
#business_country ⇒ String
Returns The country of the business or organization using the Tollfree number.
522 523 524 |
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 522 def business_country @properties['business_country'] end |
#business_name ⇒ String
Returns The name of the business or organization using the Tollfree number.
486 487 488 |
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 486 def business_name @properties['business_name'] end |
#business_postal_code ⇒ String
Returns The postal code of the business or organization using the Tollfree number.
516 517 518 |
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 516 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.
510 511 512 |
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 510 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.
492 493 494 |
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 492 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.
498 499 500 |
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 498 def business_street_address2 @properties['business_street_address2'] end |
#business_website ⇒ String
Returns The website of the business or organization using the Tollfree number.
528 529 530 |
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 528 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
435 436 437 438 439 440 |
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 435 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.
456 457 458 |
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 456 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.
468 469 470 |
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 468 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.
474 475 476 |
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 474 def date_updated @properties['date_updated'] end |
#edit_expiration ⇒ Time
Returns The date and time when the ability to edit a rejected verification expires.
636 637 638 |
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 636 def edit_expiration @properties['edit_expiration'] end |
#error_code ⇒ String
Returns The error code given when a Tollfree Verification has been rejected.
630 631 632 |
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 630 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.
648 649 650 |
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 648 def external_reference_id @properties['external_reference_id'] end |
#fetch ⇒ TollfreeVerificationInstance
Fetch the TollfreeVerificationInstance
655 656 657 658 |
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 655 def fetch context.fetch end |
#inspect ⇒ Object
Provide a detailed, user friendly representation
739 740 741 742 |
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 739 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.
594 595 596 |
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 594 def @properties['message_volume'] end |
#notification_email ⇒ String
Returns The email address to receive the notification about the verification result. .
558 559 560 |
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 558 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.
582 583 584 |
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 582 def opt_in_image_urls @properties['opt_in_image_urls'] end |
#opt_in_type ⇒ OptInType
588 589 590 |
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 588 def opt_in_type @properties['opt_in_type'] end |
#production_message_sample ⇒ String
Returns An example of message content, i.e. a sample message.
576 577 578 |
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 576 def @properties['production_message_sample'] end |
#regulated_item_sid ⇒ String
Returns The SID of the Regulated Item.
480 481 482 |
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 480 def regulated_item_sid @properties['regulated_item_sid'] end |
#rejection_reason ⇒ String
Returns The rejection reason given when a Tollfree Verification has been rejected.
624 625 626 |
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 624 def rejection_reason @properties['rejection_reason'] end |
#resource_links ⇒ Hash
Returns The URLs of the documents associated with the Tollfree Verification resource.
642 643 644 |
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 642 def resource_links @properties['resource_links'] end |
#sid ⇒ String
Returns The unique string to identify Tollfree Verification.
444 445 446 |
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 444 def sid @properties['sid'] end |
#status ⇒ Status
612 613 614 |
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 612 def status @properties['status'] end |
#to_s ⇒ Object
Provide a user friendly representation
732 733 734 735 |
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 732 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.
606 607 608 |
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 606 def tollfree_phone_number_sid @properties['tollfree_phone_number_sid'] end |
#trust_product_sid ⇒ String
Returns Tollfree TrustProduct Bundle BundleSid.
462 463 464 |
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 462 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) ⇒ TollfreeVerificationInstance
Update the TollfreeVerificationInstance
683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 |
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 683 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 ) 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: , opt_in_image_urls: opt_in_image_urls, opt_in_type: opt_in_type, 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, ) end |
#url ⇒ String
Returns The absolute URL of the Tollfree Verification resource.
618 619 620 |
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 618 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..
564 565 566 |
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 564 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.
570 571 572 |
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 570 def use_case_summary @properties['use_case_summary'] end |