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



28
29
30
31
32
33
34
 
# 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



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

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

#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.



110
111
112
113
114
115
116
117
118
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb', line 110

def each
    limits = @version.read_limits

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

    @version.stream(page,
        limit: limits[:limit],
        page_limit: limits[:page_limit]).each {|x| yield x}
end

#get_page(target_url) ⇒ Page

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



147
148
149
150
151
152
153
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb', line 147

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.



79
80
81
82
83
84
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb', line 79

def list(limit: nil, page_size: nil)
    self.stream(
        limit: limit,
        page_size: page_size
    ).entries
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.



127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb', line 127

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.



97
98
99
100
101
102
103
104
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb', line 97

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

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

    @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
end

#to_s ⇒ Object

Provide a user friendly representation



158
159
160
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb', line 158

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