Class: Twilio::REST::Preview::HostedNumbers::HostedNumberOrderList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/preview/hosted_numbers/hosted_number_order.rb

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ HostedNumberOrderList

Initialize the HostedNumberOrderList



26
27
28
29
30
31
32
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/hosted_number_order.rb', line 26

def initialize(version)
    super(version)
    # Path Solution
    @solution = {  }
    @uri = "/HostedNumberOrders"
    
end

Instance Method Details

#create(phone_number: nil, sms_capability: nil, account_sid: :unset, friendly_name: :unset, unique_name: :unset, cc_emails: :unset, sms_url: :unset, sms_method: :unset, sms_fallback_url: :unset, sms_fallback_method: :unset, status_callback_url: :unset, status_callback_method: :unset, sms_application_sid: :unset, address_sid: :unset, email: :unset, verification_type: :unset, verification_document_sid: :unset) ⇒ HostedNumberOrderInstance

Create the HostedNumberOrderInstance



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
95
96
97
98
99
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/hosted_number_order.rb', line 53

def create(
    phone_number: nil, 
    sms_capability: nil, 
    account_sid: :unset, 
    friendly_name: :unset, 
    unique_name: :unset, 
    cc_emails: :unset, 
    sms_url: :unset, 
    sms_method: :unset, 
    sms_fallback_url: :unset, 
    sms_fallback_method: :unset, 
    status_callback_url: :unset, 
    status_callback_method: :unset, 
    sms_application_sid: :unset, 
    address_sid: :unset, 
    email: :unset, 
    verification_type: :unset, 
    verification_document_sid: :unset
)

    data = Twilio::Values.of({
        'PhoneNumber' => phone_number,
        'SmsCapability' => sms_capability,
        'AccountSid' => ,
        'FriendlyName' => friendly_name,
        'UniqueName' => unique_name,
        'CcEmails' => Twilio.serialize_list(cc_emails) { |e| e },
        'SmsUrl' => sms_url,
        'SmsMethod' => sms_method,
        'SmsFallbackUrl' => sms_fallback_url,
        'SmsFallbackMethod' => sms_fallback_method,
        'StatusCallbackUrl' => status_callback_url,
        'StatusCallbackMethod' => status_callback_method,
        'SmsApplicationSid' => sms_application_sid,
        'AddressSid' => address_sid,
        'Email' => email,
        'VerificationType' => verification_type,
        'VerificationDocumentSid' => verification_document_sid,
    })

    
    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.



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

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.



208
209
210
211
212
213
214
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/hosted_number_order.rb', line 208

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



118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/hosted_number_order.rb', line 118

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



186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/hosted_number_order.rb', line 186

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)

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



146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/hosted_number_order.rb', line 146

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



219
220
221
 
# File 'lib/twilio-ruby/rest/preview/hosted_numbers/hosted_number_order.rb', line 219

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