Class: Twilio::REST::Taskrouter::V1::WorkspaceContext::WorkspaceCumulativeStatisticsInstance
- Inherits:
-
InstanceResource
- Object
- InstanceResource
- Twilio::REST::Taskrouter::V1::WorkspaceContext::WorkspaceCumulativeStatisticsInstance
- Defined in:
- lib/twilio-ruby/rest/taskrouter/v1/workspace/workspace_cumulative_statistics.rb
Instance Method Summary collapse
-
#account_sid ⇒ String
The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the Workspace resource.
-
#avg_task_acceptance_time ⇒ String
The average time in seconds between Task creation and acceptance.
-
#context ⇒ WorkspaceCumulativeStatisticsContext
Generate an instance context for the instance, the context is capable of performing various actions.
-
#end_time ⇒ Time
The end of the interval during which these statistics were calculated, in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.
-
#fetch(end_date: :unset, minutes: :unset, start_date: :unset, task_channel: :unset, split_by_wait_time: :unset) ⇒ WorkspaceCumulativeStatisticsInstance
Fetch the WorkspaceCumulativeStatisticsInstance.
-
#initialize(version, payload, workspace_sid: nil) ⇒ WorkspaceCumulativeStatisticsInstance
constructor
Initialize the WorkspaceCumulativeStatisticsInstance.
-
#inspect ⇒ Object
Provide a detailed, user friendly representation.
-
#reservations_accepted ⇒ String
The total number of Reservations accepted by Workers.
-
#reservations_canceled ⇒ String
The total number of Reservations that were canceled.
-
#reservations_created ⇒ String
The total number of Reservations that were created for Workers.
-
#reservations_rejected ⇒ String
The total number of Reservations that were rejected.
-
#reservations_rescinded ⇒ String
The total number of Reservations that were rescinded.
-
#reservations_timed_out ⇒ String
The total number of Reservations that were timed out.
-
#split_by_wait_time ⇒ Hash
A list of objects that describe the number of Tasks canceled and reservations accepted above and below the thresholds specified in seconds.
-
#start_time ⇒ Time
The beginning of the interval during which these statistics were calculated, in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.
-
#tasks_canceled ⇒ String
The total number of Tasks that were canceled.
-
#tasks_completed ⇒ String
The total number of Tasks that were completed.
-
#tasks_created ⇒ String
The total number of Tasks created.
-
#tasks_deleted ⇒ String
The total number of Tasks that were deleted.
-
#tasks_moved ⇒ String
The total number of Tasks that were moved from one queue to another.
-
#tasks_timed_out_in_workflow ⇒ String
The total number of Tasks that were timed out of their Workflows (and deleted).
-
#to_s ⇒ Object
Provide a user friendly representation.
-
#url ⇒ String
The absolute URL of the Workspace statistics resource.
-
#wait_duration_until_accepted ⇒ Hash
The wait duration statistics (‘avg`, `min`, `max`, `total`) for Tasks that were accepted.
-
#wait_duration_until_canceled ⇒ Hash
The wait duration statistics (‘avg`, `min`, `max`, `total`) for Tasks that were canceled.
-
#workspace_sid ⇒ String
The SID of the Workspace.
Constructor Details
#initialize(version, payload, workspace_sid: nil) ⇒ WorkspaceCumulativeStatisticsInstance
Initialize the WorkspaceCumulativeStatisticsInstance
144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workspace_cumulative_statistics.rb', line 144 def initialize(version, payload , workspace_sid: nil) super(version) # Marshaled Properties @properties = { 'account_sid' => payload['account_sid'], 'avg_task_acceptance_time' => payload['avg_task_acceptance_time'] == nil ? payload['avg_task_acceptance_time'] : payload['avg_task_acceptance_time'].to_i, 'start_time' => Twilio.deserialize_iso8601_datetime(payload['start_time']), 'end_time' => Twilio.deserialize_iso8601_datetime(payload['end_time']), 'reservations_created' => payload['reservations_created'] == nil ? payload['reservations_created'] : payload['reservations_created'].to_i, 'reservations_accepted' => payload['reservations_accepted'] == nil ? payload['reservations_accepted'] : payload['reservations_accepted'].to_i, 'reservations_rejected' => payload['reservations_rejected'] == nil ? payload['reservations_rejected'] : payload['reservations_rejected'].to_i, 'reservations_timed_out' => payload['reservations_timed_out'] == nil ? payload['reservations_timed_out'] : payload['reservations_timed_out'].to_i, 'reservations_canceled' => payload['reservations_canceled'] == nil ? payload['reservations_canceled'] : payload['reservations_canceled'].to_i, 'reservations_rescinded' => payload['reservations_rescinded'] == nil ? payload['reservations_rescinded'] : payload['reservations_rescinded'].to_i, 'split_by_wait_time' => payload['split_by_wait_time'], 'wait_duration_until_accepted' => payload['wait_duration_until_accepted'], 'wait_duration_until_canceled' => payload['wait_duration_until_canceled'], 'tasks_canceled' => payload['tasks_canceled'] == nil ? payload['tasks_canceled'] : payload['tasks_canceled'].to_i, 'tasks_completed' => payload['tasks_completed'] == nil ? payload['tasks_completed'] : payload['tasks_completed'].to_i, 'tasks_created' => payload['tasks_created'] == nil ? payload['tasks_created'] : payload['tasks_created'].to_i, 'tasks_deleted' => payload['tasks_deleted'] == nil ? payload['tasks_deleted'] : payload['tasks_deleted'].to_i, 'tasks_moved' => payload['tasks_moved'] == nil ? payload['tasks_moved'] : payload['tasks_moved'].to_i, 'tasks_timed_out_in_workflow' => payload['tasks_timed_out_in_workflow'] == nil ? payload['tasks_timed_out_in_workflow'] : payload['tasks_timed_out_in_workflow'].to_i, 'workspace_sid' => payload['workspace_sid'], 'url' => payload['url'], } # Context @instance_context = nil @params = { 'workspace_sid' => workspace_sid || @properties['workspace_sid'] , } end |
Instance Method Details
#account_sid ⇒ String
Returns The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the Workspace resource.
190 191 192 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workspace_cumulative_statistics.rb', line 190 def account_sid @properties['account_sid'] end |
#avg_task_acceptance_time ⇒ String
Returns The average time in seconds between Task creation and acceptance.
196 197 198 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workspace_cumulative_statistics.rb', line 196 def avg_task_acceptance_time @properties['avg_task_acceptance_time'] end |
#context ⇒ WorkspaceCumulativeStatisticsContext
Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context
181 182 183 184 185 186 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workspace_cumulative_statistics.rb', line 181 def context unless @instance_context @instance_context = WorkspaceCumulativeStatisticsContext.new(@version , @params['workspace_sid']) end @instance_context end |
#end_time ⇒ Time
Returns The end of the interval during which these statistics were calculated, in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.
208 209 210 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workspace_cumulative_statistics.rb', line 208 def end_time @properties['end_time'] end |
#fetch(end_date: :unset, minutes: :unset, start_date: :unset, task_channel: :unset, split_by_wait_time: :unset) ⇒ WorkspaceCumulativeStatisticsInstance
Fetch the WorkspaceCumulativeStatisticsInstance
322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workspace_cumulative_statistics.rb', line 322 def fetch( end_date: :unset, minutes: :unset, start_date: :unset, task_channel: :unset, split_by_wait_time: :unset ) context.fetch( end_date: end_date, minutes: minutes, start_date: start_date, task_channel: task_channel, split_by_wait_time: split_by_wait_time, ) end |
#inspect ⇒ Object
Provide a detailed, user friendly representation
348 349 350 351 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workspace_cumulative_statistics.rb', line 348 def inspect values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Taskrouter.V1.WorkspaceCumulativeStatisticsInstance #{values}>" end |
#reservations_accepted ⇒ String
Returns The total number of Reservations accepted by Workers.
220 221 222 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workspace_cumulative_statistics.rb', line 220 def reservations_accepted @properties['reservations_accepted'] end |
#reservations_canceled ⇒ String
Returns The total number of Reservations that were canceled.
238 239 240 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workspace_cumulative_statistics.rb', line 238 def reservations_canceled @properties['reservations_canceled'] end |
#reservations_created ⇒ String
Returns The total number of Reservations that were created for Workers.
214 215 216 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workspace_cumulative_statistics.rb', line 214 def reservations_created @properties['reservations_created'] end |
#reservations_rejected ⇒ String
Returns The total number of Reservations that were rejected.
226 227 228 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workspace_cumulative_statistics.rb', line 226 def reservations_rejected @properties['reservations_rejected'] end |
#reservations_rescinded ⇒ String
Returns The total number of Reservations that were rescinded.
244 245 246 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workspace_cumulative_statistics.rb', line 244 def reservations_rescinded @properties['reservations_rescinded'] end |
#reservations_timed_out ⇒ String
Returns The total number of Reservations that were timed out.
232 233 234 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workspace_cumulative_statistics.rb', line 232 def reservations_timed_out @properties['reservations_timed_out'] end |
#split_by_wait_time ⇒ Hash
Returns A list of objects that describe the number of Tasks canceled and reservations accepted above and below the thresholds specified in seconds.
250 251 252 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workspace_cumulative_statistics.rb', line 250 def split_by_wait_time @properties['split_by_wait_time'] end |
#start_time ⇒ Time
Returns The beginning of the interval during which these statistics were calculated, in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.
202 203 204 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workspace_cumulative_statistics.rb', line 202 def start_time @properties['start_time'] end |
#tasks_canceled ⇒ String
Returns The total number of Tasks that were canceled.
268 269 270 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workspace_cumulative_statistics.rb', line 268 def tasks_canceled @properties['tasks_canceled'] end |
#tasks_completed ⇒ String
Returns The total number of Tasks that were completed.
274 275 276 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workspace_cumulative_statistics.rb', line 274 def tasks_completed @properties['tasks_completed'] end |
#tasks_created ⇒ String
Returns The total number of Tasks created.
280 281 282 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workspace_cumulative_statistics.rb', line 280 def tasks_created @properties['tasks_created'] end |
#tasks_deleted ⇒ String
Returns The total number of Tasks that were deleted.
286 287 288 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workspace_cumulative_statistics.rb', line 286 def tasks_deleted @properties['tasks_deleted'] end |
#tasks_moved ⇒ String
Returns The total number of Tasks that were moved from one queue to another.
292 293 294 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workspace_cumulative_statistics.rb', line 292 def tasks_moved @properties['tasks_moved'] end |
#tasks_timed_out_in_workflow ⇒ String
Returns The total number of Tasks that were timed out of their Workflows (and deleted).
298 299 300 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workspace_cumulative_statistics.rb', line 298 def tasks_timed_out_in_workflow @properties['tasks_timed_out_in_workflow'] end |
#to_s ⇒ Object
Provide a user friendly representation
341 342 343 344 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workspace_cumulative_statistics.rb', line 341 def to_s values = @params.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Taskrouter.V1.WorkspaceCumulativeStatisticsInstance #{values}>" end |
#url ⇒ String
Returns The absolute URL of the Workspace statistics resource.
310 311 312 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workspace_cumulative_statistics.rb', line 310 def url @properties['url'] end |
#wait_duration_until_accepted ⇒ Hash
Returns The wait duration statistics (‘avg`, `min`, `max`, `total`) for Tasks that were accepted.
256 257 258 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workspace_cumulative_statistics.rb', line 256 def wait_duration_until_accepted @properties['wait_duration_until_accepted'] end |
#wait_duration_until_canceled ⇒ Hash
Returns The wait duration statistics (‘avg`, `min`, `max`, `total`) for Tasks that were canceled.
262 263 264 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workspace_cumulative_statistics.rb', line 262 def wait_duration_until_canceled @properties['wait_duration_until_canceled'] end |
#workspace_sid ⇒ String
Returns The SID of the Workspace.
304 305 306 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workspace_cumulative_statistics.rb', line 304 def workspace_sid @properties['workspace_sid'] end |