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



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

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 



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

def 
  @properties['account_sid']
end

#activity_name ⇒ String 



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

def activity_name
  @properties['activity_name']
end

#activity_sid ⇒ String 



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

def activity_sid
  @properties['activity_sid']
end

#attributes ⇒ String 



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

def attributes
  @properties['attributes']
end

#available ⇒ Boolean 



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

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



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

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



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

def cumulative_statistics
  context.cumulative_statistics
end

#date_created ⇒ Time 



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

def date_created
  @properties['date_created']
end

#date_status_changed ⇒ Time 



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

def date_status_changed
  @properties['date_status_changed']
end

#date_updated ⇒ Time 



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the WorkerInstance



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

def delete
  context.delete
end

#fetch ⇒ WorkerInstance

Fetch a WorkerInstance



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

def fetch
  context.fetch
end

#friendly_name ⇒ String 



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

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#links ⇒ String 



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

def links
  @properties['links']
end

#real_time_statistics ⇒ real_time_statistics

Access the real_time_statistics



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

def real_time_statistics
  context.real_time_statistics
end

#reservations ⇒ reservations

Access the reservations



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

def reservations
  context.reservations
end

#sid ⇒ String 



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

def sid
  @properties['sid']
end

#statistics ⇒ statistics

Access the statistics



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

def statistics
  context.statistics
end

#to_s ⇒ Object

Provide a user friendly representation



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

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

Update the WorkerInstance



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

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

#url ⇒ String 



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

def url
  @properties['url']
end

#worker_channels ⇒ worker_channels

Access the worker_channels



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

def worker_channels
  context.worker_channels
end

#workspace_sid ⇒ String 



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

def workspace_sid
  @properties['workspace_sid']
end