Class: Twilio::REST::Trusthub::V1::ComplianceTollfreeInquiriesList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/trusthub/v1/compliance_tollfree_inquiries.rb

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ ComplianceTollfreeInquiriesList

Initialize the ComplianceTollfreeInquiriesList

Parameters:

  • version (Version) —

    Version that contains the resource



26
27
28
29
30
31
32
 
# File 'lib/twilio-ruby/rest/trusthub/v1/compliance_tollfree_inquiries.rb', line 26

def initialize(version)
    super(version)
    # Path Solution
    @solution = {  }
    @uri = "/ComplianceInquiries/Tollfree/Initialize"
    
end

Instance Method Details

#create(tollfree_phone_number: nil, notification_email: nil, business_name: :unset, business_website: :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, theme_set_id: :unset, skip_messaging_use_case: :unset) ⇒ ComplianceTollfreeInquiriesInstance

Create the ComplianceTollfreeInquiriesInstance

Parameters:

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

    The Tollfree phone number to be verified

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

    The email address to receive the notification about the verification result.

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

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

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

    Theme id for styling the inquiry form.

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

    Skip the messaging use case screen of the inquiry form.

Returns:



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/twilio-ruby/rest/trusthub/v1/compliance_tollfree_inquiries.rb', line 59

def create(
    tollfree_phone_number: nil, 
    notification_email: nil, 
    business_name: :unset, 
    business_website: :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, 
    theme_set_id: :unset, 
    skip_messaging_use_case: :unset
)

    data = Twilio::Values.of({
        'TollfreePhoneNumber' => tollfree_phone_number,
        'NotificationEmail' => notification_email,
        'BusinessName' => business_name,
        'BusinessWebsite' => business_website,
        '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,
        'ThemeSetId' => theme_set_id,
        'SkipMessagingUseCase' => skip_messaging_use_case,
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.create('POST', @uri, data: data, headers: headers)
    ComplianceTollfreeInquiriesInstance.new(
        @version,
        payload,
    )
end

#to_s ⇒ Object

Provide a user friendly representation



128
129
130
 
# File 'lib/twilio-ruby/rest/trusthub/v1/compliance_tollfree_inquiries.rb', line 128

def to_s
    '#<Twilio.Trusthub.V1.ComplianceTollfreeInquiriesList>'
end