Package com.chrt.api.resources.taskgroups

Class TaskGroupsClient

java.lang.Object

com.chrt.api.resources.taskgroups.TaskGroupsClient

public class TaskGroupsClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientOptions	clientOptions
protected java.util.function.Supplier<ExpandedClient>	expandedClient
protected java.util.function.Supplier<ExpandedListClient>	expandedListClient

Constructor Summary

Constructors

Constructor	Description
TaskGroupsClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
ExpandedClient	expanded()
ExpandedListClient	expandedList()
boolean	startV1(java.lang.String taskGroupId)	Starts a task group by changing its status to in-progress and updating the order status.
boolean	startV1(java.lang.String taskGroupId, RequestOptions requestOptions)	Starts a task group by changing its status to in-progress and updating the order status.
boolean	togglePauseV1(java.lang.String id, SetTaskGroupPauseReq request)	Toggles the pause status of an in-progress task group.
boolean	togglePauseV1(java.lang.String id, SetTaskGroupPauseReq request, RequestOptions requestOptions)	Toggles the pause status of an in-progress task group.
boolean	updateV1(UpdateTaskGroupReq request)	Updates task group driver assignments by adding or removing drivers.
boolean	updateV1(UpdateTaskGroupReq request, RequestOptions requestOptions)	Updates task group driver assignments by adding or removing drivers.
RawTaskGroupsClient	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

expandedClient

protected final java.util.function.Supplier<ExpandedClient> expandedClient

expandedListClient

protected final java.util.function.Supplier<ExpandedListClient> expandedListClient

Constructor Detail

TaskGroupsClient

public TaskGroupsClient(ClientOptions clientOptions)

Method Detail

withRawResponse

public RawTaskGroupsClient withRawResponse()

Get responses with HTTP metadata like headers

updateV1

public boolean updateV1(UpdateTaskGroupReq request)

Updates task group driver assignments by adding or removing drivers.

updateV1

public boolean updateV1(UpdateTaskGroupReq request,
                        RequestOptions requestOptions)

Updates task group driver assignments by adding or removing drivers.

startV1

public boolean startV1(java.lang.String taskGroupId)

Starts a task group by changing its status to in-progress and updating the order status. Only authorized personas (task_group_driver or task_group_courier_org_administrator) can start a task group.

startV1

public boolean startV1(java.lang.String taskGroupId,
                       RequestOptions requestOptions)

Starts a task group by changing its status to in-progress and updating the order status. Only authorized personas (task_group_driver or task_group_courier_org_administrator) can start a task group.

togglePauseV1

public boolean togglePauseV1(java.lang.String id,
                             SetTaskGroupPauseReq request)

Toggles the pause status of an in-progress task group.

togglePauseV1

public boolean togglePauseV1(java.lang.String id,
                             SetTaskGroupPauseReq request,
                             RequestOptions requestOptions)

Toggles the pause status of an in-progress task group.

expanded

public ExpandedClient expanded()

expandedList

public ExpandedListClient expandedList()