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



21
22
23
24
25
26
27
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb', line 21

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



119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb', line 119

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,
  })

  payload = @version.create('POST', @uri, data: data)

  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.



67
68
69
70
71
72
73
74
75
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb', line 67

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.



101
102
103
104
105
106
107
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb', line 101

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.



40
41
42
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb', line 40

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.



84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb', line 84

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

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

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

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

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



55
56
57
58
59
60
61
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb', line 55

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



133
134
135
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb', line 133

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