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



303
304
305
306
307
308
309
310
311
312
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb', line 303

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(if_match: :unset) ⇒ Boolean

Delete the TaskInstance



369
370
371
372
373
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb', line 369

def delete(if_match: :unset)
  headers = Twilio::Values.of({'If-Match' => if_match, })

   @version.delete('DELETE', @uri, headers: headers)
end

#fetch ⇒ TaskInstance

Fetch the TaskInstance



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

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

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

#inspect ⇒ Object

Provide a detailed, user friendly representation



406
407
408
409
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb', line 406

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

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

Access the reservations

Raises:

  • (ArgumentError) 


379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb', line 379

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



399
400
401
402
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb', line 399

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, if_match: :unset) ⇒ TaskInstance

Update the TaskInstance



346
347
348
349
350
351
352
353
354
355
356
357
358
359
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb', line 346

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

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

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