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



317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb', line 317

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'].to_i,
      '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 



355
356
357
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb', line 355

def 
  @properties['account_sid']
end

#assignment_callback_url ⇒ String 



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

def assignment_callback_url
  @properties['assignment_callback_url']
end

#configuration ⇒ String 



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

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



346
347
348
349
350
351
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb', line 346

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



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

def cumulative_statistics
  context.cumulative_statistics
end

#date_created ⇒ Time 



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time 



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Delete the WorkflowInstance



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

def delete
  context.delete
end

#document_content_type ⇒ String 



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

def document_content_type
  @properties['document_content_type']
end

#fallback_assignment_callback_url ⇒ String 



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

def fallback_assignment_callback_url
  @properties['fallback_assignment_callback_url']
end

#fetch ⇒ WorkflowInstance

Fetch the WorkflowInstance



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

def fetch
  context.fetch
end

#friendly_name ⇒ String 



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

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#links ⇒ String 



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

def links
  @properties['links']
end

#real_time_statistics ⇒ real_time_statistics

Access the real_time_statistics



488
489
490
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb', line 488

def real_time_statistics
  context.real_time_statistics
end

#sid ⇒ String 



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

def sid
  @properties['sid']
end

#statistics ⇒ statistics

Access the statistics



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

def statistics
  context.statistics
end

#task_reservation_timeout ⇒ String 



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

def task_reservation_timeout
  @properties['task_reservation_timeout']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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



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

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 



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

def url
  @properties['url']
end

#workspace_sid ⇒ String 



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

def workspace_sid
  @properties['workspace_sid']
end