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 ID of the Workflow this worker is associated with

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

    The sid



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

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 ID of the account that owns this worker.

Returns:

  • (String) —

    The ID of the account that owns this worker



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

def 
  @properties['account_sid']
end

#activity_name ⇒ String

Returns Filter by workers that are in a particular Activity by Friendly Name.

Returns:

  • (String) —

    Filter by workers that are in a particular Activity by Friendly Name



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

def activity_name
  @properties['activity_name']
end

#activity_sid ⇒ String

Returns Filter by workers that are in a particular Activity by SID.

Returns:

  • (String) —

    Filter by workers that are in a particular Activity by SID



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

def activity_sid
  @properties['activity_sid']
end

#attributes ⇒ String

Returns JSON object describing this worker.

Returns:

  • (String) —

    JSON object describing this worker.



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

def attributes
  @properties['attributes']
end

#available ⇒ Boolean

Returns Filter by workers that are available or unavailable.

Returns:

  • (Boolean) —

    Filter by workers that are available or unavailable.



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

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:



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

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:



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

def cumulative_statistics
  context.cumulative_statistics
end

#date_created ⇒ Time

Returns DateTime this worker was created.

Returns:

  • (Time) —

    DateTime this worker was created



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

def date_created
  @properties['date_created']
end

#date_status_changed ⇒ Time

Returns DateTime of the last change to the Worker’s activity.

Returns:

  • (Time) —

    DateTime of the last change to the Worker’s activity.



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

def date_status_changed
  @properties['date_status_changed']
end

#date_updated ⇒ Time

Returns DateTime of the last update.

Returns:

  • (Time) —

    DateTime of the last update



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the WorkerInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



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

def delete
  context.delete
end

#fetch ⇒ WorkerInstance

Fetch a WorkerInstance

Returns:



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

def fetch
  context.fetch
end

#friendly_name ⇒ String

Returns Filter by a worker’s friendly name.

Returns:

  • (String) —

    Filter by a worker’s friendly name



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

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#links ⇒ String

Returns The links.

Returns:

  • (String) —

    The links



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

def links
  @properties['links']
end

#real_time_statistics ⇒ real_time_statistics

Access the real_time_statistics

Returns:



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

def real_time_statistics
  context.real_time_statistics
end

#reservations ⇒ reservations

Access the reservations

Returns:



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

def reservations
  context.reservations
end

#sid ⇒ String

Returns The unique ID of the worker.

Returns:

  • (String) —

    The unique ID of the worker



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

def sid
  @properties['sid']
end

#statistics ⇒ statistics

Access the statistics

Returns:



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

def statistics
  context.statistics
end

#to_s ⇒ Object

Provide a user friendly representation



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

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) ⇒ WorkerInstance

Update the WorkerInstance

Parameters:

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

    The activity_sid

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

    The attributes

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

    The friendly_name

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

    The reject_pending_reservations

Returns:



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

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

#url ⇒ String

Returns The url.

Returns:

  • (String) —

    The url



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

def url
  @properties['url']
end

#worker_channels ⇒ worker_channels

Access the worker_channels

Returns:



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

def worker_channels
  context.worker_channels
end

#workspace_sid ⇒ String

Returns The ID of the Workflow this worker is associated with.

Returns:

  • (String) —

    The ID of the Workflow this worker is associated with



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

def workspace_sid
  @properties['workspace_sid']
end