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.



295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 295

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'],
      'resource_links' => payload['resource_links'],
  }

  # 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



357
358
359
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 357

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



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

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



411
412
413
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 411

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



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

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



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

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



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

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



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

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



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

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



393
394
395
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 393

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



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

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



417
418
419
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 417

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



399
400
401
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 399

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



405
406
407
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 405

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



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

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:



342
343
344
345
346
347
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 342

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



363
364
365
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 363

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



375
376
377
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 375

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



381
382
383
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 381

def date_updated
  @properties['date_updated']
end

#fetch ⇒ TollfreeVerificationInstance

Fetch the TollfreeVerificationInstance

Returns:



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

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



551
552
553
554
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 551

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



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

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.



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

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



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

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



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

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



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

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



387
388
389
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 387

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



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

def resource_links
  @properties['resource_links']
end

#sid ⇒ String

Returns Tollfree Verification Sid.

Returns:

  • (String) —

    Tollfree Verification Sid



351
352
353
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 351

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.



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

def status
  @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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



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

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



369
370
371
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 369

def trust_product_sid
  @properties['trust_product_sid']
end

#url ⇒ String

Returns The absolute URL of the Tollfree Verification.

Returns:

  • (String) —

    The absolute URL of the Tollfree Verification



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

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.



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

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



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

def use_case_summary
  @properties['use_case_summary']
end