twilio-ruby 5.19.0 → 5.20.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (76) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGES.md +13 -0
  3. data/README.md +2 -2
  4. data/lib/twilio-ruby/rest/api.rb +16 -13
  5. data/lib/twilio-ruby/rest/api/v2010/account/address.rb +85 -88
  6. data/lib/twilio-ruby/rest/api/v2010/account/address/dependent_phone_number.rb +4 -4
  7. data/lib/twilio-ruby/rest/api/v2010/account/application.rb +135 -146
  8. data/lib/twilio-ruby/rest/api/v2010/account/authorized_connect_app.rb +21 -17
  9. data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number.rb +14 -8
  10. data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/local.rb +150 -166
  11. data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/machine_to_machine.rb +174 -79
  12. data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/mobile.rb +147 -160
  13. data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/national.rb +174 -79
  14. data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/shared_cost.rb +174 -79
  15. data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/toll_free.rb +147 -160
  16. data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/voip.rb +174 -79
  17. data/lib/twilio-ruby/rest/api/v2010/account/connect_app.rb +51 -51
  18. data/lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb +246 -251
  19. data/lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on.rb +31 -26
  20. data/lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on/assigned_add_on_extension.rb +34 -26
  21. data/lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/local.rb +109 -112
  22. data/lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/mobile.rb +108 -112
  23. data/lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/toll_free.rb +108 -112
  24. data/lib/twilio-ruby/rest/api/v2010/account/message/feedback.rb +21 -11
  25. data/lib/twilio-ruby/rest/api/v2010/account/new_key.rb +7 -6
  26. data/lib/twilio-ruby/rest/api/v2010/account/new_signing_key.rb +7 -6
  27. data/lib/twilio-ruby/rest/api/v2010/account/notification.rb +32 -25
  28. data/lib/twilio-ruby/rest/api/v2010/account/outgoing_caller_id.rb +36 -36
  29. data/lib/twilio-ruby/rest/api/v2010/account/sip.rb +2 -1
  30. data/lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb +70 -66
  31. data/lib/twilio-ruby/rest/api/v2010/account/sip/domain/auth_types.rb +10 -10
  32. data/lib/twilio-ruby/rest/api/v2010/account/sip/domain/auth_types/auth_calls_mapping.rb +14 -14
  33. data/lib/twilio-ruby/rest/api/v2010/account/sip/domain/auth_types/auth_calls_mapping/auth_calls_credential_list_mapping.rb +26 -23
  34. data/lib/twilio-ruby/rest/api/v2010/account/sip/domain/auth_types/auth_calls_mapping/auth_calls_ip_access_control_list_mapping.rb +26 -23
  35. data/lib/twilio-ruby/rest/api/v2010/account/sip/domain/auth_types/auth_registrations_mapping.rb +12 -12
  36. data/lib/twilio-ruby/rest/api/v2010/account/sip/domain/auth_types/auth_registrations_mapping/auth_registrations_credential_list_mapping.rb +26 -23
  37. data/lib/twilio-ruby/rest/api/v2010/account/sip/domain/credential_list_mapping.rb +4 -4
  38. data/lib/twilio-ruby/rest/api/v2010/account/sip/domain/ip_access_control_list_mapping.rb +4 -4
  39. data/lib/twilio-ruby/rest/api/v2010/account/token.rb +11 -9
  40. data/lib/twilio-ruby/rest/api/v2010/account/usage.rb +2 -1
  41. data/lib/twilio-ruby/rest/api/v2010/account/usage/record.rb +56 -47
  42. data/lib/twilio-ruby/rest/api/v2010/account/usage/record/all_time.rb +59 -44
  43. data/lib/twilio-ruby/rest/api/v2010/account/usage/record/daily.rb +59 -44
  44. data/lib/twilio-ruby/rest/api/v2010/account/usage/record/last_month.rb +59 -47
  45. data/lib/twilio-ruby/rest/api/v2010/account/usage/record/monthly.rb +59 -44
  46. data/lib/twilio-ruby/rest/api/v2010/account/usage/record/this_month.rb +59 -44
  47. data/lib/twilio-ruby/rest/api/v2010/account/usage/record/today.rb +59 -44
  48. data/lib/twilio-ruby/rest/api/v2010/account/usage/record/yearly.rb +59 -44
  49. data/lib/twilio-ruby/rest/api/v2010/account/usage/record/yesterday.rb +59 -44
  50. data/lib/twilio-ruby/rest/api/v2010/account/usage/trigger.rb +76 -74
  51. data/lib/twilio-ruby/rest/authy.rb +8 -8
  52. data/lib/twilio-ruby/rest/authy/v1.rb +15 -15
  53. data/lib/twilio-ruby/rest/client.rb +16 -13
  54. data/lib/twilio-ruby/rest/messaging.rb +15 -0
  55. data/lib/twilio-ruby/rest/messaging/v1.rb +23 -0
  56. data/lib/twilio-ruby/rest/messaging/v1/session.rb +482 -0
  57. data/lib/twilio-ruby/rest/messaging/v1/session/message.rb +434 -0
  58. data/lib/twilio-ruby/rest/messaging/v1/session/participant.rb +458 -0
  59. data/lib/twilio-ruby/rest/messaging/v1/webhook.rb +285 -0
  60. data/lib/twilio-ruby/rest/preview.rb +8 -8
  61. data/lib/twilio-ruby/rest/preview/marketplace.rb +13 -13
  62. data/lib/twilio-ruby/rest/proxy/v1/service/session.rb +3 -2
  63. data/lib/twilio-ruby/rest/video.rb +9 -9
  64. data/lib/twilio-ruby/rest/video/v1.rb +16 -16
  65. data/lib/twilio-ruby/rest/video/v1/composition.rb +7 -6
  66. data/lib/twilio-ruby/rest/video/v1/composition_hook.rb +37 -21
  67. data/lib/twilio-ruby/rest/video/v1/recording.rb +12 -3
  68. data/lib/twilio-ruby/security/request_validator.rb +2 -2
  69. data/lib/twilio-ruby/version.rb +1 -1
  70. data/spec/integration/messaging/v1/session/message_spec.rb +238 -0
  71. data/spec/integration/messaging/v1/session/participant_spec.rb +256 -0
  72. data/spec/integration/messaging/v1/session_spec.rb +223 -0
  73. data/spec/integration/messaging/v1/webhook_spec.rb +92 -0
  74. data/spec/integration/video/v1/composition_hook_spec.rb +1 -1
  75. data/spec/security/request_validator_spec.rb +5 -7
  76. metadata +14 -2
@@ -148,8 +148,12 @@ module Twilio
148
148
  ##
149
149
  # Initialize the AvailablePhoneNumberCountryContext
150
150
  # @param [Version] version Version that contains the resource
151
- # @param [String] account_sid The account_sid
152
- # @param [String] country_code The country_code
151
+ # @param [String] account_sid The SID of the
152
+ # [Account](https://www.twilio.com/docs/api/rest/account) requesting the available
153
+ # phone number Country resource.
154
+ # @param [String] country_code The
155
+ # [ISO-3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of
156
+ # the country to fetch available phone number information about.
153
157
  # @return [AvailablePhoneNumberCountryContext] AvailablePhoneNumberCountryContext
154
158
  def initialize(version, account_sid, country_code)
155
159
  super(version)
@@ -315,7 +319,9 @@ module Twilio
315
319
  # @param [Hash] payload payload that contains response from Twilio
316
320
  # @param [String] account_sid A 34 character string that uniquely identifies this
317
321
  # resource.
318
- # @param [String] country_code The country_code
322
+ # @param [String] country_code The
323
+ # [ISO-3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of
324
+ # the country to fetch available phone number information about.
319
325
  # @return [AvailablePhoneNumberCountryInstance] AvailablePhoneNumberCountryInstance
320
326
  def initialize(version, payload, account_sid: nil, country_code: nil)
321
327
  super(version)
@@ -353,31 +359,31 @@ module Twilio
353
359
  end
354
360
 
355
361
  ##
356
- # @return [String] The ISO Country code to lookup phone numbers for.
362
+ # @return [String] The ISO-3166-1 country code of the country.
357
363
  def country_code
358
364
  @properties['country_code']
359
365
  end
360
366
 
361
367
  ##
362
- # @return [String] The country
368
+ # @return [String] The name of the country
363
369
  def country
364
370
  @properties['country']
365
371
  end
366
372
 
367
373
  ##
368
- # @return [String] The uri
374
+ # @return [String] The URI of the Country resource, relative to `https://api.twilio.com`
369
375
  def uri
370
376
  @properties['uri']
371
377
  end
372
378
 
373
379
  ##
374
- # @return [Boolean] True if new to Twilio platform.
380
+ # @return [Boolean] Whether all phone numbers available in the country are new to the Twilio platform.
375
381
  def beta
376
382
  @properties['beta']
377
383
  end
378
384
 
379
385
  ##
380
- # @return [String] The subresource_uris
386
+ # @return [String] A list of related resources identified by their relative URIs
381
387
  def subresource_uris
382
388
  @properties['subresource_uris']
383
389
  end
@@ -16,9 +16,10 @@ module Twilio
16
16
  ##
17
17
  # Initialize the LocalList
18
18
  # @param [Version] version Version that contains the resource
19
- # @param [String] account_sid The 34 character string that uniquely identifies
20
- # your account.
21
- # @param [String] country_code The ISO Country code to lookup phone numbers for.
19
+ # @param [String] account_sid The account_sid
20
+ # @param [String] country_code The
21
+ # [ISO-3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of
22
+ # the country.
22
23
  # @return [LocalList] LocalList
23
24
  def initialize(version, account_sid: nil, country_code: nil)
24
25
  super(version)
@@ -32,63 +33,57 @@ module Twilio
32
33
  # Lists LocalInstance records from the API as a list.
33
34
  # Unlike stream(), this operation is eager and will load `limit` records into
34
35
  # memory before returning.
35
- # @param [String] area_code Find phone numbers in the specified area code. (US and
36
- # Canada only)
37
- # @param [String] contains A pattern on which to match phone numbers. Valid
38
- # characters are `'*'` and `[0-9a-zA-Z]`. The `'*'` character will match any
39
- # single digit. See [Example
40
- # 2](https://www.twilio.com/docs/api/rest/available-phone-numbers#local-get-basic-example-2) and [Example 3](https://www.twilio.com/docs/api/rest/available-phone-numbers#local-get-basic-example-3) below. *NOTE:* Patterns must be at least two characters long.
41
- # @param [Boolean] sms_enabled This indicates whether the phone numbers can
42
- # receive text messages. Possible values are `true` or `false`.
43
- # @param [Boolean] mms_enabled This indicates whether the phone numbers can
44
- # receive MMS messages. Possible values are `true` or `false`.
45
- # @param [Boolean] voice_enabled This indicates whether the phone numbers can
46
- # receive calls. Possible values are `true` or `false`.
47
- # @param [Boolean] exclude_all_address_required Indicates whether the response
48
- # includes phone numbers which require any
49
- # [Address](https://www.twilio.com/docs/usage/api/addresses). Possible values are
50
- # `true` or `false`. If not specified, the default is `false`, and results could
51
- # include phone numbers with an Address required.
52
- # @param [Boolean] exclude_local_address_required Indicates whether the response
53
- # includes phone numbers which require a local
54
- # [Address](https://www.twilio.com/docs/usage/api/addresses). Possible values are
55
- # `true` or `false`. If not specified, the default is `false`, and results could
56
- # include phone numbers with a local Address required.
57
- # @param [Boolean] exclude_foreign_address_required Indicates whether the response
58
- # includes phone numbers which require a foreign
59
- # [Address](https://www.twilio.com/docs/usage/api/addresses). Possible values are
60
- # `true` or `false`. If not specified, the default is `false`, and results could
61
- # include phone numbers with a foreign Address required.
62
- # @param [Boolean] beta Include phone numbers new to the Twilio platform. Possible
63
- # values are either `true` or `false`. Default is `true`.
36
+ # @param [String] area_code The area code of the phone numbers to read. Applies to
37
+ # only phone numbers in the US and Canada.
38
+ # @param [String] contains The pattern on which to match phone numbers. Valid
39
+ # characters are `*`, `0-9`, `a-z`, and `A-Z`. The `*` character matches any
40
+ # single digit. For examples, see [Example
41
+ # 2](https://www.twilio.com/docs/api/rest/available-phone-numbers#local-get-basic-example-2) and [Example 3](https://www.twilio.com/docs/api/rest/available-phone-numbers#local-get-basic-example-3). If specified, this value must have at least two characters.
42
+ # @param [Boolean] sms_enabled Whether the phone numbers can receive text
43
+ # messages. Can be: `true` or `false`.
44
+ # @param [Boolean] mms_enabled Whether the phone numbers can receive MMS messages.
45
+ # Can be: `true` or `false`.
46
+ # @param [Boolean] voice_enabled Whether the phone numbers can receive calls. Can
47
+ # be: `true` or `false`.
48
+ # @param [Boolean] exclude_all_address_required Whether to exclude phone numbers
49
+ # that require an [Address](https://www.twilio.com/docs/usage/api/addresses). Can
50
+ # be: `true` or `false` and the default is `false`.
51
+ # @param [Boolean] exclude_local_address_required Whether to exclude phone numbers
52
+ # that require a local [Address](https://www.twilio.com/docs/usage/api/addresses).
53
+ # Can be: `true` or `false` and the default is `false`.
54
+ # @param [Boolean] exclude_foreign_address_required Whether to exclude phone
55
+ # numbers that require a foreign
56
+ # [Address](https://www.twilio.com/docs/usage/api/addresses). Can be: `true` or
57
+ # `false` and the default is `false`.
58
+ # @param [Boolean] beta Whether to read phone numbers that are new to the Twilio
59
+ # platform. Can be: `true` or `false` and the default is `true`.
64
60
  # @param [String] near_number Given a phone number, find a geographically close
65
- # number within `Distance` miles. Distance defaults to 25 miles. *Limited to US
66
- # and Canadian phone numbers.*
61
+ # number within `distance` miles. Distance defaults to 25 miles. Applies to only
62
+ # phone numbers in the US and Canada.
67
63
  # @param [String] near_lat_long Given a latitude/longitude pair `lat,long` find
68
- # geographically close numbers within `Distance` miles. *Limited to US and
69
- # Canadian phone numbers.*
70
- # @param [String] distance Specifies the search radius for a `Near-` query in
71
- # miles. If not specified this defaults to 25 miles. Maximum searchable distance
72
- # is 500 miles. *Limited to US and Canadian phone numbers.*
64
+ # geographically close numbers within `distance` miles. Applies to only phone
65
+ # numbers in the US and Canada.
66
+ # @param [String] distance The search radius, in miles, for a `near_` query. Can
67
+ # be up to `500` and the default is `25`. Applies to only phone numbers in the US
68
+ # and Canada.
73
69
  # @param [String] in_postal_code Limit results to a particular postal code. Given
74
- # a phone number, search within the same postal code as that number. *Limited to
75
- # US and Canadian phone numbers.*
76
- # @param [String] in_region Limit results to a particular region (i.e.
77
- # State/Province). Given a phone number, search within the same Region as that
78
- # number. *Limited to US and Canadian phone numbers.*
70
+ # a phone number, search within the same postal code as that number. Applies to
71
+ # only phone numbers in the US and Canada.
72
+ # @param [String] in_region Limit results to a particular region, state, or
73
+ # province. Given a phone number, search within the same region as that number.
74
+ # Applies to only phone numbers in the US and Canada.
79
75
  # @param [String] in_rate_center Limit results to a specific rate center, or given
80
76
  # a phone number search within the same rate center as that number. Requires
81
- # InLata to be set as well. *Limited to US and Canadian phone numbers.*
82
- # @param [String] in_lata Limit results to a specific Local access and transport
77
+ # `in_lata` to be set as well. Applies to only phone numbers in the US and Canada.
78
+ # @param [String] in_lata Limit results to a specific local access and transport
83
79
  # area ([LATA](http://en.wikipedia.org/wiki/Local_access_and_transport_area)).
84
80
  # Given a phone number, search within the same
85
81
  # [LATA](http://en.wikipedia.org/wiki/Local_access_and_transport_area) as that
86
- # number. *Limited to US and Canadian phone numbers.*
87
- # @param [String] in_locality Limit results to a particular locality (i.e. City).
88
- # Given a phone number, search within the same Locality as that number. *Limited
89
- # to US and Canadian phone numbers.*
90
- # @param [Boolean] fax_enabled This indicates whether the phone numbers can
91
- # receive faxes. Possible values are `true` or `false`.
82
+ # number. Applies to only phone numbers in the US and Canada.
83
+ # @param [String] in_locality Limit results to a particular locality or city.
84
+ # Given a phone number, search within the same Locality as that number.
85
+ # @param [Boolean] fax_enabled Whether the phone numbers can receive faxes. Can
86
+ # be: `true` or `false`.
92
87
  # @param [Integer] limit Upper limit for the number of records to return. stream()
93
88
  # guarantees to never return more than limit. Default is no limit
94
89
  # @param [Integer] page_size Number of records to fetch per request, when
@@ -125,63 +120,57 @@ module Twilio
125
120
  # Streams LocalInstance records from the API as an Enumerable.
126
121
  # This operation lazily loads records as efficiently as possible until the limit
127
122
  # is reached.
128
- # @param [String] area_code Find phone numbers in the specified area code. (US and
129
- # Canada only)
130
- # @param [String] contains A pattern on which to match phone numbers. Valid
131
- # characters are `'*'` and `[0-9a-zA-Z]`. The `'*'` character will match any
132
- # single digit. See [Example
133
- # 2](https://www.twilio.com/docs/api/rest/available-phone-numbers#local-get-basic-example-2) and [Example 3](https://www.twilio.com/docs/api/rest/available-phone-numbers#local-get-basic-example-3) below. *NOTE:* Patterns must be at least two characters long.
134
- # @param [Boolean] sms_enabled This indicates whether the phone numbers can
135
- # receive text messages. Possible values are `true` or `false`.
136
- # @param [Boolean] mms_enabled This indicates whether the phone numbers can
137
- # receive MMS messages. Possible values are `true` or `false`.
138
- # @param [Boolean] voice_enabled This indicates whether the phone numbers can
139
- # receive calls. Possible values are `true` or `false`.
140
- # @param [Boolean] exclude_all_address_required Indicates whether the response
141
- # includes phone numbers which require any
142
- # [Address](https://www.twilio.com/docs/usage/api/addresses). Possible values are
143
- # `true` or `false`. If not specified, the default is `false`, and results could
144
- # include phone numbers with an Address required.
145
- # @param [Boolean] exclude_local_address_required Indicates whether the response
146
- # includes phone numbers which require a local
147
- # [Address](https://www.twilio.com/docs/usage/api/addresses). Possible values are
148
- # `true` or `false`. If not specified, the default is `false`, and results could
149
- # include phone numbers with a local Address required.
150
- # @param [Boolean] exclude_foreign_address_required Indicates whether the response
151
- # includes phone numbers which require a foreign
152
- # [Address](https://www.twilio.com/docs/usage/api/addresses). Possible values are
153
- # `true` or `false`. If not specified, the default is `false`, and results could
154
- # include phone numbers with a foreign Address required.
155
- # @param [Boolean] beta Include phone numbers new to the Twilio platform. Possible
156
- # values are either `true` or `false`. Default is `true`.
123
+ # @param [String] area_code The area code of the phone numbers to read. Applies to
124
+ # only phone numbers in the US and Canada.
125
+ # @param [String] contains The pattern on which to match phone numbers. Valid
126
+ # characters are `*`, `0-9`, `a-z`, and `A-Z`. The `*` character matches any
127
+ # single digit. For examples, see [Example
128
+ # 2](https://www.twilio.com/docs/api/rest/available-phone-numbers#local-get-basic-example-2) and [Example 3](https://www.twilio.com/docs/api/rest/available-phone-numbers#local-get-basic-example-3). If specified, this value must have at least two characters.
129
+ # @param [Boolean] sms_enabled Whether the phone numbers can receive text
130
+ # messages. Can be: `true` or `false`.
131
+ # @param [Boolean] mms_enabled Whether the phone numbers can receive MMS messages.
132
+ # Can be: `true` or `false`.
133
+ # @param [Boolean] voice_enabled Whether the phone numbers can receive calls. Can
134
+ # be: `true` or `false`.
135
+ # @param [Boolean] exclude_all_address_required Whether to exclude phone numbers
136
+ # that require an [Address](https://www.twilio.com/docs/usage/api/addresses). Can
137
+ # be: `true` or `false` and the default is `false`.
138
+ # @param [Boolean] exclude_local_address_required Whether to exclude phone numbers
139
+ # that require a local [Address](https://www.twilio.com/docs/usage/api/addresses).
140
+ # Can be: `true` or `false` and the default is `false`.
141
+ # @param [Boolean] exclude_foreign_address_required Whether to exclude phone
142
+ # numbers that require a foreign
143
+ # [Address](https://www.twilio.com/docs/usage/api/addresses). Can be: `true` or
144
+ # `false` and the default is `false`.
145
+ # @param [Boolean] beta Whether to read phone numbers that are new to the Twilio
146
+ # platform. Can be: `true` or `false` and the default is `true`.
157
147
  # @param [String] near_number Given a phone number, find a geographically close
158
- # number within `Distance` miles. Distance defaults to 25 miles. *Limited to US
159
- # and Canadian phone numbers.*
148
+ # number within `distance` miles. Distance defaults to 25 miles. Applies to only
149
+ # phone numbers in the US and Canada.
160
150
  # @param [String] near_lat_long Given a latitude/longitude pair `lat,long` find
161
- # geographically close numbers within `Distance` miles. *Limited to US and
162
- # Canadian phone numbers.*
163
- # @param [String] distance Specifies the search radius for a `Near-` query in
164
- # miles. If not specified this defaults to 25 miles. Maximum searchable distance
165
- # is 500 miles. *Limited to US and Canadian phone numbers.*
151
+ # geographically close numbers within `distance` miles. Applies to only phone
152
+ # numbers in the US and Canada.
153
+ # @param [String] distance The search radius, in miles, for a `near_` query. Can
154
+ # be up to `500` and the default is `25`. Applies to only phone numbers in the US
155
+ # and Canada.
166
156
  # @param [String] in_postal_code Limit results to a particular postal code. Given
167
- # a phone number, search within the same postal code as that number. *Limited to
168
- # US and Canadian phone numbers.*
169
- # @param [String] in_region Limit results to a particular region (i.e.
170
- # State/Province). Given a phone number, search within the same Region as that
171
- # number. *Limited to US and Canadian phone numbers.*
157
+ # a phone number, search within the same postal code as that number. Applies to
158
+ # only phone numbers in the US and Canada.
159
+ # @param [String] in_region Limit results to a particular region, state, or
160
+ # province. Given a phone number, search within the same region as that number.
161
+ # Applies to only phone numbers in the US and Canada.
172
162
  # @param [String] in_rate_center Limit results to a specific rate center, or given
173
163
  # a phone number search within the same rate center as that number. Requires
174
- # InLata to be set as well. *Limited to US and Canadian phone numbers.*
175
- # @param [String] in_lata Limit results to a specific Local access and transport
164
+ # `in_lata` to be set as well. Applies to only phone numbers in the US and Canada.
165
+ # @param [String] in_lata Limit results to a specific local access and transport
176
166
  # area ([LATA](http://en.wikipedia.org/wiki/Local_access_and_transport_area)).
177
167
  # Given a phone number, search within the same
178
168
  # [LATA](http://en.wikipedia.org/wiki/Local_access_and_transport_area) as that
179
- # number. *Limited to US and Canadian phone numbers.*
180
- # @param [String] in_locality Limit results to a particular locality (i.e. City).
181
- # Given a phone number, search within the same Locality as that number. *Limited
182
- # to US and Canadian phone numbers.*
183
- # @param [Boolean] fax_enabled This indicates whether the phone numbers can
184
- # receive faxes. Possible values are `true` or `false`.
169
+ # number. Applies to only phone numbers in the US and Canada.
170
+ # @param [String] in_locality Limit results to a particular locality or city.
171
+ # Given a phone number, search within the same Locality as that number.
172
+ # @param [Boolean] fax_enabled Whether the phone numbers can receive faxes. Can
173
+ # be: `true` or `false`.
185
174
  # @param [Integer] limit Upper limit for the number of records to return. stream()
186
175
  # guarantees to never return more than limit. Default is no limit.
187
176
  # @param [Integer] page_size Number of records to fetch per request, when
@@ -234,63 +223,57 @@ module Twilio
234
223
  ##
235
224
  # Retrieve a single page of LocalInstance records from the API.
236
225
  # Request is executed immediately.
237
- # @param [String] area_code Find phone numbers in the specified area code. (US and
238
- # Canada only)
239
- # @param [String] contains A pattern on which to match phone numbers. Valid
240
- # characters are `'*'` and `[0-9a-zA-Z]`. The `'*'` character will match any
241
- # single digit. See [Example
242
- # 2](https://www.twilio.com/docs/api/rest/available-phone-numbers#local-get-basic-example-2) and [Example 3](https://www.twilio.com/docs/api/rest/available-phone-numbers#local-get-basic-example-3) below. *NOTE:* Patterns must be at least two characters long.
243
- # @param [Boolean] sms_enabled This indicates whether the phone numbers can
244
- # receive text messages. Possible values are `true` or `false`.
245
- # @param [Boolean] mms_enabled This indicates whether the phone numbers can
246
- # receive MMS messages. Possible values are `true` or `false`.
247
- # @param [Boolean] voice_enabled This indicates whether the phone numbers can
248
- # receive calls. Possible values are `true` or `false`.
249
- # @param [Boolean] exclude_all_address_required Indicates whether the response
250
- # includes phone numbers which require any
251
- # [Address](https://www.twilio.com/docs/usage/api/addresses). Possible values are
252
- # `true` or `false`. If not specified, the default is `false`, and results could
253
- # include phone numbers with an Address required.
254
- # @param [Boolean] exclude_local_address_required Indicates whether the response
255
- # includes phone numbers which require a local
256
- # [Address](https://www.twilio.com/docs/usage/api/addresses). Possible values are
257
- # `true` or `false`. If not specified, the default is `false`, and results could
258
- # include phone numbers with a local Address required.
259
- # @param [Boolean] exclude_foreign_address_required Indicates whether the response
260
- # includes phone numbers which require a foreign
261
- # [Address](https://www.twilio.com/docs/usage/api/addresses). Possible values are
262
- # `true` or `false`. If not specified, the default is `false`, and results could
263
- # include phone numbers with a foreign Address required.
264
- # @param [Boolean] beta Include phone numbers new to the Twilio platform. Possible
265
- # values are either `true` or `false`. Default is `true`.
226
+ # @param [String] area_code The area code of the phone numbers to read. Applies to
227
+ # only phone numbers in the US and Canada.
228
+ # @param [String] contains The pattern on which to match phone numbers. Valid
229
+ # characters are `*`, `0-9`, `a-z`, and `A-Z`. The `*` character matches any
230
+ # single digit. For examples, see [Example
231
+ # 2](https://www.twilio.com/docs/api/rest/available-phone-numbers#local-get-basic-example-2) and [Example 3](https://www.twilio.com/docs/api/rest/available-phone-numbers#local-get-basic-example-3). If specified, this value must have at least two characters.
232
+ # @param [Boolean] sms_enabled Whether the phone numbers can receive text
233
+ # messages. Can be: `true` or `false`.
234
+ # @param [Boolean] mms_enabled Whether the phone numbers can receive MMS messages.
235
+ # Can be: `true` or `false`.
236
+ # @param [Boolean] voice_enabled Whether the phone numbers can receive calls. Can
237
+ # be: `true` or `false`.
238
+ # @param [Boolean] exclude_all_address_required Whether to exclude phone numbers
239
+ # that require an [Address](https://www.twilio.com/docs/usage/api/addresses). Can
240
+ # be: `true` or `false` and the default is `false`.
241
+ # @param [Boolean] exclude_local_address_required Whether to exclude phone numbers
242
+ # that require a local [Address](https://www.twilio.com/docs/usage/api/addresses).
243
+ # Can be: `true` or `false` and the default is `false`.
244
+ # @param [Boolean] exclude_foreign_address_required Whether to exclude phone
245
+ # numbers that require a foreign
246
+ # [Address](https://www.twilio.com/docs/usage/api/addresses). Can be: `true` or
247
+ # `false` and the default is `false`.
248
+ # @param [Boolean] beta Whether to read phone numbers that are new to the Twilio
249
+ # platform. Can be: `true` or `false` and the default is `true`.
266
250
  # @param [String] near_number Given a phone number, find a geographically close
267
- # number within `Distance` miles. Distance defaults to 25 miles. *Limited to US
268
- # and Canadian phone numbers.*
251
+ # number within `distance` miles. Distance defaults to 25 miles. Applies to only
252
+ # phone numbers in the US and Canada.
269
253
  # @param [String] near_lat_long Given a latitude/longitude pair `lat,long` find
270
- # geographically close numbers within `Distance` miles. *Limited to US and
271
- # Canadian phone numbers.*
272
- # @param [String] distance Specifies the search radius for a `Near-` query in
273
- # miles. If not specified this defaults to 25 miles. Maximum searchable distance
274
- # is 500 miles. *Limited to US and Canadian phone numbers.*
254
+ # geographically close numbers within `distance` miles. Applies to only phone
255
+ # numbers in the US and Canada.
256
+ # @param [String] distance The search radius, in miles, for a `near_` query. Can
257
+ # be up to `500` and the default is `25`. Applies to only phone numbers in the US
258
+ # and Canada.
275
259
  # @param [String] in_postal_code Limit results to a particular postal code. Given
276
- # a phone number, search within the same postal code as that number. *Limited to
277
- # US and Canadian phone numbers.*
278
- # @param [String] in_region Limit results to a particular region (i.e.
279
- # State/Province). Given a phone number, search within the same Region as that
280
- # number. *Limited to US and Canadian phone numbers.*
260
+ # a phone number, search within the same postal code as that number. Applies to
261
+ # only phone numbers in the US and Canada.
262
+ # @param [String] in_region Limit results to a particular region, state, or
263
+ # province. Given a phone number, search within the same region as that number.
264
+ # Applies to only phone numbers in the US and Canada.
281
265
  # @param [String] in_rate_center Limit results to a specific rate center, or given
282
266
  # a phone number search within the same rate center as that number. Requires
283
- # InLata to be set as well. *Limited to US and Canadian phone numbers.*
284
- # @param [String] in_lata Limit results to a specific Local access and transport
267
+ # `in_lata` to be set as well. Applies to only phone numbers in the US and Canada.
268
+ # @param [String] in_lata Limit results to a specific local access and transport
285
269
  # area ([LATA](http://en.wikipedia.org/wiki/Local_access_and_transport_area)).
286
270
  # Given a phone number, search within the same
287
271
  # [LATA](http://en.wikipedia.org/wiki/Local_access_and_transport_area) as that
288
- # number. *Limited to US and Canadian phone numbers.*
289
- # @param [String] in_locality Limit results to a particular locality (i.e. City).
290
- # Given a phone number, search within the same Locality as that number. *Limited
291
- # to US and Canadian phone numbers.*
292
- # @param [Boolean] fax_enabled This indicates whether the phone numbers can
293
- # receive faxes. Possible values are `true` or `false`.
272
+ # number. Applies to only phone numbers in the US and Canada.
273
+ # @param [String] in_locality Limit results to a particular locality or city.
274
+ # Given a phone number, search within the same Locality as that number.
275
+ # @param [Boolean] fax_enabled Whether the phone numbers can receive faxes. Can
276
+ # be: `true` or `false`.
294
277
  # @param [String] page_token PageToken provided by the API
295
278
  # @param [Integer] page_number Page Number, this value is simply for client state
296
279
  # @param [Integer] page_size Number of records to return, defaults to 50
@@ -386,9 +369,10 @@ module Twilio
386
369
  # Initialize the LocalInstance
387
370
  # @param [Version] version Version that contains the resource
388
371
  # @param [Hash] payload payload that contains response from Twilio
389
- # @param [String] account_sid The 34 character string that uniquely identifies
390
- # your account.
391
- # @param [String] country_code The ISO Country code to lookup phone numbers for.
372
+ # @param [String] account_sid The account_sid
373
+ # @param [String] country_code The
374
+ # [ISO-3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of
375
+ # the country.
392
376
  # @return [LocalInstance] LocalInstance
393
377
  def initialize(version, payload, account_sid: nil, country_code: nil)
394
378
  super(version)
@@ -412,79 +396,79 @@ module Twilio
412
396
  end
413
397
 
414
398
  ##
415
- # @return [String] A nicely-formatted version of the phone number.
399
+ # @return [String] A formatted version of the phone number
416
400
  def friendly_name
417
401
  @properties['friendly_name']
418
402
  end
419
403
 
420
404
  ##
421
- # @return [String] The phone number, in E.
405
+ # @return [String] The phone number in E.164 format
422
406
  def phone_number
423
407
  @properties['phone_number']
424
408
  end
425
409
 
426
410
  ##
427
- # @return [String] The LATA of this phone number.
411
+ # @return [String] The LATA of this phone number
428
412
  def lata
429
413
  @properties['lata']
430
414
  end
431
415
 
432
416
  ##
433
- # @return [String] The locality/city of this phone number.
417
+ # @return [String] The locality or city of this phone number's location
434
418
  def locality
435
419
  @properties['locality']
436
420
  end
437
421
 
438
422
  ##
439
- # @return [String] The rate center of this phone number.
423
+ # @return [String] The rate center of this phone number
440
424
  def rate_center
441
425
  @properties['rate_center']
442
426
  end
443
427
 
444
428
  ##
445
- # @return [String] The latitude coordinate of this phone number.
429
+ # @return [String] The latitude of this phone number's location
446
430
  def latitude
447
431
  @properties['latitude']
448
432
  end
449
433
 
450
434
  ##
451
- # @return [String] The longitude coordinate of this phone number.
435
+ # @return [String] The longitude of this phone number's location
452
436
  def longitude
453
437
  @properties['longitude']
454
438
  end
455
439
 
456
440
  ##
457
- # @return [String] The two-letter state or province abbreviation of this phone number.
441
+ # @return [String] The two-letter state or province abbreviation of this phone number's location
458
442
  def region
459
443
  @properties['region']
460
444
  end
461
445
 
462
446
  ##
463
- # @return [String] The postal code of this phone number.
447
+ # @return [String] The postal or ZIP code of this phone number's location
464
448
  def postal_code
465
449
  @properties['postal_code']
466
450
  end
467
451
 
468
452
  ##
469
- # @return [String] The ISO country code of this phone number.
453
+ # @return [String] The ISO country code of this phone number
470
454
  def iso_country
471
455
  @properties['iso_country']
472
456
  end
473
457
 
474
458
  ##
475
- # @return [String] This indicates whether the phone number requires you or your customer to have an Address registered with Twilio.
459
+ # @return [String] The type of Address resource the phone number requires
476
460
  def address_requirements
477
461
  @properties['address_requirements']
478
462
  end
479
463
 
480
464
  ##
481
- # @return [Boolean] Phone numbers new to the Twilio platform are marked as beta.
465
+ # @return [Boolean] Whether the phone number is new to the Twilio platform
482
466
  def beta
483
467
  @properties['beta']
484
468
  end
485
469
 
486
470
  ##
487
- # @return [String] This is a set of boolean properties that indicate whether a phone number can receive calls or messages.
471
+ # @return [String] Whether a phone number can receive calls or messages
488
472
  def capabilities
489
473
  @properties['capabilities']
490
474
  end