Class: Twilio::REST::Numbers::V3::HostedNumberOrderList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/numbers/v3/hosted_number_order.rb

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ HostedNumberOrderList

Initialize the HostedNumberOrderList

Parameters:

  • version (Version) —

    Version that contains the resource



26
27
28
29
30
31
32
33
 
# File 'lib/twilio-ruby/rest/numbers/v3/hosted_number_order.rb', line 26

def initialize(version)
    super(version)
    
    # Path Solution
    @solution = {  }
    @uri = "/HostedNumbers/HostedNumberOrders"
    
end

Instance Method Details

#create(phone_number: nil, sms_capability: nil, account_sid: :unset, friendly_name: :unset, unique_name: :unset, cc_emails: :unset, sms_url: :unset, sms_method: :unset, sms_fallback_url: :unset, sms_fallback_method: :unset, status_callback_url: :unset, status_callback_method: :unset, sms_application_sid: :unset, address_sid: :unset, email: :unset, verification_type: :unset, verification_document_sid: :unset) ⇒ HostedNumberOrderInstance

Create the HostedNumberOrderInstance

Parameters:

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

    The number to host in [+E.164](en.wikipedia.org/wiki/E.164) format

  • sms_capability (Boolean) (defaults to: nil) —

    Used to specify that the SMS capability will be hosted on Twilio’s platform.

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

    This defaults to the AccountSid of the authorization the user is using. This can be provided to specify a subaccount to add the HostedNumberOrder to.

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

    A 64 character string that is a human readable text that describes this resource.

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

    Optional. Provides a unique and addressable name to be assigned to this HostedNumberOrder, assigned by the developer, to be optionally used in addition to SID.

  • cc_emails (Array[String]) (defaults to: :unset) —

    Optional. A list of emails that the LOA document for this HostedNumberOrder will be carbon copied to.

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

    The URL that Twilio should request when somebody sends an SMS to the phone number. This will be copied onto the IncomingPhoneNumber resource.

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

    The HTTP method that should be used to request the SmsUrl. Must be either GET or POST. This will be copied onto the IncomingPhoneNumber resource.

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

    A URL that Twilio will request if an error occurs requesting or executing the TwiML defined by SmsUrl. This will be copied onto the IncomingPhoneNumber resource.

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

    The HTTP method that should be used to request the SmsFallbackUrl. Must be either GET or POST. This will be copied onto the IncomingPhoneNumber resource.

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

    Optional. The Status Callback URL attached to the IncomingPhoneNumber resource.

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

    Optional. The Status Callback Method attached to the IncomingPhoneNumber resource.

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

    Optional. The 34 character sid of the application Twilio should use to handle SMS messages sent to this number. If a SmsApplicationSid is present, Twilio will ignore all of the SMS urls above and use those set on the application.

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

    Optional. A 34 character string that uniquely identifies the Address resource that represents the address of the owner of this phone number.

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

    Optional. Email of the owner of this phone number that is being hosted.

  • verification_type (VerificationType) (defaults to: :unset)
  • verification_document_sid (String) (defaults to: :unset) —

    Optional. The unique sid identifier of the Identity Document that represents the document for verifying ownership of the number to be hosted. Required when VerificationType is phone-bill.

Returns:



54
55
56
57
58
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
 
# File 'lib/twilio-ruby/rest/numbers/v3/hosted_number_order.rb', line 54

def create(
    phone_number: nil, 
    sms_capability: nil, 
    account_sid: :unset, 
    friendly_name: :unset, 
    unique_name: :unset, 
    cc_emails: :unset, 
    sms_url: :unset, 
    sms_method: :unset, 
    sms_fallback_url: :unset, 
    sms_fallback_method: :unset, 
    status_callback_url: :unset, 
    status_callback_method: :unset, 
    sms_application_sid: :unset, 
    address_sid: :unset, 
    email: :unset, 
    verification_type: :unset, 
    verification_document_sid: :unset
)

    data = Twilio::Values.of({
        'phoneNumber' => phone_number,
        'smsCapability' => sms_capability,
        'accountSid' => ,
        'friendlyName' => friendly_name,
        'uniqueName' => unique_name,
        'ccEmails' => Twilio.serialize_list(cc_emails) { |e| e },
        'smsUrl' => sms_url,
        'smsMethod' => sms_method,
        'smsFallbackUrl' => sms_fallback_url,
        'smsFallbackMethod' => sms_fallback_method,
        'statusCallbackUrl' => status_callback_url,
        'statusCallbackMethod' => status_callback_method,
        'smsApplicationSid' => sms_application_sid,
        'addressSid' => address_sid,
        'email' => email,
        'verificationType' => verification_type,
        'verificationDocumentSid' => verification_document_sid,
    })

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

#create_with_metadata(phone_number: nil, sms_capability: nil, account_sid: :unset, friendly_name: :unset, unique_name: :unset, cc_emails: :unset, sms_url: :unset, sms_method: :unset, sms_fallback_url: :unset, sms_fallback_method: :unset, status_callback_url: :unset, status_callback_method: :unset, sms_application_sid: :unset, address_sid: :unset, email: :unset, verification_type: :unset, verification_document_sid: :unset) ⇒ HostedNumberOrderInstance

Create the HostedNumberOrderInstanceMetadata

Parameters:

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

    The number to host in [+E.164](en.wikipedia.org/wiki/E.164) format

  • sms_capability (Boolean) (defaults to: nil) —

    Used to specify that the SMS capability will be hosted on Twilio’s platform.

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

    This defaults to the AccountSid of the authorization the user is using. This can be provided to specify a subaccount to add the HostedNumberOrder to.

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

    A 64 character string that is a human readable text that describes this resource.

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

    Optional. Provides a unique and addressable name to be assigned to this HostedNumberOrder, assigned by the developer, to be optionally used in addition to SID.

  • cc_emails (Array[String]) (defaults to: :unset) —

    Optional. A list of emails that the LOA document for this HostedNumberOrder will be carbon copied to.

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

    The URL that Twilio should request when somebody sends an SMS to the phone number. This will be copied onto the IncomingPhoneNumber resource.

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

    The HTTP method that should be used to request the SmsUrl. Must be either GET or POST. This will be copied onto the IncomingPhoneNumber resource.

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

    A URL that Twilio will request if an error occurs requesting or executing the TwiML defined by SmsUrl. This will be copied onto the IncomingPhoneNumber resource.

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

    The HTTP method that should be used to request the SmsFallbackUrl. Must be either GET or POST. This will be copied onto the IncomingPhoneNumber resource.

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

    Optional. The Status Callback URL attached to the IncomingPhoneNumber resource.

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

    Optional. The Status Callback Method attached to the IncomingPhoneNumber resource.

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

    Optional. The 34 character sid of the application Twilio should use to handle SMS messages sent to this number. If a SmsApplicationSid is present, Twilio will ignore all of the SMS urls above and use those set on the application.

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

    Optional. A 34 character string that uniquely identifies the Address resource that represents the address of the owner of this phone number.

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

    Optional. Email of the owner of this phone number that is being hosted.

  • verification_type (VerificationType) (defaults to: :unset)
  • verification_document_sid (String) (defaults to: :unset) —

    Optional. The unique sid identifier of the Identity Document that represents the document for verifying ownership of the number to be hosted. Required when VerificationType is phone-bill.

Returns:



127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/twilio-ruby/rest/numbers/v3/hosted_number_order.rb', line 127

def create_with_metadata(
  phone_number: nil, 
  sms_capability: nil, 
  account_sid: :unset, 
  friendly_name: :unset, 
  unique_name: :unset, 
  cc_emails: :unset, 
  sms_url: :unset, 
  sms_method: :unset, 
  sms_fallback_url: :unset, 
  sms_fallback_method: :unset, 
  status_callback_url: :unset, 
  status_callback_method: :unset, 
  sms_application_sid: :unset, 
  address_sid: :unset, 
  email: :unset, 
  verification_type: :unset, 
  verification_document_sid: :unset
)

    data = Twilio::Values.of({
        'phoneNumber' => phone_number,
        'smsCapability' => sms_capability,
        'accountSid' => ,
        'friendlyName' => friendly_name,
        'uniqueName' => unique_name,
        'ccEmails' => Twilio.serialize_list(cc_emails) { |e| e },
        'smsUrl' => sms_url,
        'smsMethod' => sms_method,
        'smsFallbackUrl' => sms_fallback_url,
        'smsFallbackMethod' => sms_fallback_method,
        'statusCallbackUrl' => status_callback_url,
        'statusCallbackMethod' => status_callback_method,
        'smsApplicationSid' => sms_application_sid,
        'addressSid' => address_sid,
        'email' => email,
        'verificationType' => verification_type,
        'verificationDocumentSid' => verification_document_sid,
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
    hosted_number_order_instance = HostedNumberOrderInstance.new(
        @version,
        response.body,
    )
    HostedNumberOrderInstanceMetadata.new(
        @version,
        hosted_number_order_instance,
        response.headers,
        response.status_code
    )
end

#to_s ⇒ Object

Provide a user friendly representation



190
191
192
 
# File 'lib/twilio-ruby/rest/numbers/v3/hosted_number_order.rb', line 190

def to_s
    '#<Twilio.Numbers.V3.HostedNumberOrderList>'
end