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

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • workspace_sid (String) (defaults to: nil) —

    The SID of the Workspace that contains the Workflow.

  • sid (String) (defaults to: nil) —

    The SID of the Workflow resource to fetch.



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

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

Returns The SID of the Account that created the resource.

Returns:

  • (String) —

    The SID of the Account that created the resource



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

def 
  @properties['account_sid']
end

#assignment_callback_url ⇒ String

Returns The URL that we call when a task managed by the Workflow is assigned to a Worker.

Returns:

  • (String) —

    The URL that we call when a task managed by the Workflow is assigned to a Worker



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

def assignment_callback_url
  @properties['assignment_callback_url']
end

#configuration ⇒ String

Returns A JSON string that contains the Workflow’s configuration.

Returns:

  • (String) —

    A JSON string that contains the Workflow’s configuration



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

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

Returns:



363
364
365
366
367
368
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb', line 363

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

Returns:



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

def cumulative_statistics
  context.cumulative_statistics
end

#date_created ⇒ Time

Returns The RFC 2822 date and time in GMT when the resource was created.

Returns:

  • (Time) —

    The RFC 2822 date and time in GMT when the resource was created



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The RFC 2822 date and time in GMT when the resource was last updated.

Returns:

  • (Time) —

    The RFC 2822 date and time in GMT when the resource was last updated



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the WorkflowInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise



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

def delete
  context.delete
end

#document_content_type ⇒ String

Returns The MIME type of the document.

Returns:

  • (String) —

    The MIME type of the document



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

def document_content_type
  @properties['document_content_type']
end

#fallback_assignment_callback_url ⇒ String

Returns The URL that we call when a call to the ‘assignment_callback_url` fails.

Returns:

  • (String) —

    The URL that we call when a call to the ‘assignment_callback_url` fails



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

def fallback_assignment_callback_url
  @properties['fallback_assignment_callback_url']
end

#fetch ⇒ WorkflowInstance

Fetch a WorkflowInstance

Returns:



451
452
453
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb', line 451

def fetch
  context.fetch
end

#friendly_name ⇒ String

Returns The string that you assigned to describe the Workflow resource.

Returns:

  • (String) —

    The string that you assigned to describe the Workflow resource



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

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



525
526
527
528
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb', line 525

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

#links ⇒ String

Returns The URLs of related resources.

Returns:

  • (String) —

    The URLs of related resources



444
445
446
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb', line 444

def links
  @properties['links']
end

#real_time_statistics ⇒ real_time_statistics

Access the real_time_statistics

Returns:



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

Returns The unique string that identifies the resource.

Returns:

  • (String) —

    The unique string that identifies the resource



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

def sid
  @properties['sid']
end

#statistics ⇒ statistics

Access the statistics

Returns:



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

def statistics
  context.statistics
end

#task_reservation_timeout ⇒ String

Returns How long TaskRouter will wait for a confirmation response from your application after it assigns a Task to a Worker.

Returns:

  • (String) —

    How long TaskRouter will wait for a confirmation response from your application after it assigns a Task to a Worker



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

def task_reservation_timeout
  @properties['task_reservation_timeout']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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

Parameters:

  • friendly_name (String) (defaults to: :unset) —

    A descriptive string that you create to describe the Workflow resource. For example, ‘Inbound Call Workflow` or `2014 Outbound Campaign`.

  • assignment_callback_url (String) (defaults to: :unset) —

    The URL from your application that will process task assignment events. See [Handling Task Assignment Callback](www.twilio.com/docs/taskrouter/handle-assignment-callbacks) for more details.

  • fallback_assignment_callback_url (String) (defaults to: :unset) —

    The URL that we should call when a call to the ‘assignment_callback_url` fails.

  • configuration (String) (defaults to: :unset) —

    A JSON string that contains the rules to apply to the Workflow. See [Configuring Workflows](www.twilio.com/docs/taskrouter/workflow-configuration) for more information.

  • task_reservation_timeout (String) (defaults to: :unset) —

    How long TaskRouter will wait for a confirmation response from your application after it assigns a Task to a Worker. Can be up to ‘86,400` (24 hours) and the default is `120`.

  • re_evaluate_tasks (String) (defaults to: :unset) —

    Whether or not to re-evaluate Tasks. The default is ‘false`, which means Tasks in the Workflow will not be processed through the assignment loop again.

Returns:



477
478
479
480
481
482
483
484
485
486
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb', line 477

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

Returns The absolute URL of the Workflow resource.

Returns:

  • (String) —

    The absolute URL of the Workflow resource



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

def url
  @properties['url']
end

#workspace_sid ⇒ String

Returns The SID of the Workspace that contains the Workflow.

Returns:

  • (String) —

    The SID of the Workspace that contains the Workflow



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

def workspace_sid
  @properties['workspace_sid']
end