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



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/worker_channel.rb', line 228

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'],
      '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



275
276
277
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/worker_channel.rb', line 275

def 
  @properties['account_sid']
end

#assigned_tasks ⇒ String

Returns The assigned_tasks.

Returns:

  • (String) —

    The assigned_tasks



281
282
283
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/worker_channel.rb', line 281

def assigned_tasks
  @properties['assigned_tasks']
end

#available ⇒ Boolean

Returns The available.

Returns:

  • (Boolean) —

    The available



287
288
289
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/worker_channel.rb', line 287

def available
  @properties['available']
end

#available_capacity_percentage ⇒ String

Returns The available_capacity_percentage.

Returns:

  • (String) —

    The available_capacity_percentage



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

def available_capacity_percentage
  @properties['available_capacity_percentage']
end

#configured_capacity ⇒ String

Returns The configured_capacity.

Returns:

  • (String) —

    The configured_capacity



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

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:



261
262
263
264
265
266
267
268
269
270
271
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/worker_channel.rb', line 261

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



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date_updated.

Returns:

  • (Time) —

    The date_updated



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

def date_updated
  @properties['date_updated']
end

#fetch ⇒ WorkerChannelInstance

Fetch a WorkerChannelInstance

Returns:



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

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#sid ⇒ String

Returns The sid.

Returns:

  • (String) —

    The sid



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

def sid
  @properties['sid']
end

#task_channel_sid ⇒ String

Returns The task_channel_sid.

Returns:

  • (String) —

    The task_channel_sid



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

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



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

def task_channel_unique_name
  @properties['task_channel_unique_name']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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:



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

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

#url ⇒ String

Returns The url.

Returns:

  • (String) —

    The url



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

def url
  @properties['url']
end

#worker_sid ⇒ String

Returns The worker_sid.

Returns:

  • (String) —

    The worker_sid



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

def worker_sid
  @properties['worker_sid']
end

#workspace_sid ⇒ String

Returns The workspace_sid.

Returns:

  • (String) —

    The workspace_sid



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

def workspace_sid
  @properties['workspace_sid']
end