Class: Twilio::REST::Preview::HostedNumbers::HostedNumberOrderList

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

Overview

PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact [email protected]

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ HostedNumberOrderList

Initialize the HostedNumberOrderList

Parameters:

  • version (Version)

    Version that contains the resource


20
21
22
23
24
25
26
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/hosted_number_order.rb', line 20

def initialize(version)
  super(version)

  # Path Solution
  @solution = {}
  @uri = "/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 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 (hosted_number_order.VerificationType) (defaults to: :unset)

    Optional. The method used for verifying ownership of the number to be hosted. One of phone-call (default) or phone-bill.

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


212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/hosted_number_order.rb', line 212

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,
  })

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

  HostedNumberOrderInstance.new(@version, payload, )
end

#eachObject

When passed a block, yields HostedNumberOrderInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.


105
106
107
108
109
110
111
112
113
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/hosted_number_order.rb', line 105

def each
  limits = @version.read_limits

  page = self.page(page_size: limits[:page_size], )

  @version.stream(page,
                  limit: limits[:limit],
                  page_limit: limits[:page_limit]).each {|x| yield x}
end

#get_page(target_url) ⇒ Page

Retrieve a single page of HostedNumberOrderInstance records from the API. Request is executed immediately.

Parameters:

  • target_url (String)

    API-generated URL for the requested results page

Returns:

  • (Page)

    Page of HostedNumberOrderInstance


156
157
158
159
160
161
162
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/hosted_number_order.rb', line 156

def get_page(target_url)
  response = @version.domain.request(
      'GET',
      target_url
  )
  HostedNumberOrderPage.new(@version, response, @solution)
end

#list(status: :unset, phone_number: :unset, incoming_phone_number_sid: :unset, friendly_name: :unset, unique_name: :unset, limit: nil, page_size: nil) ⇒ Array

Lists HostedNumberOrderInstance records from the API as a list. Unlike stream(), this operation is eager and will load `limit` records into memory before returning.

Parameters:

  • status (hosted_number_order.Status) (defaults to: :unset)

    The Status of this HostedNumberOrder. One of `received`, `pending-verification`, `verified`, `pending-loa`, `carrier-processing`, `testing`, `completed`, `failed`, or `action-required`.

  • phone_number (String) (defaults to: :unset)

    An E164 formatted phone number hosted by this HostedNumberOrder.

  • incoming_phone_number_sid (String) (defaults to: :unset)

    A 34 character string that uniquely identifies the IncomingPhoneNumber resource created by this HostedNumberOrder.

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

    A human readable description of this resource, up to 64 characters.

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

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

  • limit (Integer) (defaults to: nil)

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit

  • page_size (Integer) (defaults to: nil)

    Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)

Returns:

  • (Array)

    Array of up to limit results


51
52
53
54
55
56
57
58
59
60
61
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/hosted_number_order.rb', line 51

def list(status: :unset, phone_number: :unset, incoming_phone_number_sid: :unset, friendly_name: :unset, unique_name: :unset, limit: nil, page_size: nil)
  self.stream(
      status: status,
      phone_number: phone_number,
      incoming_phone_number_sid: incoming_phone_number_sid,
      friendly_name: friendly_name,
      unique_name: unique_name,
      limit: limit,
      page_size: page_size
  ).entries
end

#page(status: :unset, phone_number: :unset, incoming_phone_number_sid: :unset, friendly_name: :unset, unique_name: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page

Retrieve a single page of HostedNumberOrderInstance records from the API. Request is executed immediately.

Parameters:

  • status (hosted_number_order.Status) (defaults to: :unset)

    The Status of this HostedNumberOrder. One of `received`, `pending-verification`, `verified`, `pending-loa`, `carrier-processing`, `testing`, `completed`, `failed`, or `action-required`.

  • phone_number (String) (defaults to: :unset)

    An E164 formatted phone number hosted by this HostedNumberOrder.

  • incoming_phone_number_sid (String) (defaults to: :unset)

    A 34 character string that uniquely identifies the IncomingPhoneNumber resource created by this HostedNumberOrder.

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

    A human readable description of this resource, up to 64 characters.

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

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

  • page_token (String) (defaults to: :unset)

    PageToken provided by the API

  • page_number (Integer) (defaults to: :unset)

    Page Number, this value is simply for client state

  • page_size (Integer) (defaults to: :unset)

    Number of records to return, defaults to 50

Returns:

  • (Page)

    Page of HostedNumberOrderInstance


134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/hosted_number_order.rb', line 134

def page(status: :unset, phone_number: :unset, incoming_phone_number_sid: :unset, friendly_name: :unset, unique_name: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
  params = Twilio::Values.of({
      'Status' => status,
      'PhoneNumber' => phone_number,
      'IncomingPhoneNumberSid' => incoming_phone_number_sid,
      'FriendlyName' => friendly_name,
      'UniqueName' => unique_name,
      'PageToken' => page_token,
      'Page' => page_number,
      'PageSize' => page_size,
  })

  response = @version.page('GET', @uri, params: params)

  HostedNumberOrderPage.new(@version, response, @solution)
end

#stream(status: :unset, phone_number: :unset, incoming_phone_number_sid: :unset, friendly_name: :unset, unique_name: :unset, limit: nil, page_size: nil) ⇒ Enumerable

Streams HostedNumberOrderInstance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.

Parameters:

  • status (hosted_number_order.Status) (defaults to: :unset)

    The Status of this HostedNumberOrder. One of `received`, `pending-verification`, `verified`, `pending-loa`, `carrier-processing`, `testing`, `completed`, `failed`, or `action-required`.

  • phone_number (String) (defaults to: :unset)

    An E164 formatted phone number hosted by this HostedNumberOrder.

  • incoming_phone_number_sid (String) (defaults to: :unset)

    A 34 character string that uniquely identifies the IncomingPhoneNumber resource created by this HostedNumberOrder.

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

    A human readable description of this resource, up to 64 characters.

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

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

  • limit (Integer) (defaults to: nil)

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit.

  • page_size (Integer) (defaults to: nil)

    Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)

Returns:

  • (Enumerable)

    Enumerable that will yield up to limit results


86
87
88
89
90
91
92
93
94
95
96
97
98
99
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/hosted_number_order.rb', line 86

def stream(status: :unset, phone_number: :unset, incoming_phone_number_sid: :unset, friendly_name: :unset, unique_name: :unset, limit: nil, page_size: nil)
  limits = @version.read_limits(limit, page_size)

  page = self.page(
      status: status,
      phone_number: phone_number,
      incoming_phone_number_sid: incoming_phone_number_sid,
      friendly_name: friendly_name,
      unique_name: unique_name,
      page_size: limits[:page_size],
  )

  @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
end

#to_sObject

Provide a user friendly representation


240
241
242
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/hosted_number_order.rb', line 240

def to_s
  '#<Twilio.Preview.HostedNumbers.HostedNumberOrderList>'
end