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.


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

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_sidString

Returns The SID of the Account that created the resource.

Returns:

  • (String)

    The SID of the Account that created the resource


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

def 
  @properties['account_sid']
end

#activity_nameString

Returns The friendly_name of the Worker's current Activity.

Returns:

  • (String)

    The friendly_name of the Worker's current Activity


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

def activity_name
  @properties['activity_name']
end

#activity_sidString

Returns The SID of the Worker's current Activity.

Returns:

  • (String)

    The SID of the Worker's current Activity


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

def activity_sid
  @properties['activity_sid']
end

#attributesString

Returns The JSON string that describes the Worker.

Returns:

  • (String)

    The JSON string that describes the Worker


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

def attributes
  @properties['attributes']
end

#availableBoolean

Returns Whether the Worker is available to perform tasks.

Returns:

  • (Boolean)

    Whether the Worker is available to perform tasks


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

def available
  @properties['available']
end

#contextWorkerContext

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

Returns:


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

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

#cumulative_statisticscumulative_statistics

Access the cumulative_statistics

Returns:


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

def cumulative_statistics
  context.cumulative_statistics
end

#date_createdTime

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


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

def date_created
  @properties['date_created']
end

#date_status_changedTime

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


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

def date_status_changed
  @properties['date_status_changed']
end

#date_updatedTime

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


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

def date_updated
  @properties['date_updated']
end

#deleteBoolean

Delete the WorkerInstance

Returns:

  • (Boolean)

    true if delete succeeds, false otherwise


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

def delete
  context.delete
end

#fetchWorkerInstance

Fetch the WorkerInstance

Returns:


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

def fetch
  context.fetch
end

#friendly_nameString

Returns The string that you assigned to describe the resource.

Returns:

  • (String)

    The string that you assigned to describe the resource


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

def friendly_name
  @properties['friendly_name']
end

#inspectObject

Provide a detailed, user friendly representation


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

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

Returns The URLs of related resources.

Returns:

  • (String)

    The URLs of related resources


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

def links
  @properties['links']
end

#real_time_statisticsreal_time_statistics

Access the real_time_statistics

Returns:


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

def real_time_statistics
  context.real_time_statistics
end

#reservationsreservations

Access the reservations

Returns:


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

def reservations
  context.reservations
end

#sidString

Returns The unique string that identifies the resource.

Returns:

  • (String)

    The unique string that identifies the resource


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

def sid
  @properties['sid']
end

#statisticsstatistics

Access the statistics

Returns:


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

def statistics
  context.statistics
end

#to_sObject

Provide a user friendly representation


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

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 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 pending reservations.

Returns:


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

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

#urlString

Returns The absolute URL of the Worker resource.

Returns:

  • (String)

    The absolute URL of the Worker resource


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

def url
  @properties['url']
end

#worker_channelsworker_channels

Access the worker_channels

Returns:


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

def worker_channels
  context.worker_channels
end

#workspace_sidString

Returns The SID of the Workspace that contains the Worker.

Returns:

  • (String)

    The SID of the Workspace that contains the Worker


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

def workspace_sid
  @properties['workspace_sid']
end