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



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

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



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

def 
  @properties['account_sid']
end

#activity_nameString



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

def activity_name
  @properties['activity_name']
end

#activity_sidString



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

def activity_sid
  @properties['activity_sid']
end

#attributesString



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

def attributes
  @properties['attributes']
end

#availableBoolean



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

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



453
454
455
456
457
458
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker.rb', line 453

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



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

def cumulative_statistics
  context.cumulative_statistics
end

#date_createdTime



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

def date_created
  @properties['date_created']
end

#date_status_changedTime



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

def date_status_changed
  @properties['date_status_changed']
end

#date_updatedTime



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

def date_updated
  @properties['date_updated']
end

#deleteBoolean

Delete the WorkerInstance



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

def delete
  context.delete
end

#fetchWorkerInstance

Fetch the WorkerInstance



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

def fetch
  context.fetch
end

#friendly_nameString



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

def friendly_name
  @properties['friendly_name']
end

#inspectObject

Provide a detailed, user friendly representation



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

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


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

def links
  @properties['links']
end

#real_time_statisticsreal_time_statistics

Access the real_time_statistics



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

def real_time_statistics
  context.real_time_statistics
end

#reservationsreservations

Access the reservations



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

def reservations
  context.reservations
end

#sidString



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

def sid
  @properties['sid']
end

#statisticsstatistics

Access the statistics



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

def statistics
  context.statistics
end

#to_sObject

Provide a user friendly representation



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

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



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

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



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

def url
  @properties['url']
end

#worker_channelsworker_channels

Access the worker_channels



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

def worker_channels
  context.worker_channels
end

#workspace_sidString



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

def workspace_sid
  @properties['workspace_sid']
end