twilio-ruby 5.27.0 → 5.27.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (115) hide show
  1. checksums.yaml +5 -5
  2. data/.dockerignore +1 -0
  3. data/CHANGES.md +13 -0
  4. data/CONTRIBUTING.md +2 -0
  5. data/Dockerfile +2 -2
  6. data/README.md +2 -2
  7. data/lib/twilio-ruby/http/http_client.rb +1 -1
  8. data/lib/twilio-ruby/rest/api/v2010/account/call.rb +18 -18
  9. data/lib/twilio-ruby/rest/api/v2010/account/message/media.rb +9 -9
  10. data/lib/twilio-ruby/rest/api/v2010/account/recording.rb +9 -9
  11. data/lib/twilio-ruby/rest/autopilot/v1/assistant/query.rb +5 -5
  12. data/lib/twilio-ruby/rest/conversations/v1/conversation/message.rb +10 -1
  13. data/lib/twilio-ruby/rest/conversations/v1/conversation/participant.rb +1 -1
  14. data/lib/twilio-ruby/rest/fax/v1/fax.rb +12 -12
  15. data/lib/twilio-ruby/rest/flex_api.rb +6 -3
  16. data/lib/twilio-ruby/rest/flex_api/v1.rb +3 -3
  17. data/lib/twilio-ruby/rest/flex_api/v1/channel.rb +23 -23
  18. data/lib/twilio-ruby/rest/flex_api/v1/configuration.rb +39 -37
  19. data/lib/twilio-ruby/rest/flex_api/v1/flex_flow.rb +102 -96
  20. data/lib/twilio-ruby/rest/flex_api/v1/web_channel.rb +20 -20
  21. data/lib/twilio-ruby/rest/messaging.rb +3 -2
  22. data/lib/twilio-ruby/rest/messaging/v1.rb +2 -3
  23. data/lib/twilio-ruby/rest/messaging/v1/service.rb +124 -91
  24. data/lib/twilio-ruby/rest/messaging/v1/service/alpha_sender.rb +22 -18
  25. data/lib/twilio-ruby/rest/messaging/v1/service/phone_number.rb +22 -16
  26. data/lib/twilio-ruby/rest/messaging/v1/service/short_code.rb +18 -20
  27. data/lib/twilio-ruby/rest/messaging/v1/session.rb +48 -44
  28. data/lib/twilio-ruby/rest/messaging/v1/session/message.rb +46 -48
  29. data/lib/twilio-ruby/rest/messaging/v1/session/participant.rb +55 -62
  30. data/lib/twilio-ruby/rest/messaging/v1/session/webhook.rb +61 -65
  31. data/lib/twilio-ruby/rest/messaging/v1/webhook.rb +30 -36
  32. data/lib/twilio-ruby/rest/monitor.rb +4 -2
  33. data/lib/twilio-ruby/rest/monitor/v1.rb +2 -2
  34. data/lib/twilio-ruby/rest/monitor/v1/alert.rb +45 -57
  35. data/lib/twilio-ruby/rest/monitor/v1/event.rb +47 -50
  36. data/lib/twilio-ruby/rest/notify/v1/service/binding.rb +8 -8
  37. data/lib/twilio-ruby/rest/notify/v1/service/notification.rb +3 -3
  38. data/lib/twilio-ruby/rest/preview/trusted_comms/branded_call.rb +6 -6
  39. data/lib/twilio-ruby/rest/preview/trusted_comms/device.rb +1 -1
  40. data/lib/twilio-ruby/rest/preview/trusted_comms/phone_call.rb +55 -55
  41. data/lib/twilio-ruby/rest/pricing/v2/voice.rb +2 -2
  42. data/lib/twilio-ruby/rest/pricing/v2/voice/country.rb +4 -4
  43. data/lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb +1 -1
  44. data/lib/twilio-ruby/rest/serverless.rb +2 -1
  45. data/lib/twilio-ruby/rest/serverless/v1.rb +1 -2
  46. data/lib/twilio-ruby/rest/serverless/v1/service.rb +27 -28
  47. data/lib/twilio-ruby/rest/serverless/v1/service/asset.rb +22 -22
  48. data/lib/twilio-ruby/rest/serverless/v1/service/asset/asset_version.rb +22 -22
  49. data/lib/twilio-ruby/rest/serverless/v1/service/build.rb +25 -24
  50. data/lib/twilio-ruby/rest/serverless/v1/service/environment.rb +26 -24
  51. data/lib/twilio-ruby/rest/serverless/v1/service/environment/deployment.rb +21 -24
  52. data/lib/twilio-ruby/rest/serverless/v1/service/environment/log.rb +31 -31
  53. data/lib/twilio-ruby/rest/serverless/v1/service/environment/variable.rb +35 -35
  54. data/lib/twilio-ruby/rest/serverless/v1/service/function.rb +22 -22
  55. data/lib/twilio-ruby/rest/serverless/v1/service/function/function_version.rb +22 -22
  56. data/lib/twilio-ruby/rest/studio/v1/flow/execution.rb +12 -12
  57. data/lib/twilio-ruby/rest/sync/v1/service/document.rb +7 -4
  58. data/lib/twilio-ruby/rest/sync/v1/service/sync_list.rb +6 -3
  59. data/lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb +15 -9
  60. data/lib/twilio-ruby/rest/sync/v1/service/sync_map.rb +6 -3
  61. data/lib/twilio-ruby/rest/sync/v1/service/sync_map/sync_map_item.rb +15 -9
  62. data/lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb +9 -6
  63. data/lib/twilio-ruby/rest/taskrouter.rb +2 -1
  64. data/lib/twilio-ruby/rest/taskrouter/v1.rb +1 -1
  65. data/lib/twilio-ruby/rest/taskrouter/v1/workspace.rb +102 -95
  66. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb +52 -44
  67. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/event.rb +90 -81
  68. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb +152 -136
  69. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb +35 -29
  70. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb +96 -89
  71. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_cumulative_statistics.rb +61 -61
  72. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_real_time_statistics.rb +27 -21
  73. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_statistics.rb +46 -46
  74. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queues_statistics.rb +57 -64
  75. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/worker.rb +98 -79
  76. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/worker_channel.rb +41 -39
  77. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/worker_statistics.rb +39 -33
  78. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/workers_cumulative_statistics.rb +32 -31
  79. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/workers_real_time_statistics.rb +16 -11
  80. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/workers_statistics.rb +42 -42
  81. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb +75 -72
  82. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_cumulative_statistics.rb +59 -51
  83. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_real_time_statistics.rb +24 -18
  84. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_statistics.rb +54 -46
  85. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/workspace_cumulative_statistics.rb +48 -46
  86. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/workspace_real_time_statistics.rb +17 -17
  87. data/lib/twilio-ruby/rest/taskrouter/v1/workspace/workspace_statistics.rb +44 -42
  88. data/lib/twilio-ruby/rest/trunking/v1/trunk.rb +24 -18
  89. data/lib/twilio-ruby/rest/trunking/v1/trunk/credential_list.rb +3 -3
  90. data/lib/twilio-ruby/rest/trunking/v1/trunk/ip_access_control_list.rb +1 -2
  91. data/lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb +1 -2
  92. data/lib/twilio-ruby/rest/verify/v2/service/messaging_configuration.rb +12 -12
  93. data/lib/twilio-ruby/rest/verify/v2/service/rate_limit.rb +6 -6
  94. data/lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb +6 -6
  95. data/lib/twilio-ruby/rest/verify/v2/service/verification.rb +2 -1
  96. data/lib/twilio-ruby/rest/verify/v2/service/verification_check.rb +2 -1
  97. data/lib/twilio-ruby/rest/video.rb +8 -8
  98. data/lib/twilio-ruby/rest/video/v1.rb +4 -7
  99. data/lib/twilio-ruby/rest/video/v1/composition.rb +89 -98
  100. data/lib/twilio-ruby/rest/video/v1/composition_hook.rb +224 -195
  101. data/lib/twilio-ruby/rest/video/v1/composition_settings.rb +34 -34
  102. data/lib/twilio-ruby/rest/video/v1/recording.rb +53 -55
  103. data/lib/twilio-ruby/rest/video/v1/recording_settings.rb +32 -32
  104. data/lib/twilio-ruby/rest/video/v1/room.rb +71 -61
  105. data/lib/twilio-ruby/rest/video/v1/room/recording.rb +45 -33
  106. data/lib/twilio-ruby/rest/video/v1/room/room_participant.rb +56 -57
  107. data/lib/twilio-ruby/rest/video/v1/room/room_participant/room_participant_published_track.rb +25 -22
  108. data/lib/twilio-ruby/rest/video/v1/room/room_participant/room_participant_subscribe_rule.rb +10 -10
  109. data/lib/twilio-ruby/rest/video/v1/room/room_participant/room_participant_subscribed_track.rb +24 -23
  110. data/lib/twilio-ruby/rest/voice/v1/dialing_permissions.rb +1 -1
  111. data/lib/twilio-ruby/rest/voice/v1/dialing_permissions/country.rb +5 -5
  112. data/lib/twilio-ruby/rest/voice/v1/dialing_permissions/country/highrisk_special_prefix.rb +2 -2
  113. data/lib/twilio-ruby/version.rb +1 -1
  114. data/spec/integration/conversations/v1/conversation/message_spec.rb +58 -0
  115. metadata +4 -4
@@ -17,8 +17,9 @@ module Twilio
17
17
  ##
18
18
  # Initialize the AlphaSenderList
19
19
  # @param [Version] version Version that contains the resource
20
- # @param [String] service_sid The 34 character unique sid of the Messaging
21
- # Service.
20
+ # @param [String] service_sid The SID of the
21
+ # [Service](https://www.twilio.com/docs/chat/rest/service-resource) the resource
22
+ # is associated with.
22
23
  # @return [AlphaSenderList] AlphaSenderList
23
24
  def initialize(version, service_sid: nil)
24
25
  super(version)
@@ -31,9 +32,9 @@ module Twilio
31
32
  ##
32
33
  # Retrieve a single page of AlphaSenderInstance records from the API.
33
34
  # Request is executed immediately.
34
- # @param [String] alpha_sender An Alphanumeric Sender ID string, up to 11
35
- # characters. Valid characters are A-Z, a-z, 0-9, space and dash ( - ). An
36
- # Alphanumeric Sender ID string cannot be comprised of only numbers.
35
+ # @param [String] alpha_sender The Alphanumeric Sender ID string. Can be up to 11
36
+ # characters long. Valid characters are A-Z, a-z, 0-9, space, and hyphen `-`. This
37
+ # value cannot contain only numbers.
37
38
  # @return [AlphaSenderInstance] Newly created AlphaSenderInstance
38
39
  def create(alpha_sender: nil)
39
40
  data = Twilio::Values.of({'AlphaSender' => alpha_sender, })
@@ -173,8 +174,10 @@ module Twilio
173
174
  ##
174
175
  # Initialize the AlphaSenderContext
175
176
  # @param [Version] version Version that contains the resource
176
- # @param [String] service_sid The service_sid
177
- # @param [String] sid The sid
177
+ # @param [String] service_sid The SID of the
178
+ # [Service](https://www.twilio.com/docs/chat/rest/service-resource) to fetch the
179
+ # resource from.
180
+ # @param [String] sid The SID of the AlphaSender resource to fetch.
178
181
  # @return [AlphaSenderContext] AlphaSenderContext
179
182
  def initialize(version, service_sid, sid)
180
183
  super(version)
@@ -233,9 +236,10 @@ module Twilio
233
236
  # Initialize the AlphaSenderInstance
234
237
  # @param [Version] version Version that contains the resource
235
238
  # @param [Hash] payload payload that contains response from Twilio
236
- # @param [String] service_sid The 34 character unique sid of the Messaging
237
- # Service.
238
- # @param [String] sid The sid
239
+ # @param [String] service_sid The SID of the
240
+ # [Service](https://www.twilio.com/docs/chat/rest/service-resource) the resource
241
+ # is associated with.
242
+ # @param [String] sid The SID of the AlphaSender resource to fetch.
239
243
  # @return [AlphaSenderInstance] AlphaSenderInstance
240
244
  def initialize(version, payload, service_sid: nil, sid: nil)
241
245
  super(version)
@@ -269,49 +273,49 @@ module Twilio
269
273
  end
270
274
 
271
275
  ##
272
- # @return [String] The 34 character unique sid of the Alpha Sender ID.
276
+ # @return [String] The unique string that identifies the resource
273
277
  def sid
274
278
  @properties['sid']
275
279
  end
276
280
 
277
281
  ##
278
- # @return [String] The 34 character unique sid of the Account.
282
+ # @return [String] The SID of the Account that created the resource
279
283
  def account_sid
280
284
  @properties['account_sid']
281
285
  end
282
286
 
283
287
  ##
284
- # @return [String] The 34 character unique sid of the Messaging Service.
288
+ # @return [String] The SID of the Service that the resource is associated with
285
289
  def service_sid
286
290
  @properties['service_sid']
287
291
  end
288
292
 
289
293
  ##
290
- # @return [Time] The date that this resource was created.
294
+ # @return [Time] The ISO 8601 date and time in GMT when the resource was created
291
295
  def date_created
292
296
  @properties['date_created']
293
297
  end
294
298
 
295
299
  ##
296
- # @return [Time] The date that this resource was last updated.
300
+ # @return [Time] The ISO 8601 date and time in GMT when the resource was last updated
297
301
  def date_updated
298
302
  @properties['date_updated']
299
303
  end
300
304
 
301
305
  ##
302
- # @return [String] An Alphanumeric Sender ID string, up to 11 characters.
306
+ # @return [String] The Alphanumeric Sender ID string
303
307
  def alpha_sender
304
308
  @properties['alpha_sender']
305
309
  end
306
310
 
307
311
  ##
308
- # @return [Hash] An array of values that indicate whether the number can receive calls or messages.
312
+ # @return [Hash] An array of values that describe whether the number can receive calls or messages
309
313
  def capabilities
310
314
  @properties['capabilities']
311
315
  end
312
316
 
313
317
  ##
314
- # @return [String] The absolute URL for this resource.
318
+ # @return [String] The absolute URL of the AlphaSender resource
315
319
  def url
316
320
  @properties['url']
317
321
  end
@@ -17,7 +17,9 @@ module Twilio
17
17
  ##
18
18
  # Initialize the PhoneNumberList
19
19
  # @param [Version] version Version that contains the resource
20
- # @param [String] service_sid The 34 character unique sid of the Service.
20
+ # @param [String] service_sid The SID of the
21
+ # [Service](https://www.twilio.com/docs/chat/rest/service-resource) the resource
22
+ # is associated with.
21
23
  # @return [PhoneNumberList] PhoneNumberList
22
24
  def initialize(version, service_sid: nil)
23
25
  super(version)
@@ -30,8 +32,8 @@ module Twilio
30
32
  ##
31
33
  # Retrieve a single page of PhoneNumberInstance records from the API.
32
34
  # Request is executed immediately.
33
- # @param [String] phone_number_sid Phone Number SID for the Phone Number being
34
- # added to the Service.
35
+ # @param [String] phone_number_sid The SID of the Phone Number being added to the
36
+ # Service.
35
37
  # @return [PhoneNumberInstance] Newly created PhoneNumberInstance
36
38
  def create(phone_number_sid: nil)
37
39
  data = Twilio::Values.of({'PhoneNumberSid' => phone_number_sid, })
@@ -171,8 +173,10 @@ module Twilio
171
173
  ##
172
174
  # Initialize the PhoneNumberContext
173
175
  # @param [Version] version Version that contains the resource
174
- # @param [String] service_sid The service_sid
175
- # @param [String] sid The sid
176
+ # @param [String] service_sid The SID of the
177
+ # [Service](https://www.twilio.com/docs/chat/rest/service-resource) to fetch the
178
+ # resource from.
179
+ # @param [String] sid The SID of the PhoneNumber resource to fetch.
176
180
  # @return [PhoneNumberContext] PhoneNumberContext
177
181
  def initialize(version, service_sid, sid)
178
182
  super(version)
@@ -231,8 +235,10 @@ module Twilio
231
235
  # Initialize the PhoneNumberInstance
232
236
  # @param [Version] version Version that contains the resource
233
237
  # @param [Hash] payload payload that contains response from Twilio
234
- # @param [String] service_sid The 34 character unique sid of the Service.
235
- # @param [String] sid The sid
238
+ # @param [String] service_sid The SID of the
239
+ # [Service](https://www.twilio.com/docs/chat/rest/service-resource) the resource
240
+ # is associated with.
241
+ # @param [String] sid The SID of the PhoneNumber resource to fetch.
236
242
  # @return [PhoneNumberInstance] PhoneNumberInstance
237
243
  def initialize(version, payload, service_sid: nil, sid: nil)
238
244
  super(version)
@@ -267,55 +273,55 @@ module Twilio
267
273
  end
268
274
 
269
275
  ##
270
- # @return [String] The 34 character unique sid of the Phone Number.
276
+ # @return [String] The unique string that identifies the resource
271
277
  def sid
272
278
  @properties['sid']
273
279
  end
274
280
 
275
281
  ##
276
- # @return [String] The 34 character unique sid of the Account.
282
+ # @return [String] The SID of the Account that created the resource
277
283
  def account_sid
278
284
  @properties['account_sid']
279
285
  end
280
286
 
281
287
  ##
282
- # @return [String] The 34 character unique sid of the Service.
288
+ # @return [String] The SID of the Service that the resource is associated with
283
289
  def service_sid
284
290
  @properties['service_sid']
285
291
  end
286
292
 
287
293
  ##
288
- # @return [Time] The date that this resource was created.
294
+ # @return [Time] The ISO 8601 date and time in GMT when the resource was created
289
295
  def date_created
290
296
  @properties['date_created']
291
297
  end
292
298
 
293
299
  ##
294
- # @return [Time] The date that this resource was last updated.
300
+ # @return [Time] The ISO 8601 date and time in GMT when the resource was last updated
295
301
  def date_updated
296
302
  @properties['date_updated']
297
303
  end
298
304
 
299
305
  ##
300
- # @return [String] The E.
306
+ # @return [String] The phone number in E.164 format
301
307
  def phone_number
302
308
  @properties['phone_number']
303
309
  end
304
310
 
305
311
  ##
306
- # @return [String] The 2 character ISO Country Code of the number.
312
+ # @return [String] The 2-character ISO Country Code of the number
307
313
  def country_code
308
314
  @properties['country_code']
309
315
  end
310
316
 
311
317
  ##
312
- # @return [String] Any array of values that indicate whether the number can receive calls or messages.
318
+ # @return [String] An array of values that describe whether the number can receive calls or messages
313
319
  def capabilities
314
320
  @properties['capabilities']
315
321
  end
316
322
 
317
323
  ##
318
- # @return [String] The absolute URL for this resource.
324
+ # @return [String] The absolute URL of the PhoneNumber resource
319
325
  def url
320
326
  @properties['url']
321
327
  end
@@ -18,8 +18,8 @@ module Twilio
18
18
  # Initialize the ShortCodeList
19
19
  # @param [Version] version Version that contains the resource
20
20
  # @param [String] service_sid The SID of the
21
- # [Service](https://www.twilio.com/docs/api/chat/rest/services) this resource is
22
- # associated with.
21
+ # [Service](https://www.twilio.com/docs/chat/rest/service-resource) the resource
22
+ # is associated with.
23
23
  # @return [ShortCodeList] ShortCodeList
24
24
  def initialize(version, service_sid: nil)
25
25
  super(version)
@@ -32,8 +32,8 @@ module Twilio
32
32
  ##
33
33
  # Retrieve a single page of ShortCodeInstance records from the API.
34
34
  # Request is executed immediately.
35
- # @param [String] short_code_sid SID of the ShortCode resource being added to the
36
- # Service.
35
+ # @param [String] short_code_sid The SID of the ShortCode resource being added to
36
+ # the Service.
37
37
  # @return [ShortCodeInstance] Newly created ShortCodeInstance
38
38
  def create(short_code_sid: nil)
39
39
  data = Twilio::Values.of({'ShortCodeSid' => short_code_sid, })
@@ -174,10 +174,9 @@ module Twilio
174
174
  # Initialize the ShortCodeContext
175
175
  # @param [Version] version Version that contains the resource
176
176
  # @param [String] service_sid The SID of the
177
- # [Service](https://www.twilio.com/docs/api/chat/rest/services) to fetch the
177
+ # [Service](https://www.twilio.com/docs/chat/rest/service-resource) to fetch the
178
178
  # resource from.
179
- # @param [String] sid The Twilio-provided string that uniquely identifies the
180
- # ShortCode resource to fetch
179
+ # @param [String] sid The SID of the ShortCode resource to fetch.
181
180
  # @return [ShortCodeContext] ShortCodeContext
182
181
  def initialize(version, service_sid, sid)
183
182
  super(version)
@@ -232,10 +231,9 @@ module Twilio
232
231
  # @param [Version] version Version that contains the resource
233
232
  # @param [Hash] payload payload that contains response from Twilio
234
233
  # @param [String] service_sid The SID of the
235
- # [Service](https://www.twilio.com/docs/api/chat/rest/services) this resource is
236
- # associated with.
237
- # @param [String] sid The Twilio-provided string that uniquely identifies the
238
- # ShortCode resource to fetch
234
+ # [Service](https://www.twilio.com/docs/chat/rest/service-resource) the resource
235
+ # is associated with.
236
+ # @param [String] sid The SID of the ShortCode resource to fetch.
239
237
  # @return [ShortCodeInstance] ShortCodeInstance
240
238
  def initialize(version, payload, service_sid: nil, sid: nil)
241
239
  super(version)
@@ -270,55 +268,55 @@ module Twilio
270
268
  end
271
269
 
272
270
  ##
273
- # @return [String] The unique string that identifies this resource
271
+ # @return [String] The unique string that identifies the resource
274
272
  def sid
275
273
  @properties['sid']
276
274
  end
277
275
 
278
276
  ##
279
- # @return [String] The SID of the Account that created this resource
277
+ # @return [String] The SID of the Account that created the resource
280
278
  def account_sid
281
279
  @properties['account_sid']
282
280
  end
283
281
 
284
282
  ##
285
- # @return [String] The SID of the Service that this resource is associated with
283
+ # @return [String] The SID of the Service that the resource is associated with
286
284
  def service_sid
287
285
  @properties['service_sid']
288
286
  end
289
287
 
290
288
  ##
291
- # @return [Time] The RFC 2822 date and time in GMT that this resource was created
289
+ # @return [Time] The ISO 8601 date and time in GMT when the resource was created
292
290
  def date_created
293
291
  @properties['date_created']
294
292
  end
295
293
 
296
294
  ##
297
- # @return [Time] The RFC 2822 date and time in GMT that this resource was last updated
295
+ # @return [Time] The ISO 8601 date and time in GMT when the resource was last updated
298
296
  def date_updated
299
297
  @properties['date_updated']
300
298
  end
301
299
 
302
300
  ##
303
- # @return [String] The E.164 format of the short code.
301
+ # @return [String] The E.164 format of the short code
304
302
  def short_code
305
303
  @properties['short_code']
306
304
  end
307
305
 
308
306
  ##
309
- # @return [String] The 2-character ISO Country Code of the number.
307
+ # @return [String] The 2-character ISO Country Code of the number
310
308
  def country_code
311
309
  @properties['country_code']
312
310
  end
313
311
 
314
312
  ##
315
- # @return [Hash] Any array of values that indicate whether the number can receive calls or messages.
313
+ # @return [Hash] An array of values that describe whether the number can receive calls or messages
316
314
  def capabilities
317
315
  @properties['capabilities']
318
316
  end
319
317
 
320
318
  ##
321
- # @return [String] The absolute URL of this ShortCode resource
319
+ # @return [String] The absolute URL of the ShortCode resource
322
320
  def url
323
321
  @properties['url']
324
322
  end
@@ -28,17 +28,19 @@ module Twilio
28
28
  ##
29
29
  # Retrieve a single page of SessionInstance records from the API.
30
30
  # Request is executed immediately.
31
- # @param [String] messaging_service_sid The unique id of the [SMS
32
- # Service](https://www.twilio.com/docs/sms/services/api) this session belongs to.
33
- # @param [String] friendly_name The human-readable name of this session. Optional.
34
- # @param [String] attributes An optional string metadata field you can use to
35
- # store any data you wish. The string value must contain structurally valid JSON
36
- # if specified. **Note** that if the attributes are not set "{}" will be
37
- # returned.
38
- # @param [Time] date_created The date that this resource was created.
39
- # @param [Time] date_updated The date that this resource was last updated.
40
- # @param [String] created_by Identity of the session's creator. If the Session was
41
- # created through the API, the value will be `system`
31
+ # @param [String] messaging_service_sid The SID of the [Messaging
32
+ # Service](https://www.twilio.com/docs/sms/services/api) the session belongs to.
33
+ # @param [String] friendly_name A descriptive string that you create to describe
34
+ # the resource. It can be up to 64 characters long.
35
+ # @param [String] attributes A JSON string that stores application-specific data.
36
+ # @param [Time] date_created The date, specified in [ISO
37
+ # 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource
38
+ # as the date it was created.
39
+ # @param [Time] date_updated The date, specified in [ISO
40
+ # 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource
41
+ # as the date it was last updated.
42
+ # @param [String] created_by The Identity of the session's creator. If the Session
43
+ # was created through the API, the value will be `system`
42
44
  # @return [SessionInstance] Newly created SessionInstance
43
45
  def create(messaging_service_sid: nil, friendly_name: :unset, attributes: :unset, date_created: :unset, date_updated: :unset, created_by: :unset)
44
46
  data = Twilio::Values.of({
@@ -185,8 +187,7 @@ module Twilio
185
187
  ##
186
188
  # Initialize the SessionContext
187
189
  # @param [Version] version Version that contains the resource
188
- # @param [String] sid A 34 character string that uniquely identifies this
189
- # resource.
190
+ # @param [String] sid The SID of the Session resource to fetch.
190
191
  # @return [SessionContext] SessionContext
191
192
  def initialize(version, sid)
192
193
  super(version)
@@ -225,15 +226,17 @@ module Twilio
225
226
 
226
227
  ##
227
228
  # Update the SessionInstance
228
- # @param [String] friendly_name The human-readable name of this session. Optional.
229
- # @param [String] attributes An optional string metadata field you can use to
230
- # store any data you wish. The string value must contain structurally valid JSON
231
- # if specified. **Note** that if the attributes are not set "{}" will be
232
- # returned.
233
- # @param [Time] date_created The date that this resource was created.
234
- # @param [Time] date_updated The date that this resource was last updated.
235
- # @param [String] created_by Identity of the session's creator. If the Session was
236
- # created through the API, the value will be `system`
229
+ # @param [String] friendly_name A descriptive string that you create to describe
230
+ # the resource. It can be up to 64 characters long.
231
+ # @param [String] attributes A JSON string that stores application-specific data.
232
+ # @param [Time] date_created The date, specified in [ISO
233
+ # 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource
234
+ # as the date it was created.
235
+ # @param [Time] date_updated The date, specified in [ISO
236
+ # 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource
237
+ # as the date it was last updated.
238
+ # @param [String] created_by The Identity of the session's creator. If the Session
239
+ # was created through the API, the value will be `system`
237
240
  # @return [SessionInstance] Updated SessionInstance
238
241
  def update(friendly_name: :unset, attributes: :unset, date_created: :unset, date_updated: :unset, created_by: :unset)
239
242
  data = Twilio::Values.of({
@@ -329,8 +332,7 @@ module Twilio
329
332
  # Initialize the SessionInstance
330
333
  # @param [Version] version Version that contains the resource
331
334
  # @param [Hash] payload payload that contains response from Twilio
332
- # @param [String] sid A 34 character string that uniquely identifies this
333
- # resource.
335
+ # @param [String] sid The SID of the Session resource to fetch.
334
336
  # @return [SessionInstance] SessionInstance
335
337
  def initialize(version, payload, sid: nil)
336
338
  super(version)
@@ -367,67 +369,67 @@ module Twilio
367
369
  end
368
370
 
369
371
  ##
370
- # @return [String] A 34 character string that uniquely identifies this resource.
372
+ # @return [String] The unique string that identifies the resource
371
373
  def sid
372
374
  @properties['sid']
373
375
  end
374
376
 
375
377
  ##
376
- # @return [String] The unique id of the Account responsible for this session.
378
+ # @return [String] The SID of the Account that created the resource
377
379
  def account_sid
378
380
  @properties['account_sid']
379
381
  end
380
382
 
381
383
  ##
382
- # @return [String] The unique id of the Chat Service this session belongs to.
384
+ # @return [String] The SID of the Service that the resource is associated with
383
385
  def service_sid
384
386
  @properties['service_sid']
385
387
  end
386
388
 
387
389
  ##
388
- # @return [String] The unique id of the SMS Service this session belongs to.
390
+ # @return [String] The SID of the SMS Service the session belongs to
389
391
  def messaging_service_sid
390
392
  @properties['messaging_service_sid']
391
393
  end
392
394
 
393
395
  ##
394
- # @return [String] The human-readable name of this session.
396
+ # @return [String] The string that you assigned to describe the resource
395
397
  def friendly_name
396
398
  @properties['friendly_name']
397
399
  end
398
400
 
399
401
  ##
400
- # @return [String] An optional string metadata field you can use to store any data you wish.
402
+ # @return [String] The JSON string that stores application-specific data
401
403
  def attributes
402
404
  @properties['attributes']
403
405
  end
404
406
 
405
407
  ##
406
- # @return [String] Identity of the session's creator.
408
+ # @return [String] The Identity of the session's creator
407
409
  def created_by
408
410
  @properties['created_by']
409
411
  end
410
412
 
411
413
  ##
412
- # @return [Time] The date that this resource was created.
414
+ # @return [Time] The ISO 8601 date and time in GMT when the resource was created
413
415
  def date_created
414
416
  @properties['date_created']
415
417
  end
416
418
 
417
419
  ##
418
- # @return [Time] The date that this resource was last updated.
420
+ # @return [Time] The ISO 8601 date and time in GMT when the resource was last updated
419
421
  def date_updated
420
422
  @properties['date_updated']
421
423
  end
422
424
 
423
425
  ##
424
- # @return [String] An absolute URL for this session.
426
+ # @return [String] The absolute URL of the session
425
427
  def url
426
428
  @properties['url']
427
429
  end
428
430
 
429
431
  ##
430
- # @return [String] Absolute URLs to access the Participants and Messages for this Session.
432
+ # @return [String] The absolute URLs of the Participants, Interactions, and Messages for the Session
431
433
  def links
432
434
  @properties['links']
433
435
  end
@@ -448,15 +450,17 @@ module Twilio
448
450
 
449
451
  ##
450
452
  # Update the SessionInstance
451
- # @param [String] friendly_name The human-readable name of this session. Optional.
452
- # @param [String] attributes An optional string metadata field you can use to
453
- # store any data you wish. The string value must contain structurally valid JSON
454
- # if specified. **Note** that if the attributes are not set "{}" will be
455
- # returned.
456
- # @param [Time] date_created The date that this resource was created.
457
- # @param [Time] date_updated The date that this resource was last updated.
458
- # @param [String] created_by Identity of the session's creator. If the Session was
459
- # created through the API, the value will be `system`
453
+ # @param [String] friendly_name A descriptive string that you create to describe
454
+ # the resource. It can be up to 64 characters long.
455
+ # @param [String] attributes A JSON string that stores application-specific data.
456
+ # @param [Time] date_created The date, specified in [ISO
457
+ # 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource
458
+ # as the date it was created.
459
+ # @param [Time] date_updated The date, specified in [ISO
460
+ # 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource
461
+ # as the date it was last updated.
462
+ # @param [String] created_by The Identity of the session's creator. If the Session
463
+ # was created through the API, the value will be `system`
460
464
  # @return [SessionInstance] Updated SessionInstance
461
465
  def update(friendly_name: :unset, attributes: :unset, date_created: :unset, date_updated: :unset, created_by: :unset)
462
466
  context.update(