Class: Twilio::REST::Numbers::V2::AuthorizationDocumentContext::DependentHostedNumberOrderList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/numbers/v2/authorization_document/dependent_hosted_number_order.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, signing_document_sid: nil) ⇒ DependentHostedNumberOrderList

Initialize the DependentHostedNumberOrderList

Parameters:

  • Version that contains the resource



28
29
30
31
32
33
34
35
 
# File 'lib/twilio-ruby/rest/numbers/v2/authorization_document/dependent_hosted_number_order.rb', line 28

def initialize(version, signing_document_sid: nil)
    super(version)
    
    # Path Solution
    @solution = { signing_document_sid: signing_document_sid }
    @uri = "/HostedNumber/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.



125
126
127
128
129
130
131
132
133
 
# File 'lib/twilio-ruby/rest/numbers/v2/authorization_document/dependent_hosted_number_order.rb', line 125

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:

  • API-generated URL for the requested results page

Returns:

  • Page of DependentHostedNumberOrderInstance



170
171
172
173
174
175
176
 
# File 'lib/twilio-ruby/rest/numbers/v2/authorization_document/dependent_hosted_number_order.rb', line 170

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, 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:

  • (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](www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/authorization-document-resource#status-values) for more information on each of these statuses.

  • (defaults to: :unset)

    An E164 formatted phone number hosted by this HostedNumberOrder.

  • (defaults to: :unset)

    A 34 character string that uniquely identifies the IncomingPhoneNumber resource created by this HostedNumberOrder.

  • (defaults to: :unset)

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

  • (defaults to: nil)

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit

  • (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 of up to limit results



52
53
54
55
56
57
58
59
60
61
 
# File 'lib/twilio-ruby/rest/numbers/v2/authorization_document/dependent_hosted_number_order.rb', line 52

def list(status: :unset, phone_number: :unset, incoming_phone_number_sid: :unset, friendly_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,
        limit: limit,
        page_size: page_size
    ).entries
end

#list_with_metadata(status: :unset, phone_number: :unset, incoming_phone_number_sid: :unset, friendly_name: :unset, limit: nil, page_size: nil) ⇒ Array

Returns Array of up to limit results.

Parameters:

  • (defaults to: nil)

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit

  • (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 of up to limit results



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/twilio-ruby/rest/numbers/v2/authorization_document/dependent_hosted_number_order.rb', line 104

def list_with_metadata(status: :unset, phone_number: :unset, incoming_phone_number_sid: :unset, friendly_name: :unset, limit: nil, page_size: nil)
    limits = @version.read_limits(limit, page_size)
    params = Twilio::Values.of({
        'Status' => status,
        'PhoneNumber' => phone_number,
        'IncomingPhoneNumberSid' => incoming_phone_number_sid,
        'FriendlyName' => friendly_name,
        
        'PageSize' => limits[:page_size],
    });
    headers = Twilio::Values.of({})

    response = @version.page('GET', @uri, params: params, headers: headers)

    DependentHostedNumberOrderPageMetadata.new(@version, response, @solution, limits[:limit])
end

#page(status: :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 DependentHostedNumberOrderInstance records from the API. Request is executed immediately.

Parameters:

  • (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](www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/authorization-document-resource#status-values) for more information on each of these statuses.

  • (defaults to: :unset)

    An E164 formatted phone number hosted by this HostedNumberOrder.

  • (defaults to: :unset)

    A 34 character string that uniquely identifies the IncomingPhoneNumber resource created by this HostedNumberOrder.

  • (defaults to: :unset)

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

  • (defaults to: :unset)

    PageToken provided by the API

  • (defaults to: :unset)

    Page Number, this value is simply for client state

  • (defaults to: :unset)

    Number of records to return, defaults to 50

Returns:

  • Page of DependentHostedNumberOrderInstance



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/twilio-ruby/rest/numbers/v2/authorization_document/dependent_hosted_number_order.rb', line 146

def page(status: :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,
        'PhoneNumber' => phone_number,
        'IncomingPhoneNumberSid' => incoming_phone_number_sid,
        'FriendlyName' => friendly_name,
        'PageToken' => page_token,
        'Page' => page_number,
        'PageSize' => page_size,
    })
    headers = Twilio::Values.of({})
    
    

    response = @version.page('GET', @uri, params: params, headers: headers)

    DependentHostedNumberOrderPage.new(@version, response, @solution)
end

#stream(status: :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.

Parameters:

  • (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](www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/authorization-document-resource#status-values) for more information on each of these statuses.

  • (defaults to: :unset)

    An E164 formatted phone number hosted by this HostedNumberOrder.

  • (defaults to: :unset)

    A 34 character string that uniquely identifies the IncomingPhoneNumber resource created by this HostedNumberOrder.

  • (defaults to: :unset)

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

  • (defaults to: nil)

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit

  • (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 that will yield up to limit results



78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/twilio-ruby/rest/numbers/v2/authorization_document/dependent_hosted_number_order.rb', line 78

def stream(status: :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,
        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



181
182
183
 
# File 'lib/twilio-ruby/rest/numbers/v2/authorization_document/dependent_hosted_number_order.rb', line 181

def to_s
    '#<Twilio.Numbers.V2.DependentHostedNumberOrderList>'
end