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

  • account_sid (String) —

    The SID of the Account that created this Workflow resource.

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

    The SID of the Call resource to fetch.



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

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

Returns The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the Workflow resource.

Returns:



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

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. See Assignment Callback URL for more information.

Returns:

  • (String) —

    The URL that we call when a task managed by the Workflow is assigned to a Worker. See Assignment Callback URL for more information.



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

def assignment_callback_url
    @properties['assignment_callback_url']
end

#configuration ⇒ String

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

Returns:



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

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:



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

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:



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

def cumulative_statistics
    context.cumulative_statistics
end

#date_created ⇒ Time

Returns The date and time in GMT when the resource was created specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.

Returns:



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

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns The date and time in GMT when the resource was last updated specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.

Returns:



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

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the WorkflowInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



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

def delete

    context.delete
end

#document_content_type ⇒ String

Returns The MIME type of the document.

Returns:

  • (String) —

    The MIME type of the document.



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

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.



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

def fallback_assignment_callback_url
    @properties['fallback_assignment_callback_url']
end

#fetch ⇒ WorkflowInstance

Fetch the WorkflowInstance

Returns:



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

def fetch

    context.fetch
end

#friendly_name ⇒ String

Returns The string that you assigned to describe the Workflow resource. For example, ‘Customer Support` or `2014 Election Campaign`.

Returns:

  • (String) —

    The string that you assigned to describe the Workflow resource. For example, ‘Customer Support` or `2014 Election Campaign`.



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

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#links ⇒ Hash

Returns The URLs of related resources.

Returns:

  • (Hash) —

    The URLs of related resources.



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

def links
    @properties['links']
end

#real_time_statistics ⇒ real_time_statistics

Access the real_time_statistics

Returns:



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

def real_time_statistics
    context.real_time_statistics
end

#sid ⇒ String

Returns The unique string that we created to identify the Workflow resource.

Returns:

  • (String) —

    The unique string that we created to identify the Workflow resource.



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

def sid
    @properties['sid']
end

#statistics ⇒ statistics

Access the statistics

Returns:



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

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. Can be up to ‘86,400` (24 hours) and the default is `120`.

Returns:

  • (String) —

    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`.



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

def task_reservation_timeout
    @properties['task_reservation_timeout']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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:



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

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.



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

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.



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

def workspace_sid
    @properties['workspace_sid']
end