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
@@ -94,22 +94,19 @@ module Twilio
94
94
 
95
95
  ##
96
96
  # Update the WebhookInstance
97
- # @param [String] webhook_method The HTTP method to be used when sending a webhook
97
+ # @param [String] webhook_method The HTTP method to use when sending a webhook
98
98
  # request.
99
99
  # @param [String] webhook_filters The list of webhook event triggers that are
100
- # enabled for this Service.
101
- # @param [String] pre_webhook_url The absolute url the pre-event webhook request
102
- # should be sent to.
103
- # @param [String] post_webhook_url The absolute url the post-event webhook request
104
- # should be sent to.
105
- # @param [String] pre_webhook_retry_count The number of retries in case of
106
- # pre-event webhook request failures. Maximum 3 retries are allowed, the default
107
- # value is 0.
108
- # @param [String] post_webhook_retry_count The number of retries in case of
109
- # post-event webhook request failures. Maximum 3 retries are allowed, the default
110
- # value is 0.
100
+ # enabled for the Service.
101
+ # @param [String] pre_webhook_url The absolute URL of the pre-event webhook.
102
+ # @param [String] post_webhook_url The absolute URL of the post-event webhook.
103
+ # @param [String] pre_webhook_retry_count The number of times to try the pre-event
104
+ # webhook request if the first attempt fails. Can be up to 3 and the default is 0.
105
+ # @param [String] post_webhook_retry_count The number of times to try the
106
+ # post-event webhook request if the first attempt fails. Can be up to 3 and the
107
+ # default is 0.
111
108
  # @param [webhook.Target] target The routing target of the webhook. Can be
112
- # ordinary or route internally to Flex
109
+ # ordinary or routed internally to Flex
113
110
  # @return [WebhookInstance] Updated WebhookInstance
114
111
  def update(webhook_method: :unset, webhook_filters: :unset, pre_webhook_url: :unset, post_webhook_url: :unset, pre_webhook_retry_count: :unset, post_webhook_retry_count: :unset, target: :unset)
115
112
  data = Twilio::Values.of({
@@ -188,61 +185,61 @@ module Twilio
188
185
  end
189
186
 
190
187
  ##
191
- # @return [String] The unique id of the Account responsible for this session.
188
+ # @return [String] The SID of the Account that created the resource
192
189
  def account_sid
193
190
  @properties['account_sid']
194
191
  end
195
192
 
196
193
  ##
197
- # @return [String] The unique id of the Chat Service this session belongs to.
194
+ # @return [String] The SID of the Chat Service that the resource is associated with
198
195
  def service_sid
199
196
  @properties['service_sid']
200
197
  end
201
198
 
202
199
  ##
203
- # @return [String] The HTTP method to be used when sending a webhook request.
200
+ # @return [String] The HTTP method to use when sending a webhook request
204
201
  def webhook_method
205
202
  @properties['webhook_method']
206
203
  end
207
204
 
208
205
  ##
209
- # @return [String] The list of webhook event triggers that are enabled for this Service.
206
+ # @return [String] The list of webhook event triggers that are enabled for the Service
210
207
  def webhook_filters
211
208
  @properties['webhook_filters']
212
209
  end
213
210
 
214
211
  ##
215
- # @return [String] The absolute url the pre-event webhook request should be sent to.
212
+ # @return [String] The absolute URL of the pre-event webhook
216
213
  def pre_webhook_url
217
214
  @properties['pre_webhook_url']
218
215
  end
219
216
 
220
217
  ##
221
- # @return [String] The absolute url the post-event webhook request should be sent to.
218
+ # @return [String] The absolute URL of the post-event webhook
222
219
  def post_webhook_url
223
220
  @properties['post_webhook_url']
224
221
  end
225
222
 
226
223
  ##
227
- # @return [String] The number of retries in case of pre-event webhook request failures.
224
+ # @return [String] The number of times to try the pre-event webhook request if the first attempt fails
228
225
  def pre_webhook_retry_count
229
226
  @properties['pre_webhook_retry_count']
230
227
  end
231
228
 
232
229
  ##
233
- # @return [String] The number of retries in case of post-event webhook request failures.
230
+ # @return [String] The number of times to try the post-event webhook request if the first attempt fails
234
231
  def post_webhook_retry_count
235
232
  @properties['post_webhook_retry_count']
236
233
  end
237
234
 
238
235
  ##
239
- # @return [webhook.Target] The routing target of the webhook.
236
+ # @return [webhook.Target] The routing target of the webhook
240
237
  def target
241
238
  @properties['target']
242
239
  end
243
240
 
244
241
  ##
245
- # @return [String] An absolute URL for this webhook.
242
+ # @return [String] The absolute URL of the webhook
246
243
  def url
247
244
  @properties['url']
248
245
  end
@@ -256,22 +253,19 @@ module Twilio
256
253
 
257
254
  ##
258
255
  # Update the WebhookInstance
259
- # @param [String] webhook_method The HTTP method to be used when sending a webhook
256
+ # @param [String] webhook_method The HTTP method to use when sending a webhook
260
257
  # request.
261
258
  # @param [String] webhook_filters The list of webhook event triggers that are
262
- # enabled for this Service.
263
- # @param [String] pre_webhook_url The absolute url the pre-event webhook request
264
- # should be sent to.
265
- # @param [String] post_webhook_url The absolute url the post-event webhook request
266
- # should be sent to.
267
- # @param [String] pre_webhook_retry_count The number of retries in case of
268
- # pre-event webhook request failures. Maximum 3 retries are allowed, the default
269
- # value is 0.
270
- # @param [String] post_webhook_retry_count The number of retries in case of
271
- # post-event webhook request failures. Maximum 3 retries are allowed, the default
272
- # value is 0.
259
+ # enabled for the Service.
260
+ # @param [String] pre_webhook_url The absolute URL of the pre-event webhook.
261
+ # @param [String] post_webhook_url The absolute URL of the post-event webhook.
262
+ # @param [String] pre_webhook_retry_count The number of times to try the pre-event
263
+ # webhook request if the first attempt fails. Can be up to 3 and the default is 0.
264
+ # @param [String] post_webhook_retry_count The number of times to try the
265
+ # post-event webhook request if the first attempt fails. Can be up to 3 and the
266
+ # default is 0.
273
267
  # @param [webhook.Target] target The routing target of the webhook. Can be
274
- # ordinary or route internally to Flex
268
+ # ordinary or routed internally to Flex
275
269
  # @return [WebhookInstance] Updated WebhookInstance
276
270
  def update(webhook_method: :unset, webhook_filters: :unset, pre_webhook_url: :unset, post_webhook_url: :unset, pre_webhook_retry_count: :unset, post_webhook_retry_count: :unset, target: :unset)
277
271
  context.update(
@@ -29,7 +29,8 @@ module Twilio
29
29
  end
30
30
 
31
31
  ##
32
- # @param [String] sid A 34 character string that uniquely identifies this Alert.
32
+ # @param [String] sid The unique string that we created to identify the Alert
33
+ # resource.
33
34
  # @return [Twilio::REST::Monitor::V1::AlertInstance] if sid was passed.
34
35
  # @return [Twilio::REST::Monitor::V1::AlertList]
35
36
  def alerts(sid=:unset)
@@ -37,7 +38,8 @@ module Twilio
37
38
  end
38
39
 
39
40
  ##
40
- # @param [String] sid A 34 character string that uniquely identifies this event.
41
+ # @param [String] sid The unique string that we created to identify the Event
42
+ # resource.
41
43
  # @return [Twilio::REST::Monitor::V1::EventInstance] if sid was passed.
42
44
  # @return [Twilio::REST::Monitor::V1::EventList]
43
45
  def events(sid=:unset)
@@ -20,7 +20,7 @@ module Twilio
20
20
  end
21
21
 
22
22
  ##
23
- # @param [String] sid A 34 character string that uniquely identifies this Alert.
23
+ # @param [String] sid The SID of the Alert resource to fetch.
24
24
  # @return [Twilio::REST::Monitor::V1::AlertContext] if sid was passed.
25
25
  # @return [Twilio::REST::Monitor::V1::AlertList]
26
26
  def alerts(sid=:unset)
@@ -34,7 +34,7 @@ module Twilio
34
34
  end
35
35
 
36
36
  ##
37
- # @param [String] sid A 34 character string that uniquely identifies this event.
37
+ # @param [String] sid The SID of the Event resource to fetch.
38
38
  # @return [Twilio::REST::Monitor::V1::EventContext] if sid was passed.
39
39
  # @return [Twilio::REST::Monitor::V1::EventList]
40
40
  def events(sid=:unset)
@@ -27,18 +27,14 @@ module Twilio
27
27
  # Lists AlertInstance records from the API as a list.
28
28
  # Unlike stream(), this operation is eager and will load `limit` records into
29
29
  # memory before returning.
30
- # @param [String] log_level Only show alerts for this log-level. One of 'error',
31
- # 'warning', 'notice', or 'debug'.
32
- # @param [Date] start_date Only show Alerts on or after this date. Useful in
33
- # combination with `EndDate` to define a date-range of Alerts. Input is a [UTC
34
- # ISO 8601 Timestamp](http://en.wikipedia.org/wiki/ISO_8601#UTC), but time of day
35
- # is ignored by the filter. Queries for Alerts older than 30 days are not
36
- # supported.
37
- # @param [Date] end_date Only show Alerts on or before this date. Useful in
38
- # combination with `StartDate` to define a date-range of Alerts. Input is a [UTC
39
- # ISO 8601 Timestamp](http://en.wikipedia.org/wiki/ISO_8601#UTC), but time of day
40
- # is ignored by the filter. Queries for Alerts older than 30 days are not
41
- # supported.
30
+ # @param [String] log_level Only show alerts for this log-level. Can be: `error`,
31
+ # `warning`, `notice`, or `debug`.
32
+ # @param [Date] start_date Only include alerts that occurred on or after this
33
+ # date. Specify the date in GMT and format as `YYYY-MM-DD`. Queries for alerts
34
+ # older than 30 days are not supported.
35
+ # @param [Date] end_date Only include alerts that occurred on or before this date.
36
+ # Specify the date in GMT and format as `YYYY-MM-DD`. Queries for alerts older
37
+ # than 30 days are not supported.
42
38
  # @param [Integer] limit Upper limit for the number of records to return. stream()
43
39
  # guarantees to never return more than limit. Default is no limit
44
40
  # @param [Integer] page_size Number of records to fetch per request, when
@@ -60,18 +56,14 @@ module Twilio
60
56
  # Streams AlertInstance records from the API as an Enumerable.
61
57
  # This operation lazily loads records as efficiently as possible until the limit
62
58
  # is reached.
63
- # @param [String] log_level Only show alerts for this log-level. One of 'error',
64
- # 'warning', 'notice', or 'debug'.
65
- # @param [Date] start_date Only show Alerts on or after this date. Useful in
66
- # combination with `EndDate` to define a date-range of Alerts. Input is a [UTC
67
- # ISO 8601 Timestamp](http://en.wikipedia.org/wiki/ISO_8601#UTC), but time of day
68
- # is ignored by the filter. Queries for Alerts older than 30 days are not
69
- # supported.
70
- # @param [Date] end_date Only show Alerts on or before this date. Useful in
71
- # combination with `StartDate` to define a date-range of Alerts. Input is a [UTC
72
- # ISO 8601 Timestamp](http://en.wikipedia.org/wiki/ISO_8601#UTC), but time of day
73
- # is ignored by the filter. Queries for Alerts older than 30 days are not
74
- # supported.
59
+ # @param [String] log_level Only show alerts for this log-level. Can be: `error`,
60
+ # `warning`, `notice`, or `debug`.
61
+ # @param [Date] start_date Only include alerts that occurred on or after this
62
+ # date. Specify the date in GMT and format as `YYYY-MM-DD`. Queries for alerts
63
+ # older than 30 days are not supported.
64
+ # @param [Date] end_date Only include alerts that occurred on or before this date.
65
+ # Specify the date in GMT and format as `YYYY-MM-DD`. Queries for alerts older
66
+ # than 30 days are not supported.
75
67
  # @param [Integer] limit Upper limit for the number of records to return. stream()
76
68
  # guarantees to never return more than limit. Default is no limit.
77
69
  # @param [Integer] page_size Number of records to fetch per request, when
@@ -109,18 +101,14 @@ module Twilio
109
101
  ##
110
102
  # Retrieve a single page of AlertInstance records from the API.
111
103
  # Request is executed immediately.
112
- # @param [String] log_level Only show alerts for this log-level. One of 'error',
113
- # 'warning', 'notice', or 'debug'.
114
- # @param [Date] start_date Only show Alerts on or after this date. Useful in
115
- # combination with `EndDate` to define a date-range of Alerts. Input is a [UTC
116
- # ISO 8601 Timestamp](http://en.wikipedia.org/wiki/ISO_8601#UTC), but time of day
117
- # is ignored by the filter. Queries for Alerts older than 30 days are not
118
- # supported.
119
- # @param [Date] end_date Only show Alerts on or before this date. Useful in
120
- # combination with `StartDate` to define a date-range of Alerts. Input is a [UTC
121
- # ISO 8601 Timestamp](http://en.wikipedia.org/wiki/ISO_8601#UTC), but time of day
122
- # is ignored by the filter. Queries for Alerts older than 30 days are not
123
- # supported.
104
+ # @param [String] log_level Only show alerts for this log-level. Can be: `error`,
105
+ # `warning`, `notice`, or `debug`.
106
+ # @param [Date] start_date Only include alerts that occurred on or after this
107
+ # date. Specify the date in GMT and format as `YYYY-MM-DD`. Queries for alerts
108
+ # older than 30 days are not supported.
109
+ # @param [Date] end_date Only include alerts that occurred on or before this date.
110
+ # Specify the date in GMT and format as `YYYY-MM-DD`. Queries for alerts older
111
+ # than 30 days are not supported.
124
112
  # @param [String] page_token PageToken provided by the API
125
113
  # @param [Integer] page_number Page Number, this value is simply for client state
126
114
  # @param [Integer] page_size Number of records to return, defaults to 50
@@ -195,7 +183,7 @@ module Twilio
195
183
  ##
196
184
  # Initialize the AlertContext
197
185
  # @param [Version] version Version that contains the resource
198
- # @param [String] sid A 34 character string that uniquely identifies this Alert.
186
+ # @param [String] sid The SID of the Alert resource to fetch.
199
187
  # @return [AlertContext] AlertContext
200
188
  def initialize(version, sid)
201
189
  super(version)
@@ -240,7 +228,7 @@ module Twilio
240
228
  # Initialize the AlertInstance
241
229
  # @param [Version] version Version that contains the resource
242
230
  # @param [Hash] payload payload that contains response from Twilio
243
- # @param [String] sid A 34 character string that uniquely identifies this Alert.
231
+ # @param [String] sid The SID of the Alert resource to fetch.
244
232
  # @return [AlertInstance] AlertInstance
245
233
  def initialize(version, payload, sid: nil)
246
234
  super(version)
@@ -285,115 +273,115 @@ module Twilio
285
273
  end
286
274
 
287
275
  ##
288
- # @return [String] The unique id of the Account responsible for this alert.
276
+ # @return [String] The SID of the Account that created the resource
289
277
  def account_sid
290
278
  @properties['account_sid']
291
279
  end
292
280
 
293
281
  ##
294
- # @return [String] The text of the alert.
282
+ # @return [String] The text of the alert
295
283
  def alert_text
296
284
  @properties['alert_text']
297
285
  end
298
286
 
299
287
  ##
300
- # @return [String] The version of the Twilio API in use when this alert was generated.
288
+ # @return [String] The API version used when the alert was generated
301
289
  def api_version
302
290
  @properties['api_version']
303
291
  end
304
292
 
305
293
  ##
306
- # @return [Time] The date that this resource was created, given in ISO 8601 format.
294
+ # @return [Time] The ISO 8601 date and time in GMT when the resource was created
307
295
  def date_created
308
296
  @properties['date_created']
309
297
  end
310
298
 
311
299
  ##
312
- # @return [Time] The date the alert was actually generated, given in ISO 8601 format.
300
+ # @return [Time] The date and time when the alert was generated specified in ISO 8601 format
313
301
  def date_generated
314
302
  @properties['date_generated']
315
303
  end
316
304
 
317
305
  ##
318
- # @return [Time] The most recent date that this resource was updated, given in ISO 8601 format.
306
+ # @return [Time] The ISO 8601 date and time in GMT when the resource was last updated
319
307
  def date_updated
320
308
  @properties['date_updated']
321
309
  end
322
310
 
323
311
  ##
324
- # @return [String] A unique error code for the error condition.
312
+ # @return [String] The error code for the condition that generated the alert
325
313
  def error_code
326
314
  @properties['error_code']
327
315
  end
328
316
 
329
317
  ##
330
- # @return [String] A string representing the log level.
318
+ # @return [String] The log level
331
319
  def log_level
332
320
  @properties['log_level']
333
321
  end
334
322
 
335
323
  ##
336
- # @return [String] A URL for more information about the error condition.
324
+ # @return [String] The URL of the page in our Error Dictionary with more information about the error condition
337
325
  def more_info
338
326
  @properties['more_info']
339
327
  end
340
328
 
341
329
  ##
342
- # @return [String] If the Alert was generated by a request Twilio made to your server, this will be the request method used when Twilio made the request to your server.
330
+ # @return [String] The method used by the request that generated the alert
343
331
  def request_method
344
332
  @properties['request_method']
345
333
  end
346
334
 
347
335
  ##
348
- # @return [String] If the Alert was generated by a request Twilio made to your server, this will be the URL on your server that generated the alert.
336
+ # @return [String] The URL of the request that generated the alert
349
337
  def request_url
350
338
  @properties['request_url']
351
339
  end
352
340
 
353
341
  ##
354
- # @return [String] The request_variables
342
+ # @return [String] The variables passed in the request that generated the alert
355
343
  def request_variables
356
344
  @properties['request_variables']
357
345
  end
358
346
 
359
347
  ##
360
- # @return [String] The unique ID of the resource for which the Alert was generated.
348
+ # @return [String] The SID of the resource for which the alert was generated
361
349
  def resource_sid
362
350
  @properties['resource_sid']
363
351
  end
364
352
 
365
353
  ##
366
- # @return [String] The response_body
354
+ # @return [String] The response body of the request that generated the alert
367
355
  def response_body
368
356
  @properties['response_body']
369
357
  end
370
358
 
371
359
  ##
372
- # @return [String] The response_headers
360
+ # @return [String] The response headers of the request that generated the alert
373
361
  def response_headers
374
362
  @properties['response_headers']
375
363
  end
376
364
 
377
365
  ##
378
- # @return [String] A 34 character string that uniquely identifies this Alert.
366
+ # @return [String] The unique string that identifies the resource
379
367
  def sid
380
368
  @properties['sid']
381
369
  end
382
370
 
383
371
  ##
384
- # @return [String] The absolute URL for this resource.
372
+ # @return [String] The absolute URL of the Alert resource
385
373
  def url
386
374
  @properties['url']
387
375
  end
388
376
 
389
377
  ##
390
- # @return [String] The request_headers
378
+ # @return [String] The request headers of the request that generated the alert
391
379
  def request_headers
392
380
  @properties['request_headers']
393
381
  end
394
382
 
395
383
  ##
396
- # @return [String] The service_sid
384
+ # @return [String] The SID of the service or resource that generated the alert
397
385
  def service_sid
398
386
  @properties['service_sid']
399
387
  end
@@ -27,22 +27,21 @@ module Twilio
27
27
  # Lists EventInstance records from the API as a list.
28
28
  # Unlike stream(), this operation is eager and will load `limit` records into
29
29
  # memory before returning.
30
- # @param [String] actor_sid Only include Events initiated by this Actor. Useful
30
+ # @param [String] actor_sid Only include events initiated by this Actor. Useful
31
31
  # for auditing actions taken by specific users or API credentials.
32
- # @param [String] event_type Only include Events of this EventType.
33
- # @param [String] resource_sid Only include Events referring to this resource.
32
+ # @param [String] event_type Only include events of this [Event
33
+ # Type](https://www.twilio.com/docs/usage/monitor-events#event-types).
34
+ # @param [String] resource_sid Only include events that refer to this resource.
34
35
  # Useful for discovering the history of a specific resource.
35
- # @param [String] source_ip_address Only include Events that originated from this
36
+ # @param [String] source_ip_address Only include events that originated from this
36
37
  # IP address. Useful for tracking suspicious activity originating from the API or
37
38
  # the Twilio Console.
38
- # @param [Time] start_date Only show events on or after this date. Useful in
39
- # combination with `EndDate` to define a date-range of events. Input is a [UTC ISO
40
- # 8601 Timestamp](http://en.wikipedia.org/wiki/ISO_8601#UTC), but time of day is
41
- # ignored by the filter.
42
- # @param [Time] end_date Only show events on or before this date. Useful in
43
- # combination with `StartDate` to define a date-range of events. Input is a [UTC
44
- # ISO 8601 Timestamp](http://en.wikipedia.org/wiki/ISO_8601#UTC), but time of day
45
- # is ignored by the filter.
39
+ # @param [Time] start_date Only include events that occurred on or after this
40
+ # date. Specify the date in GMT and [ISO
41
+ # 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
42
+ # @param [Time] end_date Only include events that occurred on or before this date.
43
+ # Specify the date in GMT and [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
44
+ # format.
46
45
  # @param [Integer] limit Upper limit for the number of records to return. stream()
47
46
  # guarantees to never return more than limit. Default is no limit
48
47
  # @param [Integer] page_size Number of records to fetch per request, when
@@ -67,22 +66,21 @@ module Twilio
67
66
  # Streams EventInstance records from the API as an Enumerable.
68
67
  # This operation lazily loads records as efficiently as possible until the limit
69
68
  # is reached.
70
- # @param [String] actor_sid Only include Events initiated by this Actor. Useful
69
+ # @param [String] actor_sid Only include events initiated by this Actor. Useful
71
70
  # for auditing actions taken by specific users or API credentials.
72
- # @param [String] event_type Only include Events of this EventType.
73
- # @param [String] resource_sid Only include Events referring to this resource.
71
+ # @param [String] event_type Only include events of this [Event
72
+ # Type](https://www.twilio.com/docs/usage/monitor-events#event-types).
73
+ # @param [String] resource_sid Only include events that refer to this resource.
74
74
  # Useful for discovering the history of a specific resource.
75
- # @param [String] source_ip_address Only include Events that originated from this
75
+ # @param [String] source_ip_address Only include events that originated from this
76
76
  # IP address. Useful for tracking suspicious activity originating from the API or
77
77
  # the Twilio Console.
78
- # @param [Time] start_date Only show events on or after this date. Useful in
79
- # combination with `EndDate` to define a date-range of events. Input is a [UTC ISO
80
- # 8601 Timestamp](http://en.wikipedia.org/wiki/ISO_8601#UTC), but time of day is
81
- # ignored by the filter.
82
- # @param [Time] end_date Only show events on or before this date. Useful in
83
- # combination with `StartDate` to define a date-range of events. Input is a [UTC
84
- # ISO 8601 Timestamp](http://en.wikipedia.org/wiki/ISO_8601#UTC), but time of day
85
- # is ignored by the filter.
78
+ # @param [Time] start_date Only include events that occurred on or after this
79
+ # date. Specify the date in GMT and [ISO
80
+ # 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
81
+ # @param [Time] end_date Only include events that occurred on or before this date.
82
+ # Specify the date in GMT and [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
83
+ # format.
86
84
  # @param [Integer] limit Upper limit for the number of records to return. stream()
87
85
  # guarantees to never return more than limit. Default is no limit.
88
86
  # @param [Integer] page_size Number of records to fetch per request, when
@@ -123,22 +121,21 @@ module Twilio
123
121
  ##
124
122
  # Retrieve a single page of EventInstance records from the API.
125
123
  # Request is executed immediately.
126
- # @param [String] actor_sid Only include Events initiated by this Actor. Useful
124
+ # @param [String] actor_sid Only include events initiated by this Actor. Useful
127
125
  # for auditing actions taken by specific users or API credentials.
128
- # @param [String] event_type Only include Events of this EventType.
129
- # @param [String] resource_sid Only include Events referring to this resource.
126
+ # @param [String] event_type Only include events of this [Event
127
+ # Type](https://www.twilio.com/docs/usage/monitor-events#event-types).
128
+ # @param [String] resource_sid Only include events that refer to this resource.
130
129
  # Useful for discovering the history of a specific resource.
131
- # @param [String] source_ip_address Only include Events that originated from this
130
+ # @param [String] source_ip_address Only include events that originated from this
132
131
  # IP address. Useful for tracking suspicious activity originating from the API or
133
132
  # the Twilio Console.
134
- # @param [Time] start_date Only show events on or after this date. Useful in
135
- # combination with `EndDate` to define a date-range of events. Input is a [UTC ISO
136
- # 8601 Timestamp](http://en.wikipedia.org/wiki/ISO_8601#UTC), but time of day is
137
- # ignored by the filter.
138
- # @param [Time] end_date Only show events on or before this date. Useful in
139
- # combination with `StartDate` to define a date-range of events. Input is a [UTC
140
- # ISO 8601 Timestamp](http://en.wikipedia.org/wiki/ISO_8601#UTC), but time of day
141
- # is ignored by the filter.
133
+ # @param [Time] start_date Only include events that occurred on or after this
134
+ # date. Specify the date in GMT and [ISO
135
+ # 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
136
+ # @param [Time] end_date Only include events that occurred on or before this date.
137
+ # Specify the date in GMT and [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
138
+ # format.
142
139
  # @param [String] page_token PageToken provided by the API
143
140
  # @param [Integer] page_number Page Number, this value is simply for client state
144
141
  # @param [Integer] page_size Number of records to return, defaults to 50
@@ -216,7 +213,7 @@ module Twilio
216
213
  ##
217
214
  # Initialize the EventContext
218
215
  # @param [Version] version Version that contains the resource
219
- # @param [String] sid A 34 character string that uniquely identifies this event.
216
+ # @param [String] sid The SID of the Event resource to fetch.
220
217
  # @return [EventContext] EventContext
221
218
  def initialize(version, sid)
222
219
  super(version)
@@ -261,7 +258,7 @@ module Twilio
261
258
  # Initialize the EventInstance
262
259
  # @param [Version] version Version that contains the resource
263
260
  # @param [Hash] payload payload that contains response from Twilio
264
- # @param [String] sid A 34 character string that uniquely identifies this event.
261
+ # @param [String] sid The SID of the Event resource to fetch.
265
262
  # @return [EventInstance] EventInstance
266
263
  def initialize(version, payload, sid: nil)
267
264
  super(version)
@@ -301,49 +298,49 @@ module Twilio
301
298
  end
302
299
 
303
300
  ##
304
- # @return [String] A 34 character string identifying the Account for which this Event was recorded.
301
+ # @return [String] The SID of the Account that created the resource
305
302
  def account_sid
306
303
  @properties['account_sid']
307
304
  end
308
305
 
309
306
  ##
310
- # @return [String] If available, a 34 character string identifying the actor that caused this event. May be null.
307
+ # @return [String] The SID of the actor that caused the event, if available
311
308
  def actor_sid
312
309
  @properties['actor_sid']
313
310
  end
314
311
 
315
312
  ##
316
- # @return [String] The type of actor that caused this event
313
+ # @return [String] The type of actor that caused the event
317
314
  def actor_type
318
315
  @properties['actor_type']
319
316
  end
320
317
 
321
318
  ##
322
- # @return [String] A human-readable description of the event. May be null.
319
+ # @return [String] A description of the event
323
320
  def description
324
321
  @properties['description']
325
322
  end
326
323
 
327
324
  ##
328
- # @return [Hash] A freeform json object encoding additional data about the event
325
+ # @return [Hash] A JSON string that represents an object with additional data about the event
329
326
  def event_data
330
327
  @properties['event_data']
331
328
  end
332
329
 
333
330
  ##
334
- # @return [Time] The date-time the event was recorded
331
+ # @return [Time] The ISO 8601 date and time in GMT when the event was recorded
335
332
  def event_date
336
333
  @properties['event_date']
337
334
  end
338
335
 
339
336
  ##
340
- # @return [String] The event's type, as a string.
337
+ # @return [String] The event's type
341
338
  def event_type
342
339
  @properties['event_type']
343
340
  end
344
341
 
345
342
  ##
346
- # @return [String] A 34 character string identifying the resource that was affected.
343
+ # @return [String] The SID of the resource that was affected
347
344
  def resource_sid
348
345
  @properties['resource_sid']
349
346
  end
@@ -355,13 +352,13 @@ module Twilio
355
352
  end
356
353
 
357
354
  ##
358
- # @return [String] A 34 character string that uniquely identifies this event.
355
+ # @return [String] The unique string that identifies the resource
359
356
  def sid
360
357
  @properties['sid']
361
358
  end
362
359
 
363
360
  ##
364
- # @return [String] The originating system or interface that caused the event. web for events caused by user action in the Twilio Console. api for events caused through a request to the REST API. twilio for events caused by an automated or internal Twilio system.
361
+ # @return [String] The originating system or interface that caused the event
365
362
  def source
366
363
  @properties['source']
367
364
  end
@@ -373,13 +370,13 @@ module Twilio
373
370
  end
374
371
 
375
372
  ##
376
- # @return [String] The url
373
+ # @return [String] The absolute URL of the resource that was affected
377
374
  def url
378
375
  @properties['url']
379
376
  end
380
377
 
381
378
  ##
382
- # @return [String] The links
379
+ # @return [String] The absolute URLs of related resources
383
380
  def links
384
381
  @properties['links']
385
382
  end