Class: Twilio::REST::Taskrouter::V1::WorkspaceInstance

Inherits:
InstanceResource show all
Defined in:
lib/twilio-ruby/rest/taskrouter/v1/workspace.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, sid: nil) ⇒ WorkspaceInstance

Initialize the WorkspaceInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • sid (String) (defaults to: nil) —

    The sid



418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 418

def initialize(version, payload, sid: nil)
  super(version)

  # Marshaled Properties
  @properties = {
      'account_sid' => payload['account_sid'],
      'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
      'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
      'default_activity_name' => payload['default_activity_name'],
      'default_activity_sid' => payload['default_activity_sid'],
      'event_callback_url' => payload['event_callback_url'],
      'events_filter' => payload['events_filter'],
      'friendly_name' => payload['friendly_name'],
      'multi_task_enabled' => payload['multi_task_enabled'],
      'sid' => payload['sid'],
      'timeout_activity_name' => payload['timeout_activity_name'],
      'timeout_activity_sid' => payload['timeout_activity_sid'],
      'prioritize_queue_order' => payload['prioritize_queue_order'],
      'url' => payload['url'],
      'links' => payload['links'],
  }

  # Context
  @instance_context = nil
  @params = {'sid' => sid || @properties['sid'], }
end

Instance Method Details

#account_sid ⇒ String

Returns The account_sid.

Returns:

  • (String) —

    The account_sid



458
459
460
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 458

def 
  @properties['account_sid']
end

#activities ⇒ activities

Access the activities

Returns:



585
586
587
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 585

def activities
  context.activities
end

#context ⇒ WorkspaceContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context

Returns:



449
450
451
452
453
454
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 449

def context
  unless @instance_context
    @instance_context = WorkspaceContext.new(@version, @params['sid'], )
  end
  @instance_context
end

#cumulative_statistics ⇒ cumulative_statistics

Access the cumulative_statistics

Returns:



641
642
643
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 641

def cumulative_statistics
  context.cumulative_statistics
end

#date_created ⇒ Time

Returns The date_created.

Returns:

  • (Time) —

    The date_created



464
465
466
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 464

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date_updated.

Returns:

  • (Time) —

    The date_updated



470
471
472
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 470

def date_updated
  @properties['date_updated']
end

#default_activity_name ⇒ String

Returns The default_activity_name.

Returns:

  • (String) —

    The default_activity_name



476
477
478
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 476

def default_activity_name
  @properties['default_activity_name']
end

#default_activity_sid ⇒ String

Returns The default_activity_sid.

Returns:

  • (String) —

    The default_activity_sid



482
483
484
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 482

def default_activity_sid
  @properties['default_activity_sid']
end

#delete ⇒ Boolean

Deletes the WorkspaceInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



578
579
580
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 578

def delete
  context.delete
end

#event_callback_url ⇒ String

Returns The event_callback_url.

Returns:

  • (String) —

    The event_callback_url



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

def event_callback_url
  @properties['event_callback_url']
end

#events ⇒ events

Access the events

Returns:



592
593
594
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 592

def events
  context.events
end

#events_filter ⇒ String

Returns The events_filter.

Returns:

  • (String) —

    The events_filter



494
495
496
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 494

def events_filter
  @properties['events_filter']
end

#fetch ⇒ WorkspaceInstance

Fetch a WorkspaceInstance

Returns:



549
550
551
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 549

def fetch
  context.fetch
end

#friendly_name ⇒ String

Returns The friendly_name.

Returns:

  • (String) —

    The friendly_name



500
501
502
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 500

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



661
662
663
664
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 661

def inspect
  values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
  "<Twilio.Taskrouter.V1.WorkspaceInstance #{values}>"
end

#links ⇒ String

Returns The links.

Returns:

  • (String) —

    The links



542
543
544
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 542

def links
  @properties['links']
end

#multi_task_enabled ⇒ Boolean

Returns The multi_task_enabled.

Returns:

  • (Boolean) —

    The multi_task_enabled



506
507
508
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 506

def multi_task_enabled
  @properties['multi_task_enabled']
end

#prioritize_queue_order ⇒ workspace.QueueOrder

Returns The prioritize_queue_order.

Returns:

  • (workspace.QueueOrder) —

    The prioritize_queue_order



530
531
532
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 530

def prioritize_queue_order
  @properties['prioritize_queue_order']
end

#real_time_statistics ⇒ real_time_statistics

Access the real_time_statistics

Returns:



634
635
636
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 634

def real_time_statistics
  context.real_time_statistics
end

#sid ⇒ String

Returns The sid.

Returns:

  • (String) —

    The sid



512
513
514
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 512

def sid
  @properties['sid']
end

#statistics ⇒ statistics

Access the statistics

Returns:



627
628
629
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 627

def statistics
  context.statistics
end

#task_channels ⇒ task_channels

Access the task_channels

Returns:



648
649
650
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 648

def task_channels
  context.task_channels
end

#task_queues ⇒ task_queues

Access the task_queues

Returns:



606
607
608
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 606

def task_queues
  context.task_queues
end

#tasks ⇒ tasks

Access the tasks

Returns:



599
600
601
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 599

def tasks
  context.tasks
end

#timeout_activity_name ⇒ String

Returns The timeout_activity_name.

Returns:

  • (String) —

    The timeout_activity_name



518
519
520
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 518

def timeout_activity_name
  @properties['timeout_activity_name']
end

#timeout_activity_sid ⇒ String

Returns The timeout_activity_sid.

Returns:

  • (String) —

    The timeout_activity_sid



524
525
526
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 524

def timeout_activity_sid
  @properties['timeout_activity_sid']
end

#to_s ⇒ Object

Provide a user friendly representation



654
655
656
657
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 654

def to_s
  values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
  "<Twilio.Taskrouter.V1.WorkspaceInstance #{values}>"
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:



563
564
565
566
567
568
569
570
571
572
573
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 563

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)
  context.update(
      default_activity_sid: default_activity_sid,
      event_callback_url: event_callback_url,
      events_filter: events_filter,
      friendly_name: friendly_name,
      multi_task_enabled: multi_task_enabled,
      timeout_activity_sid: timeout_activity_sid,
      prioritize_queue_order: prioritize_queue_order,
  )
end

#url ⇒ String

Returns The url.

Returns:

  • (String) —

    The url



536
537
538
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 536

def url
  @properties['url']
end

#workers ⇒ workers

Access the workers

Returns:



613
614
615
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 613

def workers
  context.workers
end

#workflows ⇒ workflows

Access the workflows

Returns:



620
621
622
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 620

def workflows
  context.workflows
end