Class: Twilio::REST::Taskrouter::V1::WorkspaceContext

Inherits:
InstanceContext show all
Defined in:
lib/twilio-ruby/rest/taskrouter/v1/workspace.rb,
lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb,
lib/twilio-ruby/rest/taskrouter/v1/workspace/event.rb,
lib/twilio-ruby/rest/taskrouter/v1/workspace/worker.rb,
lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb,
lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb,
lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb,
lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb,
lib/twilio-ruby/rest/taskrouter/v1/workspace/task/reservation.rb,
lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/reservation.rb,
lib/twilio-ruby/rest/taskrouter/v1/workspace/workspace_statistics.rb,
lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/worker_channel.rb,
lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/worker_statistics.rb,
lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/workers_statistics.rb,
lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_statistics.rb,
lib/twilio-ruby/rest/taskrouter/v1/workspace/workspace_real_time_statistics.rb,
lib/twilio-ruby/rest/taskrouter/v1/workspace/workspace_cumulative_statistics.rb,
lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_statistics.rb,
lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queues_statistics.rb,
lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/workers_real_time_statistics.rb,
lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/workers_cumulative_statistics.rb,
lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_real_time_statistics.rb,
lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_cumulative_statistics.rb,
lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_real_time_statistics.rb,
lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_cumulative_statistics.rb

Defined Under Namespace

Classes: ActivityContext, ActivityInstance, ActivityList, ActivityPage, EventContext, EventInstance, EventList, EventPage, TaskChannelContext, TaskChannelInstance, TaskChannelList, TaskChannelPage, TaskContext, TaskInstance, TaskList, TaskPage, TaskQueueContext, TaskQueueInstance, TaskQueueList, TaskQueuePage, WorkerContext, WorkerInstance, WorkerList, WorkerPage, WorkflowContext, WorkflowInstance, WorkflowList, WorkflowPage, WorkspaceCumulativeStatisticsContext, WorkspaceCumulativeStatisticsInstance, WorkspaceCumulativeStatisticsList, WorkspaceCumulativeStatisticsPage, WorkspaceRealTimeStatisticsContext, WorkspaceRealTimeStatisticsInstance, WorkspaceRealTimeStatisticsList, WorkspaceRealTimeStatisticsPage, WorkspaceStatisticsContext, WorkspaceStatisticsInstance, WorkspaceStatisticsList, WorkspaceStatisticsPage

Instance Method Summary collapse

Constructor Details

#initialize(version, sid) ⇒ WorkspaceContext

Initialize the WorkspaceContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • sid (String) —

    The sid



196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 196

def initialize(version, sid)
  super(version)

  # Path Solution
  @solution = {
      sid: sid,
  }
  @uri = "/Workspaces/#{@solution[:sid]}"

  # Dependents
  @activities = nil
  @events = nil
  @tasks = nil
  @task_queues = nil
  @workers = nil
  @workflows = nil
  @statistics = nil
  @real_time_statistics = nil
  @cumulative_statistics = nil
  @task_channels = nil
end

Instance Method Details

#activities(sid = :unset) ⇒ ActivityList, ActivityContext

Access the activities

Returns:

Raises:

  • (ArgumentError) 


282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 282

def activities(sid=:unset)
  raise ArgumentError, 'sid cannot be nil' if sid.nil?

  if sid != :unset
    return ActivityContext.new(
        @version,
        @solution[:sid],
        sid,
    )
  end

  unless @activities
    @activities = ActivityList.new(
        @version,
        workspace_sid: @solution[:sid],
    )
  end

  @activities
end

#cumulative_statistics ⇒ WorkspaceCumulativeStatisticsList, WorkspaceCumulativeStatisticsContext

Access the cumulative_statistics

Returns:



454
455
456
457
458
459
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 454

def cumulative_statistics
  WorkspaceCumulativeStatisticsContext.new(
      @version,
      @solution[:sid],
  )
end

#delete ⇒ Boolean

Deletes the WorkspaceInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



274
275
276
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 274

def delete
  @version.delete('delete', @uri)
end

#events(sid = :unset) ⇒ EventList, EventContext

Access the events

Returns:

Raises:

  • (ArgumentError) 


307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 307

def events(sid=:unset)
  raise ArgumentError, 'sid cannot be nil' if sid.nil?

  if sid != :unset
    return EventContext.new(
        @version,
        @solution[:sid],
        sid,
    )
  end

  unless @events
    @events = EventList.new(
        @version,
        workspace_sid: @solution[:sid],
    )
  end

  @events
end

#fetch ⇒ WorkspaceInstance

Fetch a WorkspaceInstance

Returns:



221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 221

def fetch
  params = Twilio::Values.of({})

  payload = @version.fetch(
      'GET',
      @uri,
      params,
  )

  WorkspaceInstance.new(
      @version,
      payload,
      sid: @solution[:sid],
  )
end

#real_time_statistics ⇒ WorkspaceRealTimeStatisticsList, WorkspaceRealTimeStatisticsContext

Access the real_time_statistics

Returns:



443
444
445
446
447
448
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 443

def real_time_statistics
  WorkspaceRealTimeStatisticsContext.new(
      @version,
      @solution[:sid],
  )
end

#statistics ⇒ WorkspaceStatisticsList, WorkspaceStatisticsContext

Access the statistics

Returns:



432
433
434
435
436
437
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 432

def statistics
  WorkspaceStatisticsContext.new(
      @version,
      @solution[:sid],
  )
end

#task_channels(sid = :unset) ⇒ TaskChannelList, TaskChannelContext

Access the task_channels

Returns:

Raises:

  • (ArgumentError) 


465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 465

def task_channels(sid=:unset)
  raise ArgumentError, 'sid cannot be nil' if sid.nil?

  if sid != :unset
    return TaskChannelContext.new(
        @version,
        @solution[:sid],
        sid,
    )
  end

  unless @task_channels
    @task_channels = TaskChannelList.new(
        @version,
        workspace_sid: @solution[:sid],
    )
  end

  @task_channels
end

#task_queues(sid = :unset) ⇒ TaskQueueList, TaskQueueContext

Access the task_queues

Returns:

Raises:

  • (ArgumentError) 


357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 357

def task_queues(sid=:unset)
  raise ArgumentError, 'sid cannot be nil' if sid.nil?

  if sid != :unset
    return TaskQueueContext.new(
        @version,
        @solution[:sid],
        sid,
    )
  end

  unless @task_queues
    @task_queues = TaskQueueList.new(
        @version,
        workspace_sid: @solution[:sid],
    )
  end

  @task_queues
end

#tasks(sid = :unset) ⇒ TaskList, TaskContext

Access the tasks

Returns:

Raises:

  • (ArgumentError) 


332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 332

def tasks(sid=:unset)
  raise ArgumentError, 'sid cannot be nil' if sid.nil?

  if sid != :unset
    return TaskContext.new(
        @version,
        @solution[:sid],
        sid,
    )
  end

  unless @tasks
    @tasks = TaskList.new(
        @version,
        workspace_sid: @solution[:sid],
    )
  end

  @tasks
end

#to_s ⇒ Object

Provide a user friendly representation



488
489
490
491
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 488

def to_s
  context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
  "#<Twilio.Taskrouter.V1.WorkspaceContext #{context}>"
end

#update(default_activity_sid: :unset, event_callback_url: :unset, events_filter: :unset, friendly_name: :unset, multi_task_enabled: :unset, timeout_activity_sid: :unset, prioritize_queue_order: :unset) ⇒ WorkspaceInstance

Update the WorkspaceInstance

Parameters:

  • default_activity_sid (String) (defaults to: :unset) —

    The default_activity_sid

  • event_callback_url (String) (defaults to: :unset) —

    The event_callback_url

  • events_filter (String) (defaults to: :unset) —

    The events_filter

  • friendly_name (String) (defaults to: :unset) —

    The friendly_name

  • multi_task_enabled (Boolean) (defaults to: :unset) —

    The multi_task_enabled

  • timeout_activity_sid (String) (defaults to: :unset) —

    The timeout_activity_sid

  • prioritize_queue_order (workspace.QueueOrder) (defaults to: :unset) —

    The prioritize_queue_order

Returns:



247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 247

def update(default_activity_sid: :unset, event_callback_url: :unset, events_filter: :unset, friendly_name: :unset, multi_task_enabled: :unset, timeout_activity_sid: :unset, prioritize_queue_order: :unset)
  data = Twilio::Values.of({
      'DefaultActivitySid' => default_activity_sid,
      'EventCallbackUrl' => event_callback_url,
      'EventsFilter' => events_filter,
      'FriendlyName' => friendly_name,
      'MultiTaskEnabled' => multi_task_enabled,
      'TimeoutActivitySid' => timeout_activity_sid,
      'PrioritizeQueueOrder' => prioritize_queue_order,
  })

  payload = @version.update(
      'POST',
      @uri,
      data: data,
  )

  WorkspaceInstance.new(
      @version,
      payload,
      sid: @solution[:sid],
  )
end

#workers(sid = :unset) ⇒ WorkerList, WorkerContext

Access the workers

Returns:

Raises:

  • (ArgumentError) 


382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 382

def workers(sid=:unset)
  raise ArgumentError, 'sid cannot be nil' if sid.nil?

  if sid != :unset
    return WorkerContext.new(
        @version,
        @solution[:sid],
        sid,
    )
  end

  unless @workers
    @workers = WorkerList.new(
        @version,
        workspace_sid: @solution[:sid],
    )
  end

  @workers
end

#workflows(sid = :unset) ⇒ WorkflowList, WorkflowContext

Access the workflows

Returns:

Raises:

  • (ArgumentError) 


407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 407

def workflows(sid=:unset)
  raise ArgumentError, 'sid cannot be nil' if sid.nil?

  if sid != :unset
    return WorkflowContext.new(
        @version,
        @solution[:sid],
        sid,
    )
  end

  unless @workflows
    @workflows = WorkflowList.new(
        @version,
        workspace_sid: @solution[:sid],
    )
  end

  @workflows
end