Skip to content

Commit e051304

Browse files
committed
[Librarian] Regenerated @ bdf3a23dbbe31ed526223499c081c55c48ccd0f5
1 parent 0fd4c35 commit e051304

33 files changed

+735
-533
lines changed

CHANGES.md

+9
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,15 @@
11
twilio-ruby changelog
22
=====================
33

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+
413
[2018-04-13] Version 5.8.0
514
---------------------------
615
**Library**

lib/twilio-ruby/rest/api.rb

+2-1
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,8 @@ def incoming_phone_numbers(sid=:unset)
111111
end
112112

113113
##
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.
115116
# @return [Twilio::REST::Api::V2010::AccountContext::KeyInstance] if sid was passed.
116117
# @return [Twilio::REST::Api::V2010::AccountContext::KeyList]
117118
def keys(sid=:unset)

lib/twilio-ruby/rest/api/v2010/account.rb

+12-9
Original file line numberDiff line numberDiff line change
@@ -43,9 +43,10 @@ def create(friendly_name: :unset)
4343
# Lists AccountInstance records from the API as a list.
4444
# Unlike stream(), this operation is eager and will load `limit` records into
4545
# 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`.
4950
# @param [Integer] limit Upper limit for the number of records to return. stream()
5051
# guarantees to never return more than limit. Default is no limit
5152
# @param [Integer] page_size Number of records to fetch per request, when
@@ -66,9 +67,10 @@ def list(friendly_name: :unset, status: :unset, limit: nil, page_size: nil)
6667
# Streams AccountInstance records from the API as an Enumerable.
6768
# This operation lazily loads records as efficiently as possible until the limit
6869
# 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`.
7274
# @param [Integer] limit Upper limit for the number of records to return. stream()
7375
# guarantees to never return more than limit. Default is no limit.
7476
# @param [Integer] page_size Number of records to fetch per request, when
@@ -101,9 +103,10 @@ def each
101103
##
102104
# Retrieve a single page of AccountInstance records from the API.
103105
# 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`.
107110
# @param [String] page_token PageToken provided by the API
108111
# @param [Integer] page_number Page Number, this value is simply for client state
109112
# @param [Integer] page_size Number of records to return, defaults to 50

lib/twilio-ruby/rest/api/v2010/account/key.rb

+8-6
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,8 @@ def fetch
174174

175175
##
176176
# 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.
178179
# @return [KeyInstance] Updated KeyInstance
179180
def update(friendly_name: :unset)
180181
data = Twilio::Values.of({'FriendlyName' => friendly_name, })
@@ -240,25 +241,25 @@ def context
240241
end
241242

242243
##
243-
# @return [String] The sid
244+
# @return [String] A 34 character string that uniquely identifies this API Key.
244245
def sid
245246
@properties['sid']
246247
end
247248

248249
##
249-
# @return [String] The friendly_name
250+
# @return [String] A descriptive string for this resource, chosen by your application, up to 64 characters long.
250251
def friendly_name
251252
@properties['friendly_name']
252253
end
253254

254255
##
255-
# @return [Time] The date_created
256+
# @return [Time] The date-time this API Key was created, given as a RFC 2822 Timestamp.
256257
def date_created
257258
@properties['date_created']
258259
end
259260

260261
##
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.
262263
def date_updated
263264
@properties['date_updated']
264265
end
@@ -272,7 +273,8 @@ def fetch
272273

273274
##
274275
# 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.
276278
# @return [KeyInstance] Updated KeyInstance
277279
def update(friendly_name: :unset)
278280
context.update(friendly_name: friendly_name, )

lib/twilio-ruby/rest/api/v2010/account/new_key.rb

+7-6
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,8 @@ def initialize(version, account_sid: nil)
2727
##
2828
# Retrieve a single page of NewKeyInstance records from the API.
2929
# 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.
3132
# @return [NewKeyInstance] Newly created NewKeyInstance
3233
def create(friendly_name: :unset)
3334
data = Twilio::Values.of({'FriendlyName' => friendly_name, })
@@ -99,31 +100,31 @@ def initialize(version, payload, account_sid: nil)
99100
end
100101

101102
##
102-
# @return [String] The sid
103+
# @return [String] A 34 character string that uniquely identifies this API Key.
103104
def sid
104105
@properties['sid']
105106
end
106107

107108
##
108-
# @return [String] The friendly_name
109+
# @return [String] A descriptive string for this resource, chosen by your application, up to 64 characters long.
109110
def friendly_name
110111
@properties['friendly_name']
111112
end
112113

113114
##
114-
# @return [Time] The date_created
115+
# @return [Time] The date-time this API Key was created, given as a RFC 2822 Timestamp.
115116
def date_created
116117
@properties['date_created']
117118
end
118119

119120
##
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.
121122
def date_updated
122123
@properties['date_updated']
123124
end
124125

125126
##
126-
# @return [String] The secret
127+
# @return [String] The secret your application uses to sign Access Tokens and to authenticate to the REST API.
127128
def secret
128129
@properties['secret']
129130
end

lib/twilio-ruby/rest/api/v2010/account/sip/credential_list/credential.rb

+12-10
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,8 @@ class CredentialList < ListResource
1515
##
1616
# Initialize the CredentialList
1717
# @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.
1920
# @param [String] credential_list_sid The credential_list_sid
2021
# @return [CredentialList] CredentialList
2122
def initialize(version, account_sid: nil, credential_list_sid: nil)
@@ -111,8 +112,8 @@ def get_page(target_url)
111112
##
112113
# Retrieve a single page of CredentialInstance records from the API.
113114
# 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.
116117
# @return [CredentialInstance] Newly created CredentialInstance
117118
def create(username: nil, password: nil)
118119
data = Twilio::Values.of({'Username' => username, 'Password' => password, })
@@ -251,7 +252,8 @@ class CredentialInstance < InstanceResource
251252
# Initialize the CredentialInstance
252253
# @param [Version] version Version that contains the resource
253254
# @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.
255257
# @param [String] credential_list_sid The credential_list_sid
256258
# @param [String] sid The sid
257259
# @return [CredentialInstance] CredentialInstance
@@ -295,13 +297,13 @@ def context
295297
end
296298

297299
##
298-
# @return [String] The sid
300+
# @return [String] A 34 character string that uniquely identifies this resource.
299301
def sid
300302
@properties['sid']
301303
end
302304

303305
##
304-
# @return [String] The account_sid
306+
# @return [String] The unique id of the Account that responsible for this resource.
305307
def account_sid
306308
@properties['account_sid']
307309
end
@@ -313,25 +315,25 @@ def credential_list_sid
313315
end
314316

315317
##
316-
# @return [String] The username
318+
# @return [String] The username for this credential.
317319
def username
318320
@properties['username']
319321
end
320322

321323
##
322-
# @return [Time] The date_created
324+
# @return [Time] The date that this resource was created, given as GMT in RFC 2822 format.
323325
def date_created
324326
@properties['date_created']
325327
end
326328

327329
##
328-
# @return [Time] The date_updated
330+
# @return [Time] The date that this resource was last updated, given as GMT in RFC 2822 format.
329331
def date_updated
330332
@properties['date_updated']
331333
end
332334

333335
##
334-
# @return [String] The uri
336+
# @return [String] The URI for this resource, relative to https://api.
335337
def uri
336338
@properties['uri']
337339
end

lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb

+13-11
Original file line numberDiff line numberDiff line change
@@ -111,21 +111,23 @@ def get_page(target_url)
111111
# Retrieve a single page of DomainInstance records from the API.
112112
# Request is executed immediately.
113113
# @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.
117117
# @param [String] auth_type The types of authentication you have mapped to your
118118
# domain
119119
# @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.
124125
# @param [String] voice_fallback_method The HTTP method Twilio will use when
125-
# requesting the VoiceFallbackUrl
126+
# requesting the VoiceFallbackUrl. Either `GET` or `POST`.
126127
# @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`.
129131
# @param [Boolean] sip_registration The sip_registration
130132
# @return [DomainInstance] Newly created DomainInstance
131133
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 @@ def voice_method
442444
end
443445

444446
##
445-
# @return [String] The voice_status_callback_method
447+
# @return [String] The HTTP method Twilio will use to make requests to the StatusCallback URL.
446448
def voice_status_callback_method
447449
@properties['voice_status_callback_method']
448450
end

lib/twilio-ruby/rest/api/v2010/account/sip/domain/credential_list_mapping.rb

+2-2
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ class CredentialListMappingList < ListResource
1717
# @param [Version] version Version that contains the resource
1818
# @param [String] account_sid The account_sid
1919
# @param [String] domain_sid A 34 character string that uniquely identifies the
20-
# SIP domain in Twilio
20+
# SIP domain in Twilio.
2121
# @return [CredentialListMappingList] CredentialListMappingList
2222
def initialize(version, account_sid: nil, domain_sid: nil)
2323
super(version)
@@ -231,7 +231,7 @@ class CredentialListMappingInstance < InstanceResource
231231
# @param [Hash] payload payload that contains response from Twilio
232232
# @param [String] account_sid The account_sid
233233
# @param [String] domain_sid A 34 character string that uniquely identifies the
234-
# SIP domain in Twilio
234+
# SIP domain in Twilio.
235235
# @param [String] sid The sid
236236
# @return [CredentialListMappingInstance] CredentialListMappingInstance
237237
def initialize(version, payload, account_sid: nil, domain_sid: nil, sid: nil)

lib/twilio-ruby/rest/api/v2010/account/sip/domain/ip_access_control_list_mapping.rb

+2-2
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ class IpAccessControlListMappingList < ListResource
1717
# @param [Version] version Version that contains the resource
1818
# @param [String] account_sid The account_sid
1919
# @param [String] domain_sid A 34 character string that uniquely identifies the
20-
# SIP domain in Twilio
20+
# SIP domain in Twilio.
2121
# @return [IpAccessControlListMappingList] IpAccessControlListMappingList
2222
def initialize(version, account_sid: nil, domain_sid: nil)
2323
super(version)
@@ -231,7 +231,7 @@ class IpAccessControlListMappingInstance < InstanceResource
231231
# @param [Hash] payload payload that contains response from Twilio
232232
# @param [String] account_sid The account_sid
233233
# @param [String] domain_sid A 34 character string that uniquely identifies the
234-
# SIP domain in Twilio
234+
# SIP domain in Twilio.
235235
# @param [String] sid The sid
236236
# @return [IpAccessControlListMappingInstance] IpAccessControlListMappingInstance
237237
def initialize(version, payload, account_sid: nil, domain_sid: nil, sid: nil)

lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list.rb

+3-2
Original file line numberDiff line numberDiff line change
@@ -110,8 +110,9 @@ def get_page(target_url)
110110
##
111111
# Retrieve a single page of IpAccessControlListInstance records from the API.
112112
# 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/#
115116
# @return [IpAccessControlListInstance] Newly created IpAccessControlListInstance
116117
def create(friendly_name: nil)
117118
data = Twilio::Values.of({'FriendlyName' => friendly_name, })

0 commit comments

Comments
 (0)