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

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

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, workspace_sid: nil, worker_sid: nil, sid: nil) ⇒ WorkerChannelInstance

Initialize the WorkerChannelInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • workspace_sid (String) (defaults to: nil) —

    The workspace_sid

  • worker_sid (String) (defaults to: nil) —

    The worker_sid

  • sid (String) (defaults to: nil) —

    The sid



245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/worker_channel.rb', line 245

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

  # Marshaled Properties
  @properties = {
      'account_sid' => payload['account_sid'],
      'assigned_tasks' => payload['assigned_tasks'].to_i,
      'available' => payload['available'],
      'available_capacity_percentage' => payload['available_capacity_percentage'].to_i,
      'configured_capacity' => payload['configured_capacity'].to_i,
      'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
      'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
      'sid' => payload['sid'],
      'task_channel_sid' => payload['task_channel_sid'],
      'task_channel_unique_name' => payload['task_channel_unique_name'],
      'worker_sid' => payload['worker_sid'],
      'workspace_sid' => payload['workspace_sid'],
      'links' => payload['links'],
      'url' => payload['url'],
  }

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

Instance Method Details

#account_sid ⇒ String

Returns The account_sid.

Returns:

  • (String) —

    The account_sid



293
294
295
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/worker_channel.rb', line 293

def 
  @properties['account_sid']
end

#assigned_tasks ⇒ String

Returns The assigned_tasks.

Returns:

  • (String) —

    The assigned_tasks



299
300
301
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/worker_channel.rb', line 299

def assigned_tasks
  @properties['assigned_tasks']
end

#available ⇒ Boolean

Returns The available.

Returns:

  • (Boolean) —

    The available



305
306
307
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/worker_channel.rb', line 305

def available
  @properties['available']
end

#available_capacity_percentage ⇒ String

Returns The available_capacity_percentage.

Returns:

  • (String) —

    The available_capacity_percentage



311
312
313
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/worker_channel.rb', line 311

def available_capacity_percentage
  @properties['available_capacity_percentage']
end

#configured_capacity ⇒ String

Returns The configured_capacity.

Returns:

  • (String) —

    The configured_capacity



317
318
319
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/worker_channel.rb', line 317

def configured_capacity
  @properties['configured_capacity']
end

#context ⇒ WorkerChannelContext

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

Returns:



279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/worker_channel.rb', line 279

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

#date_created ⇒ Time

Returns The date_created.

Returns:

  • (Time) —

    The date_created



323
324
325
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/worker_channel.rb', line 323

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date_updated.

Returns:

  • (Time) —

    The date_updated



329
330
331
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/worker_channel.rb', line 329

def date_updated
  @properties['date_updated']
end

#fetch ⇒ WorkerChannelInstance

Fetch a WorkerChannelInstance

Returns:



378
379
380
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/worker_channel.rb', line 378

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



403
404
405
406
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/worker_channel.rb', line 403

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

#links ⇒ String

Returns The links.

Returns:

  • (String) —

    The links



365
366
367
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/worker_channel.rb', line 365

def links
  @properties['links']
end

#sid ⇒ String

Returns The sid.

Returns:

  • (String) —

    The sid



335
336
337
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/worker_channel.rb', line 335

def sid
  @properties['sid']
end

#task_channel_sid ⇒ String

Returns The task_channel_sid.

Returns:

  • (String) —

    The task_channel_sid



341
342
343
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/worker_channel.rb', line 341

def task_channel_sid
  @properties['task_channel_sid']
end

#task_channel_unique_name ⇒ String

Returns The task_channel_unique_name.

Returns:

  • (String) —

    The task_channel_unique_name



347
348
349
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/worker_channel.rb', line 347

def task_channel_unique_name
  @properties['task_channel_unique_name']
end

#to_s ⇒ Object

Provide a user friendly representation



396
397
398
399
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/worker_channel.rb', line 396

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

#update(capacity: :unset, available: :unset) ⇒ WorkerChannelInstance

Update the WorkerChannelInstance

Parameters:

  • capacity (String) (defaults to: :unset) —

    The capacity

  • available (Boolean) (defaults to: :unset) —

    The available

Returns:



387
388
389
390
391
392
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/worker_channel.rb', line 387

def update(capacity: :unset, available: :unset)
  context.update(
      capacity: capacity,
      available: available,
  )
end

#url ⇒ String

Returns The url.

Returns:

  • (String) —

    The url



371
372
373
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/worker_channel.rb', line 371

def url
  @properties['url']
end

#worker_sid ⇒ String

Returns The worker_sid.

Returns:

  • (String) —

    The worker_sid



353
354
355
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/worker_channel.rb', line 353

def worker_sid
  @properties['worker_sid']
end

#workspace_sid ⇒ String

Returns The workspace_sid.

Returns:

  • (String) —

    The workspace_sid



359
360
361
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/worker_channel.rb', line 359

def workspace_sid
  @properties['workspace_sid']
end