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

  • account_sid (String) —

    The SID of the Account that created this WorkersRealTimeStatistics resource.

  • sid (String) —

    The SID of the Call resource to fetch.



222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/workers_real_time_statistics.rb', line 222

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'] == 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 that created the Worker resource.

Returns:

  • (String) —

    The SID of the Account that created the Worker resource.



253
254
255
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/workers_real_time_statistics.rb', line 253

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.



259
260
261
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/workers_real_time_statistics.rb', line 259

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:



244
245
246
247
248
249
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/workers_real_time_statistics.rb', line 244

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

#fetch(task_channel: :unset) ⇒ WorkersRealTimeStatisticsInstance

Fetch the 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:



285
286
287
288
289
290
291
292
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/workers_real_time_statistics.rb', line 285

def fetch(
  task_channel: :unset
)

    context.fetch(
        task_channel: task_channel, 
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



303
304
305
306
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/workers_real_time_statistics.rb', line 303

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

#to_s ⇒ Object

Provide a user friendly representation



296
297
298
299
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/workers_real_time_statistics.rb', line 296

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.



265
266
267
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/workers_real_time_statistics.rb', line 265

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.



277
278
279
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/workers_real_time_statistics.rb', line 277

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.



271
272
273
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/workers_real_time_statistics.rb', line 271

def workspace_sid
    @properties['workspace_sid']
end