Class: Twilio::REST::Taskrouter::V1::WorkspaceContext::TaskChannelInstance

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

Instance Method Summary collapse

Constructor Details

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

Initialize the TaskChannelInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

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

    The unique ID of the Workspace that this TaskChannel belongs to.

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

    The unique ID for this TaskChannel.



265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb', line 265

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

  # Marshaled Properties
  @properties = {
      'account_sid' => payload['account_sid'],
      'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
      'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
      'friendly_name' => payload['friendly_name'],
      'sid' => payload['sid'],
      'unique_name' => payload['unique_name'],
      'workspace_sid' => payload['workspace_sid'],
      'channel_optimized_routing' => payload['channel_optimized_routing'],
      'url' => payload['url'],
      'links' => payload['links'],
  }

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

Instance Method Details

#account_sid ⇒ String

Returns The unique ID of the Account that owns this TaskChannel.

Returns:

  • (String) —

    The unique ID of the Account that owns this TaskChannel.



300
301
302
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb', line 300

def 
  @properties['account_sid']
end

#channel_optimized_routing ⇒ Boolean

Returns If true then prioritize longest idle workers.

Returns:

  • (Boolean) —

    If true then prioritize longest idle workers



342
343
344
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb', line 342

def channel_optimized_routing
  @properties['channel_optimized_routing']
end

#context ⇒ TaskChannelContext

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

Returns:



291
292
293
294
295
296
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb', line 291

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

#date_created ⇒ Time

Returns The date this TaskChannel was created.

Returns:

  • (Time) —

    The date this TaskChannel was created.



306
307
308
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb', line 306

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date this TaskChannel was updated.

Returns:

  • (Time) —

    The date this TaskChannel was updated.



312
313
314
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb', line 312

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the TaskChannelInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



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

def delete
  context.delete
end

#fetch ⇒ TaskChannelInstance

Fetch a TaskChannelInstance

Returns:



361
362
363
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb', line 361

def fetch
  context.fetch
end

#friendly_name ⇒ String

Returns The friendly name of this TaskChannel.

Returns:

  • (String) —

    The friendly name of this TaskChannel



318
319
320
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb', line 318

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



391
392
393
394
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb', line 391

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

#links ⇒ String

Returns The links.

Returns:

  • (String) —

    The links



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

def links
  @properties['links']
end

#sid ⇒ String

Returns The unique ID for this TaskChannel.

Returns:

  • (String) —

    The unique ID for this TaskChannel.



324
325
326
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb', line 324

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



384
385
386
387
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb', line 384

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

#unique_name ⇒ String

Returns The unique name of TaskChannel, such as ‘voice’, ‘sms’, etc.

Returns:

  • (String) —

    The unique name of TaskChannel, such as ‘voice’, ‘sms’, etc.



330
331
332
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb', line 330

def unique_name
  @properties['unique_name']
end

#update(friendly_name: :unset, channel_optimized_routing: :unset) ⇒ TaskChannelInstance

Update the TaskChannelInstance

Parameters:

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

    Toggle the FriendlyName for the TaskChannel

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

    A boolean that if true; mean that the channel will prioritize workers that have been idle

Returns:



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

def update(friendly_name: :unset, channel_optimized_routing: :unset)
  context.update(friendly_name: friendly_name, channel_optimized_routing: channel_optimized_routing, )
end

#url ⇒ String

Returns The url.

Returns:

  • (String) —

    The url



348
349
350
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb', line 348

def url
  @properties['url']
end

#workspace_sid ⇒ String

Returns The unique ID of the Workspace that this TaskChannel belongs to.

Returns:

  • (String) —

    The unique ID of the Workspace that this TaskChannel belongs to.



336
337
338
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb', line 336

def workspace_sid
  @properties['workspace_sid']
end