Class: Twilio::REST::Preview::HostedNumbers::HostedNumberOrderList
- Inherits:
-
ListResource
- Object
- ListResource
- Twilio::REST::Preview::HostedNumbers::HostedNumberOrderList
- 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
-
#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.
-
#each ⇒ Object
When passed a block, yields HostedNumberOrderInstance records from the API.
-
#get_page(target_url) ⇒ Page
Retrieve a single page of HostedNumberOrderInstance records from the API.
-
#initialize(version) ⇒ HostedNumberOrderList
constructor
Initialize the HostedNumberOrderList.
-
#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.
-
#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.
-
#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.
-
#to_s ⇒ Object
Provide a user friendly representation.
Constructor Details
#initialize(version) ⇒ HostedNumberOrderList
Initialize the HostedNumberOrderList
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
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' => account_sid, '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 |
#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.
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.
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.
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.
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.
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_s ⇒ Object
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 |