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

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

Overview

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

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

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

    The unique string to identify Tollfree Verification.



370
371
372
373
374
375
376
377
378
379
380
381
382
383
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
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 370

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,
      '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 that created the resource.

Returns:

  • (String) —

    The SID of the Account that created the resource



435
436
437
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 435

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



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

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



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

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



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

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



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

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



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

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.

Returns:

  • (String) —

    The phone number of the contact for the business or organization using the Tollfree number



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

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



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

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



471
472
473
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 471

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



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

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



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

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



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

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



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

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



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

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:



420
421
422
423
424
425
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 420

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



441
442
443
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 441

def customer_profile_sid
  @properties['customer_profile_sid']
end

#date_created ⇒ Time

Returns The ISO 8601 date and time in GMT when the resource was created.

Returns:

  • (Time) —

    The ISO 8601 date and time in GMT when the resource was created



453
454
455
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 453

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The ISO 8601 date and time in GMT when the resource was last updated.

Returns:

  • (Time) —

    The ISO 8601 date and time in GMT when the resource was last updated



459
460
461
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 459

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



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

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



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

def external_reference_id
  @properties['external_reference_id']
end

#fetch ⇒ TollfreeVerificationInstance

Fetch the TollfreeVerificationInstance

Returns:



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

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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



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

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.



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

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



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

def opt_in_image_urls
  @properties['opt_in_image_urls']
end

#opt_in_type ⇒ tollfree_verification.OptInType

Returns Describe how a user opts-in to text messages.

Returns:

  • (tollfree_verification.OptInType) —

    Describe how a user opts-in to text messages



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

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



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

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



465
466
467
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 465

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.



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

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



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

def resource_links
  @properties['resource_links']
end

#sid ⇒ String

Returns Tollfree Verification Sid.

Returns:

  • (String) —

    Tollfree Verification Sid



429
430
431
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 429

def sid
  @properties['sid']
end

#status ⇒ tollfree_verification.Status

Returns The compliance status of the Tollfree Verification record.

Returns:

  • (tollfree_verification.Status) —

    The compliance status of the Tollfree Verification record.



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

def status
  @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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



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

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



447
448
449
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 447

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

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 (tollfree_verification.OptInType) (defaults to: :unset) —

    Describe how a user opts-in to text messages.

  • 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 phone number of the contact for the business or organization using the Tollfree number.

Returns:



681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 681

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: 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,
  )
end

#url ⇒ String

Returns The absolute URL of the Tollfree Verification.

Returns:

  • (String) —

    The absolute URL of the Tollfree Verification



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

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.



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

def use_case_categories
  @properties['use_case_categories']
end

#use_case_summary ⇒ String

Returns Further explaination on how messaging is used by the business or organization.

Returns:

  • (String) —

    Further explaination on how messaging is used by the business or organization



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

def use_case_summary
  @properties['use_case_summary']
end