Class: Twilio::REST::Taskrouter::V1::WorkspaceContext::TaskChannelList

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

Instance Method Summary collapse

Constructor Details

#initialize(version, workspace_sid: nil) ⇒ TaskChannelList

Initialize the TaskChannelList

Parameters:

  • version (Version) —

    Version that contains the resource



28
29
30
31
32
33
34
35
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb', line 28

def initialize(version, workspace_sid: nil)
    super(version)
    
    # Path Solution
    @solution = { workspace_sid: workspace_sid }
    @uri = "/Workspaces/#{@solution[:workspace_sid]}/TaskChannels"
    
end

Instance Method Details

#create(friendly_name: nil, unique_name: nil, channel_optimized_routing: :unset) ⇒ TaskChannelInstance

Create the TaskChannelInstance

Parameters:

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

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

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

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

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

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

Returns:



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb', line 42

def create(
  friendly_name: nil, 
  unique_name: nil, 
  channel_optimized_routing: :unset
)

    data = Twilio::Values.of({
        'FriendlyName' => friendly_name,
        'UniqueName' => unique_name,
        'ChannelOptimizedRouting' => channel_optimized_routing,
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.create('POST', @uri, data: data, headers: headers)
    TaskChannelInstance.new(
        @version,
        payload,
        workspace_sid: @solution[:workspace_sid],
    )
end

#create_with_metadata(friendly_name: nil, unique_name: nil, channel_optimized_routing: :unset) ⇒ TaskChannelInstance

Create the TaskChannelInstanceMetadata

Parameters:

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

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

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

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

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

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

Returns:



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb', line 74

def create_with_metadata(
  friendly_name: nil, 
  unique_name: nil, 
  channel_optimized_routing: :unset
)

    data = Twilio::Values.of({
        'FriendlyName' => friendly_name,
        'UniqueName' => unique_name,
        'ChannelOptimizedRouting' => channel_optimized_routing,
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
    task_channel_instance = TaskChannelInstance.new(
        @version,
        response.body,
        workspace_sid: @solution[:workspace_sid],
    )
    TaskChannelInstanceMetadata.new(
        @version,
        task_channel_instance,
        response.headers,
        response.status_code
    )
end

#each ⇒ Object

When passed a block, yields TaskChannelInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.



175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb', line 175

def each
    limits = @version.read_limits

    page = self.page(page_size: limits[:page_size], )

    return [].each if page.nil?

    result = @version.stream(page,
        limit: limits[:limit],
        page_limit: limits[:page_limit])
    return [].each if result.nil?
    result.each {|x| yield x}
end

#get_page(target_url) ⇒ Page

Retrieve a single page of TaskChannelInstance records from the API. Request is executed immediately.

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of TaskChannelInstance



216
217
218
219
220
221
222
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb', line 216

def get_page(target_url)
    response = @version.domain.request(
        'GET',
        target_url
    )
TaskChannelPage.new(@version, response, @solution)
end

#list(limit: nil, page_size: nil) ⇒ Array

Lists TaskChannelInstance records from the API as a list. Unlike stream(), this operation is eager and will load ‘limit` records into memory before returning.

Parameters:

  • limit (Integer) (defaults to: nil) —

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit

  • page_size (Integer) (defaults to: nil) —

    Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)

Returns:

  • (Array) —

    Array of up to limit results



118
119
120
121
122
123
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb', line 118

def list(limit: nil, page_size: nil)
    self.stream(
        limit: limit,
        page_size: page_size
    ).entries
end

#list_with_metadata(limit: nil, page_size: nil) ⇒ Array

Lists TaskChannelPageMetadata records from the API as a list.

Parameters:

  • limit (Integer) (defaults to: nil) —

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit

  • page_size (Integer) (defaults to: nil) —

    Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)

Returns:

  • (Array) —

    Array of up to limit results



158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb', line 158

def list_with_metadata(limit: nil, page_size: nil)
    limits = @version.read_limits(limit, page_size)
    params = Twilio::Values.of({
        
        'PageSize' => limits[:page_size],
    });
    headers = Twilio::Values.of({})

    response = @version.page('GET', @uri, params: params, headers: headers)

    TaskChannelPageMetadata.new(@version, response, @solution, limits[:limit])
end

#page(page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page

Retrieve a single page of TaskChannelInstance records from the API. Request is executed immediately.

Parameters:

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

    PageToken provided by the API

  • page_number (Integer) (defaults to: :unset) —

    Page Number, this value is simply for client state

  • page_size (Integer) (defaults to: :unset) —

    Number of records to return, defaults to 50

Returns:

  • (Page) —

    Page of TaskChannelInstance



196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb', line 196

def page(page_token: :unset, page_number: :unset,page_size: :unset)
    params = Twilio::Values.of({
        'PageToken' => page_token,
        'Page' => page_number,
        'PageSize' => page_size,
    })
    headers = Twilio::Values.of({})
    
    

    response = @version.page('GET', @uri, params: params, headers: headers)

    TaskChannelPage.new(@version, response, @solution)
end

#stream(limit: nil, page_size: nil) ⇒ Enumerable

Streams Instance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.

Parameters:

  • limit (Integer) (defaults to: nil) —

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit

  • page_size (Integer) (defaults to: nil) —

    Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)

Returns:

  • (Enumerable) —

    Enumerable that will yield up to limit results



136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb', line 136

def stream(limit: nil, page_size: nil)
    limits = @version.read_limits(limit, page_size)

    page = self.page(
        page_size: limits[:page_size], )

    return [].each if page.nil?

    result = @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
    return [].each if result.nil?
    result
end

#to_s ⇒ Object

Provide a user friendly representation



227
228
229
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb', line 227

def to_s
    '#<Twilio.Taskrouter.V1.TaskChannelList>'
end