Class: Twilio::REST::Api::V2010::AccountContext::AvailablePhoneNumberCountryContext::SharedCostList

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

Instance Method Summary collapse

Constructor Details

#initialize(version, account_sid: nil, country_code: nil) ⇒ SharedCostList

Initialize the SharedCostList

Parameters:

  • version (Version) —

    Version that contains the resource

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

    The 34 character string that uniquely identifies your account.

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

    The ISO Country code to lookup phone numbers for.



23
24
25
26
27
28
29
 
# File 'lib/twilio-ruby/rest/api/v2010/account/available_phone_number/shared_cost.rb', line 23

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

  # Path Solution
  @solution = {account_sid: , country_code: country_code}
  @uri = "/Accounts/#{@solution[:account_sid]}/AvailablePhoneNumbers/#{@solution[:country_code]}/SharedCost.json"
end

Instance Method Details

#each ⇒ Object

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



150
151
152
153
154
155
156
157
158
 
# File 'lib/twilio-ruby/rest/api/v2010/account/available_phone_number/shared_cost.rb', line 150

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

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of SharedCostInstance



224
225
226
227
228
229
230
 
# File 'lib/twilio-ruby/rest/api/v2010/account/available_phone_number/shared_cost.rb', line 224

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

#list(area_code: :unset, contains: :unset, sms_enabled: :unset, mms_enabled: :unset, voice_enabled: :unset, exclude_all_address_required: :unset, exclude_local_address_required: :unset, exclude_foreign_address_required: :unset, beta: :unset, near_number: :unset, near_lat_long: :unset, distance: :unset, in_postal_code: :unset, in_region: :unset, in_rate_center: :unset, in_lata: :unset, in_locality: :unset, fax_enabled: :unset, limit: nil, page_size: nil) ⇒ Array

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

Parameters:

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

    The area_code

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

    The contains

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

    The sms_enabled

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

    The mms_enabled

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

    The voice_enabled

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

    The exclude_all_address_required

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

    The exclude_local_address_required

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

    The exclude_foreign_address_required

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

    The beta

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

    The near_number

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

    The near_lat_long

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

    The distance

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

    The in_postal_code

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

    The in_region

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

    The in_rate_center

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

    The in_lata

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

    The in_locality

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

    The fax_enabled

  • 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



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/twilio-ruby/rest/api/v2010/account/available_phone_number/shared_cost.rb', line 62

def list(area_code: :unset, contains: :unset, sms_enabled: :unset, mms_enabled: :unset, voice_enabled: :unset, exclude_all_address_required: :unset, exclude_local_address_required: :unset, exclude_foreign_address_required: :unset, beta: :unset, near_number: :unset, near_lat_long: :unset, distance: :unset, in_postal_code: :unset, in_region: :unset, in_rate_center: :unset, in_lata: :unset, in_locality: :unset, fax_enabled: :unset, limit: nil, page_size: nil)
  self.stream(
      area_code: area_code,
      contains: contains,
      sms_enabled: sms_enabled,
      mms_enabled: mms_enabled,
      voice_enabled: voice_enabled,
      exclude_all_address_required: exclude_all_address_required,
      exclude_local_address_required: exclude_local_address_required,
      exclude_foreign_address_required: exclude_foreign_address_required,
      beta: beta,
      near_number: near_number,
      near_lat_long: near_lat_long,
      distance: distance,
      in_postal_code: in_postal_code,
      in_region: in_region,
      in_rate_center: in_rate_center,
      in_lata: in_lata,
      in_locality: in_locality,
      fax_enabled: fax_enabled,
      limit: limit,
      page_size: page_size
  ).entries
end

#page(area_code: :unset, contains: :unset, sms_enabled: :unset, mms_enabled: :unset, voice_enabled: :unset, exclude_all_address_required: :unset, exclude_local_address_required: :unset, exclude_foreign_address_required: :unset, beta: :unset, near_number: :unset, near_lat_long: :unset, distance: :unset, in_postal_code: :unset, in_region: :unset, in_rate_center: :unset, in_lata: :unset, in_locality: :unset, fax_enabled: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page

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

Parameters:

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

    The area_code

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

    The contains

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

    The sms_enabled

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

    The mms_enabled

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

    The voice_enabled

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

    The exclude_all_address_required

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

    The exclude_local_address_required

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

    The exclude_foreign_address_required

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

    The beta

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

    The near_number

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

    The near_lat_long

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

    The distance

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

    The in_postal_code

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

    The in_region

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

    The in_rate_center

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

    The in_lata

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

    The in_locality

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

    The fax_enabled

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



187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/twilio-ruby/rest/api/v2010/account/available_phone_number/shared_cost.rb', line 187

def page(area_code: :unset, contains: :unset, sms_enabled: :unset, mms_enabled: :unset, voice_enabled: :unset, exclude_all_address_required: :unset, exclude_local_address_required: :unset, exclude_foreign_address_required: :unset, beta: :unset, near_number: :unset, near_lat_long: :unset, distance: :unset, in_postal_code: :unset, in_region: :unset, in_rate_center: :unset, in_lata: :unset, in_locality: :unset, fax_enabled: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
  params = Twilio::Values.of({
      'AreaCode' => area_code,
      'Contains' => contains,
      'SmsEnabled' => sms_enabled,
      'MmsEnabled' => mms_enabled,
      'VoiceEnabled' => voice_enabled,
      'ExcludeAllAddressRequired' => exclude_all_address_required,
      'ExcludeLocalAddressRequired' => exclude_local_address_required,
      'ExcludeForeignAddressRequired' => exclude_foreign_address_required,
      'Beta' => beta,
      'NearNumber' => near_number,
      'NearLatLong' => near_lat_long,
      'Distance' => distance,
      'InPostalCode' => in_postal_code,
      'InRegion' => in_region,
      'InRateCenter' => in_rate_center,
      'InLata' => in_lata,
      'InLocality' => in_locality,
      'FaxEnabled' => fax_enabled,
      'PageToken' => page_token,
      'Page' => page_number,
      'PageSize' => page_size,
  })
  response = @version.page(
      'GET',
      @uri,
      params
  )
  SharedCostPage.new(@version, response, @solution)
end

#stream(area_code: :unset, contains: :unset, sms_enabled: :unset, mms_enabled: :unset, voice_enabled: :unset, exclude_all_address_required: :unset, exclude_local_address_required: :unset, exclude_foreign_address_required: :unset, beta: :unset, near_number: :unset, near_lat_long: :unset, distance: :unset, in_postal_code: :unset, in_region: :unset, in_rate_center: :unset, in_lata: :unset, in_locality: :unset, fax_enabled: :unset, limit: nil, page_size: nil) ⇒ Enumerable

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

Parameters:

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

    The area_code

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

    The contains

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

    The sms_enabled

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

    The mms_enabled

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

    The voice_enabled

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

    The exclude_all_address_required

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

    The exclude_local_address_required

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

    The exclude_foreign_address_required

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

    The beta

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

    The near_number

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

    The near_lat_long

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

    The distance

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

    The in_postal_code

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

    The in_region

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

    The in_rate_center

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

    The in_lata

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

    The in_locality

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

    The fax_enabled

  • 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



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/twilio-ruby/rest/api/v2010/account/available_phone_number/shared_cost.rb', line 118

def stream(area_code: :unset, contains: :unset, sms_enabled: :unset, mms_enabled: :unset, voice_enabled: :unset, exclude_all_address_required: :unset, exclude_local_address_required: :unset, exclude_foreign_address_required: :unset, beta: :unset, near_number: :unset, near_lat_long: :unset, distance: :unset, in_postal_code: :unset, in_region: :unset, in_rate_center: :unset, in_lata: :unset, in_locality: :unset, fax_enabled: :unset, limit: nil, page_size: nil)
  limits = @version.read_limits(limit, page_size)

  page = self.page(
      area_code: area_code,
      contains: contains,
      sms_enabled: sms_enabled,
      mms_enabled: mms_enabled,
      voice_enabled: voice_enabled,
      exclude_all_address_required: exclude_all_address_required,
      exclude_local_address_required: exclude_local_address_required,
      exclude_foreign_address_required: exclude_foreign_address_required,
      beta: beta,
      near_number: near_number,
      near_lat_long: near_lat_long,
      distance: distance,
      in_postal_code: in_postal_code,
      in_region: in_region,
      in_rate_center: in_rate_center,
      in_lata: in_lata,
      in_locality: in_locality,
      fax_enabled: fax_enabled,
      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



234
235
236
 
# File 'lib/twilio-ruby/rest/api/v2010/account/available_phone_number/shared_cost.rb', line 234

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