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

Inherits:
InstanceResource
  • 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, payload, workspace_sid: nil, workflow_sid: nil) ⇒ WorkflowRealTimeStatisticsInstance

Initialize the WorkflowRealTimeStatisticsInstance

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 WorkflowRealTimeStatistics resource.

  • sid (String) —

    The SID of the Call resource to fetch.



142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_real_time_statistics.rb', line 142

def initialize(version, payload , workspace_sid: nil, workflow_sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'account_sid' => payload['account_sid'],
        'longest_task_waiting_age' => payload['longest_task_waiting_age'] == nil ? payload['longest_task_waiting_age'] : payload['longest_task_waiting_age'].to_i,
        'longest_task_waiting_sid' => payload['longest_task_waiting_sid'],
        'tasks_by_priority' => payload['tasks_by_priority'],
        'tasks_by_status' => payload['tasks_by_status'],
        'total_tasks' => payload['total_tasks'] == nil ? payload['total_tasks'] : payload['total_tasks'].to_i,
        '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

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

Returns:



176
177
178
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_real_time_statistics.rb', line 176

def 
    @properties['account_sid']
end

#context ⇒ WorkflowRealTimeStatisticsContext

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

Returns:



167
168
169
170
171
172
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_real_time_statistics.rb', line 167

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

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



232
233
234
235
236
237
238
239
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_real_time_statistics.rb', line 232

def fetch(
    task_channel: :unset
)

    context.fetch(
        task_channel: task_channel, 
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



250
251
252
253
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_real_time_statistics.rb', line 250

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

#longest_task_waiting_age ⇒ String

Returns The age of the longest waiting Task.

Returns:

  • (String) —

    The age of the longest waiting Task.



182
183
184
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_real_time_statistics.rb', line 182

def longest_task_waiting_age
    @properties['longest_task_waiting_age']
end

#longest_task_waiting_sid ⇒ String

Returns The SID of the longest waiting Task.

Returns:

  • (String) —

    The SID of the longest waiting Task.



188
189
190
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_real_time_statistics.rb', line 188

def longest_task_waiting_sid
    @properties['longest_task_waiting_sid']
end

#tasks_by_priority ⇒ Hash

Returns The number of Tasks by priority. For example: ‘"10", "99": "5"` shows 10 Tasks at priority 0 and 5 at priority 99.

Returns:

  • (Hash) —

    The number of Tasks by priority. For example: ‘"10", "99": "5"` shows 10 Tasks at priority 0 and 5 at priority 99.



194
195
196
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_real_time_statistics.rb', line 194

def tasks_by_priority
    @properties['tasks_by_priority']
end

#tasks_by_status ⇒ Hash

Returns The number of Tasks by their current status. For example: ‘"1", "reserved": "3", "assigned": "2", "completed": "5"`.

Returns:

  • (Hash) —

    The number of Tasks by their current status. For example: ‘"1", "reserved": "3", "assigned": "2", "completed": "5"`.



200
201
202
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_real_time_statistics.rb', line 200

def tasks_by_status
    @properties['tasks_by_status']
end

#to_s ⇒ Object

Provide a user friendly representation



243
244
245
246
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_real_time_statistics.rb', line 243

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

#total_tasks ⇒ String

Returns The total number of Tasks.

Returns:

  • (String) —

    The total number of Tasks.



206
207
208
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_real_time_statistics.rb', line 206

def total_tasks
    @properties['total_tasks']
end

#url ⇒ String

Returns The absolute URL of the Workflow statistics resource.

Returns:

  • (String) —

    The absolute URL of the Workflow statistics resource.



224
225
226
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_real_time_statistics.rb', line 224

def url
    @properties['url']
end

#workflow_sid ⇒ String

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

Returns:

  • (String) —

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



212
213
214
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_real_time_statistics.rb', line 212

def workflow_sid
    @properties['workflow_sid']
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.



218
219
220
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_real_time_statistics.rb', line 218

def workspace_sid
    @properties['workspace_sid']
end