Class: Twilio::REST::Api::V2010::AccountContext::IncomingPhoneNumberList::LocalList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/local.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, account_sid: nil) ⇒ LocalList

Initialize the LocalList

Parameters:

  • version (Version) —

    Version that contains the resource

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

    The unique id of the Account responsible for this phone number.



20
21
22
23
24
25
26
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/local.rb', line 20

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

  # Path Solution
  @solution = {account_sid: }
  @uri = "/Accounts/#{@solution[:account_sid]}/IncomingPhoneNumbers/Local.json"
end

Instance Method Details

#create(phone_number: nil, api_version: :unset, friendly_name: :unset, sms_application_sid: :unset, sms_fallback_method: :unset, sms_fallback_url: :unset, sms_method: :unset, sms_url: :unset, status_callback: :unset, status_callback_method: :unset, voice_application_sid: :unset, voice_caller_id_lookup: :unset, voice_fallback_method: :unset, voice_fallback_url: :unset, voice_method: :unset, voice_url: :unset, identity_sid: :unset, address_sid: :unset) ⇒ LocalInstance

Retrieve a single page of LocalInstance records from the API. Request is executed immediately.

Parameters:

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

    The phone_number

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

    The api_version

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

    The friendly_name

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

    The sms_application_sid

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

    The sms_fallback_method

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

    The sms_fallback_url

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

    The sms_method

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

    The sms_url

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

    The status_callback

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

    The status_callback_method

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

    The voice_application_sid

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

    The voice_caller_id_lookup

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

    The voice_fallback_method

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

    The voice_fallback_url

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

    The voice_method

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

    The voice_url

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

    The identity_sid

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

    The address_sid

Returns:



161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/local.rb', line 161

def create(phone_number: nil, api_version: :unset, friendly_name: :unset, sms_application_sid: :unset, sms_fallback_method: :unset, sms_fallback_url: :unset, sms_method: :unset, sms_url: :unset, status_callback: :unset, status_callback_method: :unset, voice_application_sid: :unset, voice_caller_id_lookup: :unset, voice_fallback_method: :unset, voice_fallback_url: :unset, voice_method: :unset, voice_url: :unset, identity_sid: :unset, address_sid: :unset)
  data = Twilio::Values.of({
      'PhoneNumber' => phone_number,
      'ApiVersion' => api_version,
      'FriendlyName' => friendly_name,
      'SmsApplicationSid' => sms_application_sid,
      'SmsFallbackMethod' => sms_fallback_method,
      'SmsFallbackUrl' => sms_fallback_url,
      'SmsMethod' => sms_method,
      'SmsUrl' => sms_url,
      'StatusCallback' => status_callback,
      'StatusCallbackMethod' => status_callback_method,
      'VoiceApplicationSid' => voice_application_sid,
      'VoiceCallerIdLookup' => voice_caller_id_lookup,
      'VoiceFallbackMethod' => voice_fallback_method,
      'VoiceFallbackUrl' => voice_fallback_url,
      'VoiceMethod' => voice_method,
      'VoiceUrl' => voice_url,
      'IdentitySid' => identity_sid,
      'AddressSid' => address_sid,
  })

  payload = @version.create(
      'POST',
      @uri,
      data: data
  )

  LocalInstance.new(@version, payload, account_sid: @solution[:account_sid], )
end

#each ⇒ Object

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



87
88
89
90
91
92
93
94
95
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/local.rb', line 87

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

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of LocalInstance



131
132
133
134
135
136
137
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/local.rb', line 131

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

#list(beta: :unset, friendly_name: :unset, phone_number: :unset, origin: :unset, limit: nil, page_size: nil) ⇒ Array

Lists LocalInstance records from the API as a list. Unlike stream(), this operation is eager and will load ‘limit` records into memory before returning.

Parameters:

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

    The beta

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

    The friendly_name

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

    The phone_number

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

    The origin

  • 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



43
44
45
46
47
48
49
50
51
52
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/local.rb', line 43

def list(beta: :unset, friendly_name: :unset, phone_number: :unset, origin: :unset, limit: nil, page_size: nil)
  self.stream(
      beta: beta,
      friendly_name: friendly_name,
      phone_number: phone_number,
      origin: origin,
      limit: limit,
      page_size: page_size
  ).entries
end

#page(beta: :unset, friendly_name: :unset, phone_number: :unset, origin: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page

Retrieve a single page of LocalInstance records from the API. Request is executed immediately.

Parameters:

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

    The beta

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

    The friendly_name

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

    The phone_number

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

    The origin

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



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/local.rb', line 108

def page(beta: :unset, friendly_name: :unset, phone_number: :unset, origin: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
  params = Twilio::Values.of({
      'Beta' => beta,
      'FriendlyName' => friendly_name,
      'PhoneNumber' => phone_number,
      'Origin' => origin,
      'PageToken' => page_token,
      'Page' => page_number,
      'PageSize' => page_size,
  })
  response = @version.page(
      'GET',
      @uri,
      params
  )
  LocalPage.new(@version, response, @solution)
end

#stream(beta: :unset, friendly_name: :unset, phone_number: :unset, origin: :unset, limit: nil, page_size: nil) ⇒ Enumerable

Streams LocalInstance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.

Parameters:

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

    The beta

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

    The friendly_name

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

    The phone_number

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

    The origin

  • 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



69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/local.rb', line 69

def stream(beta: :unset, friendly_name: :unset, phone_number: :unset, origin: :unset, limit: nil, page_size: nil)
  limits = @version.read_limits(limit, page_size)

  page = self.page(
      beta: beta,
      friendly_name: friendly_name,
      phone_number: phone_number,
      origin: origin,
      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



194
195
196
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/local.rb', line 194

def to_s
  '#<Twilio.Api.V2010.LocalList>'
end