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



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

def initialize(version)
  super(version)

  # Path Solution
  @solution = {}
  @uri = "/HostedNumberOrders"
end

Instance Method Details

#create(address_sid: nil, phone_number: nil, iso_country: nil, sms_capability: nil, email: 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) ⇒ HostedNumberOrderInstance

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

Parameters:

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

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

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

    An E164 formatted phone number hosted by this HostedNumberOrder.

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

    The ISO country code of the phone_number.

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

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

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

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

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

    Optional. The unique SID identifier of the Account or Sub-Account to create this HostedNumberOrder on.

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

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

  • 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 (String) (defaults to: :unset) —

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

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

    Optional. The SMS URL attached to the IncomingPhoneNumber resource.

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

    Optional. The SMS Method attached to the IncomingPhoneNumber resource.

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

    Optional. The SMS Fallback URL attached to the IncomingPhoneNumber resource.

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

    Optional. The SMS Fallback Method attached to 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.

Returns:



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/hosted_number_order.rb', line 204

def create(address_sid: nil, phone_number: nil, iso_country: nil, sms_capability: nil, email: 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)
  data = Twilio::Values.of({
      'AddressSid' => address_sid,
      'PhoneNumber' => phone_number,
      'IsoCountry' => iso_country,
      'SmsCapability' => sms_capability,
      'Email' => email,
      'AccountSid' => ,
      'FriendlyName' => friendly_name,
      'UniqueName' => unique_name,
      'CcEmails' => cc_emails,
      '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,
  })

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

  HostedNumberOrderInstance.new(
      @version,
      payload,
  )
end

#each ⇒ Object

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



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

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



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

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



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

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
150
151
 
# 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
  )
  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



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

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_s ⇒ Object

Provide a user friendly representation



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

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