Class: Twilio::REST::Taskrouter::V1::WorkspaceContext::WorkspaceRealTimeStatisticsInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/taskrouter/v1/workspace/workspace_real_time_statistics.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, workspace_sid: nil) ⇒ WorkspaceRealTimeStatisticsInstance

Initialize the WorkspaceRealTimeStatisticsInstance

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

  • sid (String) —

    The SID of the Call resource to fetch.



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workspace_real_time_statistics.rb', line 132

def initialize(version, payload , workspace_sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'account_sid' => payload['account_sid'],
        'activity_statistics' => payload['activity_statistics'],
        '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,
        'total_workers' => payload['total_workers'] == nil ? payload['total_workers'] : payload['total_workers'].to_i,
        'workspace_sid' => payload['workspace_sid'],
        'url' => payload['url'],
    }

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

Instance Method Details

#account_sid ⇒ String

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

Returns:



167
168
169
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workspace_real_time_statistics.rb', line 167

def 
    @properties['account_sid']
end

#activity_statistics ⇒ Array<Hash>

Returns The number of current Workers by Activity.

Returns:

  • (Array<Hash>) —

    The number of current Workers by Activity.



173
174
175
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workspace_real_time_statistics.rb', line 173

def activity_statistics
    @properties['activity_statistics']
end

#context ⇒ WorkspaceRealTimeStatisticsContext

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

Returns:



158
159
160
161
162
163
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workspace_real_time_statistics.rb', line 158

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

#fetch(task_channel: :unset) ⇒ WorkspaceRealTimeStatisticsInstance

Fetch the WorkspaceRealTimeStatisticsInstance

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:



229
230
231
232
233
234
235
236
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workspace_real_time_statistics.rb', line 229

def fetch(
    task_channel: :unset
)

    context.fetch(
        task_channel: task_channel, 
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



247
248
249
250
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workspace_real_time_statistics.rb', line 247

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

#longest_task_waiting_age ⇒ String

Returns The age of the longest waiting Task.

Returns:

  • (String) —

    The age of the longest waiting Task.



179
180
181
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workspace_real_time_statistics.rb', line 179

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.



185
186
187
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workspace_real_time_statistics.rb', line 185

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.



191
192
193
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workspace_real_time_statistics.rb', line 191

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



197
198
199
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workspace_real_time_statistics.rb', line 197

def tasks_by_status
    @properties['tasks_by_status']
end

#to_s ⇒ Object

Provide a user friendly representation



240
241
242
243
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workspace_real_time_statistics.rb', line 240

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

#total_tasks ⇒ String

Returns The total number of Tasks.

Returns:

  • (String) —

    The total number of Tasks.



203
204
205
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workspace_real_time_statistics.rb', line 203

def total_tasks
    @properties['total_tasks']
end

#total_workers ⇒ String

Returns The total number of Workers in the Workspace.

Returns:

  • (String) —

    The total number of Workers in the Workspace.



209
210
211
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workspace_real_time_statistics.rb', line 209

def total_workers
    @properties['total_workers']
end

#url ⇒ String

Returns The absolute URL of the Workspace statistics resource.

Returns:

  • (String) —

    The absolute URL of the Workspace statistics resource.



221
222
223
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workspace_real_time_statistics.rb', line 221

def url
    @properties['url']
end

#workspace_sid ⇒ String

Returns The SID of the Workspace.

Returns:

  • (String) —

    The SID of the Workspace.



215
216
217
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workspace_real_time_statistics.rb', line 215

def workspace_sid
    @properties['workspace_sid']
end