Class: Twilio::REST::Numbers::V2::HostedNumberOrderList
- Inherits:
-
ListResource
- Object
- ListResource
- Twilio::REST::Numbers::V2::HostedNumberOrderList
- Defined in:
- lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb
Instance Method Summary collapse
-
#create(phone_number: nil, contact_phone_number: nil, address_sid: nil, email: nil, account_sid: :unset, friendly_name: :unset, cc_emails: :unset, sms_url: :unset, sms_method: :unset, sms_fallback_url: :unset, sms_capability: :unset, sms_fallback_method: :unset, status_callback_url: :unset, status_callback_method: :unset, sms_application_sid: :unset, contact_title: :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, sms_capability: :unset, phone_number: :unset, incoming_phone_number_sid: :unset, friendly_name: :unset, limit: nil, page_size: nil) ⇒ Array
Lists HostedNumberOrderInstance records from the API as a list.
-
#page(status: :unset, sms_capability: :unset, phone_number: :unset, incoming_phone_number_sid: :unset, friendly_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, sms_capability: :unset, phone_number: :unset, incoming_phone_number_sid: :unset, friendly_name: :unset, limit: nil, page_size: nil) ⇒ Enumerable
Streams Instance records from the API as an Enumerable.
-
#to_s ⇒ Object
Provide a user friendly representation.
Constructor Details
#initialize(version) ⇒ HostedNumberOrderList
Initialize the HostedNumberOrderList
25 26 27 28 29 30 31 |
# File 'lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb', line 25 def initialize(version) super(version) # Path Solution @solution = { } @uri = "/HostedNumber/Orders" end |
Instance Method Details
#create(phone_number: nil, contact_phone_number: nil, address_sid: nil, email: nil, account_sid: :unset, friendly_name: :unset, cc_emails: :unset, sms_url: :unset, sms_method: :unset, sms_fallback_url: :unset, sms_capability: :unset, sms_fallback_method: :unset, status_callback_url: :unset, status_callback_method: :unset, sms_application_sid: :unset, contact_title: :unset) ⇒ HostedNumberOrderInstance
Create the HostedNumberOrderInstance
51 52 53 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 |
# File 'lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb', line 51 def create( phone_number: nil, contact_phone_number: nil, address_sid: nil, email: nil, account_sid: :unset, friendly_name: :unset, cc_emails: :unset, sms_url: :unset, sms_method: :unset, sms_fallback_url: :unset, sms_capability: :unset, sms_fallback_method: :unset, status_callback_url: :unset, status_callback_method: :unset, sms_application_sid: :unset, contact_title: :unset ) data = Twilio::Values.of({ 'PhoneNumber' => phone_number, 'ContactPhoneNumber' => contact_phone_number, 'AddressSid' => address_sid, 'Email' => email, 'AccountSid' => account_sid, 'FriendlyName' => friendly_name, 'CcEmails' => Twilio.serialize_list(cc_emails) { |e| e }, 'SmsUrl' => sms_url, 'SmsMethod' => sms_method, 'SmsFallbackUrl' => sms_fallback_url, 'SmsCapability' => sms_capability, 'SmsFallbackMethod' => sms_fallback_method, 'StatusCallbackUrl' => status_callback_url, 'StatusCallbackMethod' => status_callback_method, 'SmsApplicationSid' => sms_application_sid, 'ContactTitle' => contact_title, }) 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.
159 160 161 162 163 164 165 166 167 |
# File 'lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb', line 159 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.
203 204 205 206 207 208 209 |
# File 'lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb', line 203 def get_page(target_url) response = @version.domain.request( 'GET', target_url ) HostedNumberOrderPage.new(@version, response, @solution) end |
#list(status: :unset, sms_capability: :unset, phone_number: :unset, incoming_phone_number_sid: :unset, friendly_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.
113 114 115 116 117 118 119 120 121 122 123 |
# File 'lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb', line 113 def list(status: :unset, sms_capability: :unset, phone_number: :unset, incoming_phone_number_sid: :unset, friendly_name: :unset, limit: nil, page_size: nil) self.stream( status: status, sms_capability: sms_capability, phone_number: phone_number, incoming_phone_number_sid: incoming_phone_number_sid, friendly_name: friendly_name, limit: limit, page_size: page_size ).entries end |
#page(status: :unset, sms_capability: :unset, phone_number: :unset, incoming_phone_number_sid: :unset, friendly_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.
181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 |
# File 'lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb', line 181 def page(status: :unset, sms_capability: :unset, phone_number: :unset, incoming_phone_number_sid: :unset, friendly_name: :unset, page_token: :unset, page_number: :unset, page_size: :unset) params = Twilio::Values.of({ 'Status' => status, 'SmsCapability' => sms_capability, 'PhoneNumber' => phone_number, 'IncomingPhoneNumberSid' => incoming_phone_number_sid, 'FriendlyName' => friendly_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, sms_capability: :unset, phone_number: :unset, incoming_phone_number_sid: :unset, friendly_name: :unset, limit: nil, page_size: nil) ⇒ Enumerable
Streams Instance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.
141 142 143 144 145 146 147 148 149 150 151 152 153 |
# File 'lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb', line 141 def stream(status: :unset, sms_capability: :unset, phone_number: :unset, incoming_phone_number_sid: :unset, friendly_name: :unset, limit: nil, page_size: nil) limits = @version.read_limits(limit, page_size) page = self.page( status: status, sms_capability: sms_capability, phone_number: phone_number, incoming_phone_number_sid: incoming_phone_number_sid, friendly_name: friendly_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
214 215 216 |
# File 'lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb', line 214 def to_s '#<Twilio.Numbers.V2.HostedNumberOrderList>' end |