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
@@ -16,8 +16,10 @@ module Twilio
16
16
  ##
17
17
  # Initialize the WorkflowRealTimeStatisticsList
18
18
  # @param [Version] version Version that contains the resource
19
- # @param [String] workspace_sid The workspace_sid
20
- # @param [String] workflow_sid The workflow_sid
19
+ # @param [String] workspace_sid The SID of the Workspace that contains the
20
+ # Workflow.
21
+ # @param [String] workflow_sid Returns the list of Tasks that are being controlled
22
+ # by the Workflow with the specified SID value.
21
23
  # @return [WorkflowRealTimeStatisticsList] WorkflowRealTimeStatisticsList
22
24
  def initialize(version, workspace_sid: nil, workflow_sid: nil)
23
25
  super(version)
@@ -71,8 +73,10 @@ module Twilio
71
73
  ##
72
74
  # Initialize the WorkflowRealTimeStatisticsContext
73
75
  # @param [Version] version Version that contains the resource
74
- # @param [String] workspace_sid The workspace_sid
75
- # @param [String] workflow_sid The workflow_sid
76
+ # @param [String] workspace_sid The SID of the Workspace with the Workflow to
77
+ # fetch.
78
+ # @param [String] workflow_sid Returns the list of Tasks that are being controlled
79
+ # by the Workflow with the specified SID value.
76
80
  # @return [WorkflowRealTimeStatisticsContext] WorkflowRealTimeStatisticsContext
77
81
  def initialize(version, workspace_sid, workflow_sid)
78
82
  super(version)
@@ -84,9 +88,9 @@ module Twilio
84
88
 
85
89
  ##
86
90
  # Fetch a WorkflowRealTimeStatisticsInstance
87
- # @param [String] task_channel Filter real-time and cumulative statistics by
88
- # TaskChannel. Takes in a Unique Name ("voice", "sms", "default", etc.) or a
89
- # TaskChannelSid.
91
+ # @param [String] task_channel Only calculate real-time statistics on this
92
+ # TaskChannel. Can be the TaskChannel's SID or its `unique_name`, such as `voice`,
93
+ # `sms`, or `default`.
90
94
  # @return [WorkflowRealTimeStatisticsInstance] Fetched WorkflowRealTimeStatisticsInstance
91
95
  def fetch(task_channel: :unset)
92
96
  params = Twilio::Values.of({'TaskChannel' => task_channel, })
@@ -125,8 +129,10 @@ module Twilio
125
129
  # Initialize the WorkflowRealTimeStatisticsInstance
126
130
  # @param [Version] version Version that contains the resource
127
131
  # @param [Hash] payload payload that contains response from Twilio
128
- # @param [String] workspace_sid The workspace_sid
129
- # @param [String] workflow_sid The workflow_sid
132
+ # @param [String] workspace_sid The SID of the Workspace that contains the
133
+ # Workflow.
134
+ # @param [String] workflow_sid Returns the list of Tasks that are being controlled
135
+ # by the Workflow with the specified SID value.
130
136
  # @return [WorkflowRealTimeStatisticsInstance] WorkflowRealTimeStatisticsInstance
131
137
  def initialize(version, payload, workspace_sid: nil, workflow_sid: nil)
132
138
  super(version)
@@ -165,7 +171,7 @@ module Twilio
165
171
  end
166
172
 
167
173
  ##
168
- # @return [String] The account_sid
174
+ # @return [String] The SID of the Account that created the resource
169
175
  def account_sid
170
176
  @properties['account_sid']
171
177
  end
@@ -183,13 +189,13 @@ module Twilio
183
189
  end
184
190
 
185
191
  ##
186
- # @return [Hash] The tasks_by_priority
192
+ # @return [Hash] The number of Tasks by priority
187
193
  def tasks_by_priority
188
194
  @properties['tasks_by_priority']
189
195
  end
190
196
 
191
197
  ##
192
- # @return [Hash] The Tasks broken down by status
198
+ # @return [Hash] The number of Tasks by their current status
193
199
  def tasks_by_status
194
200
  @properties['tasks_by_status']
195
201
  end
@@ -201,28 +207,28 @@ module Twilio
201
207
  end
202
208
 
203
209
  ##
204
- # @return [String] The workflow_sid
210
+ # @return [String] Returns the list of Tasks that are being controlled by the Workflow with the specified SID value
205
211
  def workflow_sid
206
212
  @properties['workflow_sid']
207
213
  end
208
214
 
209
215
  ##
210
- # @return [String] The workspace_sid
216
+ # @return [String] The SID of the Workspace that contains the Workflow.
211
217
  def workspace_sid
212
218
  @properties['workspace_sid']
213
219
  end
214
220
 
215
221
  ##
216
- # @return [String] The url
222
+ # @return [String] The absolute URL of the Workflow statistics resource
217
223
  def url
218
224
  @properties['url']
219
225
  end
220
226
 
221
227
  ##
222
228
  # Fetch a WorkflowRealTimeStatisticsInstance
223
- # @param [String] task_channel Filter real-time and cumulative statistics by
224
- # TaskChannel. Takes in a Unique Name ("voice", "sms", "default", etc.) or a
225
- # TaskChannelSid.
229
+ # @param [String] task_channel Only calculate real-time statistics on this
230
+ # TaskChannel. Can be the TaskChannel's SID or its `unique_name`, such as `voice`,
231
+ # `sms`, or `default`.
226
232
  # @return [WorkflowRealTimeStatisticsInstance] Fetched WorkflowRealTimeStatisticsInstance
227
233
  def fetch(task_channel: :unset)
228
234
  context.fetch(task_channel: task_channel, )
@@ -16,8 +16,10 @@ module Twilio
16
16
  ##
17
17
  # Initialize the WorkflowStatisticsList
18
18
  # @param [Version] version Version that contains the resource
19
- # @param [String] workspace_sid The workspace_sid
20
- # @param [String] workflow_sid The workflow_sid
19
+ # @param [String] workspace_sid The SID of the Workspace that contains the
20
+ # Workflow.
21
+ # @param [String] workflow_sid Returns the list of Tasks that are being controlled
22
+ # by the Workflow with the specified SID value.
21
23
  # @return [WorkflowStatisticsList] WorkflowStatisticsList
22
24
  def initialize(version, workspace_sid: nil, workflow_sid: nil)
23
25
  super(version)
@@ -71,8 +73,10 @@ module Twilio
71
73
  ##
72
74
  # Initialize the WorkflowStatisticsContext
73
75
  # @param [Version] version Version that contains the resource
74
- # @param [String] workspace_sid The workspace_sid
75
- # @param [String] workflow_sid The workflow_sid
76
+ # @param [String] workspace_sid The SID of the Workspace with the Workflow to
77
+ # fetch.
78
+ # @param [String] workflow_sid Returns the list of Tasks that are being controlled
79
+ # by the Workflow with the specified SID value.
76
80
  # @return [WorkflowStatisticsContext] WorkflowStatisticsContext
77
81
  def initialize(version, workspace_sid, workflow_sid)
78
82
  super(version)
@@ -84,23 +88,24 @@ module Twilio
84
88
 
85
89
  ##
86
90
  # Fetch a WorkflowStatisticsInstance
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 GMT ISO 8601
92
- # Timestamp
93
- # @param [Time] end_date Filter cumulative statistics by an end date. This is
94
- # helpful for defining a range of statistics to capture. Input is a GMT ISO 8601
95
- # Timestamp
96
- # @param [String] task_channel Filter real-time and cumulative statistics by
97
- # TaskChannel. Takes in a Unique Name ("voice", "sms", "default", etc.) or a
98
- # TaskChannelSid.
99
- # @param [String] split_by_wait_time A comma separated values for viewing splits
100
- # of tasks canceled and accepted above the given threshold in seconds. Ex: "5,30"
101
- # would show splits of tasks that were canceled or accepted before or after 5
102
- # seconds and respectively, 30 seconds. This is great for showing short abandoned
103
- # tasks or tasks that failed to meet your SLA.
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 calculate statistics from this date and time and
97
+ # earlier, specified in GMT as an [ISO
98
+ # 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time.
99
+ # @param [String] task_channel Only calculate real-time statistics on this
100
+ # TaskChannel. Can be the TaskChannel's SID or its `unique_name`, such as `voice`,
101
+ # `sms`, or `default`.
102
+ # @param [String] split_by_wait_time A comma separated list of values that
103
+ # describes the thresholds, in seconds, to calculate statistics on. For each
104
+ # threshold specified, the number of Tasks canceled and reservations accepted
105
+ # above and below the specified thresholds in seconds are computed. For example,
106
+ # `5,30` would show splits of Tasks that were canceled or accepted before and
107
+ # after 5 seconds and before and after 30 seconds. This can be used to show short
108
+ # abandoned Tasks or Tasks that failed to meet an SLA.
104
109
  # @return [WorkflowStatisticsInstance] Fetched WorkflowStatisticsInstance
105
110
  def fetch(minutes: :unset, start_date: :unset, end_date: :unset, task_channel: :unset, split_by_wait_time: :unset)
106
111
  params = Twilio::Values.of({
@@ -145,8 +150,10 @@ module Twilio
145
150
  # Initialize the WorkflowStatisticsInstance
146
151
  # @param [Version] version Version that contains the resource
147
152
  # @param [Hash] payload payload that contains response from Twilio
148
- # @param [String] workspace_sid The workspace_sid
149
- # @param [String] workflow_sid The workflow_sid
153
+ # @param [String] workspace_sid The SID of the Workspace that contains the
154
+ # Workflow.
155
+ # @param [String] workflow_sid Returns the list of Tasks that are being controlled
156
+ # by the Workflow with the specified SID value.
150
157
  # @return [WorkflowStatisticsInstance] WorkflowStatisticsInstance
151
158
  def initialize(version, payload, workspace_sid: nil, workflow_sid: nil)
152
159
  super(version)
@@ -182,60 +189,61 @@ module Twilio
182
189
  end
183
190
 
184
191
  ##
185
- # @return [String] The account_sid
192
+ # @return [String] The SID of the Account that created the resource
186
193
  def account_sid
187
194
  @properties['account_sid']
188
195
  end
189
196
 
190
197
  ##
191
- # @return [Hash] The cumulative
198
+ # @return [Hash] An object that contains the cumulative statistics for the Workflow
192
199
  def cumulative
193
200
  @properties['cumulative']
194
201
  end
195
202
 
196
203
  ##
197
- # @return [Hash] The realtime
204
+ # @return [Hash] An object that contains the real-time statistics for the Workflow
198
205
  def realtime
199
206
  @properties['realtime']
200
207
  end
201
208
 
202
209
  ##
203
- # @return [String] The workflow_sid
210
+ # @return [String] Returns the list of Tasks that are being controlled by the Workflow with the specified SID value
204
211
  def workflow_sid
205
212
  @properties['workflow_sid']
206
213
  end
207
214
 
208
215
  ##
209
- # @return [String] The workspace_sid
216
+ # @return [String] The SID of the Workspace that contains the Workflow
210
217
  def workspace_sid
211
218
  @properties['workspace_sid']
212
219
  end
213
220
 
214
221
  ##
215
- # @return [String] The url
222
+ # @return [String] The absolute URL of the Workflow statistics resource
216
223
  def url
217
224
  @properties['url']
218
225
  end
219
226
 
220
227
  ##
221
228
  # Fetch a WorkflowStatisticsInstance
222
- # @param [String] minutes Filter cumulative statistics by up to 'x' minutes in the
223
- # past. This is helpful for statistics for the last 15 minutes, 240 minutes (4
224
- # hours), and 480 minutes (8 hours) to see trends. Defaults to 15 minutes.
225
- # @param [Time] start_date Filter cumulative statistics by a start date. This is
226
- # helpful for defining a range of statistics to capture. Input is a GMT ISO 8601
227
- # Timestamp
228
- # @param [Time] end_date Filter cumulative statistics by an end date. This is
229
- # helpful for defining a range of statistics to capture. Input is a GMT ISO 8601
230
- # Timestamp
231
- # @param [String] task_channel Filter real-time and cumulative statistics by
232
- # TaskChannel. Takes in a Unique Name ("voice", "sms", "default", etc.) or a
233
- # TaskChannelSid.
234
- # @param [String] split_by_wait_time A comma separated values for viewing splits
235
- # of tasks canceled and accepted above the given threshold in seconds. Ex: "5,30"
236
- # would show splits of tasks that were canceled or accepted before or after 5
237
- # seconds and respectively, 30 seconds. This is great for showing short abandoned
238
- # tasks or tasks that failed to meet your SLA.
229
+ # @param [String] minutes Only calculate statistics since this many minutes in the
230
+ # past. The default 15 minutes. This is helpful for displaying statistics for the
231
+ # last 15 minutes, 240 minutes (4 hours), and 480 minutes (8 hours) to see trends.
232
+ # @param [Time] start_date Only calculate statistics from this date and time and
233
+ # later, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
234
+ # @param [Time] end_date Only calculate statistics from this date and time and
235
+ # earlier, specified in GMT as an [ISO
236
+ # 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time.
237
+ # @param [String] task_channel Only calculate real-time statistics on this
238
+ # TaskChannel. Can be the TaskChannel's SID or its `unique_name`, such as `voice`,
239
+ # `sms`, or `default`.
240
+ # @param [String] split_by_wait_time A comma separated list of values that
241
+ # describes the thresholds, in seconds, to calculate statistics on. For each
242
+ # threshold specified, the number of Tasks canceled and reservations accepted
243
+ # above and below the specified thresholds in seconds are computed. For example,
244
+ # `5,30` would show splits of Tasks that were canceled or accepted before and
245
+ # after 5 seconds and before and after 30 seconds. This can be used to show short
246
+ # abandoned Tasks or Tasks that failed to meet an SLA.
239
247
  # @return [WorkflowStatisticsInstance] Fetched WorkflowStatisticsInstance
240
248
  def fetch(minutes: :unset, start_date: :unset, end_date: :unset, task_channel: :unset, split_by_wait_time: :unset)
241
249
  context.fetch(
@@ -15,7 +15,7 @@ module Twilio
15
15
  ##
16
16
  # Initialize the WorkspaceCumulativeStatisticsList
17
17
  # @param [Version] version Version that contains the resource
18
- # @param [String] workspace_sid The workspace_sid
18
+ # @param [String] workspace_sid The SID of the Workspace.
19
19
  # @return [WorkspaceCumulativeStatisticsList] WorkspaceCumulativeStatisticsList
20
20
  def initialize(version, workspace_sid: nil)
21
21
  super(version)
@@ -68,7 +68,7 @@ module Twilio
68
68
  ##
69
69
  # Initialize the WorkspaceCumulativeStatisticsContext
70
70
  # @param [Version] version Version that contains the resource
71
- # @param [String] workspace_sid The workspace_sid
71
+ # @param [String] workspace_sid The SID of the Workspace to fetch.
72
72
  # @return [WorkspaceCumulativeStatisticsContext] WorkspaceCumulativeStatisticsContext
73
73
  def initialize(version, workspace_sid)
74
74
  super(version)
@@ -80,23 +80,24 @@ module Twilio
80
80
 
81
81
  ##
82
82
  # Fetch a WorkspaceCumulativeStatisticsInstance
83
- # @param [Time] end_date Filter cumulative statistics by an end date. This is
84
- # helpful for defining a range of statistics to capture. Input is a GMT ISO 8601
85
- # Timestamp
86
- # @param [String] minutes Filter cumulative statistics by up to 'x' minutes in the
87
- # past. This is helpful for statistics for the last 15 minutes, 240 minutes (4
88
- # hours), and 480 minutes (8 hours) to see trends. Defaults to 15 minutes.
89
- # @param [Time] start_date Filter cumulative statistics by a start date. This is
90
- # helpful for defining a range of statistics to capture. Input is a GMT ISO 8601
91
- # Timestamp
92
- # @param [String] task_channel Filter real-time and cumulative statistics by
93
- # TaskChannel. Takes in a Unique Name ("voice", "sms", "default", etc.) or a
94
- # TaskChannelSid.
95
- # @param [String] split_by_wait_time A comma separated values for viewing splits
96
- # of tasks canceled and accepted above the given threshold in seconds. Ex: "5,30"
97
- # would show splits of tasks that were canceled or accepted before or after 5
98
- # seconds and respectively, 30 seconds. This is great for showing short abandoned
99
- # tasks or tasks that failed to meet your SLA.
83
+ # @param [Time] end_date Only include usage that occurred on or before this date,
84
+ # specified in GMT as an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
85
+ # date-time.
86
+ # @param [String] minutes Only calculate statistics since this many minutes in the
87
+ # past. The default 15 minutes. This is helpful for displaying statistics for the
88
+ # last 15 minutes, 240 minutes (4 hours), and 480 minutes (8 hours) to see trends.
89
+ # @param [Time] start_date Only calculate statistics from this date and time and
90
+ # later, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
91
+ # @param [String] task_channel Only calculate cumulative statistics on this
92
+ # TaskChannel. Can be the TaskChannel's SID or its `unique_name`, such as `voice`,
93
+ # `sms`, or `default`.
94
+ # @param [String] split_by_wait_time A comma separated list of values that
95
+ # describes the thresholds, in seconds, to calculate statistics on. For each
96
+ # threshold specified, the number of Tasks canceled and reservations accepted
97
+ # above and below the specified thresholds in seconds are computed. For example,
98
+ # `5,30` would show splits of Tasks that were canceled or accepted before and
99
+ # after 5 seconds and before and after 30 seconds. This can be used to show short
100
+ # abandoned Tasks or Tasks that failed to meet an SLA.
100
101
  # @return [WorkspaceCumulativeStatisticsInstance] Fetched WorkspaceCumulativeStatisticsInstance
101
102
  def fetch(end_date: :unset, minutes: :unset, start_date: :unset, task_channel: :unset, split_by_wait_time: :unset)
102
103
  params = Twilio::Values.of({
@@ -140,7 +141,7 @@ module Twilio
140
141
  # Initialize the WorkspaceCumulativeStatisticsInstance
141
142
  # @param [Version] version Version that contains the resource
142
143
  # @param [Hash] payload payload that contains response from Twilio
143
- # @param [String] workspace_sid The workspace_sid
144
+ # @param [String] workspace_sid The SID of the Workspace.
144
145
  # @return [WorkspaceCumulativeStatisticsInstance] WorkspaceCumulativeStatisticsInstance
145
146
  def initialize(version, payload, workspace_sid: nil)
146
147
  super(version)
@@ -187,25 +188,25 @@ module Twilio
187
188
  end
188
189
 
189
190
  ##
190
- # @return [String] The account_sid
191
+ # @return [String] The SID of the Account that created the resource
191
192
  def account_sid
192
193
  @properties['account_sid']
193
194
  end
194
195
 
195
196
  ##
196
- # @return [String] The average time from Task creation to acceptance
197
+ # @return [String] The average time in seconds between Task creation and acceptance
197
198
  def avg_task_acceptance_time
198
199
  @properties['avg_task_acceptance_time']
199
200
  end
200
201
 
201
202
  ##
202
- # @return [Time] The start_time
203
+ # @return [Time] The beginning of the interval during which these statistics were calculated
203
204
  def start_time
204
205
  @properties['start_time']
205
206
  end
206
207
 
207
208
  ##
208
- # @return [Time] The end_time
209
+ # @return [Time] The end of the interval during which these statistics were calculated
209
210
  def end_time
210
211
  @properties['end_time']
211
212
  end
@@ -247,19 +248,19 @@ module Twilio
247
248
  end
248
249
 
249
250
  ##
250
- # @return [Hash] The splits of the tasks canceled and accepted based on the provided SplitByWaitTime parameter.
251
+ # @return [Hash] A list of objects that describe the Tasks canceled and reservations accepted above and below the specified thresholds
251
252
  def split_by_wait_time
252
253
  @properties['split_by_wait_time']
253
254
  end
254
255
 
255
256
  ##
256
- # @return [Hash] The wait duration stats for tasks that were accepted.
257
+ # @return [Hash] The wait duration statistics for Tasks that were accepted
257
258
  def wait_duration_until_accepted
258
259
  @properties['wait_duration_until_accepted']
259
260
  end
260
261
 
261
262
  ##
262
- # @return [Hash] The wait duration stats for tasks that were canceled.
263
+ # @return [Hash] The wait duration statistics for Tasks that were canceled
263
264
  def wait_duration_until_canceled
264
265
  @properties['wait_duration_until_canceled']
265
266
  end
@@ -301,36 +302,37 @@ module Twilio
301
302
  end
302
303
 
303
304
  ##
304
- # @return [String] The workspace_sid
305
+ # @return [String] The SID of the Workspace
305
306
  def workspace_sid
306
307
  @properties['workspace_sid']
307
308
  end
308
309
 
309
310
  ##
310
- # @return [String] The url
311
+ # @return [String] The absolute URL of the Workspace statistics resource
311
312
  def url
312
313
  @properties['url']
313
314
  end
314
315
 
315
316
  ##
316
317
  # Fetch a WorkspaceCumulativeStatisticsInstance
317
- # @param [Time] end_date Filter cumulative statistics by an end date. This is
318
- # helpful for defining a range of statistics to capture. Input is a GMT ISO 8601
319
- # Timestamp
320
- # @param [String] minutes Filter cumulative statistics by up to 'x' minutes in the
321
- # past. This is helpful for statistics for the last 15 minutes, 240 minutes (4
322
- # hours), and 480 minutes (8 hours) to see trends. Defaults to 15 minutes.
323
- # @param [Time] start_date Filter cumulative statistics by a start date. This is
324
- # helpful for defining a range of statistics to capture. Input is a GMT ISO 8601
325
- # Timestamp
326
- # @param [String] task_channel Filter real-time and cumulative statistics by
327
- # TaskChannel. Takes in a Unique Name ("voice", "sms", "default", etc.) or a
328
- # TaskChannelSid.
329
- # @param [String] split_by_wait_time A comma separated values for viewing splits
330
- # of tasks canceled and accepted above the given threshold in seconds. Ex: "5,30"
331
- # would show splits of tasks that were canceled or accepted before or after 5
332
- # seconds and respectively, 30 seconds. This is great for showing short abandoned
333
- # tasks or tasks that failed to meet your SLA.
318
+ # @param [Time] end_date Only include usage that occurred on or before this date,
319
+ # specified in GMT as an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
320
+ # date-time.
321
+ # @param [String] minutes Only calculate statistics since this many minutes in the
322
+ # past. The default 15 minutes. This is helpful for displaying statistics for the
323
+ # last 15 minutes, 240 minutes (4 hours), and 480 minutes (8 hours) to see trends.
324
+ # @param [Time] start_date Only calculate statistics from this date and time and
325
+ # later, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
326
+ # @param [String] task_channel Only calculate cumulative statistics on this
327
+ # TaskChannel. Can be the TaskChannel's SID or its `unique_name`, such as `voice`,
328
+ # `sms`, or `default`.
329
+ # @param [String] split_by_wait_time A comma separated list of values that
330
+ # describes the thresholds, in seconds, to calculate statistics on. For each
331
+ # threshold specified, the number of Tasks canceled and reservations accepted
332
+ # above and below the specified thresholds in seconds are computed. For example,
333
+ # `5,30` would show splits of Tasks that were canceled or accepted before and
334
+ # after 5 seconds and before and after 30 seconds. This can be used to show short
335
+ # abandoned Tasks or Tasks that failed to meet an SLA.
334
336
  # @return [WorkspaceCumulativeStatisticsInstance] Fetched WorkspaceCumulativeStatisticsInstance
335
337
  def fetch(end_date: :unset, minutes: :unset, start_date: :unset, task_channel: :unset, split_by_wait_time: :unset)
336
338
  context.fetch(
@@ -15,7 +15,7 @@ module Twilio
15
15
  ##
16
16
  # Initialize the WorkspaceRealTimeStatisticsList
17
17
  # @param [Version] version Version that contains the resource
18
- # @param [String] workspace_sid The workspace_sid
18
+ # @param [String] workspace_sid The SID of the Workspace.
19
19
  # @return [WorkspaceRealTimeStatisticsList] WorkspaceRealTimeStatisticsList
20
20
  def initialize(version, workspace_sid: nil)
21
21
  super(version)
@@ -64,7 +64,7 @@ module Twilio
64
64
  ##
65
65
  # Initialize the WorkspaceRealTimeStatisticsContext
66
66
  # @param [Version] version Version that contains the resource
67
- # @param [String] workspace_sid The workspace_sid
67
+ # @param [String] workspace_sid The SID of the Workspace to fetch.
68
68
  # @return [WorkspaceRealTimeStatisticsContext] WorkspaceRealTimeStatisticsContext
69
69
  def initialize(version, workspace_sid)
70
70
  super(version)
@@ -76,9 +76,9 @@ module Twilio
76
76
 
77
77
  ##
78
78
  # Fetch a WorkspaceRealTimeStatisticsInstance
79
- # @param [String] task_channel Filter real-time and cumulative statistics by
80
- # TaskChannel. Takes in a Unique Name ("voice", "sms", "default", etc.) or a
81
- # TaskChannelSid.
79
+ # @param [String] task_channel Only calculate real-time statistics on this
80
+ # TaskChannel. Can be the TaskChannel's SID or its `unique_name`, such as `voice`,
81
+ # `sms`, or `default`.
82
82
  # @return [WorkspaceRealTimeStatisticsInstance] Fetched WorkspaceRealTimeStatisticsInstance
83
83
  def fetch(task_channel: :unset)
84
84
  params = Twilio::Values.of({'TaskChannel' => task_channel, })
@@ -112,7 +112,7 @@ module Twilio
112
112
  # Initialize the WorkspaceRealTimeStatisticsInstance
113
113
  # @param [Version] version Version that contains the resource
114
114
  # @param [Hash] payload payload that contains response from Twilio
115
- # @param [String] workspace_sid The workspace_sid
115
+ # @param [String] workspace_sid The SID of the Workspace.
116
116
  # @return [WorkspaceRealTimeStatisticsInstance] WorkspaceRealTimeStatisticsInstance
117
117
  def initialize(version, payload, workspace_sid: nil)
118
118
  super(version)
@@ -148,13 +148,13 @@ module Twilio
148
148
  end
149
149
 
150
150
  ##
151
- # @return [String] The account_sid
151
+ # @return [String] The SID of the Account that created the resource
152
152
  def account_sid
153
153
  @properties['account_sid']
154
154
  end
155
155
 
156
156
  ##
157
- # @return [Hash] A breakdown of Workers by Activity
157
+ # @return [Hash] The number of current Workers by Activity
158
158
  def activity_statistics
159
159
  @properties['activity_statistics']
160
160
  end
@@ -166,19 +166,19 @@ module Twilio
166
166
  end
167
167
 
168
168
  ##
169
- # @return [String] The longest_task_waiting_sid
169
+ # @return [String] The SID of the longest waiting Task
170
170
  def longest_task_waiting_sid
171
171
  @properties['longest_task_waiting_sid']
172
172
  end
173
173
 
174
174
  ##
175
- # @return [Hash] The tasks_by_priority
175
+ # @return [Hash] The number of Tasks by priority
176
176
  def tasks_by_priority
177
177
  @properties['tasks_by_priority']
178
178
  end
179
179
 
180
180
  ##
181
- # @return [Hash] The Tasks broken down by status
181
+ # @return [Hash] The number of Tasks by their current status
182
182
  def tasks_by_status
183
183
  @properties['tasks_by_status']
184
184
  end
@@ -190,28 +190,28 @@ module Twilio
190
190
  end
191
191
 
192
192
  ##
193
- # @return [String] The total number of Workers in the workspace
193
+ # @return [String] The total number of Workers in the Workspace
194
194
  def total_workers
195
195
  @properties['total_workers']
196
196
  end
197
197
 
198
198
  ##
199
- # @return [String] The workspace_sid
199
+ # @return [String] The SID of the Workspace
200
200
  def workspace_sid
201
201
  @properties['workspace_sid']
202
202
  end
203
203
 
204
204
  ##
205
- # @return [String] The url
205
+ # @return [String] The absolute URL of the Workspace statistics resource
206
206
  def url
207
207
  @properties['url']
208
208
  end
209
209
 
210
210
  ##
211
211
  # Fetch a WorkspaceRealTimeStatisticsInstance
212
- # @param [String] task_channel Filter real-time and cumulative statistics by
213
- # TaskChannel. Takes in a Unique Name ("voice", "sms", "default", etc.) or a
214
- # TaskChannelSid.
212
+ # @param [String] task_channel Only calculate real-time statistics on this
213
+ # TaskChannel. Can be the TaskChannel's SID or its `unique_name`, such as `voice`,
214
+ # `sms`, or `default`.
215
215
  # @return [WorkspaceRealTimeStatisticsInstance] Fetched WorkspaceRealTimeStatisticsInstance
216
216
  def fetch(task_channel: :unset)
217
217
  context.fetch(task_channel: task_channel, )