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



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 



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

def 
    @properties['account_sid']
end

#assignment_callback_url ⇒ String 



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 



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



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



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 



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 



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



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 



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 



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



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

def fetch

    context.fetch
end

#friendly_name ⇒ String 



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 



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



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 



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



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

def statistics
    context.statistics
end

#task_reservation_timeout ⇒ String 



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



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 



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

def url
    @properties['url']
end

#workspace_sid ⇒ String 



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

def workspace_sid
    @properties['workspace_sid']
end