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



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

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  || @properties['workspace_sid']  ,'sid' => sid  || @properties['sid']  , }
end

Instance Method Details

#account_sid ⇒ String 



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

def 
    @properties['account_sid']
end

#activity_name ⇒ String 



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

def activity_name
    @properties['activity_name']
end

#activity_sid ⇒ String 



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

def activity_sid
    @properties['activity_sid']
end

#attributes ⇒ String 



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

def attributes
    @properties['attributes']
end

#available ⇒ Boolean 



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

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



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

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



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

def cumulative_statistics
    context.cumulative_statistics
end

#date_created ⇒ Time 



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

def date_created
    @properties['date_created']
end

#date_status_changed ⇒ Time 



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

def date_status_changed
    @properties['date_status_changed']
end

#date_updated ⇒ Time 



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

def date_updated
    @properties['date_updated']
end

#delete(if_match: :unset) ⇒ Boolean

Delete the WorkerInstance



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

def delete(
    if_match: :unset
)

    context.delete(
        if_match: if_match, 
    )
end

#fetch ⇒ WorkerInstance

Fetch the WorkerInstance



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

def fetch

    context.fetch
end

#friendly_name ⇒ String 



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

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#links ⇒ Hash 



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

def links
    @properties['links']
end

#real_time_statistics ⇒ real_time_statistics

Access the real_time_statistics



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

def real_time_statistics
    context.real_time_statistics
end

#reservations ⇒ reservations

Access the reservations



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

def reservations
    context.reservations
end

#sid ⇒ String 



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

def sid
    @properties['sid']
end

#statistics ⇒ statistics

Access the statistics



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

def statistics
    context.statistics
end

#to_s ⇒ Object

Provide a user friendly representation



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

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



566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker.rb', line 566

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

#url ⇒ String 



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

def url
    @properties['url']
end

#worker_channels ⇒ worker_channels

Access the worker_channels



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

def worker_channels
    context.worker_channels
end

#workspace_sid ⇒ String 



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

def workspace_sid
    @properties['workspace_sid']
end