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

  • workspace_sid (String) (defaults to: nil)

    The SID of the Workspace.


113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workspace_real_time_statistics.rb', line 113

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'].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'].to_i,
      'total_workers' => payload['total_workers'].to_i,
      'workspace_sid' => payload['workspace_sid'],
      'url' => payload['url'],
  }

  # Context
  @instance_context = nil
  @params = {'workspace_sid' => workspace_sid, }
end

Instance Method Details

#account_sidString

Returns The SID of the Account that created the resource.

Returns:

  • (String)

    The SID of the Account that created the resource


148
149
150
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workspace_real_time_statistics.rb', line 148

def 
  @properties['account_sid']
end

#activity_statisticsArray[Hash]

Returns The number of current Workers by Activity.

Returns:

  • (Array[Hash])

    The number of current Workers by Activity


154
155
156
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workspace_real_time_statistics.rb', line 154

def activity_statistics
  @properties['activity_statistics']
end

#contextWorkspaceRealTimeStatisticsContext

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

Returns:


139
140
141
142
143
144
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workspace_real_time_statistics.rb', line 139

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:


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

def fetch(task_channel: :unset)
  context.fetch(task_channel: task_channel, )
end

#inspectObject

Provide a detailed, user friendly representation


225
226
227
228
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workspace_real_time_statistics.rb', line 225

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

#longest_task_waiting_ageString

Returns The age of the longest waiting Task.

Returns:

  • (String)

    The age of the longest waiting Task


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

def longest_task_waiting_age
  @properties['longest_task_waiting_age']
end

#longest_task_waiting_sidString

Returns The SID of the longest waiting Task.

Returns:

  • (String)

    The SID of the longest waiting Task


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

def longest_task_waiting_sid
  @properties['longest_task_waiting_sid']
end

#tasks_by_priorityHash

Returns The number of Tasks by priority.

Returns:

  • (Hash)

    The number of Tasks by priority


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

def tasks_by_priority
  @properties['tasks_by_priority']
end

#tasks_by_statusHash

Returns The number of Tasks by their current status.

Returns:

  • (Hash)

    The number of Tasks by their current status


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

def tasks_by_status
  @properties['tasks_by_status']
end

#to_sObject

Provide a user friendly representation


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

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

#total_tasksString

Returns The total number of Tasks.

Returns:

  • (String)

    The total number of Tasks


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

def total_tasks
  @properties['total_tasks']
end

#total_workersString

Returns The total number of Workers in the Workspace.

Returns:

  • (String)

    The total number of Workers in the Workspace


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

def total_workers
  @properties['total_workers']
end

#urlString

Returns The absolute URL of the Workspace statistics resource.

Returns:

  • (String)

    The absolute URL of the Workspace statistics resource


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

def url
  @properties['url']
end

#workspace_sidString

Returns The SID of the Workspace.

Returns:

  • (String)

    The SID of the Workspace


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

def workspace_sid
  @properties['workspace_sid']
end