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
@@ -16,8 +16,10 @@ module Twilio
16
16
  ##
17
17
  # Initialize the WorkerStatisticsList
18
18
  # @param [Version] version Version that contains the resource
19
- # @param [String] workspace_sid The workspace_sid
20
- # @param [String] worker_sid The worker_sid
19
+ # @param [String] workspace_sid The SID of the Workspace that contains the
20
+ # WorkerChannel.
21
+ # @param [String] worker_sid The SID of the Worker that contains the
22
+ # WorkerChannel.
21
23
  # @return [WorkerStatisticsList] WorkerStatisticsList
22
24
  def initialize(version, workspace_sid: nil, worker_sid: nil)
23
25
  super(version)
@@ -71,8 +73,10 @@ module Twilio
71
73
  ##
72
74
  # Initialize the WorkerStatisticsContext
73
75
  # @param [Version] version Version that contains the resource
74
- # @param [String] workspace_sid The workspace_sid
75
- # @param [String] worker_sid The worker_sid
76
+ # @param [String] workspace_sid The SID of the Workspace with the WorkerChannel to
77
+ # fetch.
78
+ # @param [String] worker_sid The SID of the Worker with the WorkerChannel to
79
+ # fetch.
76
80
  # @return [WorkerStatisticsContext] WorkerStatisticsContext
77
81
  def initialize(version, workspace_sid, worker_sid)
78
82
  super(version)
@@ -84,17 +88,17 @@ module Twilio
84
88
 
85
89
  ##
86
90
  # Fetch a WorkerStatisticsInstance
87
- # @param [String] minutes Filter cumulative statistics by up to 'x' minutes in the
88
- # past. This is helpful for statistics for the last 15 minutes, 240 minutes (4
89
- # hours), and 480 minutes (8 hours) to see trends. Defaults to 15 minutes.
90
- # @param [Time] start_date Filter cumulative statistics by a start date. This is
91
- # helpful for defining a range of statistics to capture. Input is a string of the
92
- # format: yyyy-MM-dd'T'HH:mm:ss'Z'.
93
- # @param [Time] end_date Filter cumulative statistics by a end date. This is
94
- # helpful for defining a range of statistics to capture. Input is a string of the
95
- # format: yyyy-MM-dd'T'HH:mm:ss'Z'.
96
- # @param [String] task_channel Filter cumulative statistics by TaskChannel. Takes
97
- # in a Unique Name ("voice", "sms", "default", etc.) or a TaskChannelSid.
91
+ # @param [String] minutes Only calculate statistics since this many minutes in the
92
+ # past. The default 15 minutes. This is helpful for displaying statistics for the
93
+ # last 15 minutes, 240 minutes (4 hours), and 480 minutes (8 hours) to see trends.
94
+ # @param [Time] start_date Only calculate statistics from this date and time and
95
+ # later, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
96
+ # @param [Time] end_date Only include usage that occurred on or before this date,
97
+ # specified in GMT as an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
98
+ # date-time.
99
+ # @param [String] task_channel Only calculate statistics on this TaskChannel. Can
100
+ # be the TaskChannel's SID or its `unique_name`, such as `voice`, `sms`, or
101
+ # `default`.
98
102
  # @return [WorkerStatisticsInstance] Fetched WorkerStatisticsInstance
99
103
  def fetch(minutes: :unset, start_date: :unset, end_date: :unset, task_channel: :unset)
100
104
  params = Twilio::Values.of({
@@ -138,8 +142,10 @@ module Twilio
138
142
  # Initialize the WorkerStatisticsInstance
139
143
  # @param [Version] version Version that contains the resource
140
144
  # @param [Hash] payload payload that contains response from Twilio
141
- # @param [String] workspace_sid The workspace_sid
142
- # @param [String] worker_sid The worker_sid
145
+ # @param [String] workspace_sid The SID of the Workspace that contains the
146
+ # WorkerChannel.
147
+ # @param [String] worker_sid The SID of the Worker that contains the
148
+ # WorkerChannel.
143
149
  # @return [WorkerStatisticsInstance] WorkerStatisticsInstance
144
150
  def initialize(version, payload, workspace_sid: nil, worker_sid: nil)
145
151
  super(version)
@@ -174,48 +180,48 @@ module Twilio
174
180
  end
175
181
 
176
182
  ##
177
- # @return [String] The account_sid
183
+ # @return [String] The SID of the Account that created the resource
178
184
  def account_sid
179
185
  @properties['account_sid']
180
186
  end
181
187
 
182
188
  ##
183
- # @return [Hash] The cumulative
189
+ # @return [Hash] An object that contains the cumulative statistics for the Worker
184
190
  def cumulative
185
191
  @properties['cumulative']
186
192
  end
187
193
 
188
194
  ##
189
- # @return [String] The worker_sid
195
+ # @return [String] The SID of the Worker that contains the WorkerChannel
190
196
  def worker_sid
191
197
  @properties['worker_sid']
192
198
  end
193
199
 
194
200
  ##
195
- # @return [String] The workspace_sid
201
+ # @return [String] The SID of the Workspace that contains the WorkerChannel
196
202
  def workspace_sid
197
203
  @properties['workspace_sid']
198
204
  end
199
205
 
200
206
  ##
201
- # @return [String] The url
207
+ # @return [String] The absolute URL of the WorkerChannel statistics resource
202
208
  def url
203
209
  @properties['url']
204
210
  end
205
211
 
206
212
  ##
207
213
  # Fetch a WorkerStatisticsInstance
208
- # @param [String] minutes Filter cumulative statistics by up to 'x' minutes in the
209
- # past. This is helpful for statistics for the last 15 minutes, 240 minutes (4
210
- # hours), and 480 minutes (8 hours) to see trends. Defaults to 15 minutes.
211
- # @param [Time] start_date Filter cumulative statistics by a start date. This is
212
- # helpful for defining a range of statistics to capture. Input is a string of the
213
- # format: yyyy-MM-dd'T'HH:mm:ss'Z'.
214
- # @param [Time] end_date Filter cumulative statistics by a end date. This is
215
- # helpful for defining a range of statistics to capture. Input is a string of the
216
- # format: yyyy-MM-dd'T'HH:mm:ss'Z'.
217
- # @param [String] task_channel Filter cumulative statistics by TaskChannel. Takes
218
- # in a Unique Name ("voice", "sms", "default", etc.) or a TaskChannelSid.
214
+ # @param [String] minutes Only calculate statistics since this many minutes in the
215
+ # past. The default 15 minutes. This is helpful for displaying statistics for the
216
+ # last 15 minutes, 240 minutes (4 hours), and 480 minutes (8 hours) to see trends.
217
+ # @param [Time] start_date Only calculate statistics from this date and time and
218
+ # later, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
219
+ # @param [Time] end_date Only include usage that occurred on or before this date,
220
+ # specified in GMT as an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
221
+ # date-time.
222
+ # @param [String] task_channel Only calculate statistics on this TaskChannel. Can
223
+ # be the TaskChannel's SID or its `unique_name`, such as `voice`, `sms`, or
224
+ # `default`.
219
225
  # @return [WorkerStatisticsInstance] Fetched WorkerStatisticsInstance
220
226
  def fetch(minutes: :unset, start_date: :unset, end_date: :unset, task_channel: :unset)
221
227
  context.fetch(
@@ -16,7 +16,8 @@ module Twilio
16
16
  ##
17
17
  # Initialize the WorkersCumulativeStatisticsList
18
18
  # @param [Version] version Version that contains the resource
19
- # @param [String] workspace_sid The workspace_sid
19
+ # @param [String] workspace_sid The SID of the Workspace that contains the
20
+ # Workers.
20
21
  # @return [WorkersCumulativeStatisticsList] WorkersCumulativeStatisticsList
21
22
  def initialize(version, workspace_sid: nil)
22
23
  super(version)
@@ -65,7 +66,8 @@ module Twilio
65
66
  ##
66
67
  # Initialize the WorkersCumulativeStatisticsContext
67
68
  # @param [Version] version Version that contains the resource
68
- # @param [String] workspace_sid The workspace_sid
69
+ # @param [String] workspace_sid The SID of the Workspace with the resource to
70
+ # fetch.
69
71
  # @return [WorkersCumulativeStatisticsContext] WorkersCumulativeStatisticsContext
70
72
  def initialize(version, workspace_sid)
71
73
  super(version)
@@ -77,17 +79,16 @@ module Twilio
77
79
 
78
80
  ##
79
81
  # Fetch a WorkersCumulativeStatisticsInstance
80
- # @param [Time] end_date Filter cumulative statistics by a end date. This is
81
- # helpful for defining a range of statistics to capture. Input is a string of the
82
- # format: yyyy-MM-dd'T'HH:mm:ss'Z'.
83
- # @param [String] minutes Filter cumulative statistics by up to 'x' minutes in the
84
- # past. This is helpful for statistics for the last 15 minutes, 240 minutes (4
85
- # hours), and 480 minutes (8 hours) to see trends. Defaults to 15 minutes.
86
- # @param [Time] start_date Filter cumulative statistics by a start date. This is
87
- # helpful for defining a range of statistics to capture. Input is a string of the
88
- # format: yyyy-MM-dd'T'HH:mm:ss'Z'.
89
- # @param [String] task_channel Filter cumulative statistics by TaskChannel. Takes
90
- # in a Unique Name ("voice", "sms", "default", etc.) or a TaskChannelSid.
82
+ # @param [Time] end_date Only calculate statistics from this date and time and
83
+ # earlier, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
84
+ # @param [String] minutes Only calculate statistics since this many minutes in the
85
+ # past. The default 15 minutes. This is helpful for displaying statistics for the
86
+ # last 15 minutes, 240 minutes (4 hours), and 480 minutes (8 hours) to see trends.
87
+ # @param [Time] start_date Only calculate statistics from this date and time and
88
+ # later, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
89
+ # @param [String] task_channel Only calculate cumulative statistics on this
90
+ # TaskChannel. Can be the TaskChannel's SID or its `unique_name`, such as `voice`,
91
+ # `sms`, or `default`.
91
92
  # @return [WorkersCumulativeStatisticsInstance] Fetched WorkersCumulativeStatisticsInstance
92
93
  def fetch(end_date: :unset, minutes: :unset, start_date: :unset, task_channel: :unset)
93
94
  params = Twilio::Values.of({
@@ -126,7 +127,8 @@ module Twilio
126
127
  # Initialize the WorkersCumulativeStatisticsInstance
127
128
  # @param [Version] version Version that contains the resource
128
129
  # @param [Hash] payload payload that contains response from Twilio
129
- # @param [String] workspace_sid The workspace_sid
130
+ # @param [String] workspace_sid The SID of the Workspace that contains the
131
+ # Workers.
130
132
  # @return [WorkersCumulativeStatisticsInstance] WorkersCumulativeStatisticsInstance
131
133
  def initialize(version, payload, workspace_sid: nil)
132
134
  super(version)
@@ -164,25 +166,25 @@ module Twilio
164
166
  end
165
167
 
166
168
  ##
167
- # @return [String] The account_sid
169
+ # @return [String] The SID of the Account that created the resource
168
170
  def account_sid
169
171
  @properties['account_sid']
170
172
  end
171
173
 
172
174
  ##
173
- # @return [Time] The start_time
175
+ # @return [Time] The beginning of the interval during which these statistics were calculated
174
176
  def start_time
175
177
  @properties['start_time']
176
178
  end
177
179
 
178
180
  ##
179
- # @return [Time] The end_time
181
+ # @return [Time] The end of the interval during which these statistics were calculated
180
182
  def end_time
181
183
  @properties['end_time']
182
184
  end
183
185
 
184
186
  ##
185
- # @return [Hash] The minimum, average, maximum and total time Workers spent in each Activity
187
+ # @return [Hash] The minimum, average, maximum, and total time that Workers spent in each Activity
186
188
  def activity_durations
187
189
  @properties['activity_durations']
188
190
  end
@@ -224,30 +226,29 @@ module Twilio
224
226
  end
225
227
 
226
228
  ##
227
- # @return [String] The workspace_sid
229
+ # @return [String] The SID of the Workspace that contains the Workers
228
230
  def workspace_sid
229
231
  @properties['workspace_sid']
230
232
  end
231
233
 
232
234
  ##
233
- # @return [String] The url
235
+ # @return [String] The absolute URL of the Workers statistics resource
234
236
  def url
235
237
  @properties['url']
236
238
  end
237
239
 
238
240
  ##
239
241
  # Fetch a WorkersCumulativeStatisticsInstance
240
- # @param [Time] end_date Filter cumulative statistics by a end date. This is
241
- # helpful for defining a range of statistics to capture. Input is a string of the
242
- # format: yyyy-MM-dd'T'HH:mm:ss'Z'.
243
- # @param [String] minutes Filter cumulative statistics by up to 'x' minutes in the
244
- # past. This is helpful for statistics for the last 15 minutes, 240 minutes (4
245
- # hours), and 480 minutes (8 hours) to see trends. Defaults to 15 minutes.
246
- # @param [Time] start_date Filter cumulative statistics by a start date. This is
247
- # helpful for defining a range of statistics to capture. Input is a string of the
248
- # format: yyyy-MM-dd'T'HH:mm:ss'Z'.
249
- # @param [String] task_channel Filter cumulative statistics by TaskChannel. Takes
250
- # in a Unique Name ("voice", "sms", "default", etc.) or a TaskChannelSid.
242
+ # @param [Time] end_date Only calculate statistics from this date and time and
243
+ # earlier, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
244
+ # @param [String] minutes Only calculate statistics since this many minutes in the
245
+ # past. The default 15 minutes. This is helpful for displaying statistics for the
246
+ # last 15 minutes, 240 minutes (4 hours), and 480 minutes (8 hours) to see trends.
247
+ # @param [Time] start_date Only calculate statistics from this date and time and
248
+ # later, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
249
+ # @param [String] task_channel Only calculate cumulative statistics on this
250
+ # TaskChannel. Can be the TaskChannel's SID or its `unique_name`, such as `voice`,
251
+ # `sms`, or `default`.
251
252
  # @return [WorkersCumulativeStatisticsInstance] Fetched WorkersCumulativeStatisticsInstance
252
253
  def fetch(end_date: :unset, minutes: :unset, start_date: :unset, task_channel: :unset)
253
254
  context.fetch(
@@ -16,7 +16,8 @@ module Twilio
16
16
  ##
17
17
  # Initialize the WorkersRealTimeStatisticsList
18
18
  # @param [Version] version Version that contains the resource
19
- # @param [String] workspace_sid The workspace_sid
19
+ # @param [String] workspace_sid The SID of the Workspace that contains the
20
+ # Workers.
20
21
  # @return [WorkersRealTimeStatisticsList] WorkersRealTimeStatisticsList
21
22
  def initialize(version, workspace_sid: nil)
22
23
  super(version)
@@ -65,7 +66,8 @@ module Twilio
65
66
  ##
66
67
  # Initialize the WorkersRealTimeStatisticsContext
67
68
  # @param [Version] version Version that contains the resource
68
- # @param [String] workspace_sid The workspace_sid
69
+ # @param [String] workspace_sid The SID of the Workspace with the resource to
70
+ # fetch.
69
71
  # @return [WorkersRealTimeStatisticsContext] WorkersRealTimeStatisticsContext
70
72
  def initialize(version, workspace_sid)
71
73
  super(version)
@@ -77,8 +79,9 @@ module Twilio
77
79
 
78
80
  ##
79
81
  # Fetch a WorkersRealTimeStatisticsInstance
80
- # @param [String] task_channel Filter cumulative statistics by TaskChannel. Takes
81
- # in a Unique Name ("voice", "sms", "default", etc.) or a TaskChannelSid.
82
+ # @param [String] task_channel Only calculate real-time statistics on this
83
+ # TaskChannel. Can be the TaskChannel's SID or its `unique_name`, such as `voice`,
84
+ # `sms`, or `default`.
82
85
  # @return [WorkersRealTimeStatisticsInstance] Fetched WorkersRealTimeStatisticsInstance
83
86
  def fetch(task_channel: :unset)
84
87
  params = Twilio::Values.of({'TaskChannel' => task_channel, })
@@ -112,7 +115,8 @@ module Twilio
112
115
  # Initialize the WorkersRealTimeStatisticsInstance
113
116
  # @param [Version] version Version that contains the resource
114
117
  # @param [Hash] payload payload that contains response from Twilio
115
- # @param [String] workspace_sid The workspace_sid
118
+ # @param [String] workspace_sid The SID of the Workspace that contains the
119
+ # Workers.
116
120
  # @return [WorkersRealTimeStatisticsInstance] WorkersRealTimeStatisticsInstance
117
121
  def initialize(version, payload, workspace_sid: nil)
118
122
  super(version)
@@ -143,13 +147,13 @@ module Twilio
143
147
  end
144
148
 
145
149
  ##
146
- # @return [String] The account_sid
150
+ # @return [String] The SID of the Account that created the resource
147
151
  def account_sid
148
152
  @properties['account_sid']
149
153
  end
150
154
 
151
155
  ##
152
- # @return [Hash] The current Worker status count breakdown by Activity
156
+ # @return [Hash] The number of current Workers by Activity
153
157
  def activity_statistics
154
158
  @properties['activity_statistics']
155
159
  end
@@ -161,21 +165,22 @@ module Twilio
161
165
  end
162
166
 
163
167
  ##
164
- # @return [String] The workspace_sid
168
+ # @return [String] The SID of the Workspace that contains the Workers
165
169
  def workspace_sid
166
170
  @properties['workspace_sid']
167
171
  end
168
172
 
169
173
  ##
170
- # @return [String] The url
174
+ # @return [String] The absolute URL of the Workers statistics resource
171
175
  def url
172
176
  @properties['url']
173
177
  end
174
178
 
175
179
  ##
176
180
  # Fetch a WorkersRealTimeStatisticsInstance
177
- # @param [String] task_channel Filter cumulative statistics by TaskChannel. Takes
178
- # in a Unique Name ("voice", "sms", "default", etc.) or a TaskChannelSid.
181
+ # @param [String] task_channel Only calculate real-time statistics on this
182
+ # TaskChannel. Can be the TaskChannel's SID or its `unique_name`, such as `voice`,
183
+ # `sms`, or `default`.
179
184
  # @return [WorkersRealTimeStatisticsInstance] Fetched WorkersRealTimeStatisticsInstance
180
185
  def fetch(task_channel: :unset)
181
186
  context.fetch(task_channel: task_channel, )
@@ -16,8 +16,7 @@ module Twilio
16
16
  ##
17
17
  # Initialize the WorkersStatisticsList
18
18
  # @param [Version] version Version that contains the resource
19
- # @param [String] workspace_sid The ID of the Workflow this worker is associated
20
- # with
19
+ # @param [String] workspace_sid The SID of the Workspace that contains the Worker.
21
20
  # @return [WorkersStatisticsList] WorkersStatisticsList
22
21
  def initialize(version, workspace_sid: nil)
23
22
  super(version)
@@ -66,7 +65,7 @@ module Twilio
66
65
  ##
67
66
  # Initialize the WorkersStatisticsContext
68
67
  # @param [Version] version Version that contains the resource
69
- # @param [String] workspace_sid The workspace_sid
68
+ # @param [String] workspace_sid The SID of the Workspace with the Worker to fetch.
70
69
  # @return [WorkersStatisticsContext] WorkersStatisticsContext
71
70
  def initialize(version, workspace_sid)
72
71
  super(version)
@@ -78,22 +77,23 @@ module Twilio
78
77
 
79
78
  ##
80
79
  # Fetch a WorkersStatisticsInstance
81
- # @param [String] minutes Filter cumulative statistics by up to 'x' minutes in the
82
- # past. This is helpful for statistics for the last 15 minutes, 240 minutes (4
83
- # hours), and 480 minutes (8 hours) to see trends. Defaults to 15 minutes.
84
- # @param [Time] start_date Filter cumulative statistics by a start date. This is
85
- # helpful for defining a range of statistics to capture. Input is a string of the
86
- # format: yyyy-MM-dd'T'HH:mm:ss'Z'.
87
- # @param [Time] end_date Filter cumulative statistics by a end date. This is
88
- # helpful for defining a range of statistics to capture. Input is a string of the
89
- # format: yyyy-MM-dd'T'HH:mm:ss'Z'.
90
- # @param [String] task_queue_sid Filter the real-time and cumulative statistics
91
- # based on Workers tied to a particular queue
92
- # @param [String] task_queue_name Filter the real-time and cumulative statistics
93
- # based on Workers tied to a particular queue
94
- # @param [String] friendly_name The friendly_name
95
- # @param [String] task_channel Filter cumulative statistics by TaskChannel. Takes
96
- # in a Unique Name ("voice", "sms", "default", etc.) or a TaskChannelSid.
80
+ # @param [String] minutes Only calculate statistics since this many minutes in the
81
+ # past. The default 15 minutes. This is helpful for displaying statistics for the
82
+ # last 15 minutes, 240 minutes (4 hours), and 480 minutes (8 hours) to see trends.
83
+ # @param [Time] start_date Only calculate statistics from this date and time and
84
+ # later, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
85
+ # @param [Time] end_date Only calculate statistics from this date and time and
86
+ # earlier, specified in GMT as an [ISO
87
+ # 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time.
88
+ # @param [String] task_queue_sid The SID of the TaskQueue for which to fetch
89
+ # Worker statistics.
90
+ # @param [String] task_queue_name The `friendly_name` of the TaskQueue for which
91
+ # to fetch Worker statistics.
92
+ # @param [String] friendly_name Only include Workers with `friendly_name` values
93
+ # that match this parameter.
94
+ # @param [String] task_channel Only calculate statistics on this TaskChannel. Can
95
+ # be the TaskChannel's SID or its `unique_name`, such as `voice`, `sms`, or
96
+ # `default`.
97
97
  # @return [WorkersStatisticsInstance] Fetched WorkersStatisticsInstance
98
98
  def fetch(minutes: :unset, start_date: :unset, end_date: :unset, task_queue_sid: :unset, task_queue_name: :unset, friendly_name: :unset, task_channel: :unset)
99
99
  params = Twilio::Values.of({
@@ -135,8 +135,7 @@ module Twilio
135
135
  # Initialize the WorkersStatisticsInstance
136
136
  # @param [Version] version Version that contains the resource
137
137
  # @param [Hash] payload payload that contains response from Twilio
138
- # @param [String] workspace_sid The ID of the Workflow this worker is associated
139
- # with
138
+ # @param [String] workspace_sid The SID of the Workspace that contains the Worker.
140
139
  # @return [WorkersStatisticsInstance] WorkersStatisticsInstance
141
140
  def initialize(version, payload, workspace_sid: nil)
142
141
  super(version)
@@ -167,53 +166,54 @@ module Twilio
167
166
  end
168
167
 
169
168
  ##
170
- # @return [Hash] The realtime
169
+ # @return [Hash] An object that contains the real-time statistics for the Worker
171
170
  def realtime
172
171
  @properties['realtime']
173
172
  end
174
173
 
175
174
  ##
176
- # @return [Hash] The cumulative
175
+ # @return [Hash] An object that contains the cumulative statistics for the Worker
177
176
  def cumulative
178
177
  @properties['cumulative']
179
178
  end
180
179
 
181
180
  ##
182
- # @return [String] The account_sid
181
+ # @return [String] The SID of the Account that created the resource
183
182
  def account_sid
184
183
  @properties['account_sid']
185
184
  end
186
185
 
187
186
  ##
188
- # @return [String] The workspace_sid
187
+ # @return [String] The SID of the Workspace that contains the Worker
189
188
  def workspace_sid
190
189
  @properties['workspace_sid']
191
190
  end
192
191
 
193
192
  ##
194
- # @return [String] The url
193
+ # @return [String] The absolute URL of the Worker statistics resource
195
194
  def url
196
195
  @properties['url']
197
196
  end
198
197
 
199
198
  ##
200
199
  # Fetch a WorkersStatisticsInstance
201
- # @param [String] minutes Filter cumulative statistics by up to 'x' minutes in the
202
- # past. This is helpful for statistics for the last 15 minutes, 240 minutes (4
203
- # hours), and 480 minutes (8 hours) to see trends. Defaults to 15 minutes.
204
- # @param [Time] start_date Filter cumulative statistics by a start date. This is
205
- # helpful for defining a range of statistics to capture. Input is a string of the
206
- # format: yyyy-MM-dd'T'HH:mm:ss'Z'.
207
- # @param [Time] end_date Filter cumulative statistics by a end date. This is
208
- # helpful for defining a range of statistics to capture. Input is a string of the
209
- # format: yyyy-MM-dd'T'HH:mm:ss'Z'.
210
- # @param [String] task_queue_sid Filter the real-time and cumulative statistics
211
- # based on Workers tied to a particular queue
212
- # @param [String] task_queue_name Filter the real-time and cumulative statistics
213
- # based on Workers tied to a particular queue
214
- # @param [String] friendly_name The friendly_name
215
- # @param [String] task_channel Filter cumulative statistics by TaskChannel. Takes
216
- # in a Unique Name ("voice", "sms", "default", etc.) or a TaskChannelSid.
200
+ # @param [String] minutes Only calculate statistics since this many minutes in the
201
+ # past. The default 15 minutes. This is helpful for displaying statistics for the
202
+ # last 15 minutes, 240 minutes (4 hours), and 480 minutes (8 hours) to see trends.
203
+ # @param [Time] start_date Only calculate statistics from this date and time and
204
+ # later, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
205
+ # @param [Time] end_date Only calculate statistics from this date and time and
206
+ # earlier, specified in GMT as an [ISO
207
+ # 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time.
208
+ # @param [String] task_queue_sid The SID of the TaskQueue for which to fetch
209
+ # Worker statistics.
210
+ # @param [String] task_queue_name The `friendly_name` of the TaskQueue for which
211
+ # to fetch Worker statistics.
212
+ # @param [String] friendly_name Only include Workers with `friendly_name` values
213
+ # that match this parameter.
214
+ # @param [String] task_channel Only calculate statistics on this TaskChannel. Can
215
+ # be the TaskChannel's SID or its `unique_name`, such as `voice`, `sms`, or
216
+ # `default`.
217
217
  # @return [WorkersStatisticsInstance] Fetched WorkersStatisticsInstance
218
218
  def fetch(minutes: :unset, start_date: :unset, end_date: :unset, task_queue_sid: :unset, task_queue_name: :unset, friendly_name: :unset, task_channel: :unset)
219
219
  context.fetch(