Package com.chrt.api.resources.shipping.taskgroups

Class RawTaskGroupsClient

java.lang.Object

com.chrt.api.resources.shipping.taskgroups.RawTaskGroupsClient

public class RawTaskGroupsClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientOptions	clientOptions

Constructor Summary

Constructors

Constructor	Description
RawTaskGroupsClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
ChrtApiHttpResponse<java.lang.Boolean>	addMessageV1(java.lang.String taskGroupId, AddMessageReq request)	Adds a message to a task group's message log.
ChrtApiHttpResponse<java.lang.Boolean>	addMessageV1(java.lang.String taskGroupId, AddMessageReq request, RequestOptions requestOptions)	Adds a message to a task group's message log.
ChrtApiHttpResponse<java.lang.Boolean>	assignRateSheetV1(java.lang.String rateSheetId, java.lang.String taskGroupId)	Assigns a rate sheet to a task group.
ChrtApiHttpResponse<java.lang.Boolean>	assignRateSheetV1(java.lang.String rateSheetId, java.lang.String taskGroupId, RequestOptions requestOptions)	Assigns a rate sheet to a task group.
ChrtApiHttpResponse<java.lang.Boolean>	removeDriverV1(java.lang.String taskGroupId)	Removes the driver from a task group (sets driver_id to null).
ChrtApiHttpResponse<java.lang.Boolean>	removeDriverV1(java.lang.String taskGroupId, RequestOptions requestOptions)	Removes the driver from a task group (sets driver_id to null).
ChrtApiHttpResponse<java.lang.Boolean>	setFlightInfoV1(java.lang.String taskGroupId)	Sets the flight number and/or fa_flight_ids on a task group.
ChrtApiHttpResponse<java.lang.Boolean>	setFlightInfoV1(java.lang.String taskGroupId, SetFlightInfoReq request)	Sets the flight number and/or fa_flight_ids on a task group.
ChrtApiHttpResponse<java.lang.Boolean>	setFlightInfoV1(java.lang.String taskGroupId, SetFlightInfoReq request, RequestOptions requestOptions)	Sets the flight number and/or fa_flight_ids on a task group.
ChrtApiHttpResponse<java.lang.Boolean>	setTaskOrderingV1(java.lang.String taskGroupId, SetTaskOrderingReq request)	Sets the ordering of tasks within a task group.
ChrtApiHttpResponse<java.lang.Boolean>	setTaskOrderingV1(java.lang.String taskGroupId, SetTaskOrderingReq request, RequestOptions requestOptions)	Sets the ordering of tasks within a task group.
ChrtApiHttpResponse<java.lang.Boolean>	startV1(java.lang.String taskGroupId)	Starts a task group by transitioning it from STAGED to IN_PROGRESS and syncing related order state.
ChrtApiHttpResponse<java.lang.Boolean>	startV1(java.lang.String taskGroupId, RequestOptions requestOptions)	Starts a task group by transitioning it from STAGED to IN_PROGRESS and syncing related order state.
ChrtApiHttpResponse<java.lang.Boolean>	updateCourierOrgV1(java.lang.String taskGroupId, UpdateCourierOrgReq request)	Updates the courier organization assigned to a task group.
ChrtApiHttpResponse<java.lang.Boolean>	updateCourierOrgV1(java.lang.String taskGroupId, UpdateCourierOrgReq request, RequestOptions requestOptions)	Updates the courier organization assigned to a task group.
ChrtApiHttpResponse<java.lang.Boolean>	updateDriverV1(java.lang.String taskGroupId, UpdateDriverReq request)	Updates the driver assigned to a task group.
ChrtApiHttpResponse<java.lang.Boolean>	updateDriverV1(java.lang.String taskGroupId, UpdateDriverReq request, RequestOptions requestOptions)	Updates the driver assigned to a task group.

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

RawTaskGroupsClient

public RawTaskGroupsClient(ClientOptions clientOptions)

Method Detail

startV1

public ChrtApiHttpResponse<java.lang.Boolean> startV1(java.lang.String taskGroupId)

Starts a task group by transitioning it from STAGED to IN_PROGRESS and syncing related order state. | authz_personas=[courier_driver, lig_owner_operators] | () -> (bool)

startV1

public ChrtApiHttpResponse<java.lang.Boolean> startV1(java.lang.String taskGroupId,
                                                      RequestOptions requestOptions)

Starts a task group by transitioning it from STAGED to IN_PROGRESS and syncing related order state. | authz_personas=[courier_driver, lig_owner_operators] | () -> (bool)

setTaskOrderingV1

public ChrtApiHttpResponse<java.lang.Boolean> setTaskOrderingV1(java.lang.String taskGroupId,
                                                                SetTaskOrderingReq request)

Sets the ordering of tasks within a task group. Requires complete list of task IDs in desired order. Completed tasks must be before staged tasks. | authz_personas=[lig_owner_operators] | (SetTaskOrderingReq) -> (bool)

setTaskOrderingV1

public ChrtApiHttpResponse<java.lang.Boolean> setTaskOrderingV1(java.lang.String taskGroupId,
                                                                SetTaskOrderingReq request,
                                                                RequestOptions requestOptions)

Sets the ordering of tasks within a task group. Requires complete list of task IDs in desired order. Completed tasks must be before staged tasks. | authz_personas=[lig_owner_operators] | (SetTaskOrderingReq) -> (bool)

updateDriverV1

public ChrtApiHttpResponse<java.lang.Boolean> updateDriverV1(java.lang.String taskGroupId,
                                                             UpdateDriverReq request)

Updates the driver assigned to a task group. | authz_personas=[courier_org_operators] | (UpdateDriverReq) -> (bool)

updateDriverV1

public ChrtApiHttpResponse<java.lang.Boolean> updateDriverV1(java.lang.String taskGroupId,
                                                             UpdateDriverReq request,
                                                             RequestOptions requestOptions)

Updates the driver assigned to a task group. | authz_personas=[courier_org_operators] | (UpdateDriverReq) -> (bool)

removeDriverV1

public ChrtApiHttpResponse<java.lang.Boolean> removeDriverV1(java.lang.String taskGroupId)

Removes the driver from a task group (sets driver_id to null). Allowed when STAGED or IN_PROGRESS (if no tasks have reached a terminal status). | authz_personas=[courier_org_operators, courier_driver] | () -> (bool)

removeDriverV1

public ChrtApiHttpResponse<java.lang.Boolean> removeDriverV1(java.lang.String taskGroupId,
                                                             RequestOptions requestOptions)

Removes the driver from a task group (sets driver_id to null). Allowed when STAGED or IN_PROGRESS (if no tasks have reached a terminal status). | authz_personas=[courier_org_operators, courier_driver] | () -> (bool)

updateCourierOrgV1

public ChrtApiHttpResponse<java.lang.Boolean> updateCourierOrgV1(java.lang.String taskGroupId,
                                                                 UpdateCourierOrgReq request)

Updates the courier organization assigned to a task group. | authz_personas=[forwarder_org_operators] | (UpdateCourierOrgReq) -> (bool)

updateCourierOrgV1

public ChrtApiHttpResponse<java.lang.Boolean> updateCourierOrgV1(java.lang.String taskGroupId,
                                                                 UpdateCourierOrgReq request,
                                                                 RequestOptions requestOptions)

Updates the courier organization assigned to a task group. | authz_personas=[forwarder_org_operators] | (UpdateCourierOrgReq) -> (bool)

assignRateSheetV1

public ChrtApiHttpResponse<java.lang.Boolean> assignRateSheetV1(java.lang.String rateSheetId,
                                                                java.lang.String taskGroupId)

Assigns a rate sheet to a task group. Can also hot-swap an existing rate sheet for a new one. Syncs the corresponding LineItemGroup and recalculates LineItems. | authz_personas=[lig_owner_operators] | () -> (bool)

assignRateSheetV1

public ChrtApiHttpResponse<java.lang.Boolean> assignRateSheetV1(java.lang.String rateSheetId,
                                                                java.lang.String taskGroupId,
                                                                RequestOptions requestOptions)

Assigns a rate sheet to a task group. Can also hot-swap an existing rate sheet for a new one. Syncs the corresponding LineItemGroup and recalculates LineItems. | authz_personas=[lig_owner_operators] | () -> (bool)

setFlightInfoV1

public ChrtApiHttpResponse<java.lang.Boolean> setFlightInfoV1(java.lang.String taskGroupId)

Sets the flight number and/or fa_flight_ids on a task group. | authz_personas=[lig_owner_operators] | (SetFlightInfoReq) -> (bool)

setFlightInfoV1

public ChrtApiHttpResponse<java.lang.Boolean> setFlightInfoV1(java.lang.String taskGroupId,
                                                              SetFlightInfoReq request)

Sets the flight number and/or fa_flight_ids on a task group. | authz_personas=[lig_owner_operators] | (SetFlightInfoReq) -> (bool)

setFlightInfoV1

public ChrtApiHttpResponse<java.lang.Boolean> setFlightInfoV1(java.lang.String taskGroupId,
                                                              SetFlightInfoReq request,
                                                              RequestOptions requestOptions)

Sets the flight number and/or fa_flight_ids on a task group. | authz_personas=[lig_owner_operators] | (SetFlightInfoReq) -> (bool)

addMessageV1

public ChrtApiHttpResponse<java.lang.Boolean> addMessageV1(java.lang.String taskGroupId,
                                                           AddMessageReq request)

Adds a message to a task group's message log. | authz_personas=[courier_driver, courier_org_operators, forwarder_org_operators, shipper_org_operators] | (AddMessageReq) -> (bool)

addMessageV1

public ChrtApiHttpResponse<java.lang.Boolean> addMessageV1(java.lang.String taskGroupId,
                                                           AddMessageReq request,
                                                           RequestOptions requestOptions)

Adds a message to a task group's message log. | authz_personas=[courier_driver, courier_org_operators, forwarder_org_operators, shipper_org_operators] | (AddMessageReq) -> (bool)