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.


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_sidString

Returns The SID of the Account that created the resource.

Returns:

  • (String)

    The SID of the Account that created the resource


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

def 
  @properties['account_sid']
end

#assignment_callback_urlString

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


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

def assignment_callback_url
  @properties['assignment_callback_url']
end

#configurationString

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

Returns:

  • (String)

    A JSON string that contains the Workflow's configuration


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

def configuration
  @properties['configuration']
end

#contextWorkflowContext

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

Returns:


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_statisticscumulative_statistics

Access the cumulative_statistics

Returns:


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

def cumulative_statistics
  context.cumulative_statistics
end

#date_createdTime

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


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

def date_created
  @properties['date_created']
end

#date_updatedTime

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


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

def date_updated
  @properties['date_updated']
end

#deleteBoolean

Delete the WorkflowInstance

Returns:

  • (Boolean)

    true if delete succeeds, false otherwise


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

def delete
  context.delete
end

#document_content_typeString

Returns The MIME type of the document.

Returns:

  • (String)

    The MIME type of the document


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_urlString

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


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

#fetchWorkflowInstance

Fetch the WorkflowInstance

Returns:


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

def fetch
  context.fetch
end

#friendly_nameString

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

Returns:

  • (String)

    The string that you assigned to describe the Workflow resource


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

def friendly_name
  @properties['friendly_name']
end

#inspectObject

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

Returns The URLs of related resources.

Returns:

  • (String)

    The URLs of related resources


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

def links
  @properties['links']
end

#real_time_statisticsreal_time_statistics

Access the real_time_statistics

Returns:


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

def real_time_statistics
  context.real_time_statistics
end

#sidString

Returns The unique string that identifies the resource.

Returns:

  • (String)

    The unique string that identifies the resource


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

def sid
  @properties['sid']
end

#statisticsstatistics

Access the statistics

Returns:


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

def statistics
  context.statistics
end

#task_reservation_timeoutString

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


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_sObject

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

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 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 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:


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

#urlString

Returns The absolute URL of the Workflow resource.

Returns:

  • (String)

    The absolute URL of the Workflow resource


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

def url
  @properties['url']
end

#workspace_sidString

Returns The SID of the Workspace that contains the Workflow.

Returns:

  • (String)

    The SID of the Workspace that contains the Workflow


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

def workspace_sid
  @properties['workspace_sid']
end