Class: Twilio::REST::Taskrouter::V1::WorkspaceContext::WorkflowContext::WorkflowStatisticsInstance

Inherits:

InstanceResource

• Object
• InstanceResource
• Twilio::REST::Taskrouter::V1::WorkspaceContext::WorkflowContext::WorkflowStatisticsInstance

Defined in:

lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_statistics.rb

Instance Method Summary

• #account_sid ⇒ String

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

• #context ⇒ WorkflowStatisticsContext

  Generate an instance context for the instance, the context is capable of performing various actions.

• #cumulative ⇒ Hash

  An object that contains the cumulative statistics for the Workflow.

• #fetch(minutes: :unset, start_date: :unset, end_date: :unset, task_channel: :unset, split_by_wait_time: :unset) ⇒ WorkflowStatisticsInstance

  Fetch the WorkflowStatisticsInstance.

• #initialize(version, payload, workspace_sid: nil, workflow_sid: nil) ⇒ WorkflowStatisticsInstance constructor

  Initialize the WorkflowStatisticsInstance.

• #inspect ⇒ Object

  Provide a detailed, user friendly representation.

• #realtime ⇒ Hash

  An object that contains the real-time statistics for the Workflow.

• #to_s ⇒ Object

  Provide a user friendly representation.

• #url ⇒ String

  The absolute URL of the Workflow statistics resource.

• #workflow_sid ⇒ String

  Returns the list of Tasks that are being controlled by the Workflow with the specified SID value.

• #workspace_sid ⇒ String

  The SID of the Workspace that contains the Workflow.

Constructor Details

#initialize(version, payload, workspace_sid: nil, workflow_sid: nil) ⇒ WorkflowStatisticsInstance

Initialize the WorkflowStatisticsInstance

# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_statistics.rb', line 308

def initialize(version, payload , workspace_sid: nil, workflow_sid: nil)
    super(version)
    
    
    # Marshaled Properties
    @properties = { 
        'account_sid' => payload['account_sid'],
        'cumulative' => payload['cumulative'],
        'realtime' => payload['realtime'],
        'workflow_sid' => payload['workflow_sid'],
        'workspace_sid' => payload['workspace_sid'],
        'url' => payload['url'],
    }

    # Context
    @instance_context = nil
    @params = { 'workspace_sid' => workspace_sid  || @properties['workspace_sid']  ,'workflow_sid' => workflow_sid  || @properties['workflow_sid']  , }
end

Instance Method Details

#account_sid ⇒ String

# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_statistics.rb', line 340

def account_sid
    @properties['account_sid']
end

#context ⇒ WorkflowStatisticsContext

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

# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_statistics.rb', line 331

def context
    unless @instance_context
        @instance_context = WorkflowStatisticsContext.new(@version , @params['workspace_sid'], @params['workflow_sid'])
    end
    @instance_context
end

#cumulative ⇒ Hash

# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_statistics.rb', line 346

def cumulative
    @properties['cumulative']
end

#fetch(minutes: :unset, start_date: :unset, end_date: :unset, task_channel: :unset, split_by_wait_time: :unset) ⇒ WorkflowStatisticsInstance

Fetch the WorkflowStatisticsInstance

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

def fetch(
    minutes: :unset, 
    start_date: :unset, 
    end_date: :unset, 
    task_channel: :unset, 
    split_by_wait_time: :unset
)

    context.fetch(
        minutes: minutes, 
        start_date: start_date, 
        end_date: end_date, 
        task_channel: task_channel, 
        split_by_wait_time: split_by_wait_time, 
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation

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

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

#realtime ⇒ Hash

# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_statistics.rb', line 352

def realtime
    @properties['realtime']
end

#to_s ⇒ Object

Provide a user friendly representation

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

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

#url ⇒ String

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

def url
    @properties['url']
end

#workflow_sid ⇒ String

# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_statistics.rb', line 358

def workflow_sid
    @properties['workflow_sid']
end

#workspace_sid ⇒ String

# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_statistics.rb', line 364

def workspace_sid
    @properties['workspace_sid']
end