Class: Twilio::REST::Taskrouter::V1::WorkspaceContext::WorkerContext::WorkersRealTimeStatisticsInstance

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

Instance Method Summary collapse

Constructor Details

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

Initialize the WorkersRealTimeStatisticsInstance

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 that contains the Workers.



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/workers_real_time_statistics.rb', line 121

def initialize(version, payload, workspace_sid: nil)
  super(version)

  # Marshaled Properties
  @properties = {
      'account_sid' => payload['account_sid'],
      'activity_statistics' => payload['activity_statistics'],
      '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_sid ⇒ String

Returns The SID of the Account that created the resource.

Returns:

  • (String) —

    The SID of the Account that created the resource



151
152
153
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/workers_real_time_statistics.rb', line 151

def 
  @properties['account_sid']
end

#activity_statistics ⇒ Hash

Returns The number of current Workers by Activity.

Returns:

  • (Hash) —

    The number of current Workers by Activity



157
158
159
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/workers_real_time_statistics.rb', line 157

def activity_statistics
  @properties['activity_statistics']
end

#context ⇒ WorkersRealTimeStatisticsContext

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

Returns:



142
143
144
145
146
147
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/workers_real_time_statistics.rb', line 142

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

#fetch(task_channel: :unset) ⇒ WorkersRealTimeStatisticsInstance

Fetch a WorkersRealTimeStatisticsInstance

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:



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

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

#inspect ⇒ Object

Provide a detailed, user friendly representation



198
199
200
201
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/workers_real_time_statistics.rb', line 198

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

#to_s ⇒ Object

Provide a user friendly representation



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

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

#total_workers ⇒ String

Returns The total number of Workers.

Returns:

  • (String) —

    The total number of Workers



163
164
165
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/workers_real_time_statistics.rb', line 163

def total_workers
  @properties['total_workers']
end

#url ⇒ String

Returns The absolute URL of the Workers statistics resource.

Returns:

  • (String) —

    The absolute URL of the Workers statistics resource



175
176
177
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/workers_real_time_statistics.rb', line 175

def url
  @properties['url']
end

#workspace_sid ⇒ String

Returns The SID of the Workspace that contains the Workers.

Returns:

  • (String) —

    The SID of the Workspace that contains the Workers



169
170
171
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/workers_real_time_statistics.rb', line 169

def workspace_sid
  @properties['workspace_sid']
end