Class: Twilio::REST::Numbers::V2::HostedNumberOrderList

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

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ HostedNumberOrderList

Initialize the HostedNumberOrderList

Parameters:

  • version (Version) —

    Version that contains the resource



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

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

Instance Method Details

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

Create the HostedNumberOrderInstance

Parameters:

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

    The number to host in [+E.164](en.wikipedia.org/wiki/E.164) format

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

    The contact phone number of the person authorized to sign the Authorization Document.

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

    Optional. A 34 character string that uniquely identifies the Address resource that represents the address of the owner of this phone number.

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

    Optional. Email of the owner of this phone number that is being hosted.

  • account_sid (String) (defaults to: :unset) —

    This defaults to the AccountSid of the authorization the user is using. This can be provided to specify a subaccount to add the HostedNumberOrder to.

  • friendly_name (String) (defaults to: :unset) —

    A 128 character string that is a human readable text that describes this resource.

  • cc_emails (Array[String]) (defaults to: :unset) —

    Optional. A list of emails that the LOA document for this HostedNumberOrder will be carbon copied to.

  • sms_url (String) (defaults to: :unset) —

    The URL that Twilio should request when somebody sends an SMS to the phone number. This will be copied onto the IncomingPhoneNumber resource.

  • sms_method (String) (defaults to: :unset) —

    The HTTP method that should be used to request the SmsUrl. Must be either ‘GET` or `POST`. This will be copied onto the IncomingPhoneNumber resource.

  • sms_fallback_url (String) (defaults to: :unset) —

    A URL that Twilio will request if an error occurs requesting or executing the TwiML defined by SmsUrl. This will be copied onto the IncomingPhoneNumber resource.

  • sms_capability (Boolean) (defaults to: :unset) —

    Used to specify that the SMS capability will be hosted on Twilio’s platform.

  • sms_fallback_method (String) (defaults to: :unset) —

    The HTTP method that should be used to request the SmsFallbackUrl. Must be either ‘GET` or `POST`. This will be copied onto the IncomingPhoneNumber resource.

  • status_callback_url (String) (defaults to: :unset) —

    Optional. The Status Callback URL attached to the IncomingPhoneNumber resource.

  • status_callback_method (String) (defaults to: :unset) —

    Optional. The Status Callback Method attached to the IncomingPhoneNumber resource.

  • sms_application_sid (String) (defaults to: :unset) —

    Optional. The 34 character sid of the application Twilio should use to handle SMS messages sent to this number. If a ‘SmsApplicationSid` is present, Twilio will ignore all of the SMS urls above and use those set on the application.

  • contact_title (String) (defaults to: :unset) —

    The title of the person authorized to sign the Authorization Document for this phone number.

Returns:



52
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
100
101
 
# File 'lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb', line 52

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

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

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.create('POST', @uri, data: data, headers: headers)
    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.



166
167
168
169
170
171
172
173
174
 
# File 'lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb', line 166

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.

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of HostedNumberOrderInstance



213
214
215
216
217
218
219
 
# File 'lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb', line 213

def get_page(target_url)
    response = @version.domain.request(
        'GET',
        target_url
    )
HostedNumberOrderPage.new(@version, response, @solution)
end

#list(status: :unset, sms_capability: :unset, phone_number: :unset, incoming_phone_number_sid: :unset, friendly_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.

Parameters:

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

    The Status of this HostedNumberOrder. One of ‘received`, `pending-verification`, `verified`, `pending-loa`, `carrier-processing`, `testing`, `completed`, `failed`, or `action-required`.

  • sms_capability (Boolean) (defaults to: :unset) —

    Whether the SMS capability will be hosted on our platform. Can be ‘true` of `false`.

  • 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 128 characters.

  • 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



120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb', line 120

def list(status: :unset, sms_capability: :unset, phone_number: :unset, incoming_phone_number_sid: :unset, friendly_name: :unset, limit: nil, page_size: nil)
    self.stream(
        status: status,
        sms_capability: sms_capability,
        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, sms_capability: :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 HostedNumberOrderInstance records from the API. Request is executed immediately.

Parameters:

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

    The Status of this HostedNumberOrder. One of ‘received`, `pending-verification`, `verified`, `pending-loa`, `carrier-processing`, `testing`, `completed`, `failed`, or `action-required`.

  • sms_capability (Boolean) (defaults to: :unset) —

    Whether the SMS capability will be hosted on our platform. Can be ‘true` of `false`.

  • 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 128 characters.

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



188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb', line 188

def page(status: :unset, sms_capability: :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,
        'SmsCapability' => sms_capability,
        '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)

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

#stream(status: :unset, sms_capability: :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:

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

    The Status of this HostedNumberOrder. One of ‘received`, `pending-verification`, `verified`, `pending-loa`, `carrier-processing`, `testing`, `completed`, `failed`, or `action-required`.

  • sms_capability (Boolean) (defaults to: :unset) —

    Whether the SMS capability will be hosted on our platform. Can be ‘true` of `false`.

  • 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 128 characters.

  • 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



148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb', line 148

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



224
225
226
 
# File 'lib/twilio-ruby/rest/numbers/v2/hosted_number_order.rb', line 224

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