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

  • account_sid (String) —

    The SID of the Account that created this TaskChannel resource.

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

    The SID of the Call resource to fetch.



296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb', line 296

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  || @properties['workspace_sid']  ,'sid' => sid  || @properties['sid']  , }
end

Instance Method Details

#account_sid ⇒ String

Returns The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the Task Channel resource.

Returns:



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

def 
    @properties['account_sid']
end

#channel_optimized_routing ⇒ Boolean

Returns Whether the Task Channel will prioritize Workers that have been idle. When ‘true`, Workers that have been idle the longest are prioritized.

Returns:

  • (Boolean) —

    Whether the Task Channel will prioritize Workers that have been idle. When ‘true`, Workers that have been idle the longest are prioritized.



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

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:



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

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 and time in GMT when the resource was created specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:



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

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns The date and time in GMT when the resource was last updated specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:



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

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the TaskChannelInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



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

def delete

    context.delete
end

#fetch ⇒ TaskChannelInstance

Fetch the TaskChannelInstance

Returns:



400
401
402
403
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb', line 400

def fetch

    context.fetch
end

#friendly_name ⇒ String

Returns The string that you assigned to describe the resource.

Returns:

  • (String) —

    The string that you assigned to describe the resource.



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

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



430
431
432
433
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb', line 430

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

#links ⇒ Hash

Returns The URLs of related resources.

Returns:

  • (Hash) —

    The URLs of related resources.



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

def links
    @properties['links']
end

#sid ⇒ String

Returns The unique string that we created to identify the Task Channel resource.

Returns:

  • (String) —

    The unique string that we created to identify the Task Channel resource.



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

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



423
424
425
426
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb', line 423

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

#unique_name ⇒ String

Returns An application-defined string that uniquely identifies the Task Channel, such as ‘voice` or `sms`.

Returns:

  • (String) —

    An application-defined string that uniquely identifies the Task Channel, such as ‘voice` or `sms`.



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

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) —

    A descriptive string that you create to describe the Task Channel. It can be up to 64 characters long.

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

    Whether the TaskChannel should prioritize Workers that have been idle. If ‘true`, Workers that have been idle the longest are prioritized.

Returns:



410
411
412
413
414
415
416
417
418
419
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb', line 410

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 absolute URL of the Task Channel resource.

Returns:

  • (String) —

    The absolute URL of the Task Channel resource.



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

def url
    @properties['url']
end

#workspace_sid ⇒ String

Returns The SID of the Workspace that contains the Task Channel.

Returns:

  • (String) —

    The SID of the Workspace that contains the Task Channel.



367
368
369
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb', line 367

def workspace_sid
    @properties['workspace_sid']
end