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

Class AsyncRawTasksClient

java.lang.Object

com.chrt.api.resources.shipping.tasks.AsyncRawTasksClient

public class AsyncRawTasksClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientOptions	clientOptions

Constructor Summary

Constructors

Constructor	Description
AsyncRawTasksClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.String>>	addToTaskGroupV1(java.lang.String taskGroupId, AddTaskToGroupReq request)	Adds a new task to a task group at a specific index.
java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.String>>	addToTaskGroupV1(java.lang.String taskGroupId, AddTaskToGroupReq request, RequestOptions requestOptions)	Adds a new task to a task group at a specific index.
java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>>	attemptV1(java.lang.String taskId)	Marks a task as ATTEMPT with an optional executor organization note.
java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>>	attemptV1(java.lang.String taskId, AttemptTaskReq request)	Marks a task as ATTEMPT with an optional executor organization note.
java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>>	attemptV1(java.lang.String taskId, AttemptTaskReq request, RequestOptions requestOptions)	Marks a task as ATTEMPT with an optional executor organization note.
java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>>	completeV1(java.lang.String taskId)	Marks a task as COMPLETED.
java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>>	completeV1(java.lang.String taskId, RequestOptions requestOptions)	Marks a task as COMPLETED.
java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>>	deleteV1(java.lang.String taskId)	Deletes a task.
java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>>	deleteV1(java.lang.String taskId, RequestOptions requestOptions)	Deletes a task.
java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>>	skipV1(java.lang.String taskId)	Marks a task as SKIPPED.
java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>>	skipV1(java.lang.String taskId, RequestOptions requestOptions)	Marks a task as SKIPPED.
java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.String>>	updateV1(java.lang.String taskId)	Updates a task.
java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.String>>	updateV1(java.lang.String taskId, TaskClientUpdate1 request)	Updates a task.
java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.String>>	updateV1(java.lang.String taskId, TaskClientUpdate1 request, RequestOptions requestOptions)	Updates a task.
java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>>	waitTimeEndV1(java.lang.String taskId)	Ends an active wait-time session for a task.
java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>>	waitTimeEndV1(java.lang.String taskId, RequestOptions requestOptions)	Ends an active wait-time session for a task.
java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<TaskWaitTimeGeofenceRes>>	waitTimeGeofenceV1(java.lang.String taskId)	Checks whether the assigned driver's available location is inside the task wait-time geofence.
java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<TaskWaitTimeGeofenceRes>>	waitTimeGeofenceV1(java.lang.String taskId, RequestOptions requestOptions)	Checks whether the assigned driver's available location is inside the task wait-time geofence.
java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>>	waitTimeOverrideV1(java.lang.String taskId)	Overrides wait-time timestamps or geofence distance for a task.
java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>>	waitTimeOverrideV1(java.lang.String taskId, WaitTimeOverrideReq request)	Overrides wait-time timestamps or geofence distance for a task.
java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>>	waitTimeOverrideV1(java.lang.String taskId, WaitTimeOverrideReq request, RequestOptions requestOptions)	Overrides wait-time timestamps or geofence distance for a task.
java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>>	waitTimeStartV1(java.lang.String taskId)	Starts wait time for a task and records whether the assigned driver's available location is inside the geofence.
java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>>	waitTimeStartV1(java.lang.String taskId, RequestOptions requestOptions)	Starts wait time for a task and records whether the assigned driver's available location is inside the geofence.
java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>>	waitTimeValidateV1(java.lang.String taskId)	Validates wait time for a task.
java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>>	waitTimeValidateV1(java.lang.String taskId, RequestOptions requestOptions)	Validates wait time for a task.

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

AsyncRawTasksClient

public AsyncRawTasksClient(ClientOptions clientOptions)

Method Detail

waitTimeGeofenceV1

public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<TaskWaitTimeGeofenceRes>> waitTimeGeofenceV1(java.lang.String taskId)

Checks whether the assigned driver's available location is inside the task wait-time geofence. | authz_personas=[driver_for_executor, executor_org_operators] | () -> (TaskWaitTimeGeofenceRes)

waitTimeGeofenceV1

public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<TaskWaitTimeGeofenceRes>> waitTimeGeofenceV1(java.lang.String taskId,
                                                                                                               RequestOptions requestOptions)

Checks whether the assigned driver's available location is inside the task wait-time geofence. | authz_personas=[driver_for_executor, executor_org_operators] | () -> (TaskWaitTimeGeofenceRes)

waitTimeStartV1

public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>> waitTimeStartV1(java.lang.String taskId)

Starts wait time for a task and records whether the assigned driver's available location is inside the geofence. | authz_personas=[driver_for_executor, executor_org_operators] | () -> (bool)

waitTimeStartV1

public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>> waitTimeStartV1(java.lang.String taskId,
                                                                                                      RequestOptions requestOptions)

Starts wait time for a task and records whether the assigned driver's available location is inside the geofence. | authz_personas=[driver_for_executor, executor_org_operators] | () -> (bool)

waitTimeEndV1

public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>> waitTimeEndV1(java.lang.String taskId)

Ends an active wait-time session for a task. | authz_personas=[driver_for_executor, executor_org_operators] | () -> (bool)

waitTimeEndV1

public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>> waitTimeEndV1(java.lang.String taskId,
                                                                                                    RequestOptions requestOptions)

Ends an active wait-time session for a task. | authz_personas=[driver_for_executor, executor_org_operators] | () -> (bool)

waitTimeValidateV1

public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>> waitTimeValidateV1(java.lang.String taskId)

Validates wait time for a task. | authz_personas=[executor_org_operators] | () -> (bool)

waitTimeValidateV1

public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>> waitTimeValidateV1(java.lang.String taskId,
                                                                                                         RequestOptions requestOptions)

Validates wait time for a task. | authz_personas=[executor_org_operators] | () -> (bool)

waitTimeOverrideV1

public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>> waitTimeOverrideV1(java.lang.String taskId)

Overrides wait-time timestamps or geofence distance for a task. | authz_personas=[executor_org_operators] | (WaitTimeOverrideReq) -> (bool)

waitTimeOverrideV1

public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>> waitTimeOverrideV1(java.lang.String taskId,
                                                                                                         WaitTimeOverrideReq request)

Overrides wait-time timestamps or geofence distance for a task. | authz_personas=[executor_org_operators] | (WaitTimeOverrideReq) -> (bool)

waitTimeOverrideV1

public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>> waitTimeOverrideV1(java.lang.String taskId,
                                                                                                         WaitTimeOverrideReq request,
                                                                                                         RequestOptions requestOptions)

Overrides wait-time timestamps or geofence distance for a task. | authz_personas=[executor_org_operators] | (WaitTimeOverrideReq) -> (bool)

addToTaskGroupV1

public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<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.util.concurrent.CompletableFuture<ChrtApiHttpResponse<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.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.String>> updateV1(java.lang.String taskId)

Updates a task. Operational fields (location, action, datetime_windows) require STAGED status (lig_owner_operators). order_placer_comments can be edited on any non-DRAFT task (order_creator_org_operators). directory_entry_ids can be edited on STAGED/IN_PROGRESS orders for tasks still in STAGED status (order_creator_org_operators OR lig_owner_operators). | (TaskClientUpdate1) -> (PydanticObjectId)

updateV1

public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.String>> updateV1(java.lang.String taskId,
                                                                                              TaskClientUpdate1 request)

Updates a task. Operational fields (location, action, datetime_windows) require STAGED status (lig_owner_operators). order_placer_comments can be edited on any non-DRAFT task (order_creator_org_operators). directory_entry_ids can be edited on STAGED/IN_PROGRESS orders for tasks still in STAGED status (order_creator_org_operators OR lig_owner_operators). | (TaskClientUpdate1) -> (PydanticObjectId)

updateV1

public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.String>> updateV1(java.lang.String taskId,
                                                                                              TaskClientUpdate1 request,
                                                                                              RequestOptions requestOptions)

Updates a task. Operational fields (location, action, datetime_windows) require STAGED status (lig_owner_operators). order_placer_comments can be edited on any non-DRAFT task (order_creator_org_operators). directory_entry_ids can be edited on STAGED/IN_PROGRESS orders for tasks still in STAGED status (order_creator_org_operators OR lig_owner_operators). | (TaskClientUpdate1) -> (PydanticObjectId)

completeV1

public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>> completeV1(java.lang.String taskId)

Marks a task as COMPLETED. | authz_personas=[driver_for_executor, coordinator_org_operators, executor_org_operators] (depending on type) | () -> (bool)

completeV1

public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>> completeV1(java.lang.String taskId,
                                                                                                 RequestOptions requestOptions)

Marks a task as COMPLETED. | authz_personas=[driver_for_executor, coordinator_org_operators, executor_org_operators] (depending on type) | () -> (bool)

skipV1

public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>> skipV1(java.lang.String taskId)

Marks a task as SKIPPED. | authz_personas=[driver_for_executor, coordinator_org_operators, executor_org_operators] (depending on type) | () -> (bool)

skipV1

public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>> skipV1(java.lang.String taskId,
                                                                                             RequestOptions requestOptions)

Marks a task as SKIPPED. | authz_personas=[driver_for_executor, coordinator_org_operators, executor_org_operators] (depending on type) | () -> (bool)

attemptV1

public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>> attemptV1(java.lang.String taskId)

Marks a task as ATTEMPT with an optional executor organization note. | authz_personas=[driver_for_executor, coordinator_org_operators, executor_org_operators] (depending on type) | (AttemptTaskReq) -> (bool)

attemptV1

public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>> attemptV1(java.lang.String taskId,
                                                                                                AttemptTaskReq request)

Marks a task as ATTEMPT with an optional executor organization note. | authz_personas=[driver_for_executor, coordinator_org_operators, executor_org_operators] (depending on type) | (AttemptTaskReq) -> (bool)

attemptV1

public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>> attemptV1(java.lang.String taskId,
                                                                                                AttemptTaskReq request,
                                                                                                RequestOptions requestOptions)

Marks a task as ATTEMPT with an optional executor organization note. | authz_personas=[driver_for_executor, coordinator_org_operators, executor_org_operators] (depending on type) | (AttemptTaskReq) -> (bool)

deleteV1

public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>> deleteV1(java.lang.String taskId)

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

deleteV1

public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>> deleteV1(java.lang.String taskId,
                                                                                               RequestOptions requestOptions)

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