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.



548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb', line 548

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:



584
585
586
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb', line 584

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.



626
627
628
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb', line 626

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:



575
576
577
578
579
580
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb', line 575

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:



590
591
592
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb', line 590

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:



596
597
598
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb', line 596

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the TaskChannelInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



645
646
647
648
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb', line 645

def delete

    context.delete
end

#fetch ⇒ TaskChannelInstance

Fetch the TaskChannelInstance

Returns:



653
654
655
656
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb', line 653

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.



602
603
604
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb', line 602

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



683
684
685
686
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb', line 683

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.



638
639
640
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb', line 638

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.



608
609
610
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb', line 608

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



676
677
678
679
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb', line 676

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.



614
615
616
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb', line 614

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:



663
664
665
666
667
668
669
670
671
672
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb', line 663

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.



632
633
634
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb', line 632

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.



620
621
622
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb', line 620

def workspace_sid
    @properties['workspace_sid']
end