class Twilio::REST::Preview::HostedNumbers::AuthorizationDocumentContext::DependentHostedNumberOrderList
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 help@twilio.com.
Public Class Methods
Initialize the DependentHostedNumberOrderList
@param [Version] version Version
that contains the resource @param [String] signing_document_sid A 34 character string that uniquely
identifies the LOA document associated with this HostedNumberOrder.
@return [DependentHostedNumberOrderList] DependentHostedNumberOrderList
Twilio::REST::ListResource::new
# File lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document/dependent_hosted_number_order.rb 23 def initialize(version, signing_document_sid: nil) 24 super(version) 25 26 # Path Solution 27 @solution = {signing_document_sid: signing_document_sid} 28 @uri = "/AuthorizationDocuments/#{@solution[:signing_document_sid]}/DependentHostedNumberOrders" 29 end
Public Instance Methods
When passed a block, yields DependentHostedNumberOrderInstance
records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.
# File lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document/dependent_hosted_number_order.rb 112 def each 113 limits = @version.read_limits 114 115 page = self.page(page_size: limits[:page_size], ) 116 117 @version.stream(page, 118 limit: limits[:limit], 119 page_limit: limits[:page_limit]).each {|x| yield x} 120 end
Retrieve a single page of DependentHostedNumberOrderInstance
records from the API. Request
is executed immediately. @param [String] target_url API-generated URL for the requested results page @return [Page] Page
of DependentHostedNumberOrderInstance
# File lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document/dependent_hosted_number_order.rb 165 def get_page(target_url) 166 response = @version.domain.request( 167 'GET', 168 target_url 169 ) 170 DependentHostedNumberOrderPage.new(@version, response, @solution) 171 end
Lists DependentHostedNumberOrderInstance
records from the API as a list. Unlike stream(), this operation is eager and will load `limit` records into memory before returning. @param [dependent_hosted_number_order.Status] status Status of an instance
resource. It can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section entitled {Status Values}[https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values] for more information on each of these statuses.
@param [String] phone_number An E164 formatted phone number hosted by this
HostedNumberOrder.
@param [String] incoming_phone_number_sid A 34 character string that uniquely
identifies the IncomingPhoneNumber resource created by this HostedNumberOrder.
@param [String] friendly_name A human readable description of this resource, up
to 64 characters.
@param [String] unique_name Provides a unique and addressable name to be
assigned to this HostedNumberOrder, assigned by the developer, to be optionally used in addition to SID.
@param [Integer] limit Upper limit for the number of records to return. stream()
guarantees to never return more than limit. Default is no limit
@param [Integer] page_size 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)
@return [Array] Array of up to limit results
# File lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document/dependent_hosted_number_order.rb 56 def list(status: :unset, phone_number: :unset, incoming_phone_number_sid: :unset, friendly_name: :unset, unique_name: :unset, limit: nil, page_size: nil) 57 self.stream( 58 status: status, 59 phone_number: phone_number, 60 incoming_phone_number_sid: incoming_phone_number_sid, 61 friendly_name: friendly_name, 62 unique_name: unique_name, 63 limit: limit, 64 page_size: page_size 65 ).entries 66 end
Retrieve a single page of DependentHostedNumberOrderInstance
records from the API. Request
is executed immediately. @param [dependent_hosted_number_order.Status] status Status of an instance
resource. It can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section entitled {Status Values}[https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values] for more information on each of these statuses.
@param [String] phone_number An E164 formatted phone number hosted by this
HostedNumberOrder.
@param [String] incoming_phone_number_sid A 34 character string that uniquely
identifies the IncomingPhoneNumber resource created by this HostedNumberOrder.
@param [String] friendly_name A human readable description of this resource, up
to 64 characters.
@param [String] unique_name Provides a unique and addressable name to be
assigned to this HostedNumberOrder, assigned by the developer, to be optionally used in addition to SID.
@param [String] page_token PageToken provided by the API @param [Integer] page_number Page
Number, this value is simply for client state @param [Integer] page_size Number of records to return, defaults to 50 @return [Page] Page
of DependentHostedNumberOrderInstance
# File lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document/dependent_hosted_number_order.rb 143 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) 144 params = Twilio::Values.of({ 145 'Status' => status, 146 'PhoneNumber' => phone_number, 147 'IncomingPhoneNumberSid' => incoming_phone_number_sid, 148 'FriendlyName' => friendly_name, 149 'UniqueName' => unique_name, 150 'PageToken' => page_token, 151 'Page' => page_number, 152 'PageSize' => page_size, 153 }) 154 155 response = @version.page('GET', @uri, params: params) 156 157 DependentHostedNumberOrderPage.new(@version, response, @solution) 158 end
Streams DependentHostedNumberOrderInstance
records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached. @param [dependent_hosted_number_order.Status] status Status of an instance
resource. It can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section entitled {Status Values}[https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values] for more information on each of these statuses.
@param [String] phone_number An E164 formatted phone number hosted by this
HostedNumberOrder.
@param [String] incoming_phone_number_sid A 34 character string that uniquely
identifies the IncomingPhoneNumber resource created by this HostedNumberOrder.
@param [String] friendly_name A human readable description of this resource, up
to 64 characters.
@param [String] unique_name Provides a unique and addressable name to be
assigned to this HostedNumberOrder, assigned by the developer, to be optionally used in addition to SID.
@param [Integer] limit Upper limit for the number of records to return. stream()
guarantees to never return more than limit. Default is no limit.
@param [Integer] page_size 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)
@return [Enumerable] Enumerable that will yield up to limit results
# File lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document/dependent_hosted_number_order.rb 93 def stream(status: :unset, phone_number: :unset, incoming_phone_number_sid: :unset, friendly_name: :unset, unique_name: :unset, limit: nil, page_size: nil) 94 limits = @version.read_limits(limit, page_size) 95 96 page = self.page( 97 status: status, 98 phone_number: phone_number, 99 incoming_phone_number_sid: incoming_phone_number_sid, 100 friendly_name: friendly_name, 101 unique_name: unique_name, 102 page_size: limits[:page_size], 103 ) 104 105 @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit]) 106 end
Provide a user friendly representation
# File lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document/dependent_hosted_number_order.rb 175 def to_s 176 '#<Twilio.Preview.HostedNumbers.DependentHostedNumberOrderList>' 177 end