Class: Twilio::REST::Taskrouter::V1::WorkspaceContext::TaskContext

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

Defined Under Namespace

Classes: ReservationContext, ReservationInstance, ReservationList, ReservationPage

Instance Method Summary collapse

Constructor Details

#initialize(version, workspace_sid, sid) ⇒ TaskContext

Initialize the TaskContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • workspace_sid (String) —

    The workspace_sid

  • sid (String) —

    The sid



249
250
251
252
253
254
255
256
257
258
259
260
261
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb', line 249

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

  # Path Solution
  @solution = {
      workspace_sid: workspace_sid,
      sid: sid,
  }
  @uri = "/Workspaces/#{@solution[:workspace_sid]}/Tasks/#{@solution[:sid]}"

  # Dependents
  @reservations = nil
end

Instance Method Details

#delete ⇒ Boolean

Deletes the TaskInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



317
318
319
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb', line 317

def delete
  @version.delete('delete', @uri)
end

#fetch ⇒ TaskInstance

Fetch a TaskInstance

Returns:



266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb', line 266

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

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

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

#reservations(sid = :unset) ⇒ ReservationList, ReservationContext

Access the reservations

Returns:

Raises:

  • (ArgumentError) 


325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb', line 325

def reservations(sid=:unset)
  raise ArgumentError, 'sid cannot be nil' if sid.nil?

  if sid != :unset
    return ReservationContext.new(
        @version,
        @solution[:workspace_sid],
        @solution[:sid],
        sid,
    )
  end

  unless @reservations
    @reservations = ReservationList.new(
        @version,
        workspace_sid: @solution[:workspace_sid],
        task_sid: @solution[:sid],
    )
  end

  @reservations
end

#to_s ⇒ Object

Provide a user friendly representation



350
351
352
353
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb', line 350

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

#update(attributes: :unset, assignment_status: :unset, reason: :unset, priority: :unset, task_channel: :unset) ⇒ TaskInstance

Update the TaskInstance

Parameters:

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

    The attributes

  • assignment_status (task.Status) (defaults to: :unset) —

    The assignment_status

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

    The reason

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

    The priority

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

    The task_channel

Returns:



291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb', line 291

def update(attributes: :unset, assignment_status: :unset, reason: :unset, priority: :unset, task_channel: :unset)
  data = Twilio::Values.of({
      'Attributes' => attributes,
      'AssignmentStatus' => assignment_status,
      'Reason' => reason,
      'Priority' => priority,
      'TaskChannel' => task_channel,
  })

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

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