twilio-ruby 5.22.1 → 5.22.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (40) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGES.md +12 -0
  3. data/README.md +2 -2
  4. data/lib/twilio-ruby/rest/api/v2010/account/address.rb +7 -0
  5. data/lib/twilio-ruby/rest/autopilot.rb +1 -1
  6. data/lib/twilio-ruby/rest/autopilot/v1.rb +2 -2
  7. data/lib/twilio-ruby/rest/autopilot/v1/assistant.rb +55 -61
  8. data/lib/twilio-ruby/rest/autopilot/v1/assistant/defaults.rb +17 -9
  9. data/lib/twilio-ruby/rest/autopilot/v1/assistant/dialogue.rb +18 -10
  10. data/lib/twilio-ruby/rest/autopilot/v1/assistant/field_type.rb +37 -28
  11. data/lib/twilio-ruby/rest/autopilot/v1/assistant/field_type/field_value.rb +39 -32
  12. data/lib/twilio-ruby/rest/autopilot/v1/assistant/model_build.rb +37 -27
  13. data/lib/twilio-ruby/rest/autopilot/v1/assistant/query.rb +58 -53
  14. data/lib/twilio-ruby/rest/autopilot/v1/assistant/style_sheet.rb +15 -9
  15. data/lib/twilio-ruby/rest/autopilot/v1/assistant/task.rb +53 -43
  16. data/lib/twilio-ruby/rest/autopilot/v1/assistant/task/field.rb +38 -25
  17. data/lib/twilio-ruby/rest/autopilot/v1/assistant/task/sample.rb +56 -50
  18. data/lib/twilio-ruby/rest/autopilot/v1/assistant/task/task_actions.rb +27 -15
  19. data/lib/twilio-ruby/rest/autopilot/v1/assistant/task/task_statistics.rb +24 -18
  20. data/lib/twilio-ruby/rest/client.rb +39 -39
  21. data/lib/twilio-ruby/rest/notify.rb +4 -2
  22. data/lib/twilio-ruby/rest/notify/v1.rb +4 -2
  23. data/lib/twilio-ruby/rest/notify/v1/credential.rb +47 -42
  24. data/lib/twilio-ruby/rest/notify/v1/service.rb +118 -103
  25. data/lib/twilio-ruby/rest/notify/v1/service/binding.rb +74 -63
  26. data/lib/twilio-ruby/rest/notify/v1/service/notification.rb +108 -111
  27. data/lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb +7 -0
  28. data/lib/twilio-ruby/rest/trunking.rb +2 -2
  29. data/lib/twilio-ruby/rest/trunking/v1.rb +2 -2
  30. data/lib/twilio-ruby/rest/trunking/v1/trunk.rb +82 -82
  31. data/lib/twilio-ruby/rest/trunking/v1/trunk/credential_list.rb +19 -14
  32. data/lib/twilio-ruby/rest/trunking/v1/trunk/ip_access_control_list.rb +16 -15
  33. data/lib/twilio-ruby/rest/trunking/v1/trunk/origination_url.rb +51 -50
  34. data/lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb +41 -32
  35. data/lib/twilio-ruby/rest/trunking/v1/trunk/terminating_sip_domain.rb +30 -31
  36. data/lib/twilio-ruby/twiml/voice_response.rb +3 -2
  37. data/lib/twilio-ruby/version.rb +1 -1
  38. data/spec/integration/api/v2010/account/address_spec.rb +4 -0
  39. data/spec/integration/proxy/v1/service/phone_number_spec.rb +8 -4
  40. metadata +2 -2
@@ -18,10 +18,12 @@ module Twilio
18
18
  ##
19
19
  # Initialize the TaskStatisticsList
20
20
  # @param [Version] version Version that contains the resource
21
- # @param [String] assistant_sid The unique ID of the
22
- # [Assistant](https://www.twilio.com/docs/autopilot/api/assistant).
23
- # @param [String] task_sid The unique ID of the
24
- # [Task](https://www.twilio.com/docs/autopilot/api/task).
21
+ # @param [String] assistant_sid The SID of the
22
+ # [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the
23
+ # parent of the Task associated with the resource.
24
+ # @param [String] task_sid The SID of the
25
+ # [Task](https://www.twilio.com/docs/autopilot/api/task) for which the statistics
26
+ # were collected.
25
27
  # @return [TaskStatisticsList] TaskStatisticsList
26
28
  def initialize(version, assistant_sid: nil, task_sid: nil)
27
29
  super(version)
@@ -79,10 +81,12 @@ module Twilio
79
81
  ##
80
82
  # Initialize the TaskStatisticsContext
81
83
  # @param [Version] version Version that contains the resource
82
- # @param [String] assistant_sid The unique ID of the
83
- # [Assistant](https://www.twilio.com/docs/autopilot/api/assistant).
84
- # @param [String] task_sid The unique ID of the
85
- # [Task](https://www.twilio.com/docs/autopilot/api/task).
84
+ # @param [String] assistant_sid The SID of the
85
+ # [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the
86
+ # parent of the resource to fetch.
87
+ # @param [String] task_sid The SID of the
88
+ # [Task](https://www.twilio.com/docs/autopilot/api/task) that is associated with
89
+ # the resource to fetch.
86
90
  # @return [TaskStatisticsContext] TaskStatisticsContext
87
91
  def initialize(version, assistant_sid, task_sid)
88
92
  super(version)
@@ -134,10 +138,12 @@ module Twilio
134
138
  # Initialize the TaskStatisticsInstance
135
139
  # @param [Version] version Version that contains the resource
136
140
  # @param [Hash] payload payload that contains response from Twilio
137
- # @param [String] assistant_sid The unique ID of the
138
- # [Assistant](https://www.twilio.com/docs/autopilot/api/assistant).
139
- # @param [String] task_sid The unique ID of the
140
- # [Task](https://www.twilio.com/docs/autopilot/api/task).
141
+ # @param [String] assistant_sid The SID of the
142
+ # [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the
143
+ # parent of the Task associated with the resource.
144
+ # @param [String] task_sid The SID of the
145
+ # [Task](https://www.twilio.com/docs/autopilot/api/task) for which the statistics
146
+ # were collected.
141
147
  # @return [TaskStatisticsInstance] TaskStatisticsInstance
142
148
  def initialize(version, payload, assistant_sid: nil, task_sid: nil)
143
149
  super(version)
@@ -173,37 +179,37 @@ module Twilio
173
179
  end
174
180
 
175
181
  ##
176
- # @return [String] The unique ID of the Account that created this resource.
182
+ # @return [String] The SID of the Account that created the resource
177
183
  def account_sid
178
184
  @properties['account_sid']
179
185
  end
180
186
 
181
187
  ##
182
- # @return [String] The unique ID of the Assistant.
188
+ # @return [String] The SID of the Assistant that is the parent of the Task associated with the resource
183
189
  def assistant_sid
184
190
  @properties['assistant_sid']
185
191
  end
186
192
 
187
193
  ##
188
- # @return [String] The unique ID of the Task associated with this Field.
194
+ # @return [String] The SID of the Task for which the statistics were collected
189
195
  def task_sid
190
196
  @properties['task_sid']
191
197
  end
192
198
 
193
199
  ##
194
- # @return [String] The total number of Samples associated with this Task.
200
+ # @return [String] The total number of Samples associated with the Task
195
201
  def samples_count
196
202
  @properties['samples_count']
197
203
  end
198
204
 
199
205
  ##
200
- # @return [String] The total number of Fields associated with this Task.
206
+ # @return [String] The total number of Fields associated with the Task
201
207
  def fields_count
202
208
  @properties['fields_count']
203
209
  end
204
210
 
205
211
  ##
206
- # @return [String] The url
212
+ # @return [String] The absolute URL of the TaskStatistics resource
207
213
  def url
208
214
  @properties['url']
209
215
  end
@@ -32,24 +32,24 @@ module Twilio
32
32
  @chat = nil
33
33
  @fax = nil
34
34
  @flex_api = nil
35
+ @insights = nil
35
36
  @ip_messaging = nil
36
37
  @lookups = nil
38
+ @messaging = nil
37
39
  @monitor = nil
38
40
  @notify = nil
39
41
  @preview = nil
40
42
  @pricing = nil
41
43
  @proxy = nil
42
44
  @serverless = nil
45
+ @studio = nil
46
+ @sync = nil
43
47
  @taskrouter = nil
44
48
  @trunking = nil
45
- @video = nil
46
- @messaging = nil
47
- @wireless = nil
48
- @sync = nil
49
- @studio = nil
50
49
  @verify = nil
50
+ @video = nil
51
51
  @voice = nil
52
- @insights = nil
52
+ @wireless = nil
53
53
  end
54
54
 
55
55
  ##
@@ -142,6 +142,12 @@ module Twilio
142
142
  @flex_api ||= FlexApi.new self
143
143
  end
144
144
 
145
+ ##
146
+ # Access the Insights Twilio Domain
147
+ def insights
148
+ @insights ||= Insights.new self
149
+ end
150
+
145
151
  ##
146
152
  # Access the IpMessaging Twilio Domain
147
153
  def ip_messaging
@@ -154,6 +160,12 @@ module Twilio
154
160
  @lookups ||= Lookups.new self
155
161
  end
156
162
 
163
+ ##
164
+ # Access the Messaging Twilio Domain
165
+ def messaging
166
+ @messaging ||= Messaging.new self
167
+ end
168
+
157
169
  ##
158
170
  # Access the Monitor Twilio Domain
159
171
  def monitor
@@ -191,33 +203,9 @@ module Twilio
191
203
  end
192
204
 
193
205
  ##
194
- # Access the Taskrouter Twilio Domain
195
- def taskrouter
196
- @taskrouter ||= Taskrouter.new self
197
- end
198
-
199
- ##
200
- # Access the Trunking Twilio Domain
201
- def trunking
202
- @trunking ||= Trunking.new self
203
- end
204
-
205
- ##
206
- # Access the Video Twilio Domain
207
- def video
208
- @video ||= Video.new self
209
- end
210
-
211
- ##
212
- # Access the Messaging Twilio Domain
213
- def messaging
214
- @messaging ||= Messaging.new self
215
- end
216
-
217
- ##
218
- # Access the Wireless Twilio Domain
219
- def wireless
220
- @wireless ||= Wireless.new self
206
+ # Access the Studio Twilio Domain
207
+ def studio
208
+ @studio ||= Studio.new self
221
209
  end
222
210
 
223
211
  ##
@@ -227,9 +215,15 @@ module Twilio
227
215
  end
228
216
 
229
217
  ##
230
- # Access the Studio Twilio Domain
231
- def studio
232
- @studio ||= Studio.new self
218
+ # Access the Taskrouter Twilio Domain
219
+ def taskrouter
220
+ @taskrouter ||= Taskrouter.new self
221
+ end
222
+
223
+ ##
224
+ # Access the Trunking Twilio Domain
225
+ def trunking
226
+ @trunking ||= Trunking.new self
233
227
  end
234
228
 
235
229
  ##
@@ -238,6 +232,12 @@ module Twilio
238
232
  @verify ||= Verify.new self
239
233
  end
240
234
 
235
+ ##
236
+ # Access the Video Twilio Domain
237
+ def video
238
+ @video ||= Video.new self
239
+ end
240
+
241
241
  ##
242
242
  # Access the Voice Twilio Domain
243
243
  def voice
@@ -245,9 +245,9 @@ module Twilio
245
245
  end
246
246
 
247
247
  ##
248
- # Access the Insights Twilio Domain
249
- def insights
250
- @insights ||= Insights.new self
248
+ # Access the Wireless Twilio Domain
249
+ def wireless
250
+ @wireless ||= Wireless.new self
251
251
  end
252
252
 
253
253
  ##
@@ -29,7 +29,8 @@ module Twilio
29
29
  end
30
30
 
31
31
  ##
32
- # @param [String] sid The sid
32
+ # @param [String] sid The unique string that we created to identify the Credential
33
+ # resource.
33
34
  # @return [Twilio::REST::Notify::V1::CredentialInstance] if sid was passed.
34
35
  # @return [Twilio::REST::Notify::V1::CredentialList]
35
36
  def credentials(sid=:unset)
@@ -37,7 +38,8 @@ module Twilio
37
38
  end
38
39
 
39
40
  ##
40
- # @param [String] sid The sid
41
+ # @param [String] sid The unique string that we created to identify the Service
42
+ # resource.
41
43
  # @return [Twilio::REST::Notify::V1::ServiceInstance] if sid was passed.
42
44
  # @return [Twilio::REST::Notify::V1::ServiceList]
43
45
  def services(sid=:unset)
@@ -20,7 +20,8 @@ module Twilio
20
20
  end
21
21
 
22
22
  ##
23
- # @param [String] sid The sid
23
+ # @param [String] sid The Twilio-provided string that uniquely identifies the
24
+ # Credential resource to fetch.
24
25
  # @return [Twilio::REST::Notify::V1::CredentialContext] if sid was passed.
25
26
  # @return [Twilio::REST::Notify::V1::CredentialList]
26
27
  def credentials(sid=:unset)
@@ -34,7 +35,8 @@ module Twilio
34
35
  end
35
36
 
36
37
  ##
37
- # @param [String] sid The sid
38
+ # @param [String] sid The Twilio-provided string that uniquely identifies the
39
+ # Service resource to fetch.
38
40
  # @return [Twilio::REST::Notify::V1::ServiceContext] if sid was passed.
39
41
  # @return [Twilio::REST::Notify::V1::ServiceList]
40
42
  def services(sid=:unset)
@@ -110,22 +110,23 @@ module Twilio
110
110
  ##
111
111
  # Retrieve a single page of CredentialInstance records from the API.
112
112
  # Request is executed immediately.
113
- # @param [credential.PushService] type Credential type, one of "gcm", "fcm", or
114
- # "apn"
115
- # @param [String] friendly_name Friendly name for stored credential
116
- # @param [String] certificate [APN only] URL encoded representation of the
113
+ # @param [credential.PushService] type The Credential type. Can be: `gcm`, `fcm`,
114
+ # or `apn`.
115
+ # @param [String] friendly_name A descriptive string that you create to describe
116
+ # the resource. It can be up to 64 characters long.
117
+ # @param [String] certificate [APN only] The URL-encoded representation of the
117
118
  # certificate. Strip everything outside of the headers, e.g. `-----BEGIN
118
119
  # CERTIFICATE-----MIIFnTCCBIWgAwIBAgIIAjy9H849+E8wDQYJKoZIhvcNAQEFBQAwgZYxCzAJBgNV.....A==-----END CERTIFICATE-----`
119
- # @param [String] private_key [APN only] URL encoded representation of the private
120
- # key. Strip everything outside of the headers, e.g. `-----BEGIN RSA PRIVATE
120
+ # @param [String] private_key [APN only] The URL-encoded representation of the
121
+ # private key. Strip everything outside of the headers, e.g. `-----BEGIN RSA
122
+ # PRIVATE
121
123
  # KEY-----MIIEpQIBAAKCAQEAuyf/lNrH9ck8DmNyo3fGgvCI1l9s+cmBY3WIz+cUDqmxiieR\n.-----END RSA PRIVATE KEY-----`
122
- # @param [Boolean] sandbox [APN only] use this credential for sending to
123
- # production or sandbox APNs (string `true` or `false`)
124
- # @param [String] api_key [GCM only] This is the "Server key" of your project from
125
- # Firebase console under Settings / Cloud messaging. Yes, you can use the server
126
- # key from the Firebase console for GCM.
127
- # @param [String] secret [FCM only] This is the "Server key" of your project from
124
+ # @param [Boolean] sandbox [APN only] Whether to send the credential to sandbox
125
+ # APNs. Can be `true` to send to sandbox APNs or `false` to send to production.
126
+ # @param [String] api_key [GCM only] The `Server key` of your project from
128
127
  # Firebase console under Settings / Cloud messaging.
128
+ # @param [String] secret [FCM only] The `Server key` of your project from Firebase
129
+ # console under Settings / Cloud messaging.
129
130
  # @return [CredentialInstance] Newly created CredentialInstance
130
131
  def create(type: nil, friendly_name: :unset, certificate: :unset, private_key: :unset, sandbox: :unset, api_key: :unset, secret: :unset)
131
132
  data = Twilio::Values.of({
@@ -191,7 +192,8 @@ module Twilio
191
192
  ##
192
193
  # Initialize the CredentialContext
193
194
  # @param [Version] version Version that contains the resource
194
- # @param [String] sid The sid
195
+ # @param [String] sid The Twilio-provided string that uniquely identifies the
196
+ # Credential resource to fetch.
195
197
  # @return [CredentialContext] CredentialContext
196
198
  def initialize(version, sid)
197
199
  super(version)
@@ -218,20 +220,21 @@ module Twilio
218
220
 
219
221
  ##
220
222
  # Update the CredentialInstance
221
- # @param [String] friendly_name Friendly name for stored credential
222
- # @param [String] certificate [APN only] URL encoded representation of the
223
+ # @param [String] friendly_name A descriptive string that you create to describe
224
+ # the resource. It can be up to 64 characters long.
225
+ # @param [String] certificate [APN only] The URL-encoded representation of the
223
226
  # certificate. Strip everything outside of the headers, e.g. `-----BEGIN
224
227
  # CERTIFICATE-----MIIFnTCCBIWgAwIBAgIIAjy9H849+E8wDQYJKoZIhvcNAQEFBQAwgZYxCzAJBgNV.....A==-----END CERTIFICATE-----`
225
- # @param [String] private_key [APN only] URL encoded representation of the private
226
- # key. Strip everything outside of the headers, e.g. `-----BEGIN RSA PRIVATE
228
+ # @param [String] private_key [APN only] The URL-encoded representation of the
229
+ # private key. Strip everything outside of the headers, e.g. `-----BEGIN RSA
230
+ # PRIVATE
227
231
  # KEY-----MIIEpQIBAAKCAQEAuyf/lNrH9ck8DmNyo3fGgvCI1l9s+cmBY3WIz+cUDqmxiieR\n.-----END RSA PRIVATE KEY-----`
228
- # @param [Boolean] sandbox [APN only] use this credential for sending to
229
- # production or sandbox APNs (string `true` or `false`)
230
- # @param [String] api_key [GCM only] This is the "Server key" of your project from
231
- # Firebase console under Settings / Cloud messaging. Yes, you can use the server
232
- # key from the Firebase console for GCM.
233
- # @param [String] secret [FCM only] This is the "Server key" of your project from
232
+ # @param [Boolean] sandbox [APN only] Whether to send the credential to sandbox
233
+ # APNs. Can be `true` to send to sandbox APNs or `false` to send to production.
234
+ # @param [String] api_key [GCM only] The `Server key` of your project from
234
235
  # Firebase console under Settings / Cloud messaging.
236
+ # @param [String] secret [FCM only] The `Server key` of your project from Firebase
237
+ # console under Settings / Cloud messaging.
235
238
  # @return [CredentialInstance] Updated CredentialInstance
236
239
  def update(friendly_name: :unset, certificate: :unset, private_key: :unset, sandbox: :unset, api_key: :unset, secret: :unset)
237
240
  data = Twilio::Values.of({
@@ -281,7 +284,8 @@ module Twilio
281
284
  # Initialize the CredentialInstance
282
285
  # @param [Version] version Version that contains the resource
283
286
  # @param [Hash] payload payload that contains response from Twilio
284
- # @param [String] sid The sid
287
+ # @param [String] sid The Twilio-provided string that uniquely identifies the
288
+ # Credential resource to fetch.
285
289
  # @return [CredentialInstance] CredentialInstance
286
290
  def initialize(version, payload, sid: nil)
287
291
  super(version)
@@ -315,49 +319,49 @@ module Twilio
315
319
  end
316
320
 
317
321
  ##
318
- # @return [String] The sid
322
+ # @return [String] The unique string that identifies the resource
319
323
  def sid
320
324
  @properties['sid']
321
325
  end
322
326
 
323
327
  ##
324
- # @return [String] The account_sid
328
+ # @return [String] The SID of the Account that created the resource
325
329
  def account_sid
326
330
  @properties['account_sid']
327
331
  end
328
332
 
329
333
  ##
330
- # @return [String] Friendly name for stored credential
334
+ # @return [String] The string that you assigned to describe the resource
331
335
  def friendly_name
332
336
  @properties['friendly_name']
333
337
  end
334
338
 
335
339
  ##
336
- # @return [credential.PushService] Credential type, one of "gcm", "fcm", or "apn"
340
+ # @return [credential.PushService] The Credential type, one of `gcm`, `fcm`, or `apn`
337
341
  def type
338
342
  @properties['type']
339
343
  end
340
344
 
341
345
  ##
342
- # @return [String] [APN only] use this credential for sending to production or sandbox APNs
346
+ # @return [String] [APN only] Whether to send the credential to sandbox APNs
343
347
  def sandbox
344
348
  @properties['sandbox']
345
349
  end
346
350
 
347
351
  ##
348
- # @return [Time] The date_created
352
+ # @return [Time] The RFC 2822 date and time in GMT when the resource was created
349
353
  def date_created
350
354
  @properties['date_created']
351
355
  end
352
356
 
353
357
  ##
354
- # @return [Time] The date_updated
358
+ # @return [Time] The RFC 2822 date and time in GMT when the resource was last updated
355
359
  def date_updated
356
360
  @properties['date_updated']
357
361
  end
358
362
 
359
363
  ##
360
- # @return [String] The url
364
+ # @return [String] The absolute URL of the Credential resource
361
365
  def url
362
366
  @properties['url']
363
367
  end
@@ -371,20 +375,21 @@ module Twilio
371
375
 
372
376
  ##
373
377
  # Update the CredentialInstance
374
- # @param [String] friendly_name Friendly name for stored credential
375
- # @param [String] certificate [APN only] URL encoded representation of the
378
+ # @param [String] friendly_name A descriptive string that you create to describe
379
+ # the resource. It can be up to 64 characters long.
380
+ # @param [String] certificate [APN only] The URL-encoded representation of the
376
381
  # certificate. Strip everything outside of the headers, e.g. `-----BEGIN
377
382
  # CERTIFICATE-----MIIFnTCCBIWgAwIBAgIIAjy9H849+E8wDQYJKoZIhvcNAQEFBQAwgZYxCzAJBgNV.....A==-----END CERTIFICATE-----`
378
- # @param [String] private_key [APN only] URL encoded representation of the private
379
- # key. Strip everything outside of the headers, e.g. `-----BEGIN RSA PRIVATE
383
+ # @param [String] private_key [APN only] The URL-encoded representation of the
384
+ # private key. Strip everything outside of the headers, e.g. `-----BEGIN RSA
385
+ # PRIVATE
380
386
  # KEY-----MIIEpQIBAAKCAQEAuyf/lNrH9ck8DmNyo3fGgvCI1l9s+cmBY3WIz+cUDqmxiieR\n.-----END RSA PRIVATE KEY-----`
381
- # @param [Boolean] sandbox [APN only] use this credential for sending to
382
- # production or sandbox APNs (string `true` or `false`)
383
- # @param [String] api_key [GCM only] This is the "Server key" of your project from
384
- # Firebase console under Settings / Cloud messaging. Yes, you can use the server
385
- # key from the Firebase console for GCM.
386
- # @param [String] secret [FCM only] This is the "Server key" of your project from
387
+ # @param [Boolean] sandbox [APN only] Whether to send the credential to sandbox
388
+ # APNs. Can be `true` to send to sandbox APNs or `false` to send to production.
389
+ # @param [String] api_key [GCM only] The `Server key` of your project from
387
390
  # Firebase console under Settings / Cloud messaging.
391
+ # @param [String] secret [FCM only] The `Server key` of your project from Firebase
392
+ # console under Settings / Cloud messaging.
388
393
  # @return [CredentialInstance] Updated CredentialInstance
389
394
  def update(friendly_name: :unset, certificate: :unset, private_key: :unset, sandbox: :unset, api_key: :unset, secret: :unset)
390
395
  context.update(
@@ -28,38 +28,38 @@ module Twilio
28
28
  ##
29
29
  # Retrieve a single page of ServiceInstance records from the API.
30
30
  # Request is executed immediately.
31
- # @param [String] friendly_name Human-readable name for this service instance
31
+ # @param [String] friendly_name A descriptive string that you create to describe
32
+ # the resource. It can be up to 64 characters long.
32
33
  # @param [String] apn_credential_sid The SID of the
33
- # [Credential](https://www.twilio.com/docs/notify/api/credentials) to be used for
34
- # APN Bindings.
34
+ # [Credential](https://www.twilio.com/docs/notify/api/credential-resource) to use
35
+ # for APN Bindings.
35
36
  # @param [String] gcm_credential_sid The SID of the
36
- # [Credential](https://www.twilio.com/docs/notify/api/credentials) to be used for
37
- # GCM Bindings.
37
+ # [Credential](https://www.twilio.com/docs/notify/api/credential-resource) to use
38
+ # for GCM Bindings.
38
39
  # @param [String] messaging_service_sid The SID of the [Messaging
39
- # Service](https://www.twilio.com/docs/api/rest/sending-messages#messaging-services) to be used for SMS Bindings. In order to send SMS notifications this parameter has to be set.
40
- # @param [String] facebook_messenger_page_id The Page ID to be used to send for
41
- # Facebook Messenger Bindings. It has to match the Page ID you configured when you
42
- # [enabled Facebook Messaging](https://www.twilio.com/console/sms/settings) on
43
- # your account.
44
- # @param [String] default_apn_notification_protocol_version The version of the
45
- # protocol to be used for sending APNS notifications. Can be overriden on a
46
- # Binding by Binding basis when creating a
47
- # [Binding](https://www.twilio.com/docs/notify/api/bindings) resource.
48
- # @param [String] default_gcm_notification_protocol_version The version of the
49
- # protocol to be used for sending GCM notifications. Can be overriden on a Binding
50
- # by Binding basis when creating a
51
- # [Binding](https://www.twilio.com/docs/notify/api/bindings) resource.
40
+ # Service](https://www.twilio.com/docs/sms/send-messages#messaging-services) to
41
+ # use for SMS Bindings. This parameter must be set in order to send SMS
42
+ # notifications.
43
+ # @param [String] facebook_messenger_page_id Deprecated.
44
+ # @param [String] default_apn_notification_protocol_version The protocol version
45
+ # to use for sending APNS notifications. Can be overridden on a Binding by Binding
46
+ # basis when creating a
47
+ # [Binding](https://www.twilio.com/docs/notify/api/binding-resource) resource.
48
+ # @param [String] default_gcm_notification_protocol_version The protocol version
49
+ # to use for sending GCM notifications. Can be overridden on a Binding by Binding
50
+ # basis when creating a
51
+ # [Binding](https://www.twilio.com/docs/notify/api/binding-resource) resource.
52
52
  # @param [String] fcm_credential_sid The SID of the
53
- # [Credential](https://www.twilio.com/docs/notify/api/credentials) to be used for
54
- # FCM Bindings.
55
- # @param [String] default_fcm_notification_protocol_version The version of the
56
- # protocol to be used for sending FCM notifications. Can be overriden on a Binding
57
- # by Binding basis when creating a
58
- # [Binding](https://www.twilio.com/docs/notify/api/bindings) resource.
59
- # @param [Boolean] log_enabled The log_enabled
60
- # @param [String] alexa_skill_id The alexa_skill_id
61
- # @param [String] default_alexa_notification_protocol_version The
62
- # default_alexa_notification_protocol_version
53
+ # [Credential](https://www.twilio.com/docs/notify/api/credential-resource) to use
54
+ # for FCM Bindings.
55
+ # @param [String] default_fcm_notification_protocol_version The protocol version
56
+ # to use for sending FCM notifications. Can be overridden on a Binding by Binding
57
+ # basis when creating a
58
+ # [Binding](https://www.twilio.com/docs/notify/api/binding-resource) resource.
59
+ # @param [Boolean] log_enabled Whether to log notifications. Can be: `true` or
60
+ # `false` and the default is `true`.
61
+ # @param [String] alexa_skill_id Deprecated.
62
+ # @param [String] default_alexa_notification_protocol_version Deprecated.
63
63
  # @return [ServiceInstance] Newly created ServiceInstance
64
64
  def create(friendly_name: :unset, apn_credential_sid: :unset, gcm_credential_sid: :unset, messaging_service_sid: :unset, facebook_messenger_page_id: :unset, default_apn_notification_protocol_version: :unset, default_gcm_notification_protocol_version: :unset, fcm_credential_sid: :unset, default_fcm_notification_protocol_version: :unset, log_enabled: :unset, alexa_skill_id: :unset, default_alexa_notification_protocol_version: :unset)
65
65
  data = Twilio::Values.of({
@@ -90,7 +90,8 @@ module Twilio
90
90
  # Lists ServiceInstance records from the API as a list.
91
91
  # Unlike stream(), this operation is eager and will load `limit` records into
92
92
  # memory before returning.
93
- # @param [String] friendly_name Filter services by FriendlyName
93
+ # @param [String] friendly_name The string that identifies the Service resources
94
+ # to read.
94
95
  # @param [Integer] limit Upper limit for the number of records to return. stream()
95
96
  # guarantees to never return more than limit. Default is no limit
96
97
  # @param [Integer] page_size Number of records to fetch per request, when
@@ -106,7 +107,8 @@ module Twilio
106
107
  # Streams ServiceInstance records from the API as an Enumerable.
107
108
  # This operation lazily loads records as efficiently as possible until the limit
108
109
  # is reached.
109
- # @param [String] friendly_name Filter services by FriendlyName
110
+ # @param [String] friendly_name The string that identifies the Service resources
111
+ # to read.
110
112
  # @param [Integer] limit Upper limit for the number of records to return. stream()
111
113
  # guarantees to never return more than limit. Default is no limit.
112
114
  # @param [Integer] page_size Number of records to fetch per request, when
@@ -139,7 +141,8 @@ module Twilio
139
141
  ##
140
142
  # Retrieve a single page of ServiceInstance records from the API.
141
143
  # Request is executed immediately.
142
- # @param [String] friendly_name Filter services by FriendlyName
144
+ # @param [String] friendly_name The string that identifies the Service resources
145
+ # to read.
143
146
  # @param [String] page_token PageToken provided by the API
144
147
  # @param [Integer] page_number Page Number, this value is simply for client state
145
148
  # @param [Integer] page_size Number of records to return, defaults to 50
@@ -216,7 +219,8 @@ module Twilio
216
219
  ##
217
220
  # Initialize the ServiceContext
218
221
  # @param [Version] version Version that contains the resource
219
- # @param [String] sid The sid
222
+ # @param [String] sid The Twilio-provided string that uniquely identifies the
223
+ # Service resource to fetch.
220
224
  # @return [ServiceContext] ServiceContext
221
225
  def initialize(version, sid)
222
226
  super(version)
@@ -254,33 +258,38 @@ module Twilio
254
258
 
255
259
  ##
256
260
  # Update the ServiceInstance
257
- # @param [String] friendly_name Human-readable name for this service instance
258
- # @param [String] apn_credential_sid The SID of the default Credential to be used
259
- # for APN Bindings
260
- # @param [String] gcm_credential_sid The SID of the default Credential to be used
261
- # for GCM Bindings
261
+ # @param [String] friendly_name A descriptive string that you create to describe
262
+ # the resource. It can be up to 64 characters long.
263
+ # @param [String] apn_credential_sid The SID of the
264
+ # [Credential](https://www.twilio.com/docs/notify/api/credential-resource) to use
265
+ # for APN Bindings.
266
+ # @param [String] gcm_credential_sid The SID of the
267
+ # [Credential](https://www.twilio.com/docs/notify/api/credential-resource) to use
268
+ # for GCM Bindings.
262
269
  # @param [String] messaging_service_sid The SID of the [Messaging
263
- # Service](https://www.twilio.com/docs/api/rest/sending-messages#messaging-services) to be used for SMS Bindings. In order to send SMS notifications this parameter has to be set.
264
- # @param [String] facebook_messenger_page_id The Page ID to be used to send for
265
- # Facebook Messenger Bindings. It has to match the Page ID you configured when you
266
- # [enabled Facebook Messaging](https://www.twilio.com/console/sms/settings) on
267
- # your account. Facebook Messenger integration is in beta. You need to be in the
268
- # beta program to be able to enable Facebook Messaging for your account.
269
- # @param [String] default_apn_notification_protocol_version The version of the
270
- # protocol to be used for sending APNS notifications. Can be overriden on a
271
- # Binding by Binding basis when creating a Binding resource.
272
- # @param [String] default_gcm_notification_protocol_version The version of the
273
- # protocol to be used for sending GCM notifications. Can be overriden on a Binding
274
- # by Binding basis when creating a Binding resource.
275
- # @param [String] fcm_credential_sid The SID of the default Credential to be used
276
- # for FCM Bindings
277
- # @param [String] default_fcm_notification_protocol_version The version of the
278
- # protocol to be used for sending FCM notifications. Can be overriden on a Binding
279
- # by Binding basis when creating a Binding resource.
280
- # @param [Boolean] log_enabled The log_enabled
281
- # @param [String] alexa_skill_id The alexa_skill_id
282
- # @param [String] default_alexa_notification_protocol_version The
283
- # default_alexa_notification_protocol_version
270
+ # Service](https://www.twilio.com/docs/sms/send-messages#messaging-services) to
271
+ # use for SMS Bindings. This parameter must be set in order to send SMS
272
+ # notifications.
273
+ # @param [String] facebook_messenger_page_id Deprecated.
274
+ # @param [String] default_apn_notification_protocol_version The protocol version
275
+ # to use for sending APNS notifications. Can be overridden on a Binding by Binding
276
+ # basis when creating a
277
+ # [Binding](https://www.twilio.com/docs/notify/api/binding-resource) resource.
278
+ # @param [String] default_gcm_notification_protocol_version The protocol version
279
+ # to use for sending GCM notifications. Can be overridden on a Binding by Binding
280
+ # basis when creating a
281
+ # [Binding](https://www.twilio.com/docs/notify/api/binding-resource) resource.
282
+ # @param [String] fcm_credential_sid The SID of the
283
+ # [Credential](https://www.twilio.com/docs/notify/api/credential-resource) to use
284
+ # for FCM Bindings.
285
+ # @param [String] default_fcm_notification_protocol_version The protocol version
286
+ # to use for sending FCM notifications. Can be overridden on a Binding by Binding
287
+ # basis when creating a
288
+ # [Binding](https://www.twilio.com/docs/notify/api/binding-resource) resource.
289
+ # @param [Boolean] log_enabled Whether to log notifications. Can be: `true` or
290
+ # `false` and the default is `true`.
291
+ # @param [String] alexa_skill_id Deprecated.
292
+ # @param [String] default_alexa_notification_protocol_version Deprecated.
284
293
  # @return [ServiceInstance] Updated ServiceInstance
285
294
  def update(friendly_name: :unset, apn_credential_sid: :unset, gcm_credential_sid: :unset, messaging_service_sid: :unset, facebook_messenger_page_id: :unset, default_apn_notification_protocol_version: :unset, default_gcm_notification_protocol_version: :unset, fcm_credential_sid: :unset, default_fcm_notification_protocol_version: :unset, log_enabled: :unset, alexa_skill_id: :unset, default_alexa_notification_protocol_version: :unset)
286
295
  data = Twilio::Values.of({
@@ -359,7 +368,8 @@ module Twilio
359
368
  # Initialize the ServiceInstance
360
369
  # @param [Version] version Version that contains the resource
361
370
  # @param [Hash] payload payload that contains response from Twilio
362
- # @param [String] sid The sid
371
+ # @param [String] sid The Twilio-provided string that uniquely identifies the
372
+ # Service resource to fetch.
363
373
  # @return [ServiceInstance] ServiceInstance
364
374
  def initialize(version, payload, sid: nil)
365
375
  super(version)
@@ -403,109 +413,109 @@ module Twilio
403
413
  end
404
414
 
405
415
  ##
406
- # @return [String] The sid
416
+ # @return [String] The unique string that identifies the resource
407
417
  def sid
408
418
  @properties['sid']
409
419
  end
410
420
 
411
421
  ##
412
- # @return [String] The account_sid
422
+ # @return [String] The SID of the Account that created the resource
413
423
  def account_sid
414
424
  @properties['account_sid']
415
425
  end
416
426
 
417
427
  ##
418
- # @return [String] Human-readable name for this service instance
428
+ # @return [String] The string that you assigned to describe the resource
419
429
  def friendly_name
420
430
  @properties['friendly_name']
421
431
  end
422
432
 
423
433
  ##
424
- # @return [Time] The date_created
434
+ # @return [Time] The RFC 2822 date and time in GMT when the resource was created
425
435
  def date_created
426
436
  @properties['date_created']
427
437
  end
428
438
 
429
439
  ##
430
- # @return [Time] The date_updated
440
+ # @return [Time] The RFC 2822 date and time in GMT when the resource was last updated
431
441
  def date_updated
432
442
  @properties['date_updated']
433
443
  end
434
444
 
435
445
  ##
436
- # @return [String] The SID of the Credential to be used for APN Bindings.
446
+ # @return [String] The SID of the Credential to use for APN Bindings
437
447
  def apn_credential_sid
438
448
  @properties['apn_credential_sid']
439
449
  end
440
450
 
441
451
  ##
442
- # @return [String] The SID of the Credential to be used for GCM Bindings.
452
+ # @return [String] The SID of the Credential to use for GCM Bindings
443
453
  def gcm_credential_sid
444
454
  @properties['gcm_credential_sid']
445
455
  end
446
456
 
447
457
  ##
448
- # @return [String] The SID of the Credential to be used for FCM Bindings.
458
+ # @return [String] The SID of the Credential to use for FCM Bindings
449
459
  def fcm_credential_sid
450
460
  @properties['fcm_credential_sid']
451
461
  end
452
462
 
453
463
  ##
454
- # @return [String] The SID of the Messaging Service to be used for SMS Bindings.
464
+ # @return [String] The SID of the Messaging Service to use for SMS Bindings
455
465
  def messaging_service_sid
456
466
  @properties['messaging_service_sid']
457
467
  end
458
468
 
459
469
  ##
460
- # @return [String] The Page ID to be used to send for Facebook Messenger Bindings.
470
+ # @return [String] Deprecated
461
471
  def facebook_messenger_page_id
462
472
  @properties['facebook_messenger_page_id']
463
473
  end
464
474
 
465
475
  ##
466
- # @return [String] The version of the protocol to be used for sending APNS notifications.
476
+ # @return [String] The protocol version to use for sending APNS notifications
467
477
  def default_apn_notification_protocol_version
468
478
  @properties['default_apn_notification_protocol_version']
469
479
  end
470
480
 
471
481
  ##
472
- # @return [String] The version of the protocol to be used for sending GCM notifications.
482
+ # @return [String] The protocol version to use for sending GCM notifications
473
483
  def default_gcm_notification_protocol_version
474
484
  @properties['default_gcm_notification_protocol_version']
475
485
  end
476
486
 
477
487
  ##
478
- # @return [String] The version of the protocol to be used for sending FCM notifications.
488
+ # @return [String] The protocol version to use for sending FCM notifications
479
489
  def default_fcm_notification_protocol_version
480
490
  @properties['default_fcm_notification_protocol_version']
481
491
  end
482
492
 
483
493
  ##
484
- # @return [Boolean] The log_enabled
494
+ # @return [Boolean] Whether to log notifications
485
495
  def log_enabled
486
496
  @properties['log_enabled']
487
497
  end
488
498
 
489
499
  ##
490
- # @return [String] The url
500
+ # @return [String] The absolute URL of the Service resource
491
501
  def url
492
502
  @properties['url']
493
503
  end
494
504
 
495
505
  ##
496
- # @return [String] The links
506
+ # @return [String] The URLs of the resources related to the service
497
507
  def links
498
508
  @properties['links']
499
509
  end
500
510
 
501
511
  ##
502
- # @return [String] The alexa_skill_id
512
+ # @return [String] Deprecated
503
513
  def alexa_skill_id
504
514
  @properties['alexa_skill_id']
505
515
  end
506
516
 
507
517
  ##
508
- # @return [String] The default_alexa_notification_protocol_version
518
+ # @return [String] Deprecated
509
519
  def default_alexa_notification_protocol_version
510
520
  @properties['default_alexa_notification_protocol_version']
511
521
  end
@@ -526,33 +536,38 @@ module Twilio
526
536
 
527
537
  ##
528
538
  # Update the ServiceInstance
529
- # @param [String] friendly_name Human-readable name for this service instance
530
- # @param [String] apn_credential_sid The SID of the default Credential to be used
531
- # for APN Bindings
532
- # @param [String] gcm_credential_sid The SID of the default Credential to be used
533
- # for GCM Bindings
539
+ # @param [String] friendly_name A descriptive string that you create to describe
540
+ # the resource. It can be up to 64 characters long.
541
+ # @param [String] apn_credential_sid The SID of the
542
+ # [Credential](https://www.twilio.com/docs/notify/api/credential-resource) to use
543
+ # for APN Bindings.
544
+ # @param [String] gcm_credential_sid The SID of the
545
+ # [Credential](https://www.twilio.com/docs/notify/api/credential-resource) to use
546
+ # for GCM Bindings.
534
547
  # @param [String] messaging_service_sid The SID of the [Messaging
535
- # Service](https://www.twilio.com/docs/api/rest/sending-messages#messaging-services) to be used for SMS Bindings. In order to send SMS notifications this parameter has to be set.
536
- # @param [String] facebook_messenger_page_id The Page ID to be used to send for
537
- # Facebook Messenger Bindings. It has to match the Page ID you configured when you
538
- # [enabled Facebook Messaging](https://www.twilio.com/console/sms/settings) on
539
- # your account. Facebook Messenger integration is in beta. You need to be in the
540
- # beta program to be able to enable Facebook Messaging for your account.
541
- # @param [String] default_apn_notification_protocol_version The version of the
542
- # protocol to be used for sending APNS notifications. Can be overriden on a
543
- # Binding by Binding basis when creating a Binding resource.
544
- # @param [String] default_gcm_notification_protocol_version The version of the
545
- # protocol to be used for sending GCM notifications. Can be overriden on a Binding
546
- # by Binding basis when creating a Binding resource.
547
- # @param [String] fcm_credential_sid The SID of the default Credential to be used
548
- # for FCM Bindings
549
- # @param [String] default_fcm_notification_protocol_version The version of the
550
- # protocol to be used for sending FCM notifications. Can be overriden on a Binding
551
- # by Binding basis when creating a Binding resource.
552
- # @param [Boolean] log_enabled The log_enabled
553
- # @param [String] alexa_skill_id The alexa_skill_id
554
- # @param [String] default_alexa_notification_protocol_version The
555
- # default_alexa_notification_protocol_version
548
+ # Service](https://www.twilio.com/docs/sms/send-messages#messaging-services) to
549
+ # use for SMS Bindings. This parameter must be set in order to send SMS
550
+ # notifications.
551
+ # @param [String] facebook_messenger_page_id Deprecated.
552
+ # @param [String] default_apn_notification_protocol_version The protocol version
553
+ # to use for sending APNS notifications. Can be overridden on a Binding by Binding
554
+ # basis when creating a
555
+ # [Binding](https://www.twilio.com/docs/notify/api/binding-resource) resource.
556
+ # @param [String] default_gcm_notification_protocol_version The protocol version
557
+ # to use for sending GCM notifications. Can be overridden on a Binding by Binding
558
+ # basis when creating a
559
+ # [Binding](https://www.twilio.com/docs/notify/api/binding-resource) resource.
560
+ # @param [String] fcm_credential_sid The SID of the
561
+ # [Credential](https://www.twilio.com/docs/notify/api/credential-resource) to use
562
+ # for FCM Bindings.
563
+ # @param [String] default_fcm_notification_protocol_version The protocol version
564
+ # to use for sending FCM notifications. Can be overridden on a Binding by Binding
565
+ # basis when creating a
566
+ # [Binding](https://www.twilio.com/docs/notify/api/binding-resource) resource.
567
+ # @param [Boolean] log_enabled Whether to log notifications. Can be: `true` or
568
+ # `false` and the default is `true`.
569
+ # @param [String] alexa_skill_id Deprecated.
570
+ # @param [String] default_alexa_notification_protocol_version Deprecated.
556
571
  # @return [ServiceInstance] Updated ServiceInstance
557
572
  def update(friendly_name: :unset, apn_credential_sid: :unset, gcm_credential_sid: :unset, messaging_service_sid: :unset, facebook_messenger_page_id: :unset, default_apn_notification_protocol_version: :unset, default_gcm_notification_protocol_version: :unset, fcm_credential_sid: :unset, default_fcm_notification_protocol_version: :unset, log_enabled: :unset, alexa_skill_id: :unset, default_alexa_notification_protocol_version: :unset)
558
573
  context.update(