twilio-ruby 5.8.0 → 5.8.1

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 (40) hide show
  1. checksums.yaml +4 -4
  2. data/.travis.yml +0 -4
  3. data/CHANGES.md +9 -0
  4. data/README.md +2 -2
  5. data/lib/twilio-ruby/framework/error.rb +11 -9
  6. data/lib/twilio-ruby/framework/page.rb +1 -1
  7. data/lib/twilio-ruby/rest/api.rb +2 -1
  8. data/lib/twilio-ruby/rest/api/v2010/account.rb +12 -9
  9. data/lib/twilio-ruby/rest/api/v2010/account/key.rb +8 -6
  10. data/lib/twilio-ruby/rest/api/v2010/account/new_key.rb +7 -6
  11. data/lib/twilio-ruby/rest/api/v2010/account/sip/credential_list/credential.rb +12 -10
  12. data/lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb +13 -11
  13. data/lib/twilio-ruby/rest/api/v2010/account/sip/domain/credential_list_mapping.rb +2 -2
  14. data/lib/twilio-ruby/rest/api/v2010/account/sip/domain/ip_access_control_list_mapping.rb +2 -2
  15. data/lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list.rb +3 -2
  16. data/lib/twilio-ruby/rest/api/v2010/account/usage/record.rb +27 -24
  17. data/lib/twilio-ruby/rest/api/v2010/account/usage/record/all_time.rb +43 -22
  18. data/lib/twilio-ruby/rest/api/v2010/account/usage/record/daily.rb +43 -22
  19. data/lib/twilio-ruby/rest/api/v2010/account/usage/record/last_month.rb +43 -22
  20. data/lib/twilio-ruby/rest/api/v2010/account/usage/record/monthly.rb +43 -22
  21. data/lib/twilio-ruby/rest/api/v2010/account/usage/record/this_month.rb +43 -22
  22. data/lib/twilio-ruby/rest/api/v2010/account/usage/record/today.rb +43 -22
  23. data/lib/twilio-ruby/rest/api/v2010/account/usage/record/yearly.rb +43 -22
  24. data/lib/twilio-ruby/rest/api/v2010/account/usage/record/yesterday.rb +43 -22
  25. data/lib/twilio-ruby/rest/api/v2010/account/usage/trigger.rb +39 -21
  26. data/lib/twilio-ruby/rest/client.rb +2 -1
  27. data/lib/twilio-ruby/rest/lookups.rb +3 -1
  28. data/lib/twilio-ruby/rest/lookups/v1/phone_number.rb +37 -11
  29. data/lib/twilio-ruby/rest/trunking.rb +2 -1
  30. data/lib/twilio-ruby/rest/trunking/v1/trunk.rb +78 -30
  31. data/lib/twilio-ruby/rest/trunking/v1/trunk/origination_url.rb +51 -28
  32. data/lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb +3 -1
  33. data/lib/twilio-ruby/rest/video/v1/room/recording.rb +15 -8
  34. data/lib/twilio-ruby/version.rb +1 -1
  35. data/spec/integration/pricing/v1/messaging/country_spec.rb +12 -12
  36. data/spec/integration/pricing/v1/phone_number/country_spec.rb +17 -17
  37. data/spec/integration/pricing/v1/voice/country_spec.rb +21 -149
  38. data/spec/integration/pricing/v1/voice/number_spec.rb +4 -4
  39. data/spec/integration/video/v1/room/recording_spec.rb +10 -0
  40. metadata +2 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: f31420e85a848a70feecfe16755e650d9239765b
4
- data.tar.gz: a8f8a197dd19c793eadc79f81457b1be96570756
3
+ metadata.gz: 96dfe1755e485568a5ae67471ebb9ca1cd4f7978
4
+ data.tar.gz: ad246f39e5739b9209436a19066a10d27ccd9ea7
5
5
  SHA512:
6
- metadata.gz: 1e2fa856f8d8c4596efa8c274d8606d1666d61971647ffdc29e8dc7d307fb038ad723b644f3ed6ec3b5f1a49fe3f681db873ded28b70cb4d9cd6ba1c0bd22bf3
7
- data.tar.gz: 24a1cb1af4daad69c49406c47a0cb98c645f7201809bc5d3da8046cec350f91f7c04f35d9aee156ab19f3041daf9cca35fa9197657654c6b3adb73004b59c6e1
6
+ metadata.gz: 64bb9b61131575a991142432d073ab5ac2b36f10239dfbdec32f8a79e2268cc7afa44ab5ce1346a13906ab2f8ded4c852dd1ffe3d620d558de28155f3a5634df
7
+ data.tar.gz: fd28ffaec1cca7d04b07c3e6b426200457cf976e7baf1ebaaa2b88449b2e6366c58d671adb370a18e88127cba105e37cc8aca930a2dfbec7abdfe298cfe03049
data/.travis.yml CHANGED
@@ -19,7 +19,3 @@ before_install:
19
19
  # Bundler on Travis may be too out of date
20
20
  # Update bundler to a recent version.
21
21
  - gem install bundler
22
-
23
- after_success:
24
- # Make sure it passes linter
25
- - make lint
data/CHANGES.md CHANGED
@@ -1,6 +1,15 @@
1
1
  twilio-ruby changelog
2
2
  =====================
3
3
 
4
+ [2018-04-20] Version 5.8.1
5
+ ---------------------------
6
+ **Library**
7
+ - PR #397: Uses Twilio::REST::RestError when a page fails to load. Thanks to @philnash!
8
+
9
+ **Twiml**
10
+ - Gather input Enum: remove unnecessary "dtmf speech" value as you can now specify multiple enum values for this parameter and both "dtmf" and "speech" are already available.
11
+
12
+
4
13
  [2018-04-13] Version 5.8.0
5
14
  ---------------------------
6
15
  **Library**
data/README.md CHANGED
@@ -27,13 +27,13 @@ in-line code documentation here in the library.
27
27
  To install using [Bundler][bundler] grab the latest stable version:
28
28
 
29
29
  ```ruby
30
- gem 'twilio-ruby', '~> 5.8.0'
30
+ gem 'twilio-ruby', '~> 5.8.1'
31
31
  ```
32
32
 
33
33
  To manually install `twilio-ruby` via [Rubygems][rubygems] simply gem install:
34
34
 
35
35
  ```bash
36
- gem install twilio-ruby -v 5.8.0
36
+ gem install twilio-ruby -v 5.8.1
37
37
  ```
38
38
 
39
39
  To build and install the development branch yourself from the latest source:
@@ -1,15 +1,10 @@
1
1
  module Twilio
2
2
  module REST
3
3
  class TwilioError < StandardError
4
- attr_reader :message, :body
5
-
6
- def initialize(message, body = nil)
7
- @message = message
8
- @body = body
9
- end
10
-
11
- def to_s
12
- "#{@message}: #{@body || 'no body'}"
4
+ # @deprecated all errors that have a body are now 'Twilio::RestError's
5
+ def body
6
+ warn "'Twilio::REST::TwilioError#body' has been deprecated. No 'TwilioError' objects are raised with a body."
7
+ nil
13
8
  end
14
9
  end
15
10
 
@@ -26,6 +21,13 @@ module Twilio
26
21
  @response = response
27
22
  end
28
23
 
24
+ # @deprecated use #response instead
25
+ def body
26
+ warn 'This error used to be a "Twilio::REST::TwilioError" but is now a "Twilio::REST::RestError". ' \
27
+ 'Please use #response instead of #body.'
28
+ @response
29
+ end
30
+
29
31
  def to_s
30
32
  message
31
33
  end
@@ -29,7 +29,7 @@ module Twilio
29
29
 
30
30
  def process_response(response)
31
31
  if response.status_code != 200
32
- raise Twilio::REST::TwilioError.new('Unable to fetch page', response)
32
+ raise Twilio::REST::RestError.new('Unable to fetch page', response)
33
33
  end
34
34
 
35
35
  response.body
@@ -111,7 +111,8 @@ module Twilio
111
111
  end
112
112
 
113
113
  ##
114
- # @param [String] sid The sid
114
+ # @param [String] sid A 34 character string that uniquely identifies this API Key.
115
+ # You will use this as the basic-auth `user` when authenticating to the API.
115
116
  # @return [Twilio::REST::Api::V2010::AccountContext::KeyInstance] if sid was passed.
116
117
  # @return [Twilio::REST::Api::V2010::AccountContext::KeyList]
117
118
  def keys(sid=:unset)
@@ -43,9 +43,10 @@ module Twilio
43
43
  # Lists AccountInstance records from the API as a list.
44
44
  # Unlike stream(), this operation is eager and will load `limit` records into
45
45
  # memory before returning.
46
- # @param [String] friendly_name Filter accounts where the friendly name exactly
47
- # matches the desired FriendlyName
48
- # @param [account.Status] status Only show accounts with the given Status
46
+ # @param [String] friendly_name Only return the Account resources with friendly
47
+ # names that exactly match this name.
48
+ # @param [account.Status] status Only return Account resources with the given
49
+ # status. Can be `closed`, `suspended` or `active`.
49
50
  # @param [Integer] limit Upper limit for the number of records to return. stream()
50
51
  # guarantees to never return more than limit. Default is no limit
51
52
  # @param [Integer] page_size Number of records to fetch per request, when
@@ -66,9 +67,10 @@ module Twilio
66
67
  # Streams AccountInstance records from the API as an Enumerable.
67
68
  # This operation lazily loads records as efficiently as possible until the limit
68
69
  # is reached.
69
- # @param [String] friendly_name Filter accounts where the friendly name exactly
70
- # matches the desired FriendlyName
71
- # @param [account.Status] status Only show accounts with the given Status
70
+ # @param [String] friendly_name Only return the Account resources with friendly
71
+ # names that exactly match this name.
72
+ # @param [account.Status] status Only return Account resources with the given
73
+ # status. Can be `closed`, `suspended` or `active`.
72
74
  # @param [Integer] limit Upper limit for the number of records to return. stream()
73
75
  # guarantees to never return more than limit. Default is no limit.
74
76
  # @param [Integer] page_size Number of records to fetch per request, when
@@ -101,9 +103,10 @@ module Twilio
101
103
  ##
102
104
  # Retrieve a single page of AccountInstance records from the API.
103
105
  # Request is executed immediately.
104
- # @param [String] friendly_name Filter accounts where the friendly name exactly
105
- # matches the desired FriendlyName
106
- # @param [account.Status] status Only show accounts with the given Status
106
+ # @param [String] friendly_name Only return the Account resources with friendly
107
+ # names that exactly match this name.
108
+ # @param [account.Status] status Only return Account resources with the given
109
+ # status. Can be `closed`, `suspended` or `active`.
107
110
  # @param [String] page_token PageToken provided by the API
108
111
  # @param [Integer] page_number Page Number, this value is simply for client state
109
112
  # @param [Integer] page_size Number of records to return, defaults to 50
@@ -174,7 +174,8 @@ module Twilio
174
174
 
175
175
  ##
176
176
  # Update the KeyInstance
177
- # @param [String] friendly_name The friendly_name
177
+ # @param [String] friendly_name A descriptive string for this resource, chosen by
178
+ # your application, up to 64 characters long.
178
179
  # @return [KeyInstance] Updated KeyInstance
179
180
  def update(friendly_name: :unset)
180
181
  data = Twilio::Values.of({'FriendlyName' => friendly_name, })
@@ -240,25 +241,25 @@ module Twilio
240
241
  end
241
242
 
242
243
  ##
243
- # @return [String] The sid
244
+ # @return [String] A 34 character string that uniquely identifies this API Key.
244
245
  def sid
245
246
  @properties['sid']
246
247
  end
247
248
 
248
249
  ##
249
- # @return [String] The friendly_name
250
+ # @return [String] A descriptive string for this resource, chosen by your application, up to 64 characters long.
250
251
  def friendly_name
251
252
  @properties['friendly_name']
252
253
  end
253
254
 
254
255
  ##
255
- # @return [Time] The date_created
256
+ # @return [Time] The date-time this API Key was created, given as a RFC 2822 Timestamp.
256
257
  def date_created
257
258
  @properties['date_created']
258
259
  end
259
260
 
260
261
  ##
261
- # @return [Time] The date_updated
262
+ # @return [Time] The date-time this API Key was most recently updated, given as a RFC 2822 Timestamp.
262
263
  def date_updated
263
264
  @properties['date_updated']
264
265
  end
@@ -272,7 +273,8 @@ module Twilio
272
273
 
273
274
  ##
274
275
  # Update the KeyInstance
275
- # @param [String] friendly_name The friendly_name
276
+ # @param [String] friendly_name A descriptive string for this resource, chosen by
277
+ # your application, up to 64 characters long.
276
278
  # @return [KeyInstance] Updated KeyInstance
277
279
  def update(friendly_name: :unset)
278
280
  context.update(friendly_name: friendly_name, )
@@ -27,7 +27,8 @@ module Twilio
27
27
  ##
28
28
  # Retrieve a single page of NewKeyInstance records from the API.
29
29
  # Request is executed immediately.
30
- # @param [String] friendly_name The friendly_name
30
+ # @param [String] friendly_name A descriptive string for this resource, chosen by
31
+ # your application, up to 64 characters long.
31
32
  # @return [NewKeyInstance] Newly created NewKeyInstance
32
33
  def create(friendly_name: :unset)
33
34
  data = Twilio::Values.of({'FriendlyName' => friendly_name, })
@@ -99,31 +100,31 @@ module Twilio
99
100
  end
100
101
 
101
102
  ##
102
- # @return [String] The sid
103
+ # @return [String] A 34 character string that uniquely identifies this API Key.
103
104
  def sid
104
105
  @properties['sid']
105
106
  end
106
107
 
107
108
  ##
108
- # @return [String] The friendly_name
109
+ # @return [String] A descriptive string for this resource, chosen by your application, up to 64 characters long.
109
110
  def friendly_name
110
111
  @properties['friendly_name']
111
112
  end
112
113
 
113
114
  ##
114
- # @return [Time] The date_created
115
+ # @return [Time] The date-time this API Key was created, given as a RFC 2822 Timestamp.
115
116
  def date_created
116
117
  @properties['date_created']
117
118
  end
118
119
 
119
120
  ##
120
- # @return [Time] The date_updated
121
+ # @return [Time] The date-time this API Key was most recently updated, given as a RFC 2822 Timestamp.
121
122
  def date_updated
122
123
  @properties['date_updated']
123
124
  end
124
125
 
125
126
  ##
126
- # @return [String] The secret
127
+ # @return [String] The secret your application uses to sign Access Tokens and to authenticate to the REST API.
127
128
  def secret
128
129
  @properties['secret']
129
130
  end
@@ -15,7 +15,8 @@ module Twilio
15
15
  ##
16
16
  # Initialize the CredentialList
17
17
  # @param [Version] version Version that contains the resource
18
- # @param [String] account_sid The account_sid
18
+ # @param [String] account_sid The unique id of the Account that responsible for
19
+ # this resource.
19
20
  # @param [String] credential_list_sid The credential_list_sid
20
21
  # @return [CredentialList] CredentialList
21
22
  def initialize(version, account_sid: nil, credential_list_sid: nil)
@@ -111,8 +112,8 @@ module Twilio
111
112
  ##
112
113
  # Retrieve a single page of CredentialInstance records from the API.
113
114
  # Request is executed immediately.
114
- # @param [String] username The username
115
- # @param [String] password The password
115
+ # @param [String] username The username for this credential.
116
+ # @param [String] password The password will not be returned in the response.
116
117
  # @return [CredentialInstance] Newly created CredentialInstance
117
118
  def create(username: nil, password: nil)
118
119
  data = Twilio::Values.of({'Username' => username, 'Password' => password, })
@@ -251,7 +252,8 @@ module Twilio
251
252
  # Initialize the CredentialInstance
252
253
  # @param [Version] version Version that contains the resource
253
254
  # @param [Hash] payload payload that contains response from Twilio
254
- # @param [String] account_sid The account_sid
255
+ # @param [String] account_sid The unique id of the Account that responsible for
256
+ # this resource.
255
257
  # @param [String] credential_list_sid The credential_list_sid
256
258
  # @param [String] sid The sid
257
259
  # @return [CredentialInstance] CredentialInstance
@@ -295,13 +297,13 @@ module Twilio
295
297
  end
296
298
 
297
299
  ##
298
- # @return [String] The sid
300
+ # @return [String] A 34 character string that uniquely identifies this resource.
299
301
  def sid
300
302
  @properties['sid']
301
303
  end
302
304
 
303
305
  ##
304
- # @return [String] The account_sid
306
+ # @return [String] The unique id of the Account that responsible for this resource.
305
307
  def account_sid
306
308
  @properties['account_sid']
307
309
  end
@@ -313,25 +315,25 @@ module Twilio
313
315
  end
314
316
 
315
317
  ##
316
- # @return [String] The username
318
+ # @return [String] The username for this credential.
317
319
  def username
318
320
  @properties['username']
319
321
  end
320
322
 
321
323
  ##
322
- # @return [Time] The date_created
324
+ # @return [Time] The date that this resource was created, given as GMT in RFC 2822 format.
323
325
  def date_created
324
326
  @properties['date_created']
325
327
  end
326
328
 
327
329
  ##
328
- # @return [Time] The date_updated
330
+ # @return [Time] The date that this resource was last updated, given as GMT in RFC 2822 format.
329
331
  def date_updated
330
332
  @properties['date_updated']
331
333
  end
332
334
 
333
335
  ##
334
- # @return [String] The uri
336
+ # @return [String] The URI for this resource, relative to https://api.
335
337
  def uri
336
338
  @properties['uri']
337
339
  end
@@ -111,21 +111,23 @@ module Twilio
111
111
  # Retrieve a single page of DomainInstance records from the API.
112
112
  # Request is executed immediately.
113
113
  # @param [String] domain_name The unique address you reserve on Twilio to which
114
- # you route your SIP traffic
115
- # @param [String] friendly_name A user-specified, human-readable name for the
116
- # trigger.
114
+ # you route your SIP traffic. Domain names can contain letters, digits, and "-".
115
+ # @param [String] friendly_name A human readable descriptive text, up to 64
116
+ # characters long.
117
117
  # @param [String] auth_type The types of authentication you have mapped to your
118
118
  # domain
119
119
  # @param [String] voice_url The URL Twilio will request when this domain receives
120
- # a call
121
- # @param [String] voice_method The HTTP method to use with the voice_url
122
- # @param [String] voice_fallback_url The URL that Twilio will use if an error
123
- # occurs retrieving or executing the TwiML requested by VoiceUrl
120
+ # a call.
121
+ # @param [String] voice_method The HTTP method Twilio will use when requesting the
122
+ # above Url. Either `GET` or `POST`.
123
+ # @param [String] voice_fallback_url The URL that Twilio will request if an error
124
+ # occurs retrieving or executing the TwiML requested by VoiceUrl.
124
125
  # @param [String] voice_fallback_method The HTTP method Twilio will use when
125
- # requesting the VoiceFallbackUrl
126
+ # requesting the VoiceFallbackUrl. Either `GET` or `POST`.
126
127
  # @param [String] voice_status_callback_url The URL that Twilio will request to
127
- # pass status parameters
128
- # @param [String] voice_status_callback_method The voice_status_callback_method
128
+ # pass status parameters (such as call ended) to your application.
129
+ # @param [String] voice_status_callback_method The HTTP method Twilio will use to
130
+ # make requests to the StatusCallback URL. Either `GET` or `POST`.
129
131
  # @param [Boolean] sip_registration The sip_registration
130
132
  # @return [DomainInstance] Newly created DomainInstance
131
133
  def create(domain_name: nil, friendly_name: :unset, auth_type: :unset, voice_url: :unset, voice_method: :unset, voice_fallback_url: :unset, voice_fallback_method: :unset, voice_status_callback_url: :unset, voice_status_callback_method: :unset, sip_registration: :unset)
@@ -442,7 +444,7 @@ module Twilio
442
444
  end
443
445
 
444
446
  ##
445
- # @return [String] The voice_status_callback_method
447
+ # @return [String] The HTTP method Twilio will use to make requests to the StatusCallback URL.
446
448
  def voice_status_callback_method
447
449
  @properties['voice_status_callback_method']
448
450
  end
@@ -17,7 +17,7 @@ module Twilio
17
17
  # @param [Version] version Version that contains the resource
18
18
  # @param [String] account_sid The account_sid
19
19
  # @param [String] domain_sid A 34 character string that uniquely identifies the
20
- # SIP domain in Twilio
20
+ # SIP domain in Twilio.
21
21
  # @return [CredentialListMappingList] CredentialListMappingList
22
22
  def initialize(version, account_sid: nil, domain_sid: nil)
23
23
  super(version)
@@ -231,7 +231,7 @@ module Twilio
231
231
  # @param [Hash] payload payload that contains response from Twilio
232
232
  # @param [String] account_sid The account_sid
233
233
  # @param [String] domain_sid A 34 character string that uniquely identifies the
234
- # SIP domain in Twilio
234
+ # SIP domain in Twilio.
235
235
  # @param [String] sid The sid
236
236
  # @return [CredentialListMappingInstance] CredentialListMappingInstance
237
237
  def initialize(version, payload, account_sid: nil, domain_sid: nil, sid: nil)
@@ -17,7 +17,7 @@ module Twilio
17
17
  # @param [Version] version Version that contains the resource
18
18
  # @param [String] account_sid The account_sid
19
19
  # @param [String] domain_sid A 34 character string that uniquely identifies the
20
- # SIP domain in Twilio
20
+ # SIP domain in Twilio.
21
21
  # @return [IpAccessControlListMappingList] IpAccessControlListMappingList
22
22
  def initialize(version, account_sid: nil, domain_sid: nil)
23
23
  super(version)
@@ -231,7 +231,7 @@ module Twilio
231
231
  # @param [Hash] payload payload that contains response from Twilio
232
232
  # @param [String] account_sid The account_sid
233
233
  # @param [String] domain_sid A 34 character string that uniquely identifies the
234
- # SIP domain in Twilio
234
+ # SIP domain in Twilio.
235
235
  # @param [String] sid The sid
236
236
  # @return [IpAccessControlListMappingInstance] IpAccessControlListMappingInstance
237
237
  def initialize(version, payload, account_sid: nil, domain_sid: nil, sid: nil)
@@ -110,8 +110,9 @@ module Twilio
110
110
  ##
111
111
  # Retrieve a single page of IpAccessControlListInstance records from the API.
112
112
  # Request is executed immediately.
113
- # @param [String] friendly_name A human readable descriptive text, up to 64
114
- # characters long.
113
+ # @param [String] friendly_name A human readable descriptive text that describes
114
+ # the IpAccessControlList, up to 64 characters long.
115
+ # https://www.twilio.com/docs/admin/pages/add/api_reference/apireferencepage/175/#
115
116
  # @return [IpAccessControlListInstance] Newly created IpAccessControlListInstance
116
117
  def create(friendly_name: nil)
117
118
  data = Twilio::Values.of({'FriendlyName' => friendly_name, })
@@ -39,15 +39,16 @@ module Twilio
39
39
  # Lists RecordInstance records from the API as a list.
40
40
  # Unlike stream(), this operation is eager and will load `limit` records into
41
41
  # memory before returning.
42
- # @param [record.Category] category Only include usage of a given category
42
+ # @param [record.Category] category Only include usage of this [usage
43
+ # category](https://www.twilio.com/docs/api/rest/usage-records#usage-categories).
43
44
  # @param [Date] start_date Only include usage that has occurred on or after this
44
- # date. Format is YYYY-MM-DD in GTM. As a convenience, you can also specify
45
- # offsets to today, for example, StartDate=-30days, which will make StartDate 30
46
- # days before today
47
- # @param [Date] end_date Only include usage that has occurred on or after this
48
- # date. Format is YYYY-MM-DD in GTM. As a convenience, you can also specify
49
- # offsets to today, for example, EndDate=+30days, which will make EndDate 30 days
50
- # from today
45
+ # date. Format is YYYY-MM-DD. All dates are in GMT. As a convenience, you can
46
+ # also specify offsets to today. For example, `StartDate=-30days` will make
47
+ # `StartDate` be 30 days before today.
48
+ # @param [Date] end_date Only include usage that has occurred on or before this
49
+ # date. Format is YYYY-MM-DD. All dates are in GMT. As a convenience, you can
50
+ # also specify offsets to today. For example, `EndDate=+30days` will make
51
+ # `EndDate` be 30 days from today.
51
52
  # @param [Integer] limit Upper limit for the number of records to return. stream()
52
53
  # guarantees to never return more than limit. Default is no limit
53
54
  # @param [Integer] page_size Number of records to fetch per request, when
@@ -69,15 +70,16 @@ module Twilio
69
70
  # Streams RecordInstance records from the API as an Enumerable.
70
71
  # This operation lazily loads records as efficiently as possible until the limit
71
72
  # is reached.
72
- # @param [record.Category] category Only include usage of a given category
73
+ # @param [record.Category] category Only include usage of this [usage
74
+ # category](https://www.twilio.com/docs/api/rest/usage-records#usage-categories).
73
75
  # @param [Date] start_date Only include usage that has occurred on or after this
74
- # date. Format is YYYY-MM-DD in GTM. As a convenience, you can also specify
75
- # offsets to today, for example, StartDate=-30days, which will make StartDate 30
76
- # days before today
77
- # @param [Date] end_date Only include usage that has occurred on or after this
78
- # date. Format is YYYY-MM-DD in GTM. As a convenience, you can also specify
79
- # offsets to today, for example, EndDate=+30days, which will make EndDate 30 days
80
- # from today
76
+ # date. Format is YYYY-MM-DD. All dates are in GMT. As a convenience, you can
77
+ # also specify offsets to today. For example, `StartDate=-30days` will make
78
+ # `StartDate` be 30 days before today.
79
+ # @param [Date] end_date Only include usage that has occurred on or before this
80
+ # date. Format is YYYY-MM-DD. All dates are in GMT. As a convenience, you can
81
+ # also specify offsets to today. For example, `EndDate=+30days` will make
82
+ # `EndDate` be 30 days from today.
81
83
  # @param [Integer] limit Upper limit for the number of records to return. stream()
82
84
  # guarantees to never return more than limit. Default is no limit.
83
85
  # @param [Integer] page_size Number of records to fetch per request, when
@@ -115,15 +117,16 @@ module Twilio
115
117
  ##
116
118
  # Retrieve a single page of RecordInstance records from the API.
117
119
  # Request is executed immediately.
118
- # @param [record.Category] category Only include usage of a given category
120
+ # @param [record.Category] category Only include usage of this [usage
121
+ # category](https://www.twilio.com/docs/api/rest/usage-records#usage-categories).
119
122
  # @param [Date] start_date Only include usage that has occurred on or after this
120
- # date. Format is YYYY-MM-DD in GTM. As a convenience, you can also specify
121
- # offsets to today, for example, StartDate=-30days, which will make StartDate 30
122
- # days before today
123
- # @param [Date] end_date Only include usage that has occurred on or after this
124
- # date. Format is YYYY-MM-DD in GTM. As a convenience, you can also specify
125
- # offsets to today, for example, EndDate=+30days, which will make EndDate 30 days
126
- # from today
123
+ # date. Format is YYYY-MM-DD. All dates are in GMT. As a convenience, you can
124
+ # also specify offsets to today. For example, `StartDate=-30days` will make
125
+ # `StartDate` be 30 days before today.
126
+ # @param [Date] end_date Only include usage that has occurred on or before this
127
+ # date. Format is YYYY-MM-DD. All dates are in GMT. As a convenience, you can
128
+ # also specify offsets to today. For example, `EndDate=+30days` will make
129
+ # `EndDate` be 30 days from today.
127
130
  # @param [String] page_token PageToken provided by the API
128
131
  # @param [Integer] page_number Page Number, this value is simply for client state
129
132
  # @param [Integer] page_size Number of records to return, defaults to 50