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

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

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, workspace_sid: nil, sid: nil) ⇒ WorkerInstance

Initialize the WorkerInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

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

    The SID of the Workspace that contains the Worker.

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

    The SID of the Worker resource to fetch.


428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker.rb', line 428

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

  # Marshaled Properties
  @properties = {
      'account_sid' => payload['account_sid'],
      'activity_name' => payload['activity_name'],
      'activity_sid' => payload['activity_sid'],
      'attributes' => payload['attributes'],
      'available' => payload['available'],
      'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
      'date_status_changed' => Twilio.deserialize_iso8601_datetime(payload['date_status_changed']),
      'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
      'friendly_name' => payload['friendly_name'],
      'sid' => payload['sid'],
      'workspace_sid' => payload['workspace_sid'],
      'url' => payload['url'],
      'links' => payload['links'],
  }

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

Instance Method Details

#account_sid ⇒ String

Returns The SID of the Account that created the resource.

Returns:

  • (String) —

    The SID of the Account that created the resource


466
467
468
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker.rb', line 466

def 
  @properties['account_sid']
end

#activity_name ⇒ String

Returns The friendly_name of the Worker's current Activity.

Returns:

  • (String) —

    The friendly_name of the Worker's current Activity


472
473
474
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker.rb', line 472

def activity_name
  @properties['activity_name']
end

#activity_sid ⇒ String

Returns The SID of the Worker's current Activity.

Returns:

  • (String) —

    The SID of the Worker's current Activity


478
479
480
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker.rb', line 478

def activity_sid
  @properties['activity_sid']
end

#attributes ⇒ String

Returns The JSON string that describes the Worker.

Returns:

  • (String) —

    The JSON string that describes the Worker


484
485
486
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker.rb', line 484

def attributes
  @properties['attributes']
end

#available ⇒ Boolean

Returns Whether the Worker is available to perform tasks.

Returns:

  • (Boolean) —

    Whether the Worker is available to perform tasks


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

def available
  @properties['available']
end

#context ⇒ WorkerContext

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

Returns:


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

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

#cumulative_statistics ⇒ cumulative_statistics

Access the cumulative_statistics

Returns:


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

def cumulative_statistics
  context.cumulative_statistics
end

#date_created ⇒ Time

Returns The ISO 8601 date and time in GMT when the resource was created.

Returns:

  • (Time) —

    The ISO 8601 date and time in GMT when the resource was created


496
497
498
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker.rb', line 496

def date_created
  @properties['date_created']
end

#date_status_changed ⇒ Time

Returns The date and time in GMT of the last change to the Worker's activity.

Returns:

  • (Time) —

    The date and time in GMT of the last change to the Worker's activity


502
503
504
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker.rb', line 502

def date_status_changed
  @properties['date_status_changed']
end

#date_updated ⇒ Time

Returns The ISO 8601 date and time in GMT when the resource was last updated.

Returns:

  • (Time) —

    The ISO 8601 date and time in GMT when the resource was last updated


508
509
510
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker.rb', line 508

def date_updated
  @properties['date_updated']
end

#delete(if_match: :unset) ⇒ Boolean

Delete the WorkerInstance

Parameters:

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

    The If-Match HTTP request header

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise


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

def delete(if_match: :unset)
  context.delete(if_match: if_match, )
end

#fetch ⇒ WorkerInstance

Fetch the WorkerInstance

Returns:


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

def fetch
  context.fetch
end

#friendly_name ⇒ String

Returns The string that you assigned to describe the resource.

Returns:

  • (String) —

    The string that you assigned to describe the resource


514
515
516
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker.rb', line 514

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation


629
630
631
632
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker.rb', line 629

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

#links ⇒ String

Returns The URLs of related resources.

Returns:

  • (String) —

    The URLs of related resources


538
539
540
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker.rb', line 538

def links
  @properties['links']
end

#real_time_statistics ⇒ real_time_statistics

Access the real_time_statistics

Returns:


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

def real_time_statistics
  context.real_time_statistics
end

#reservations ⇒ reservations

Access the reservations

Returns:


609
610
611
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker.rb', line 609

def reservations
  context.reservations
end

#sid ⇒ String

Returns The unique string that identifies the resource.

Returns:

  • (String) —

    The unique string that identifies the resource


520
521
522
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker.rb', line 520

def sid
  @properties['sid']
end

#statistics ⇒ statistics

Access the statistics

Returns:


602
603
604
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker.rb', line 602

def statistics
  context.statistics
end

#to_s ⇒ Object

Provide a user friendly representation


622
623
624
625
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker.rb', line 622

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

#update(activity_sid: :unset, attributes: :unset, friendly_name: :unset, reject_pending_reservations: :unset, if_match: :unset) ⇒ WorkerInstance

Update the WorkerInstance

Parameters:

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

    The SID of a valid Activity that will describe the Worker's initial state. See Activities for more information.

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

    The JSON string that describes the Worker. For example: `{ “email”: “[email protected]”, “phone”: “+5095551234” }`. This data is passed to the `assignment_callback_url` when TaskRouter assigns a Task to the Worker. Defaults to {}.

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

    A descriptive string that you create to describe the Worker. It can be up to 64 characters long.

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

    Whether to reject the Worker's pending reservations. This option is only valid if the Worker's new Activity resource has its `availability` property set to `False`.

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

    The If-Match HTTP request header

Returns:


567
568
569
570
571
572
573
574
575
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker.rb', line 567

def update(activity_sid: :unset, attributes: :unset, friendly_name: :unset, reject_pending_reservations: :unset, if_match: :unset)
  context.update(
      activity_sid: activity_sid,
      attributes: attributes,
      friendly_name: friendly_name,
      reject_pending_reservations: reject_pending_reservations,
      if_match: if_match,
  )
end

#url ⇒ String

Returns The absolute URL of the Worker resource.

Returns:

  • (String) —

    The absolute URL of the Worker resource


532
533
534
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker.rb', line 532

def url
  @properties['url']
end

#worker_channels ⇒ worker_channels

Access the worker_channels

Returns:


616
617
618
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker.rb', line 616

def worker_channels
  context.worker_channels
end

#workspace_sid ⇒ String

Returns The SID of the Workspace that contains the Worker.

Returns:

  • (String) —

    The SID of the Workspace that contains the Worker


526
527
528
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker.rb', line 526

def workspace_sid
  @properties['workspace_sid']
end