Class: Twilio::REST::Preview::HostedNumbers::AuthorizationDocumentContext::DependentHostedNumberOrderList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document/dependent_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, signing_document_sid: nil) ⇒ DependentHostedNumberOrderList

Initialize the DependentHostedNumberOrderList

Parameters:

  • version (Version) —

    Version that contains the resource

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

    A 34 character string that uniquely identifies the LOA document associated with this HostedNumberOrder.


23
24
25
26
27
28
29
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document/dependent_hosted_number_order.rb', line 23

def initialize(version, signing_document_sid: nil)
  super(version)

  # Path Solution
  @solution = {signing_document_sid: signing_document_sid}
  @uri = "/AuthorizationDocuments/#{@solution[:signing_document_sid]}/DependentHostedNumberOrders"
end

Instance Method Details

#each ⇒ Object

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


112
113
114
115
116
117
118
119
120
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document/dependent_hosted_number_order.rb', line 112

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 DependentHostedNumberOrderInstance records from the API. Request is executed immediately.

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of DependentHostedNumberOrderInstance


165
166
167
168
169
170
171
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document/dependent_hosted_number_order.rb', line 165

def get_page(target_url)
  response = @version.domain.request(
      'GET',
      target_url
  )
  DependentHostedNumberOrderPage.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 DependentHostedNumberOrderInstance records from the API as a list. Unlike stream(), this operation is eager and will load `limit` records into memory before returning.

Parameters:

  • status (dependent_hosted_number_order.Status) (defaults to: :unset) —

    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 for more information on each of these statuses.

  • 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


56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document/dependent_hosted_number_order.rb', line 56

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 DependentHostedNumberOrderInstance records from the API. Request is executed immediately.

Parameters:

  • status (dependent_hosted_number_order.Status) (defaults to: :unset) —

    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 for more information on each of these statuses.

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


143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document/dependent_hosted_number_order.rb', line 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)
  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)

  DependentHostedNumberOrderPage.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 DependentHostedNumberOrderInstance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.

Parameters:

  • status (dependent_hosted_number_order.Status) (defaults to: :unset) —

    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 for more information on each of these statuses.

  • 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


93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document/dependent_hosted_number_order.rb', line 93

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


175
176
177
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document/dependent_hosted_number_order.rb', line 175

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