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



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

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



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

def 
  @properties['account_sid']
end

#activity_nameString



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

def activity_name
  @properties['activity_name']
end

#activity_sidString



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

def activity_sid
  @properties['activity_sid']
end

#attributesString



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

def attributes
  @properties['attributes']
end

#availableBoolean



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

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



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

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



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

def cumulative_statistics
  context.cumulative_statistics
end

#date_createdTime



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

def date_created
  @properties['date_created']
end

#date_status_changedTime



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

def date_status_changed
  @properties['date_status_changed']
end

#date_updatedTime



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

def date_updated
  @properties['date_updated']
end

#delete(if_match: :unset) ⇒ Boolean

Delete the WorkerInstance



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

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

#fetchWorkerInstance

Fetch the WorkerInstance



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

def fetch
  context.fetch
end

#friendly_nameString



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

def friendly_name
  @properties['friendly_name']
end

#inspectObject

Provide a detailed, user friendly representation



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

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


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

def links
  @properties['links']
end

#real_time_statisticsreal_time_statistics

Access the real_time_statistics



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

def real_time_statistics
  context.real_time_statistics
end

#reservationsreservations

Access the reservations



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

def reservations
  context.reservations
end

#sidString



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

def sid
  @properties['sid']
end

#statisticsstatistics

Access the statistics



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

def statistics
  context.statistics
end

#to_sObject

Provide a user friendly representation



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

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



573
574
575
576
577
578
579
580
581
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker.rb', line 573

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

#urlString



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

def url
  @properties['url']
end

#worker_channelsworker_channels

Access the worker_channels



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

def worker_channels
  context.worker_channels
end

#workspace_sidString



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

def workspace_sid
  @properties['workspace_sid']
end