twilio-ruby 5.27.0 → 5.27.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (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,7 @@ module Twilio
17
17
  ##
18
18
  # Initialize the MessageList
19
19
  # @param [Version] version Version that contains the resource
20
- # @param [String] session_sid The unique id of the
21
- # [Session](https://www.twilio.com/docs/sessions/api/session) for this message.
20
+ # @param [String] session_sid The SID of the Session for the message.
22
21
  # @return [MessageList] MessageList
23
22
  def initialize(version, session_sid: nil)
24
23
  super(version)
@@ -31,15 +30,16 @@ module Twilio
31
30
  ##
32
31
  # Retrieve a single page of MessageInstance records from the API.
33
32
  # Request is executed immediately.
34
- # @param [String] author The
35
- # [identity](https://www.twilio.com/docs/api/chat/guides/identity) of the
36
- # message's author. Defaults to `system`.
37
- # @param [String] attributes A string metadata field you can use to store any data
38
- # you wish. The string value must contain structurally valid JSON if specified.
39
- # @param [Time] date_created The date that this resource was created.
40
- # @param [Time] date_updated The date that this resource was last updated. `null`
41
- # if the message has not been edited.
42
- # @param [String] body The contents of the message.
33
+ # @param [String] author The [identity](https://www.twilio.com/docs/chat/identity)
34
+ # of the message's author. Defaults to `system`.
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] body The message body.
43
43
  # @return [MessageInstance] Newly created MessageInstance
44
44
  def create(author: :unset, attributes: :unset, date_created: :unset, date_updated: :unset, body: :unset)
45
45
  data = Twilio::Values.of({
@@ -185,10 +185,8 @@ module Twilio
185
185
  ##
186
186
  # Initialize the MessageContext
187
187
  # @param [Version] version Version that contains the resource
188
- # @param [String] session_sid The unique id of the
189
- # [Session](https://www.twilio.com/docs/sessions/api/session) for this message.
190
- # @param [String] sid A 34 character string that uniquely identifies this
191
- # resource.
188
+ # @param [String] session_sid The SID of the Session with the message to fetch.
189
+ # @param [String] sid The SID of the SessionMessage resource to fetch.
192
190
  # @return [MessageContext] MessageContext
193
191
  def initialize(version, session_sid, sid)
194
192
  super(version)
@@ -215,15 +213,16 @@ module Twilio
215
213
 
216
214
  ##
217
215
  # Update the MessageInstance
218
- # @param [String] author The
219
- # [identity](https://www.twilio.com/docs/api/chat/guides/identity) of the
220
- # message's author. Defaults to `system`.
221
- # @param [String] attributes A string metadata field you can use to store any data
222
- # you wish. The string value must contain structurally valid JSON if specified.
223
- # @param [Time] date_created The date that this resource was created.
224
- # @param [Time] date_updated The date that this resource was last updated. `null`
225
- # if the message has not been edited.
226
- # @param [String] body The contents of the message.
216
+ # @param [String] author The [identity](https://www.twilio.com/docs/chat/identity)
217
+ # of the message's author. Defaults to `system`.
218
+ # @param [String] attributes A JSON string that stores application-specific data.
219
+ # @param [Time] date_created The date, specified in [ISO
220
+ # 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource
221
+ # as the date it was created.
222
+ # @param [Time] date_updated The date, specified in [ISO
223
+ # 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource
224
+ # as the date it was last updated.
225
+ # @param [String] body The message body.
227
226
  # @return [MessageInstance] Updated MessageInstance
228
227
  def update(author: :unset, attributes: :unset, date_created: :unset, date_updated: :unset, body: :unset)
229
228
  data = Twilio::Values.of({
@@ -272,10 +271,8 @@ module Twilio
272
271
  # Initialize the MessageInstance
273
272
  # @param [Version] version Version that contains the resource
274
273
  # @param [Hash] payload payload that contains response from Twilio
275
- # @param [String] session_sid The unique id of the
276
- # [Session](https://www.twilio.com/docs/sessions/api/session) for this message.
277
- # @param [String] sid A 34 character string that uniquely identifies this
278
- # resource.
274
+ # @param [String] session_sid The SID of the Session for the message.
275
+ # @param [String] sid The SID of the SessionMessage resource to fetch.
279
276
  # @return [MessageInstance] MessageInstance
280
277
  def initialize(version, payload, session_sid: nil, sid: nil)
281
278
  super(version)
@@ -313,31 +310,31 @@ module Twilio
313
310
  end
314
311
 
315
312
  ##
316
- # @return [String] The unique id of the Account responsible for this message.
313
+ # @return [String] The SID of the Account that created the resource
317
314
  def account_sid
318
315
  @properties['account_sid']
319
316
  end
320
317
 
321
318
  ##
322
- # @return [String] The unique id of the Chat Service this message belongs to.
319
+ # @return [String] The SID of the Service that the resource is associated with
323
320
  def service_sid
324
321
  @properties['service_sid']
325
322
  end
326
323
 
327
324
  ##
328
- # @return [String] The unique id of the SMS Service this message belongs to.
325
+ # @return [String] The SID of the Messaging Service the message belongs to
329
326
  def messaging_service_sid
330
327
  @properties['messaging_service_sid']
331
328
  end
332
329
 
333
330
  ##
334
- # @return [String] The unique id of the Session for this message.
331
+ # @return [String] The SID of the Session for the message
335
332
  def session_sid
336
333
  @properties['session_sid']
337
334
  end
338
335
 
339
336
  ##
340
- # @return [String] A 34 character string that uniquely identifies this resource.
337
+ # @return [String] The unique string that identifies the resource
341
338
  def sid
342
339
  @properties['sid']
343
340
  end
@@ -349,37 +346,37 @@ module Twilio
349
346
  end
350
347
 
351
348
  ##
352
- # @return [String] The identity or the address of the device of the message's author.
349
+ # @return [String] The identity or the address of the device of the message's author
353
350
  def author
354
351
  @properties['author']
355
352
  end
356
353
 
357
354
  ##
358
- # @return [String] The contents of the message.
355
+ # @return [String] The message body
359
356
  def body
360
357
  @properties['body']
361
358
  end
362
359
 
363
360
  ##
364
- # @return [String] A string metadata field you can use to store any data you wish.
361
+ # @return [String] The JSON string that stores application-specific data
365
362
  def attributes
366
363
  @properties['attributes']
367
364
  end
368
365
 
369
366
  ##
370
- # @return [Time] The date that this resource was created.
367
+ # @return [Time] The ISO 8601 date and time in GMT when the resource was created
371
368
  def date_created
372
369
  @properties['date_created']
373
370
  end
374
371
 
375
372
  ##
376
- # @return [Time] The date that this resource was last updated.
373
+ # @return [Time] The ISO 8601 date and time in GMT when the resource was last updated
377
374
  def date_updated
378
375
  @properties['date_updated']
379
376
  end
380
377
 
381
378
  ##
382
- # @return [String] An absolute URL for this message.
379
+ # @return [String] The absolute URL of the message
383
380
  def url
384
381
  @properties['url']
385
382
  end
@@ -393,15 +390,16 @@ module Twilio
393
390
 
394
391
  ##
395
392
  # Update the MessageInstance
396
- # @param [String] author The
397
- # [identity](https://www.twilio.com/docs/api/chat/guides/identity) of the
398
- # message's author. Defaults to `system`.
399
- # @param [String] attributes A string metadata field you can use to store any data
400
- # you wish. The string value must contain structurally valid JSON if specified.
401
- # @param [Time] date_created The date that this resource was created.
402
- # @param [Time] date_updated The date that this resource was last updated. `null`
403
- # if the message has not been edited.
404
- # @param [String] body The contents of the message.
393
+ # @param [String] author The [identity](https://www.twilio.com/docs/chat/identity)
394
+ # of the message's author. Defaults to `system`.
395
+ # @param [String] attributes A JSON string that stores application-specific data.
396
+ # @param [Time] date_created The date, specified in [ISO
397
+ # 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource
398
+ # as the date it was created.
399
+ # @param [Time] date_updated The date, specified in [ISO
400
+ # 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource
401
+ # as the date it was last updated.
402
+ # @param [String] body The message body.
405
403
  # @return [MessageInstance] Updated MessageInstance
406
404
  def update(author: :unset, attributes: :unset, date_created: :unset, date_updated: :unset, body: :unset)
407
405
  context.update(
@@ -17,9 +17,7 @@ module Twilio
17
17
  ##
18
18
  # Initialize the ParticipantList
19
19
  # @param [Version] version Version that contains the resource
20
- # @param [String] session_sid The unique id of the
21
- # [Session](https://www.twilio.com/docs/sessions/api/session) for this
22
- # participant.
20
+ # @param [String] session_sid The SID of the Session for the participant.
23
21
  # @return [ParticipantList] ParticipantList
24
22
  def initialize(version, session_sid: nil)
25
23
  super(version)
@@ -32,28 +30,28 @@ module Twilio
32
30
  ##
33
31
  # Retrieve a single page of ParticipantInstance records from the API.
34
32
  # Request is executed immediately.
35
- # @param [String] attributes An optional string metadata field you can use to
36
- # store any data you wish. The string value must contain structurally valid JSON
37
- # if specified. **Note** that if the attributes are not set "{}" will be
38
- # returned.
39
- # @param [String] twilio_address The address of the Twilio phone number (or
40
- # WhatsApp number, or Messenger Page ID) that the participant is in contact with.
41
- # This field, together with user_address, is only null when the participant is
33
+ # @param [String] attributes A JSON string that stores application-specific data.
34
+ # @param [String] twilio_address The address of the Twilio phone number, WhatsApp
35
+ # number, or Messenger Page ID that the participant is in contact with. This
36
+ # field, together with user_address, is only null when the participant is
42
37
  # interacting from a Chat endpoint (see the 'identity' field).
43
- # @param [Time] date_created The date that this resource was created. This is most
44
- # often useful when bulk-importing messages from another system, as the provided
45
- # value will be trusted and displayed on SDK clients.
46
- # @param [Time] date_updated The date that this resource was last updated. This is
47
- # most often provided when bulk-importing messages from another system, as the
48
- # provided value will be trusted and displayed on SDK clients.
49
- # @param [String] identity A unique string identifier for the session participant
50
- # as [Chat User](https://www.twilio.com/docs/api/chat/rest/users). This parameter
51
- # is non-null if (and only if) the participant is using the Programmable Chat SDK
52
- # to communicate.
53
- # @param [String] user_address The address of the participant's device, e.g. a
38
+ # @param [Time] date_created The date, specified in [ISO
39
+ # 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource
40
+ # as the date it was created. This is used when importing messages from another
41
+ # system, as the provided value will be trusted and displayed on SDK clients.
42
+ # @param [Time] date_updated The date, specified in [ISO
43
+ # 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource
44
+ # as the date it was last updated. This is used when importing messages from
45
+ # another system, as the provided value will be trusted and displayed on SDK
46
+ # clients.
47
+ # @param [String] identity The application-defined string that uniquely identifies
48
+ # the [Chat User](https://www.twilio.com/docs/chat/rest/user-resource) as the
49
+ # session participant. This parameter is null unless the participant is using the
50
+ # Programmable Chat SDK to communicate.
51
+ # @param [String] user_address The address of the participant's device. Can be a
54
52
  # phone number or Messenger ID. Together with the Twilio Address, this determines
55
- # a participant uniquely. This field (with twilio_address) is only null when the
56
- # participant is interacting from a Chat endpoint (see the 'identity' field).
53
+ # a participant uniquely. This field (with twilio_address) is null when the
54
+ # participant is interacting from a Chat endpoint (see the `identity` field).
57
55
  # @return [ParticipantInstance] Newly created ParticipantInstance
58
56
  def create(attributes: :unset, twilio_address: :unset, date_created: :unset, date_updated: :unset, identity: :unset, user_address: :unset)
59
57
  data = Twilio::Values.of({
@@ -200,11 +198,9 @@ module Twilio
200
198
  ##
201
199
  # Initialize the ParticipantContext
202
200
  # @param [Version] version Version that contains the resource
203
- # @param [String] session_sid The unique id of the
204
- # [Session](https://www.twilio.com/docs/sessions/api/session) for this
205
- # participant.
206
- # @param [String] sid A 34 character string that uniquely identifies this
207
- # resource.
201
+ # @param [String] session_sid The SID of the Session with the participant to
202
+ # fetch.
203
+ # @param [String] sid The SID of the SessionParticipant resource to fetch.
208
204
  # @return [ParticipantContext] ParticipantContext
209
205
  def initialize(version, session_sid, sid)
210
206
  super(version)
@@ -216,14 +212,14 @@ module Twilio
216
212
 
217
213
  ##
218
214
  # Update the ParticipantInstance
219
- # @param [String] attributes An optional string metadata field you can use to
220
- # store any data you wish. The string value must contain structurally valid JSON
221
- # if specified. **Note** that if the attributes are not set "{}" will be
222
- # returned.
223
- # @param [Time] date_created The date that this resource was created. This is
224
- # useful when bulk-importing messages from another system, as the provided value
225
- # will be trusted and displayed on SDK clients.
226
- # @param [Time] date_updated The date that this resource was last updated.
215
+ # @param [String] attributes A JSON string that stores application-specific data.
216
+ # @param [Time] date_created The date, specified in [ISO
217
+ # 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource
218
+ # as the date it was created. This is used when importing messages from another
219
+ # system, as the provided value will be trusted and displayed on SDK clients.
220
+ # @param [Time] date_updated The date, specified in [ISO
221
+ # 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource
222
+ # as the date it was last updated.
227
223
  # @return [ParticipantInstance] Updated ParticipantInstance
228
224
  def update(attributes: :unset, date_created: :unset, date_updated: :unset)
229
225
  data = Twilio::Values.of({
@@ -295,11 +291,8 @@ module Twilio
295
291
  # Initialize the ParticipantInstance
296
292
  # @param [Version] version Version that contains the resource
297
293
  # @param [Hash] payload payload that contains response from Twilio
298
- # @param [String] session_sid The unique id of the
299
- # [Session](https://www.twilio.com/docs/sessions/api/session) for this
300
- # participant.
301
- # @param [String] sid A 34 character string that uniquely identifies this
302
- # resource.
294
+ # @param [String] session_sid The SID of the Session for the participant.
295
+ # @param [String] sid The SID of the SessionParticipant resource to fetch.
303
296
  # @return [ParticipantInstance] ParticipantInstance
304
297
  def initialize(version, payload, session_sid: nil, sid: nil)
305
298
  super(version)
@@ -338,93 +331,93 @@ module Twilio
338
331
  end
339
332
 
340
333
  ##
341
- # @return [String] The unique id of the Account responsible for this session.
334
+ # @return [String] The SID of the Account that created the resource
342
335
  def account_sid
343
336
  @properties['account_sid']
344
337
  end
345
338
 
346
339
  ##
347
- # @return [String] The unique id of the Chat Service this session belongs to.
340
+ # @return [String] The SID of the Service the session belongs to
348
341
  def service_sid
349
342
  @properties['service_sid']
350
343
  end
351
344
 
352
345
  ##
353
- # @return [String] The unique id of the SMS Service this session belongs to.
346
+ # @return [String] The SID of the SMS Service the session belongs to
354
347
  def messaging_service_sid
355
348
  @properties['messaging_service_sid']
356
349
  end
357
350
 
358
351
  ##
359
- # @return [String] The unique id of the Session for this participant.
352
+ # @return [String] The SID of the Session for the participant
360
353
  def session_sid
361
354
  @properties['session_sid']
362
355
  end
363
356
 
364
357
  ##
365
- # @return [String] A 34 character string that uniquely identifies this resource.
358
+ # @return [String] The unique string that identifies the resource
366
359
  def sid
367
360
  @properties['sid']
368
361
  end
369
362
 
370
363
  ##
371
- # @return [String] A unique string identifier for the session participant as Chat User.
364
+ # @return [String] The string that identifies the resource's User
372
365
  def identity
373
366
  @properties['identity']
374
367
  end
375
368
 
376
369
  ##
377
- # @return [String] The address of the Twilio phone number that the participant is in contact with.
370
+ # @return [String] The address of the Twilio phone number that the participant is in contact with
378
371
  def twilio_address
379
372
  @properties['twilio_address']
380
373
  end
381
374
 
382
375
  ##
383
- # @return [String] The address of the participant's device.
376
+ # @return [String] The address of the participant's device
384
377
  def user_address
385
378
  @properties['user_address']
386
379
  end
387
380
 
388
381
  ##
389
- # @return [String] An optional string metadata field you can use to store any data you wish.
382
+ # @return [String] The JSON string that stores application-specific data
390
383
  def attributes
391
384
  @properties['attributes']
392
385
  end
393
386
 
394
387
  ##
395
- # @return [participant.ParticipantType] The type of twilio product, participant is a user of.
388
+ # @return [participant.ParticipantType] The type of messaging used by the participant
396
389
  def type
397
390
  @properties['type']
398
391
  end
399
392
 
400
393
  ##
401
- # @return [Time] The date that this resource was created.
394
+ # @return [Time] The ISO 8601 date and time in GMT when the resource was created
402
395
  def date_created
403
396
  @properties['date_created']
404
397
  end
405
398
 
406
399
  ##
407
- # @return [Time] The date that this resource was last updated.
400
+ # @return [Time] The ISO 8601 date and time in GMT when the resource was last updated
408
401
  def date_updated
409
402
  @properties['date_updated']
410
403
  end
411
404
 
412
405
  ##
413
- # @return [String] An absolute URL for this participant.
406
+ # @return [String] The absolute URL of the participant
414
407
  def url
415
408
  @properties['url']
416
409
  end
417
410
 
418
411
  ##
419
412
  # Update the ParticipantInstance
420
- # @param [String] attributes An optional string metadata field you can use to
421
- # store any data you wish. The string value must contain structurally valid JSON
422
- # if specified. **Note** that if the attributes are not set "{}" will be
423
- # returned.
424
- # @param [Time] date_created The date that this resource was created. This is
425
- # useful when bulk-importing messages from another system, as the provided value
426
- # will be trusted and displayed on SDK clients.
427
- # @param [Time] date_updated The date that this resource was last updated.
413
+ # @param [String] attributes A JSON string that stores application-specific data.
414
+ # @param [Time] date_created The date, specified in [ISO
415
+ # 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource
416
+ # as the date it was created. This is used when importing messages from another
417
+ # system, as the provided value will be trusted and displayed on SDK clients.
418
+ # @param [Time] date_updated The date, specified in [ISO
419
+ # 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource
420
+ # as the date it was last updated.
428
421
  # @return [ParticipantInstance] Updated ParticipantInstance
429
422
  def update(attributes: :unset, date_created: :unset, date_updated: :unset)
430
423
  context.update(attributes: attributes, date_created: date_created, date_updated: date_updated, )
@@ -17,8 +17,7 @@ module Twilio
17
17
  ##
18
18
  # Initialize the WebhookList
19
19
  # @param [Version] version Version that contains the resource
20
- # @param [String] session_sid The unique id of the
21
- # [Session](https://www.twilio.com/docs/sessions/api/session) for this webhook.
20
+ # @param [String] session_sid The SID of the Session for the webhook.
22
21
  # @return [WebhookList] WebhookList
23
22
  def initialize(version, session_sid: nil)
24
23
  super(version)
@@ -113,25 +112,25 @@ module Twilio
113
112
  ##
114
113
  # Retrieve a single page of WebhookInstance records from the API.
115
114
  # Request is executed immediately.
116
- # @param [webhook.Target] target The target of this webhook.
117
- # @param [String] configuration_url The absolute url the webhook request should be
115
+ # @param [webhook.Target] target The target of the webhook.
116
+ # @param [String] configuration_url The absolute URL the webhook request should be
118
117
  # sent to.
119
- # @param [webhook.Method] configuration_method The HTTP method to be used when
120
- # sending a webhook request.
121
- # @param [String] configuration_filters The list of events, firing webhook event
122
- # for this Session.
118
+ # @param [webhook.Method] configuration_method The HTTP method we should use when
119
+ # sending a webhook request to `url`. Can be `POST` or `GET`.
120
+ # @param [String] configuration_filters The list of events that trigger a webhook
121
+ # event for the Session.
123
122
  # @param [String] configuration_triggers The list of keywords, firing webhook
124
- # event for this Session.
125
- # @param [String] configuration_flow_sid The studio flow sid, where the webhook
126
- # should be sent to.
127
- # @param [String] configuration_retry_count The number of retries in case of
128
- # webhook request failures. Maximum 3 retries are allowed, the default value is 0.
129
- # @param [String] configuration_replay_after The message index for which and it's
130
- # successors the webhook will be replayed. Not set by default
131
- # @param [Boolean] configuration_buffer_messages The flag whether buffering should
132
- # be applied to messages. Not set by default
133
- # @param [String] configuration_buffer_window The period of buffering messages.
134
- # Default is 3000 ms.
123
+ # event for the Session.
124
+ # @param [String] configuration_flow_sid The SID of the studio flow where the
125
+ # webhook should be sent to.
126
+ # @param [String] configuration_retry_count The number of times to call the
127
+ # webhook request if the first attempt fails. Can be up to 3 and the default is 0.
128
+ # @param [String] configuration_replay_after The message index for which and its
129
+ # successors the webhook will be replayed. Not set by default.
130
+ # @param [Boolean] configuration_buffer_messages Whether buffering should be
131
+ # applied to messages. Not set by default.
132
+ # @param [String] configuration_buffer_window The period to buffer messages in
133
+ # milliseconds. Default is 3,000 ms.
135
134
  # @return [WebhookInstance] Newly created WebhookInstance
136
135
  def create(target: nil, configuration_url: :unset, configuration_method: :unset, configuration_filters: :unset, configuration_triggers: :unset, configuration_flow_sid: :unset, configuration_retry_count: :unset, configuration_replay_after: :unset, configuration_buffer_messages: :unset, configuration_buffer_window: :unset)
137
136
  data = Twilio::Values.of({
@@ -200,10 +199,9 @@ module Twilio
200
199
  ##
201
200
  # Initialize the WebhookContext
202
201
  # @param [Version] version Version that contains the resource
203
- # @param [String] session_sid The unique id of the
204
- # [Session](https://www.twilio.com/docs/sessions/api/session) for this webhook.
205
- # @param [String] sid A 34 character string that uniquely identifies this
206
- # resource.
202
+ # @param [String] session_sid The SID of the Session with the Webhook resource to
203
+ # fetch.
204
+ # @param [String] sid The SID of the resource to fetch.
207
205
  # @return [WebhookContext] WebhookContext
208
206
  def initialize(version, session_sid, sid)
209
207
  super(version)
@@ -230,22 +228,22 @@ module Twilio
230
228
 
231
229
  ##
232
230
  # Update the WebhookInstance
233
- # @param [String] configuration_url The absolute url the webhook request should be
231
+ # @param [String] configuration_url The absolute URL the webhook request should be
234
232
  # sent to.
235
- # @param [webhook.Method] configuration_method The HTTP method to be used when
236
- # sending a webhook request.
237
- # @param [String] configuration_filters The list of events, firing webhook event
238
- # for this Session.
239
- # @param [String] configuration_triggers The list of keywords, firing webhook
240
- # event for this Session.
241
- # @param [String] configuration_flow_sid The studio flow sid, where the webhook
242
- # should be sent to.
243
- # @param [String] configuration_retry_count The number of retries in case of
244
- # webhook request failures. Maximum 3 retries are allowed, the default value is 0.
245
- # @param [Boolean] configuration_buffer_messages The flag whether buffering should
246
- # be applied to messages. Not set by default
247
- # @param [String] configuration_buffer_window The period of buffering messages.
248
- # Default is 3000 ms.
233
+ # @param [webhook.Method] configuration_method The HTTP method we should use when
234
+ # sending a webhook request to `url`. Can be `POST` or `GET`.
235
+ # @param [String] configuration_filters The list of events that trigger a webhook
236
+ # event for the Session.
237
+ # @param [String] configuration_triggers The list of keywords that trigger a
238
+ # webhook event for the Session.
239
+ # @param [String] configuration_flow_sid The SID of the studio flow where the
240
+ # webhook should be sent to.
241
+ # @param [String] configuration_retry_count The number of times to try the webhook
242
+ # request if the first attempt fails. Can be up to 3 and the default is 0.
243
+ # @param [Boolean] configuration_buffer_messages Whether buffering should be
244
+ # applied to messages. Not set by default.
245
+ # @param [String] configuration_buffer_window The period to buffer messages in
246
+ # milliseconds. Default is 3,000 ms.
249
247
  # @return [WebhookInstance] Updated WebhookInstance
250
248
  def update(configuration_url: :unset, configuration_method: :unset, configuration_filters: :unset, configuration_triggers: :unset, configuration_flow_sid: :unset, configuration_retry_count: :unset, configuration_buffer_messages: :unset, configuration_buffer_window: :unset)
251
249
  data = Twilio::Values.of({
@@ -297,10 +295,8 @@ module Twilio
297
295
  # Initialize the WebhookInstance
298
296
  # @param [Version] version Version that contains the resource
299
297
  # @param [Hash] payload payload that contains response from Twilio
300
- # @param [String] session_sid The unique id of the
301
- # [Session](https://www.twilio.com/docs/sessions/api/session) for this webhook.
302
- # @param [String] sid A 34 character string that uniquely identifies this
303
- # resource.
298
+ # @param [String] session_sid The SID of the Session for the webhook.
299
+ # @param [String] sid The SID of the resource to fetch.
304
300
  # @return [WebhookInstance] WebhookInstance
305
301
  def initialize(version, payload, session_sid: nil, sid: nil)
306
302
  super(version)
@@ -334,49 +330,49 @@ module Twilio
334
330
  end
335
331
 
336
332
  ##
337
- # @return [String] A 34 character string that uniquely identifies this resource.
333
+ # @return [String] The unique string that identifies the resource
338
334
  def sid
339
335
  @properties['sid']
340
336
  end
341
337
 
342
338
  ##
343
- # @return [String] The unique id of the Account responsible for this session.
339
+ # @return [String] The SID of the Account that created the resource
344
340
  def account_sid
345
341
  @properties['account_sid']
346
342
  end
347
343
 
348
344
  ##
349
- # @return [String] The unique id of the Session for this webhook.
345
+ # @return [String] The SID of the Session for the webhook
350
346
  def session_sid
351
347
  @properties['session_sid']
352
348
  end
353
349
 
354
350
  ##
355
- # @return [String] The target of this webhook.
351
+ # @return [String] The target of the webhook
356
352
  def target
357
353
  @properties['target']
358
354
  end
359
355
 
360
356
  ##
361
- # @return [String] An absolute URL for this webhook.
357
+ # @return [String] The absolute URL of the webhook
362
358
  def url
363
359
  @properties['url']
364
360
  end
365
361
 
366
362
  ##
367
- # @return [Hash] The configuration of this webhook.
363
+ # @return [Hash] The configuration of the webhook
368
364
  def configuration
369
365
  @properties['configuration']
370
366
  end
371
367
 
372
368
  ##
373
- # @return [Time] The date that this resource was created.
369
+ # @return [Time] The ISO 8601 date and time in GMT when the resource was created
374
370
  def date_created
375
371
  @properties['date_created']
376
372
  end
377
373
 
378
374
  ##
379
- # @return [Time] The date that this resource was last updated.
375
+ # @return [Time] The ISO 8601 date and time in GMT when the resource was last updated
380
376
  def date_updated
381
377
  @properties['date_updated']
382
378
  end
@@ -390,22 +386,22 @@ module Twilio
390
386
 
391
387
  ##
392
388
  # Update the WebhookInstance
393
- # @param [String] configuration_url The absolute url the webhook request should be
389
+ # @param [String] configuration_url The absolute URL the webhook request should be
394
390
  # sent to.
395
- # @param [webhook.Method] configuration_method The HTTP method to be used when
396
- # sending a webhook request.
397
- # @param [String] configuration_filters The list of events, firing webhook event
398
- # for this Session.
399
- # @param [String] configuration_triggers The list of keywords, firing webhook
400
- # event for this Session.
401
- # @param [String] configuration_flow_sid The studio flow sid, where the webhook
402
- # should be sent to.
403
- # @param [String] configuration_retry_count The number of retries in case of
404
- # webhook request failures. Maximum 3 retries are allowed, the default value is 0.
405
- # @param [Boolean] configuration_buffer_messages The flag whether buffering should
406
- # be applied to messages. Not set by default
407
- # @param [String] configuration_buffer_window The period of buffering messages.
408
- # Default is 3000 ms.
391
+ # @param [webhook.Method] configuration_method The HTTP method we should use when
392
+ # sending a webhook request to `url`. Can be `POST` or `GET`.
393
+ # @param [String] configuration_filters The list of events that trigger a webhook
394
+ # event for the Session.
395
+ # @param [String] configuration_triggers The list of keywords that trigger a
396
+ # webhook event for the Session.
397
+ # @param [String] configuration_flow_sid The SID of the studio flow where the
398
+ # webhook should be sent to.
399
+ # @param [String] configuration_retry_count The number of times to try the webhook
400
+ # request if the first attempt fails. Can be up to 3 and the default is 0.
401
+ # @param [Boolean] configuration_buffer_messages Whether buffering should be
402
+ # applied to messages. Not set by default.
403
+ # @param [String] configuration_buffer_window The period to buffer messages in
404
+ # milliseconds. Default is 3,000 ms.
409
405
  # @return [WebhookInstance] Updated WebhookInstance
410
406
  def update(configuration_url: :unset, configuration_method: :unset, configuration_filters: :unset, configuration_triggers: :unset, configuration_flow_sid: :unset, configuration_retry_count: :unset, configuration_buffer_messages: :unset, configuration_buffer_window: :unset)
411
407
  context.update(