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



28
29
30
31
32
33
34
 
# 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.



94
95
96
97
98
99
100
101
102
 
# File 'lib/twilio-ruby/rest/numbers/v2/authorization_document/dependent_hosted_number_order.rb', line 94

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.



139
140
141
142
143
144
145
 
# File 'lib/twilio-ruby/rest/numbers/v2/authorization_document/dependent_hosted_number_order.rb', line 139

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.



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

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

#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.



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/twilio-ruby/rest/numbers/v2/authorization_document/dependent_hosted_number_order.rb', line 115

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.



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

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



150
151
152
 
# File 'lib/twilio-ruby/rest/numbers/v2/authorization_document/dependent_hosted_number_order.rb', line 150

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