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 SID of the Workspace with the Task to update.

  • sid (String) —

    The SID of the Task resource to update.



231
232
233
234
235
236
237
238
239
240
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb', line 231

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

Parameters:

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



245
246
247
248
249
250
251
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb', line 245

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

Returns:



256
257
258
259
260
261
262
263
264
265
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb', line 256

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



332
333
334
335
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb', line 332

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

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

Access the reservations

Returns:

Raises:

  • (ArgumentError) 


307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb', line 307

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



325
326
327
328
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb', line 325

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

Parameters:

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

    The JSON string that describes the custom attributes of the task.

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

    The reason that the Task was canceled or completed. This parameter is required only if the Task is canceled or completed. Setting this value queues the task for deletion and logs the reason.

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

    The Task’s new priority value. When supplied, the Task takes on the specified priority unless it matches a Workflow Target with a Priority set. Value can be 0 to 2^31^ (2,147,483,647).

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

    When MultiTasking is enabled, specify the TaskChannel with the task to update. Can be the TaskChannel’s SID or its ‘unique_name`, such as `voice`, `sms`, or `default`.

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

    If provided, applies this mutation if (and only if) the [ETag](developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag) header of the Task matches the provided value. This matches the semantics of (and is implemented with) the HTTP [If-Match header](developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Match).

Returns:



276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb', line 276

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