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

  • account_sid (String) —

    The SID of the Account that created this Worker resource.

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

    The SID of the Call resource to fetch.



438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker.rb', line 438

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  || @properties['workspace_sid']  ,'sid' => sid  || @properties['sid']  , }
end

Instance Method Details

#account_sid ⇒ String

Returns The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the Worker resource.

Returns:



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

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.



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

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.



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

def activity_sid
    @properties['activity_sid']
end

#attributes ⇒ String

Returns The JSON string that describes the Worker. For example: ‘{ "email": "[email protected]", "phone": "+5095551234" }`. Note If this property has been assigned a value, it will only be displayed in FETCH actions that return a single resource. Otherwise, this property will be null, even if it has a value. This data is passed to the `assignment_callback_url` when TaskRouter assigns a Task to the Worker.

Returns:

  • (String) —

    The JSON string that describes the Worker. For example: ‘{ "email": "[email protected]", "phone": "+5095551234" }`. Note If this property has been assigned a value, it will only be displayed in FETCH actions that return a single resource. Otherwise, this property will be null, even if it has a value. This data is passed to the `assignment_callback_url` when TaskRouter assigns a Task to the Worker.



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

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.



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

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:



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

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:



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

def cumulative_statistics
    context.cumulative_statistics
end

#date_created ⇒ Time

Returns The date and time in GMT when the resource was created specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:



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

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 specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format. Used to calculate Workflow statistics.

Returns:

  • (Time) —

    The date and time in GMT of the last change to the Worker’s activity specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format. Used to calculate Workflow statistics.



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

def date_status_changed
    @properties['date_status_changed']
end

#date_updated ⇒ Time

Returns The date and time in GMT when the resource was last updated specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:



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

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



556
557
558
559
560
561
562
563
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker.rb', line 556

def delete(
    if_match: :unset
)

    context.delete(
        if_match: if_match, 
    )
end

#fetch ⇒ WorkerInstance

Fetch the WorkerInstance

Returns:



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

def fetch

    context.fetch
end

#friendly_name ⇒ String

Returns The string that you assigned to describe the resource. Friendly names are case insensitive, and unique within the TaskRouter Workspace.

Returns:

  • (String) —

    The string that you assigned to describe the resource. Friendly names are case insensitive, and unique within the TaskRouter Workspace.



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

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#links ⇒ Hash

Returns The URLs of related resources.

Returns:

  • (Hash) —

    The URLs of related resources.



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

def links
    @properties['links']
end

#real_time_statistics ⇒ real_time_statistics

Access the real_time_statistics

Returns:



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

def real_time_statistics
    context.real_time_statistics
end

#reservations ⇒ reservations

Access the reservations

Returns:



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

def reservations
    context.reservations
end

#sid ⇒ String

Returns The unique string that we created to identify the Worker resource.

Returns:

  • (String) —

    The unique string that we created to identify the Worker resource.



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

def sid
    @properties['sid']
end

#statistics ⇒ statistics

Access the statistics

Returns:



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

def statistics
    context.statistics
end

#to_s ⇒ Object

Provide a user friendly representation



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

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](www.twilio.com/docs/taskrouter/api/activity) 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](www.twilio.com/docs/taskrouter/api/activity) resource has its ‘availability` property set to `False`.

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

    The If-Match HTTP request header

Returns:



581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker.rb', line 581

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.



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

def url
    @properties['url']
end

#worker_channels ⇒ worker_channels

Access the worker_channels

Returns:



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

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.



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

def workspace_sid
    @properties['workspace_sid']
end