Class: Twilio::REST::Taskrouter::V1::WorkspaceContext::WorkerContext::WorkerChannelContext

Inherits:
InstanceContext
  • Object
show all
Defined in:
lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/worker_channel.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, workspace_sid, worker_sid, sid) ⇒ WorkerChannelContext

Initialize the WorkerChannelContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • workspace_sid (String) —

    The workspace_sid

  • worker_sid (String) —

    The worker_sid

  • sid (String) —

    The sid



159
160
161
162
163
164
165
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/worker_channel.rb', line 159

def initialize(version, workspace_sid, worker_sid, sid)
  super(version)

  # Path Solution
  @solution = {workspace_sid: workspace_sid, worker_sid: worker_sid, sid: sid, }
  @uri = "/Workspaces/#{@solution[:workspace_sid]}/Workers/#{@solution[:worker_sid]}/Channels/#{@solution[:sid]}"
end

Instance Method Details

#fetch ⇒ WorkerChannelInstance

Fetch a WorkerChannelInstance

Returns:



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/worker_channel.rb', line 170

def fetch
  params = Twilio::Values.of({})

  payload = @version.fetch(
      'GET',
      @uri,
      params,
  )

  WorkerChannelInstance.new(
      @version,
      payload,
      workspace_sid: @solution[:workspace_sid],
      worker_sid: @solution[:worker_sid],
      sid: @solution[:sid],
  )
end

#to_s ⇒ Object

Provide a user friendly representation



213
214
215
216
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/worker_channel.rb', line 213

def to_s
  context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
  "#<Twilio.Taskrouter.V1.WorkerChannelContext #{context}>"
end

#update(capacity: :unset, available: :unset) ⇒ WorkerChannelInstance

Update the WorkerChannelInstance

Parameters:

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

    The capacity

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

    The available

Returns:



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

def update(capacity: :unset, available: :unset)
  data = Twilio::Values.of({'Capacity' => capacity, 'Available' => available, })

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

  WorkerChannelInstance.new(
      @version,
      payload,
      workspace_sid: @solution[:workspace_sid],
      worker_sid: @solution[:worker_sid],
      sid: @solution[:sid],
  )
end