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



477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 477

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



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

def 
  @properties['account_sid']
end

#activities ⇒ activities

Access the activities

Returns:



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

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:



510
511
512
513
514
515
516
517
518
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 510

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

#date_created ⇒ Time

Returns The date_created.

Returns:

  • (Time) —

    The date_created



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date_updated.

Returns:

  • (Time) —

    The date_updated



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

def date_updated
  @properties['date_updated']
end

#default_activity_name ⇒ String

Returns The default_activity_name.

Returns:

  • (String) —

    The default_activity_name



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

def default_activity_name
  @properties['default_activity_name']
end

#default_activity_sid ⇒ String

Returns The default_activity_sid.

Returns:

  • (String) —

    The default_activity_sid



546
547
548
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 546

def default_activity_sid
  @properties['default_activity_sid']
end

#delete ⇒ Boolean

Deletes the WorkspaceInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



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

def delete
  context.delete
end

#event_callback_url ⇒ String

Returns The event_callback_url.

Returns:

  • (String) —

    The event_callback_url



552
553
554
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 552

def event_callback_url
  @properties['event_callback_url']
end

#events ⇒ events

Access the events

Returns:



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

def events
  context.events
end

#events_filter ⇒ String

Returns The events_filter.

Returns:

  • (String) —

    The events_filter



558
559
560
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 558

def events_filter
  @properties['events_filter']
end

#fetch ⇒ WorkspaceInstance

Fetch a WorkspaceInstance

Returns:



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

def fetch
  context.fetch
end

#friendly_name ⇒ String

Returns The friendly_name.

Returns:

  • (String) —

    The friendly_name



564
565
566
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 564

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



711
712
713
714
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 711

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



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

def links
  @properties['links']
end

#multi_task_enabled ⇒ Boolean

Returns The multi_task_enabled.

Returns:

  • (Boolean) —

    The multi_task_enabled



570
571
572
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 570

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



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

def prioritize_queue_order
  @properties['prioritize_queue_order']
end

#sid ⇒ String

Returns The sid.

Returns:

  • (String) —

    The sid



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

def sid
  @properties['sid']
end

#statistics ⇒ statistics

Access the statistics

Returns:



691
692
693
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 691

def statistics
  context.statistics
end

#task_channels ⇒ task_channels

Access the task_channels

Returns:



698
699
700
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 698

def task_channels
  context.task_channels
end

#task_queues ⇒ task_queues

Access the task_queues

Returns:



670
671
672
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 670

def task_queues
  context.task_queues
end

#tasks ⇒ tasks

Access the tasks

Returns:



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

def tasks
  context.tasks
end

#timeout_activity_name ⇒ String

Returns The timeout_activity_name.

Returns:

  • (String) —

    The timeout_activity_name



582
583
584
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 582

def timeout_activity_name
  @properties['timeout_activity_name']
end

#timeout_activity_sid ⇒ String

Returns The timeout_activity_sid.

Returns:

  • (String) —

    The timeout_activity_sid



588
589
590
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 588

def timeout_activity_sid
  @properties['timeout_activity_sid']
end

#to_s ⇒ Object

Provide a user friendly representation



704
705
706
707
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 704

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:



627
628
629
630
631
632
633
634
635
636
637
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 627

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



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

def url
  @properties['url']
end

#workers ⇒ workers

Access the workers

Returns:



677
678
679
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 677

def workers
  context.workers
end

#workflows ⇒ workflows

Access the workflows

Returns:



684
685
686
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 684

def workflows
  context.workflows
end