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.



628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb', line 628

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:



667
668
669
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb', line 667

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.



673
674
675
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb', line 673

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:



679
680
681
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb', line 679

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:



658
659
660
661
662
663
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb', line 658

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:



797
798
799
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb', line 797

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:



685
686
687
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb', line 685

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:



691
692
693
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb', line 691

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the WorkflowInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



746
747
748
749
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb', line 746

def delete

    context.delete
end

#document_content_type ⇒ String

Returns The MIME type of the document.

Returns:

  • (String) —

    The MIME type of the document.



697
698
699
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb', line 697

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.



703
704
705
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb', line 703

def fallback_assignment_callback_url
    @properties['fallback_assignment_callback_url']
end

#fetch ⇒ WorkflowInstance

Fetch the WorkflowInstance

Returns:



754
755
756
757
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb', line 754

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



709
710
711
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb', line 709

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



817
818
819
820
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb', line 817

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.



739
740
741
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb', line 739

def links
    @properties['links']
end

#real_time_statistics ⇒ real_time_statistics

Access the real_time_statistics

Returns:



804
805
806
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb', line 804

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.



715
716
717
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb', line 715

def sid
    @properties['sid']
end

#statistics ⇒ statistics

Access the statistics

Returns:



790
791
792
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb', line 790

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.



721
722
723
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb', line 721

def task_reservation_timeout
    @properties['task_reservation_timeout']
end

#to_s ⇒ Object

Provide a user friendly representation



810
811
812
813
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb', line 810

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:



768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb', line 768

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.



733
734
735
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb', line 733

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.



727
728
729
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb', line 727

def workspace_sid
    @properties['workspace_sid']
end