Package com.chrt.api.resources.shipping.tasks

Class TasksClient

java.lang.Object

com.chrt.api.resources.shipping.tasks.TasksClient

public class TasksClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientOptions	clientOptions

Constructor Summary

Constructors

Constructor	Description
TasksClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
java.lang.String	addToTaskGroupV1(java.lang.String taskGroupId, AddTaskToGroupReq request)	Adds a new task to a task group at a specific index.
java.lang.String	addToTaskGroupV1(java.lang.String taskGroupId, AddTaskToGroupReq request, RequestOptions requestOptions)	Adds a new task to a task group at a specific index.
boolean	completeV1(java.lang.String taskId)	Marks a task as COMPLETED.
boolean	completeV1(java.lang.String taskId, RequestOptions requestOptions)	Marks a task as COMPLETED.
boolean	deleteV1(java.lang.String taskId)	Deletes a task.
boolean	deleteV1(java.lang.String taskId, RequestOptions requestOptions)	Deletes a task.
boolean	skipV1(java.lang.String taskId)	Marks a task as SKIPPED.
boolean	skipV1(java.lang.String taskId, RequestOptions requestOptions)	Marks a task as SKIPPED.
java.lang.String	updateV1(java.lang.String taskId)	Updates a task.
java.lang.String	updateV1(java.lang.String taskId, TaskClientUpdate1 request)	Updates a task.
java.lang.String	updateV1(java.lang.String taskId, TaskClientUpdate1 request, RequestOptions requestOptions)	Updates a task.
RawTasksClient	withRawResponse()	Get responses with HTTP metadata like headers

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

clientOptions

protected final ClientOptions clientOptions

Constructor Detail

TasksClient

public TasksClient(ClientOptions clientOptions)

Method Detail

withRawResponse

public RawTasksClient withRawResponse()

Get responses with HTTP metadata like headers

addToTaskGroupV1

public java.lang.String addToTaskGroupV1(java.lang.String taskGroupId,
                                         AddTaskToGroupReq request)

Adds a new task to a task group at a specific index. | authz_personas=[lig_owner_operators] | (AddTaskToGroupReq) -> (PydanticObjectId)

addToTaskGroupV1

public java.lang.String addToTaskGroupV1(java.lang.String taskGroupId,
                                         AddTaskToGroupReq request,
                                         RequestOptions requestOptions)

Adds a new task to a task group at a specific index. | authz_personas=[lig_owner_operators] | (AddTaskToGroupReq) -> (PydanticObjectId)

updateV1

public java.lang.String updateV1(java.lang.String taskId)

Updates a task. Task must be in STAGED status. | authz_personas=[lig_owner_operators] | (TaskClientUpdate1) -> (PydanticObjectId)

updateV1

public java.lang.String updateV1(java.lang.String taskId,
                                 TaskClientUpdate1 request)

Updates a task. Task must be in STAGED status. | authz_personas=[lig_owner_operators] | (TaskClientUpdate1) -> (PydanticObjectId)

updateV1

public java.lang.String updateV1(java.lang.String taskId,
                                 TaskClientUpdate1 request,
                                 RequestOptions requestOptions)

Updates a task. Task must be in STAGED status. | authz_personas=[lig_owner_operators] | (TaskClientUpdate1) -> (PydanticObjectId)

completeV1

public boolean completeV1(java.lang.String taskId)

Marks a task as COMPLETED. | authz_personas=[courier_driver, forwarder_org_operators, courier_org_operators] (depending on type) | () -> (bool)

completeV1

public boolean completeV1(java.lang.String taskId,
                          RequestOptions requestOptions)

Marks a task as COMPLETED. | authz_personas=[courier_driver, forwarder_org_operators, courier_org_operators] (depending on type) | () -> (bool)

skipV1

public boolean skipV1(java.lang.String taskId)

Marks a task as SKIPPED. | authz_personas=[courier_driver, forwarder_org_operators, courier_org_operators] (depending on type) | () -> (bool)

skipV1

public boolean skipV1(java.lang.String taskId,
                      RequestOptions requestOptions)

Marks a task as SKIPPED. | authz_personas=[courier_driver, forwarder_org_operators, courier_org_operators] (depending on type) | () -> (bool)

deleteV1

public boolean deleteV1(java.lang.String taskId)

Deletes a task. Task must be in STAGED status. | authz_personas=[lig_owner_operators] | () -> (bool)

deleteV1

public boolean deleteV1(java.lang.String taskId,
                        RequestOptions requestOptions)

Deletes a task. Task must be in STAGED status. | authz_personas=[lig_owner_operators] | () -> (bool)