Class: Twilio::REST::Messaging::V1::TollfreeVerificationContext

Inherits:
InstanceContext
  • 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, sid) ⇒ TollfreeVerificationContext

Initialize the TollfreeVerificationContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • sid (String) —

    The unique string to identify Tollfree Verification.



257
258
259
260
261
262
263
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 257

def initialize(version, sid)
  super(version)

  # Path Solution
  @solution = {sid: sid, }
  @uri = "/Tollfree/Verifications/#{@solution[:sid]}"
end

Instance Method Details

#fetch ⇒ TollfreeVerificationInstance

Fetch the TollfreeVerificationInstance

Returns:



268
269
270
271
272
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 268

def fetch
  payload = @version.fetch('GET', @uri)

  TollfreeVerificationInstance.new(@version, payload, sid: @solution[:sid], )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

def inspect
  context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
  "#<Twilio.Messaging.V1.TollfreeVerificationContext #{context}>"
end

#to_s ⇒ Object

Provide a user friendly representation



348
349
350
351
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 348

def to_s
  context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
  "#<Twilio.Messaging.V1.TollfreeVerificationContext #{context}>"
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:



317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 317

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)
  data = Twilio::Values.of({
      'BusinessName' => business_name,
      'BusinessWebsite' => business_website,
      'NotificationEmail' => notification_email,
      'UseCaseCategories' => Twilio.serialize_list(use_case_categories) { |e| e },
      'UseCaseSummary' => use_case_summary,
      'ProductionMessageSample' => production_message_sample,
      'OptInImageUrls' => Twilio.serialize_list(opt_in_image_urls) { |e| e },
      'OptInType' => opt_in_type,
      'MessageVolume' => message_volume,
      'BusinessStreetAddress' => business_street_address,
      'BusinessStreetAddress2' => business_street_address2,
      'BusinessCity' => business_city,
      'BusinessStateProvinceRegion' => business_state_province_region,
      'BusinessPostalCode' => business_postal_code,
      'BusinessCountry' => business_country,
      'AdditionalInformation' => additional_information,
      'BusinessContactFirstName' => business_contact_first_name,
      'BusinessContactLastName' => business_contact_last_name,
      'BusinessContactEmail' => business_contact_email,
      'BusinessContactPhone' => business_contact_phone,
  })

  payload = @version.update('POST', @uri, data: data)

  TollfreeVerificationInstance.new(@version, payload, sid: @solution[:sid], )
end