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

Inherits:
InstanceContext
  • Object
show all
Defined in:
lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_real_time_statistics.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, workspace_sid, workflow_sid) ⇒ WorkflowRealTimeStatisticsContext

Initialize the WorkflowRealTimeStatisticsContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • workspace_sid (String) —

    The SID of the Workspace with the Workflow to fetch.

  • workflow_sid (String) —

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



54
55
56
57
58
59
60
61
62
63
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_real_time_statistics.rb', line 54

def initialize(version, workspace_sid, workflow_sid)
    super(version)
    

    # Path Solution
    @solution = { workspace_sid: workspace_sid, workflow_sid: workflow_sid,  }
    @uri = "/Workspaces/#{@solution[:workspace_sid]}/Workflows/#{@solution[:workflow_sid]}/RealTimeStatistics"

    
end

Instance Method Details

#fetch(task_channel: :unset) ⇒ WorkflowRealTimeStatisticsInstance

Fetch the WorkflowRealTimeStatisticsInstance

Parameters:

  • task_channel (String) (defaults to: :unset) —

    Only calculate real-time statistics on this TaskChannel. Can be the TaskChannel’s SID or its unique_name, such as voice, sms, or default.

Returns:



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_real_time_statistics.rb', line 68

def fetch(
    task_channel: :unset
)

    params = Twilio::Values.of({
        'TaskChannel' => task_channel,
    })
    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.fetch('GET', @uri, params: params, headers: headers)
    WorkflowRealTimeStatisticsInstance.new(
        @version,
        payload,
        workspace_sid: @solution[:workspace_sid],
        workflow_sid: @solution[:workflow_sid],
    )
end

#fetch_with_metadata(task_channel: :unset) ⇒ WorkflowRealTimeStatisticsInstance

Fetch the WorkflowRealTimeStatisticsInstanceMetadata

Parameters:

  • task_channel (String) (defaults to: :unset) —

    Only calculate real-time statistics on this TaskChannel. Can be the TaskChannel’s SID or its unique_name, such as voice, sms, or default.

Returns:



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_real_time_statistics.rb', line 94

def fetch_with_metadata(
  task_channel: :unset
)

    params = Twilio::Values.of({
        'TaskChannel' => task_channel,
    })
    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.fetch_with_metadata('GET', @uri, params: params, headers: headers)
    workflow_real_time_statistics_instance = WorkflowRealTimeStatisticsInstance.new(
        @version,
        response.body,
        workspace_sid: @solution[:workspace_sid],
        workflow_sid: @solution[:workflow_sid],
    )
    WorkflowRealTimeStatisticsInstanceMetadata.new(
        @version,
        workflow_real_time_statistics_instance,
        response.headers,
        response.status_code
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



132
133
134
135
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_real_time_statistics.rb', line 132

def inspect
    context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
    "#<Twilio.Taskrouter.V1.WorkflowRealTimeStatisticsContext #{context}>"
end

#to_s ⇒ Object

Provide a user friendly representation



125
126
127
128
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_real_time_statistics.rb', line 125

def to_s
    context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
    "#<Twilio.Taskrouter.V1.WorkflowRealTimeStatisticsContext #{context}>"
end