Class: Twilio::REST::Taskrouter::V1::WorkspaceContext::WorkflowInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, workspace_sid: nil, sid: nil) ⇒ WorkflowInstance

Initialize the WorkflowInstance



330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb', line 330

def initialize(version, payload , workspace_sid: nil, sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'account_sid' => payload['account_sid'],
        'assignment_callback_url' => payload['assignment_callback_url'],
        'configuration' => payload['configuration'],
        'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
        'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
        'document_content_type' => payload['document_content_type'],
        'fallback_assignment_callback_url' => payload['fallback_assignment_callback_url'],
        'friendly_name' => payload['friendly_name'],
        'sid' => payload['sid'],
        'task_reservation_timeout' => payload['task_reservation_timeout'] == nil ? payload['task_reservation_timeout'] : payload['task_reservation_timeout'].to_i,
        '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 



368
369
370
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb', line 368

def 
    @properties['account_sid']
end

#assignment_callback_url ⇒ String 



374
375
376
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb', line 374

def assignment_callback_url
    @properties['assignment_callback_url']
end

#configuration ⇒ String 



380
381
382
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb', line 380

def configuration
    @properties['configuration']
end

#context ⇒ WorkflowContext

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



359
360
361
362
363
364
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb', line 359

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

#cumulative_statistics ⇒ cumulative_statistics

Access the cumulative_statistics



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

def cumulative_statistics
    context.cumulative_statistics
end

#date_created ⇒ Time 



386
387
388
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb', line 386

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time 



392
393
394
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb', line 392

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the WorkflowInstance



447
448
449
450
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb', line 447

def delete

    context.delete
end

#document_content_type ⇒ String 



398
399
400
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb', line 398

def document_content_type
    @properties['document_content_type']
end

#fallback_assignment_callback_url ⇒ String 



404
405
406
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb', line 404

def fallback_assignment_callback_url
    @properties['fallback_assignment_callback_url']
end

#fetch ⇒ WorkflowInstance

Fetch the WorkflowInstance



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

def fetch

    context.fetch
end

#friendly_name ⇒ String 



410
411
412
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb', line 410

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#links ⇒ Hash 



440
441
442
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb', line 440

def links
    @properties['links']
end

#real_time_statistics ⇒ real_time_statistics

Access the real_time_statistics



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

def real_time_statistics
    context.real_time_statistics
end

#sid ⇒ String 



416
417
418
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb', line 416

def sid
    @properties['sid']
end

#statistics ⇒ statistics

Access the statistics



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

def statistics
    context.statistics
end

#task_reservation_timeout ⇒ String 



422
423
424
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb', line 422

def task_reservation_timeout
    @properties['task_reservation_timeout']
end

#to_s ⇒ Object

Provide a user friendly representation



511
512
513
514
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb', line 511

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

#update(friendly_name: :unset, assignment_callback_url: :unset, fallback_assignment_callback_url: :unset, configuration: :unset, task_reservation_timeout: :unset, re_evaluate_tasks: :unset) ⇒ WorkflowInstance

Update the WorkflowInstance



469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb', line 469

def update(
    friendly_name: :unset, 
    assignment_callback_url: :unset, 
    fallback_assignment_callback_url: :unset, 
    configuration: :unset, 
    task_reservation_timeout: :unset, 
    re_evaluate_tasks: :unset
)

    context.update(
        friendly_name: friendly_name, 
        assignment_callback_url: assignment_callback_url, 
        fallback_assignment_callback_url: fallback_assignment_callback_url, 
        configuration: configuration, 
        task_reservation_timeout: task_reservation_timeout, 
        re_evaluate_tasks: re_evaluate_tasks, 
    )
end

#url ⇒ String 



434
435
436
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb', line 434

def url
    @properties['url']
end

#workspace_sid ⇒ String 



428
429
430
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb', line 428

def workspace_sid
    @properties['workspace_sid']
end