Class AsyncRawTaskGroupsClient
- java.lang.Object
-
- com.chrt.api.resources.shipping.taskgroups.AsyncRawTaskGroupsClient
-
public class AsyncRawTaskGroupsClient extends java.lang.Object
-
-
Field Summary
Fields Modifier and Type Field Description protected ClientOptionsclientOptions
-
Constructor Summary
Constructors Constructor Description AsyncRawTaskGroupsClient(ClientOptions clientOptions)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>>addExecutorV1(java.lang.String taskGroupId)Assigns an executor organization (on-chrt or off-chrt) to a task group.java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>>addExecutorV1(java.lang.String taskGroupId, AddExecutorReq request)Assigns an executor organization (on-chrt or off-chrt) to a task group.java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>>addExecutorV1(java.lang.String taskGroupId, AddExecutorReq request, RequestOptions requestOptions)Assigns an executor organization (on-chrt or off-chrt) to a task group.java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>>addMessageV1(java.lang.String taskGroupId, AddMessageReq request)Adds a message to a task group's message log.java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>>addMessageV1(java.lang.String taskGroupId, AddMessageReq request, RequestOptions requestOptions)Adds a message to a task group's message log.java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<BillingLedgerPeriod1>>attachBillingLedgerPeriodToProviderPayDriverV1(java.lang.String taskGroupId, AttachBillingLedgerPeriodReq request)Links the operator-supplied OPEN BillingLedgerPeriod to this TaskGroup's PPD vector.java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<BillingLedgerPeriod1>>attachBillingLedgerPeriodToProviderPayDriverV1(java.lang.String taskGroupId, AttachBillingLedgerPeriodReq request, RequestOptions requestOptions)Links the operator-supplied OPEN BillingLedgerPeriod to this TaskGroup's PPD vector.java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<BillingLedgerPeriod1>>attachBillingLedgerPeriodToProviderPayProviderV1(java.lang.String taskGroupId, AttachBillingLedgerPeriodReq request)Links the operator-supplied OPEN BillingLedgerPeriod to this TaskGroup's PPP vector.java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<BillingLedgerPeriod1>>attachBillingLedgerPeriodToProviderPayProviderV1(java.lang.String taskGroupId, AttachBillingLedgerPeriodReq request, RequestOptions requestOptions)Links the operator-supplied OPEN BillingLedgerPeriod to this TaskGroup's PPP vector.java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<BillingLedgerPeriod1>>attachBillingLedgerPeriodToShipperPayProviderV1(java.lang.String taskGroupId, AttachBillingLedgerPeriodReq request)Links the operator-supplied OPEN BillingLedgerPeriod to this TaskGroup's SPP vector.java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<BillingLedgerPeriod1>>attachBillingLedgerPeriodToShipperPayProviderV1(java.lang.String taskGroupId, AttachBillingLedgerPeriodReq request, RequestOptions requestOptions)Links the operator-supplied OPEN BillingLedgerPeriod to this TaskGroup's SPP vector.java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>>attachLigToProviderPayDriverV1(java.lang.String taskGroupId, AttachLigToVectorClientReq request)Attaches a STAGED, detached LineItemGroup to the PPD vector AND setsLineItemGroup1.task_group_id(one txn).java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>>attachLigToProviderPayDriverV1(java.lang.String taskGroupId, AttachLigToVectorClientReq request, RequestOptions requestOptions)Attaches a STAGED, detached LineItemGroup to the PPD vector AND setsLineItemGroup1.task_group_id(one txn).java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>>attachLigToProviderPayProviderV1(java.lang.String taskGroupId, AttachLigToVectorClientReq request)Attaches a STAGED, detached LineItemGroup to the PPP vector AND setsLineItemGroup1.task_group_id(one txn).java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>>attachLigToProviderPayProviderV1(java.lang.String taskGroupId, AttachLigToVectorClientReq request, RequestOptions requestOptions)Attaches a STAGED, detached LineItemGroup to the PPP vector AND setsLineItemGroup1.task_group_id(one txn).java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>>attachLigToShipperPayProviderV1(java.lang.String taskGroupId, AttachLigToVectorClientReq request)Attaches a STAGED, detached LineItemGroup to the SPP vector AND setsLineItemGroup1.task_group_id(one txn).java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>>attachLigToShipperPayProviderV1(java.lang.String taskGroupId, AttachLigToVectorClientReq request, RequestOptions requestOptions)Attaches a STAGED, detached LineItemGroup to the SPP vector AND setsLineItemGroup1.task_group_id(one txn).java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>>detachBillingLedgerPeriodFromProviderPayDriverV1(java.lang.String taskGroupId)Detaches the PPD billing ledger period from this TaskGroup.java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>>detachBillingLedgerPeriodFromProviderPayDriverV1(java.lang.String taskGroupId, RequestOptions requestOptions)Detaches the PPD billing ledger period from this TaskGroup.java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>>detachBillingLedgerPeriodFromProviderPayProviderV1(java.lang.String taskGroupId)Detaches the PPP billing ledger period from this TaskGroup.java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>>detachBillingLedgerPeriodFromProviderPayProviderV1(java.lang.String taskGroupId, RequestOptions requestOptions)Detaches the PPP billing ledger period from this TaskGroup.java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>>detachBillingLedgerPeriodFromShipperPayProviderV1(java.lang.String taskGroupId)Detaches the SPP billing ledger period from this TaskGroup.java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>>detachBillingLedgerPeriodFromShipperPayProviderV1(java.lang.String taskGroupId, RequestOptions requestOptions)Detaches the SPP billing ledger period from this TaskGroup.java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>>detachLigFromProviderPayDriverV1(java.lang.String taskGroupId)Clears the PPD vector's_line_item_group_idand_rate_sheet_idAND clears the LIG'stask_group_idback-ref (one txn).java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>>detachLigFromProviderPayDriverV1(java.lang.String taskGroupId, RequestOptions requestOptions)Clears the PPD vector's_line_item_group_idand_rate_sheet_idAND clears the LIG'stask_group_idback-ref (one txn).java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>>detachLigFromProviderPayProviderV1(java.lang.String taskGroupId)Clears the PPP vector's_line_item_group_idand_rate_sheet_idAND clears the LIG'stask_group_idback-ref (one txn).java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>>detachLigFromProviderPayProviderV1(java.lang.String taskGroupId, RequestOptions requestOptions)Clears the PPP vector's_line_item_group_idand_rate_sheet_idAND clears the LIG'stask_group_idback-ref (one txn).java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>>detachLigFromShipperPayProviderV1(java.lang.String taskGroupId)Clears the SPP vector's_line_item_group_idand_rate_sheet_idAND clears the LIG'stask_group_idback-ref (one txn).java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>>detachLigFromShipperPayProviderV1(java.lang.String taskGroupId, RequestOptions requestOptions)Clears the SPP vector's_line_item_group_idand_rate_sheet_idAND clears the LIG'stask_group_idback-ref (one txn).java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<TaskGroupQuoteResp>>quoteForProviderPayDriverV1(java.lang.String taskGroupId, TaskGroupQuoteForProviderPayDriverClientReq request)Preview the LineItem materialization that would result from applying a rate sheet to the PPD vector of the named TaskGroup.java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<TaskGroupQuoteResp>>quoteForProviderPayDriverV1(java.lang.String taskGroupId, TaskGroupQuoteForProviderPayDriverClientReq request, RequestOptions requestOptions)Preview the LineItem materialization that would result from applying a rate sheet to the PPD vector of the named TaskGroup.java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<TaskGroupQuoteResp>>quoteForProviderPayProviderV1(java.lang.String taskGroupId)Preview the LineItem materialization that would result from applying a rate sheet to the PPP vector of the named TaskGroup.java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<TaskGroupQuoteResp>>quoteForProviderPayProviderV1(java.lang.String taskGroupId, TaskGroupQuoteForProviderPayProviderClientReq request)Preview the LineItem materialization that would result from applying a rate sheet to the PPP vector of the named TaskGroup.java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<TaskGroupQuoteResp>>quoteForProviderPayProviderV1(java.lang.String taskGroupId, TaskGroupQuoteForProviderPayProviderClientReq request, RequestOptions requestOptions)Preview the LineItem materialization that would result from applying a rate sheet to the PPP vector of the named TaskGroup.java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<TaskGroupQuoteResp>>quoteForShipperPayProviderV1(java.lang.String taskGroupId)Preview the LineItem materialization that would result from applying a rate sheet to the SPP vector of the named TaskGroup.java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<TaskGroupQuoteResp>>quoteForShipperPayProviderV1(java.lang.String taskGroupId, TaskGroupQuoteForShipperPayProviderClientReq request)Preview the LineItem materialization that would result from applying a rate sheet to the SPP vector of the named TaskGroup.java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<TaskGroupQuoteResp>>quoteForShipperPayProviderV1(java.lang.String taskGroupId, TaskGroupQuoteForShipperPayProviderClientReq request, RequestOptions requestOptions)Preview the LineItem materialization that would result from applying a rate sheet to the SPP vector of the named TaskGroup.java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>>removeDriverV1(java.lang.String taskGroupId)Removes the driver from a task group (sets driver_id to null).java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>>removeDriverV1(java.lang.String taskGroupId, RequestOptions requestOptions)Removes the driver from a task group (sets driver_id to null).java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>>removeExecutorV1(java.lang.String taskGroupId)Clears the executor and assigned driver on a task group.java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>>removeExecutorV1(java.lang.String taskGroupId, RequestOptions requestOptions)Clears the executor and assigned driver on a task group.java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>>setFlightInfoV1(java.lang.String taskGroupId, SetFlightInfoReq request)Replaces the ordered list of flights on a task group.java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>>setFlightInfoV1(java.lang.String taskGroupId, SetFlightInfoReq request, RequestOptions requestOptions)Replaces the ordered list of flights on a task group.java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>>setTaskOrderingV1(java.lang.String taskGroupId, SetTaskOrderingReq request)Sets the ordering of tasks within a task group.java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>>setTaskOrderingV1(java.lang.String taskGroupId, SetTaskOrderingReq request, RequestOptions requestOptions)Sets the ordering of tasks within a task group.java.util.concurrent.CompletableFuture<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.java.util.concurrent.CompletableFuture<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.java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.util.List<TaskGroupTypeaheadResult>>>typeaheadV1(TaskGroupsTypeaheadV1Request request)Returns distinct order_short_id and order_off_chrt_reference_id values matching the query via case-insensitive regex.java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.util.List<TaskGroupTypeaheadResult>>>typeaheadV1(TaskGroupsTypeaheadV1Request request, RequestOptions requestOptions)Returns distinct order_short_id and order_off_chrt_reference_id values matching the query via case-insensitive regex.java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>>updateDriverV1(java.lang.String taskGroupId, UpdateDriverReq request)Assigns or swaps the driver on a task group.java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>>updateDriverV1(java.lang.String taskGroupId, UpdateDriverReq request, RequestOptions requestOptions)Assigns or swaps the driver on a task group.
-
-
-
Field Detail
-
clientOptions
protected final ClientOptions clientOptions
-
-
Constructor Detail
-
AsyncRawTaskGroupsClient
public AsyncRawTaskGroupsClient(ClientOptions clientOptions)
-
-
Method Detail
-
typeaheadV1
public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.util.List<TaskGroupTypeaheadResult>>> typeaheadV1(TaskGroupsTypeaheadV1Request request)
Returns distinct order_short_id and order_off_chrt_reference_id values matching the query via case-insensitive regex. Searches non-draft task groups where the caller's provider org is the executor. | authz: allowed_org_types=[provider], min_org_role=driver | () -> (list[TaskGroupTypeaheadResult])
-
typeaheadV1
public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.util.List<TaskGroupTypeaheadResult>>> typeaheadV1(TaskGroupsTypeaheadV1Request request, RequestOptions requestOptions)
Returns distinct order_short_id and order_off_chrt_reference_id values matching the query via case-insensitive regex. Searches non-draft task groups where the caller's provider org is the executor. | authz: allowed_org_types=[provider], min_org_role=driver | () -> (list[TaskGroupTypeaheadResult])
-
startV1
public java.util.concurrent.CompletableFuture<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=[driver_for_executor, executor_org_operators, coordinator_org_operators] | () -> (bool)
-
startV1
public java.util.concurrent.CompletableFuture<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=[driver_for_executor, executor_org_operators, coordinator_org_operators] | () -> (bool)
-
setTaskOrderingV1
public java.util.concurrent.CompletableFuture<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 java.util.concurrent.CompletableFuture<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 java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>> updateDriverV1(java.lang.String taskGroupId, UpdateDriverReq request)
Assigns or swaps the driver on a task group. Driver must belong to the task group's executor organization. | authz_personas=[executor_org_operators] | (UpdateDriverReq) -> (bool)
-
updateDriverV1
public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>> updateDriverV1(java.lang.String taskGroupId, UpdateDriverReq request, RequestOptions requestOptions)
Assigns or swaps the driver on a task group. Driver must belong to the task group's executor organization. | authz_personas=[executor_org_operators] | (UpdateDriverReq) -> (bool)
-
removeDriverV1
public java.util.concurrent.CompletableFuture<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=[executor_org_operators, driver_for_executor] | () -> (bool)
-
removeDriverV1
public java.util.concurrent.CompletableFuture<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=[executor_org_operators, driver_for_executor] | () -> (bool)
-
addExecutorV1
public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>> addExecutorV1(java.lang.String taskGroupId)
Assigns an executor organization (on-chrt or off-chrt) to a task group. Coordinator-only. Requires both executor_org_id and off_chrt_executor_org_id to be None (use remove_executor/v1 first to swap). | authz_personas=[coordinator_org_operators] | (AddExecutorReq) -> (bool)
-
addExecutorV1
public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>> addExecutorV1(java.lang.String taskGroupId, AddExecutorReq request)
Assigns an executor organization (on-chrt or off-chrt) to a task group. Coordinator-only. Requires both executor_org_id and off_chrt_executor_org_id to be None (use remove_executor/v1 first to swap). | authz_personas=[coordinator_org_operators] | (AddExecutorReq) -> (bool)
-
addExecutorV1
public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>> addExecutorV1(java.lang.String taskGroupId, AddExecutorReq request, RequestOptions requestOptions)
Assigns an executor organization (on-chrt or off-chrt) to a task group. Coordinator-only. Requires both executor_org_id and off_chrt_executor_org_id to be None (use remove_executor/v1 first to swap). | authz_personas=[coordinator_org_operators] | (AddExecutorReq) -> (bool)
-
removeExecutorV1
public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>> removeExecutorV1(java.lang.String taskGroupId)
Clears the executor and assigned driver on a task group. Refuses while PPP or PPD billing is attached; detach billing explicitly first. | authz_personas=[coordinator_org_operators] | () -> (bool)
-
removeExecutorV1
public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>> removeExecutorV1(java.lang.String taskGroupId, RequestOptions requestOptions)
Clears the executor and assigned driver on a task group. Refuses while PPP or PPD billing is attached; detach billing explicitly first. | authz_personas=[coordinator_org_operators] | () -> (bool)
-
setFlightInfoV1
public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>> setFlightInfoV1(java.lang.String taskGroupId, SetFlightInfoReq request)
Replaces the ordered list of flights on a task group. | authz_personas=[lig_owner_operators] | (SetFlightInfoReq) -> (bool)
-
setFlightInfoV1
public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>> setFlightInfoV1(java.lang.String taskGroupId, SetFlightInfoReq request, RequestOptions requestOptions)
Replaces the ordered list of flights on a task group. | authz_personas=[lig_owner_operators] | (SetFlightInfoReq) -> (bool)
-
addMessageV1
public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>> addMessageV1(java.lang.String taskGroupId, AddMessageReq request)
Adds a message to a task group's message log. | authz_personas=[driver_for_executor, executor_org_operators, coordinator_org_operators, shipper_org_operators] | (AddMessageReq) -> (bool)
-
addMessageV1
public java.util.concurrent.CompletableFuture<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=[driver_for_executor, executor_org_operators, coordinator_org_operators, shipper_org_operators] | (AddMessageReq) -> (bool)
-
attachBillingLedgerPeriodToShipperPayProviderV1
public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<BillingLedgerPeriod1>> attachBillingLedgerPeriodToShipperPayProviderV1(java.lang.String taskGroupId, AttachBillingLedgerPeriodReq request)
Links the operator-supplied OPEN BillingLedgerPeriod to this TaskGroup's SPP vector. Period parties must match the TG's SPP parties. The SPP vector must have no ledger attached and no rate sheet (rate-sheet/ledger exclusivity). Ad-hoc LIGs without a rate sheet may coexist. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[task_group_coordinator_operators] | (AttachBillingLedgerPeriodReq) -> (BillingLedgerPeriod1)
-
attachBillingLedgerPeriodToShipperPayProviderV1
public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<BillingLedgerPeriod1>> attachBillingLedgerPeriodToShipperPayProviderV1(java.lang.String taskGroupId, AttachBillingLedgerPeriodReq request, RequestOptions requestOptions)
Links the operator-supplied OPEN BillingLedgerPeriod to this TaskGroup's SPP vector. Period parties must match the TG's SPP parties. The SPP vector must have no ledger attached and no rate sheet (rate-sheet/ledger exclusivity). Ad-hoc LIGs without a rate sheet may coexist. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[task_group_coordinator_operators] | (AttachBillingLedgerPeriodReq) -> (BillingLedgerPeriod1)
-
attachBillingLedgerPeriodToProviderPayProviderV1
public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<BillingLedgerPeriod1>> attachBillingLedgerPeriodToProviderPayProviderV1(java.lang.String taskGroupId, AttachBillingLedgerPeriodReq request)
Links the operator-supplied OPEN BillingLedgerPeriod to this TaskGroup's PPP vector. Period parties must match the TG's PPP parties. The PPP vector must have no ledger attached and no rate sheet (rate-sheet/ledger exclusivity). Ad-hoc LIGs without a rate sheet may coexist. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[task_group_coordinator_operators] | (AttachBillingLedgerPeriodReq) -> (BillingLedgerPeriod1)
-
attachBillingLedgerPeriodToProviderPayProviderV1
public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<BillingLedgerPeriod1>> attachBillingLedgerPeriodToProviderPayProviderV1(java.lang.String taskGroupId, AttachBillingLedgerPeriodReq request, RequestOptions requestOptions)
Links the operator-supplied OPEN BillingLedgerPeriod to this TaskGroup's PPP vector. Period parties must match the TG's PPP parties. The PPP vector must have no ledger attached and no rate sheet (rate-sheet/ledger exclusivity). Ad-hoc LIGs without a rate sheet may coexist. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[task_group_coordinator_operators] | (AttachBillingLedgerPeriodReq) -> (BillingLedgerPeriod1)
-
attachBillingLedgerPeriodToProviderPayDriverV1
public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<BillingLedgerPeriod1>> attachBillingLedgerPeriodToProviderPayDriverV1(java.lang.String taskGroupId, AttachBillingLedgerPeriodReq request)
Links the operator-supplied OPEN BillingLedgerPeriod to this TaskGroup's PPD vector. Period parties must match the TG's PPD parties. The PPD vector must have no ledger attached and no rate sheet (rate-sheet/ledger exclusivity). Ad-hoc LIGs without a rate sheet may coexist. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[executor_org_operators] | (AttachBillingLedgerPeriodReq) -> (BillingLedgerPeriod1)
-
attachBillingLedgerPeriodToProviderPayDriverV1
public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<BillingLedgerPeriod1>> attachBillingLedgerPeriodToProviderPayDriverV1(java.lang.String taskGroupId, AttachBillingLedgerPeriodReq request, RequestOptions requestOptions)
Links the operator-supplied OPEN BillingLedgerPeriod to this TaskGroup's PPD vector. Period parties must match the TG's PPD parties. The PPD vector must have no ledger attached and no rate sheet (rate-sheet/ledger exclusivity). Ad-hoc LIGs without a rate sheet may coexist. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[executor_org_operators] | (AttachBillingLedgerPeriodReq) -> (BillingLedgerPeriod1)
-
detachBillingLedgerPeriodFromShipperPayProviderV1
public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>> detachBillingLedgerPeriodFromShipperPayProviderV1(java.lang.String taskGroupId)
Detaches the SPP billing ledger period from this TaskGroup. Reverses attach_billing_ledger_period_to_shipper_pay_provider/v1. Linked period must be OPEN. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[task_group_coordinator_operators] | () -> (bool)
-
detachBillingLedgerPeriodFromShipperPayProviderV1
public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>> detachBillingLedgerPeriodFromShipperPayProviderV1(java.lang.String taskGroupId, RequestOptions requestOptions)
Detaches the SPP billing ledger period from this TaskGroup. Reverses attach_billing_ledger_period_to_shipper_pay_provider/v1. Linked period must be OPEN. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[task_group_coordinator_operators] | () -> (bool)
-
detachBillingLedgerPeriodFromProviderPayProviderV1
public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>> detachBillingLedgerPeriodFromProviderPayProviderV1(java.lang.String taskGroupId)
Detaches the PPP billing ledger period from this TaskGroup. Reverses attach_billing_ledger_period_to_provider_pay_provider/v1. Linked period must be OPEN. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[task_group_coordinator_operators] | () -> (bool)
-
detachBillingLedgerPeriodFromProviderPayProviderV1
public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>> detachBillingLedgerPeriodFromProviderPayProviderV1(java.lang.String taskGroupId, RequestOptions requestOptions)
Detaches the PPP billing ledger period from this TaskGroup. Reverses attach_billing_ledger_period_to_provider_pay_provider/v1. Linked period must be OPEN. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[task_group_coordinator_operators] | () -> (bool)
-
detachBillingLedgerPeriodFromProviderPayDriverV1
public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>> detachBillingLedgerPeriodFromProviderPayDriverV1(java.lang.String taskGroupId)
Detaches the PPD billing ledger period from this TaskGroup. Reverses attach_billing_ledger_period_to_provider_pay_driver/v1. Linked period must be OPEN. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[executor_org_operators] | () -> (bool)
-
detachBillingLedgerPeriodFromProviderPayDriverV1
public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>> detachBillingLedgerPeriodFromProviderPayDriverV1(java.lang.String taskGroupId, RequestOptions requestOptions)
Detaches the PPD billing ledger period from this TaskGroup. Reverses attach_billing_ledger_period_to_provider_pay_driver/v1. Linked period must be OPEN. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[executor_org_operators] | () -> (bool)
-
attachLigToShipperPayProviderV1
public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>> attachLigToShipperPayProviderV1(java.lang.String taskGroupId, AttachLigToVectorClientReq request)
Attaches a STAGED, detached LineItemGroup to the SPP vector AND setsLineItemGroup1.task_group_id(one txn). The LIG must havetask_group_id is None, be owned by the coordinator, and be party-matched to SPP. The SPP vector must have no LIG attached; if the LIG carriesrate_sheet_id, no billing ledger period may be attached either (rate-sheet/ledger exclusivity). The LIG'srate_sheet_idis stamped ontoshipper_pay_provider_rate_sheet_idas a breadcrumb. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[task_group_coordinator_operators] | (AttachLigToVectorClientReq) -> (bool)
-
attachLigToShipperPayProviderV1
public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>> attachLigToShipperPayProviderV1(java.lang.String taskGroupId, AttachLigToVectorClientReq request, RequestOptions requestOptions)
Attaches a STAGED, detached LineItemGroup to the SPP vector AND setsLineItemGroup1.task_group_id(one txn). The LIG must havetask_group_id is None, be owned by the coordinator, and be party-matched to SPP. The SPP vector must have no LIG attached; if the LIG carriesrate_sheet_id, no billing ledger period may be attached either (rate-sheet/ledger exclusivity). The LIG'srate_sheet_idis stamped ontoshipper_pay_provider_rate_sheet_idas a breadcrumb. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[task_group_coordinator_operators] | (AttachLigToVectorClientReq) -> (bool)
-
attachLigToProviderPayProviderV1
public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>> attachLigToProviderPayProviderV1(java.lang.String taskGroupId, AttachLigToVectorClientReq request)
Attaches a STAGED, detached LineItemGroup to the PPP vector AND setsLineItemGroup1.task_group_id(one txn). The LIG must havetask_group_id is None, be owned by the coordinator, and be party-matched to PPP. The PPP vector must have no LIG attached; if the LIG carriesrate_sheet_id, no billing ledger period may be attached either (rate-sheet/ledger exclusivity). The LIG'srate_sheet_idis stamped ontoprovider_pay_provider_rate_sheet_idas a breadcrumb. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[task_group_coordinator_operators] | (AttachLigToVectorClientReq) -> (bool)
-
attachLigToProviderPayProviderV1
public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>> attachLigToProviderPayProviderV1(java.lang.String taskGroupId, AttachLigToVectorClientReq request, RequestOptions requestOptions)
Attaches a STAGED, detached LineItemGroup to the PPP vector AND setsLineItemGroup1.task_group_id(one txn). The LIG must havetask_group_id is None, be owned by the coordinator, and be party-matched to PPP. The PPP vector must have no LIG attached; if the LIG carriesrate_sheet_id, no billing ledger period may be attached either (rate-sheet/ledger exclusivity). The LIG'srate_sheet_idis stamped ontoprovider_pay_provider_rate_sheet_idas a breadcrumb. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[task_group_coordinator_operators] | (AttachLigToVectorClientReq) -> (bool)
-
attachLigToProviderPayDriverV1
public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>> attachLigToProviderPayDriverV1(java.lang.String taskGroupId, AttachLigToVectorClientReq request)
Attaches a STAGED, detached LineItemGroup to the PPD vector AND setsLineItemGroup1.task_group_id(one txn). The LIG must havetask_group_id is None, be owned by the executor, and be party-matched to PPD. The PPD vector must have no LIG attached; if the LIG carriesrate_sheet_id, no billing ledger period may be attached either (rate-sheet/ledger exclusivity). The LIG'srate_sheet_idis stamped ontoprovider_pay_driver_rate_sheet_idas a breadcrumb. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[executor_org_operators] | (AttachLigToVectorClientReq) -> (bool)
-
attachLigToProviderPayDriverV1
public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>> attachLigToProviderPayDriverV1(java.lang.String taskGroupId, AttachLigToVectorClientReq request, RequestOptions requestOptions)
Attaches a STAGED, detached LineItemGroup to the PPD vector AND setsLineItemGroup1.task_group_id(one txn). The LIG must havetask_group_id is None, be owned by the executor, and be party-matched to PPD. The PPD vector must have no LIG attached; if the LIG carriesrate_sheet_id, no billing ledger period may be attached either (rate-sheet/ledger exclusivity). The LIG'srate_sheet_idis stamped ontoprovider_pay_driver_rate_sheet_idas a breadcrumb. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[executor_org_operators] | (AttachLigToVectorClientReq) -> (bool)
-
detachLigFromShipperPayProviderV1
public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>> detachLigFromShipperPayProviderV1(java.lang.String taskGroupId)
Clears the SPP vector's_line_item_group_idand_rate_sheet_idAND clears the LIG'stask_group_idback-ref (one txn). The LIG document and its line items remain alive but fully detached on both sides. The SPP vector must currently have a LIG attached. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[task_group_coordinator_operators] | () -> (bool)
-
detachLigFromShipperPayProviderV1
public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>> detachLigFromShipperPayProviderV1(java.lang.String taskGroupId, RequestOptions requestOptions)
Clears the SPP vector's_line_item_group_idand_rate_sheet_idAND clears the LIG'stask_group_idback-ref (one txn). The LIG document and its line items remain alive but fully detached on both sides. The SPP vector must currently have a LIG attached. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[task_group_coordinator_operators] | () -> (bool)
-
detachLigFromProviderPayProviderV1
public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>> detachLigFromProviderPayProviderV1(java.lang.String taskGroupId)
Clears the PPP vector's_line_item_group_idand_rate_sheet_idAND clears the LIG'stask_group_idback-ref (one txn). The LIG document and its line items remain alive but fully detached on both sides. The PPP vector must currently have a LIG attached. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[task_group_coordinator_operators] | () -> (bool)
-
detachLigFromProviderPayProviderV1
public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>> detachLigFromProviderPayProviderV1(java.lang.String taskGroupId, RequestOptions requestOptions)
Clears the PPP vector's_line_item_group_idand_rate_sheet_idAND clears the LIG'stask_group_idback-ref (one txn). The LIG document and its line items remain alive but fully detached on both sides. The PPP vector must currently have a LIG attached. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[task_group_coordinator_operators] | () -> (bool)
-
detachLigFromProviderPayDriverV1
public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>> detachLigFromProviderPayDriverV1(java.lang.String taskGroupId)
Clears the PPD vector's_line_item_group_idand_rate_sheet_idAND clears the LIG'stask_group_idback-ref (one txn). The LIG document and its line items remain alive but fully detached on both sides. The PPD vector must currently have a LIG attached. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[executor_org_operators] | () -> (bool)
-
detachLigFromProviderPayDriverV1
public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>> detachLigFromProviderPayDriverV1(java.lang.String taskGroupId, RequestOptions requestOptions)
Clears the PPD vector's_line_item_group_idand_rate_sheet_idAND clears the LIG'stask_group_idback-ref (one txn). The LIG document and its line items remain alive but fully detached on both sides. The PPD vector must currently have a LIG attached. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[executor_org_operators] | () -> (bool)
-
quoteForShipperPayProviderV1
public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<TaskGroupQuoteResp>> quoteForShipperPayProviderV1(java.lang.String taskGroupId)
Preview the LineItem materialization that would result from applying a rate sheet to the SPP vector of the named TaskGroup. Returns the resolved rate sheet, materialized LineItems (NOT inserted), the pre-adjustment total, and the requested parties (shipper -> coordinator). Auto-resolves the rate sheet via RateSheetMapping1 for the requested shipper unless body.rate_sheet_id is provided. No DB writes — operator can iterate freely. To commit, call from_rate_sheet/create_for_shipper_pay_provider/v1 then attach_lig_to_shipper_pay_provider/v1. | authz: allowed_org_types=[provider, shipper], min_org_role=operator, authz_personas=[task_group_coordinator_operators, shipper_org_operators] | (TaskGroupQuoteForShipperPayProviderClientReq) -> (TaskGroupQuoteResp)
-
quoteForShipperPayProviderV1
public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<TaskGroupQuoteResp>> quoteForShipperPayProviderV1(java.lang.String taskGroupId, TaskGroupQuoteForShipperPayProviderClientReq request)
Preview the LineItem materialization that would result from applying a rate sheet to the SPP vector of the named TaskGroup. Returns the resolved rate sheet, materialized LineItems (NOT inserted), the pre-adjustment total, and the requested parties (shipper -> coordinator). Auto-resolves the rate sheet via RateSheetMapping1 for the requested shipper unless body.rate_sheet_id is provided. No DB writes — operator can iterate freely. To commit, call from_rate_sheet/create_for_shipper_pay_provider/v1 then attach_lig_to_shipper_pay_provider/v1. | authz: allowed_org_types=[provider, shipper], min_org_role=operator, authz_personas=[task_group_coordinator_operators, shipper_org_operators] | (TaskGroupQuoteForShipperPayProviderClientReq) -> (TaskGroupQuoteResp)
-
quoteForShipperPayProviderV1
public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<TaskGroupQuoteResp>> quoteForShipperPayProviderV1(java.lang.String taskGroupId, TaskGroupQuoteForShipperPayProviderClientReq request, RequestOptions requestOptions)
Preview the LineItem materialization that would result from applying a rate sheet to the SPP vector of the named TaskGroup. Returns the resolved rate sheet, materialized LineItems (NOT inserted), the pre-adjustment total, and the requested parties (shipper -> coordinator). Auto-resolves the rate sheet via RateSheetMapping1 for the requested shipper unless body.rate_sheet_id is provided. No DB writes — operator can iterate freely. To commit, call from_rate_sheet/create_for_shipper_pay_provider/v1 then attach_lig_to_shipper_pay_provider/v1. | authz: allowed_org_types=[provider, shipper], min_org_role=operator, authz_personas=[task_group_coordinator_operators, shipper_org_operators] | (TaskGroupQuoteForShipperPayProviderClientReq) -> (TaskGroupQuoteResp)
-
quoteForProviderPayProviderV1
public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<TaskGroupQuoteResp>> quoteForProviderPayProviderV1(java.lang.String taskGroupId)
Preview the LineItem materialization that would result from applying a rate sheet to the PPP vector of the named TaskGroup. Returns the resolved rate sheet, materialized LineItems (NOT inserted), the pre-adjustment total, and the requested parties (coordinator -> executor). Auto-resolves the rate sheet via RateSheetMapping1 for the requested executor unless body.rate_sheet_id is provided. No DB writes — operator can iterate freely. To commit, call from_rate_sheet/create_for_provider_pay_provider/v1 then attach_lig_to_provider_pay_provider/v1. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[task_group_coordinator_operators] | (TaskGroupQuoteForProviderPayProviderClientReq) -> (TaskGroupQuoteResp)
-
quoteForProviderPayProviderV1
public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<TaskGroupQuoteResp>> quoteForProviderPayProviderV1(java.lang.String taskGroupId, TaskGroupQuoteForProviderPayProviderClientReq request)
Preview the LineItem materialization that would result from applying a rate sheet to the PPP vector of the named TaskGroup. Returns the resolved rate sheet, materialized LineItems (NOT inserted), the pre-adjustment total, and the requested parties (coordinator -> executor). Auto-resolves the rate sheet via RateSheetMapping1 for the requested executor unless body.rate_sheet_id is provided. No DB writes — operator can iterate freely. To commit, call from_rate_sheet/create_for_provider_pay_provider/v1 then attach_lig_to_provider_pay_provider/v1. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[task_group_coordinator_operators] | (TaskGroupQuoteForProviderPayProviderClientReq) -> (TaskGroupQuoteResp)
-
quoteForProviderPayProviderV1
public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<TaskGroupQuoteResp>> quoteForProviderPayProviderV1(java.lang.String taskGroupId, TaskGroupQuoteForProviderPayProviderClientReq request, RequestOptions requestOptions)
Preview the LineItem materialization that would result from applying a rate sheet to the PPP vector of the named TaskGroup. Returns the resolved rate sheet, materialized LineItems (NOT inserted), the pre-adjustment total, and the requested parties (coordinator -> executor). Auto-resolves the rate sheet via RateSheetMapping1 for the requested executor unless body.rate_sheet_id is provided. No DB writes — operator can iterate freely. To commit, call from_rate_sheet/create_for_provider_pay_provider/v1 then attach_lig_to_provider_pay_provider/v1. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[task_group_coordinator_operators] | (TaskGroupQuoteForProviderPayProviderClientReq) -> (TaskGroupQuoteResp)
-
quoteForProviderPayDriverV1
public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<TaskGroupQuoteResp>> quoteForProviderPayDriverV1(java.lang.String taskGroupId, TaskGroupQuoteForProviderPayDriverClientReq request)
Preview the LineItem materialization that would result from applying a rate sheet to the PPD vector of the named TaskGroup. Returns the resolved rate sheet, materialized LineItems (NOT inserted), the pre-adjustment total, and the requested parties (executor -> driver). Auto-resolves the rate sheet via RateSheetMapping1 for the requested driver unless body.rate_sheet_id is provided. PPD is on-chrt-executor only — TGs with an off-chrt executor are 400'd. No DB writes — operator can iterate freely. To commit, call from_rate_sheet/create_for_provider_pay_driver/v1 then attach_lig_to_provider_pay_driver/v1. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[executor_org_operators] | (TaskGroupQuoteForProviderPayDriverClientReq) -> (TaskGroupQuoteResp)
-
quoteForProviderPayDriverV1
public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<TaskGroupQuoteResp>> quoteForProviderPayDriverV1(java.lang.String taskGroupId, TaskGroupQuoteForProviderPayDriverClientReq request, RequestOptions requestOptions)
Preview the LineItem materialization that would result from applying a rate sheet to the PPD vector of the named TaskGroup. Returns the resolved rate sheet, materialized LineItems (NOT inserted), the pre-adjustment total, and the requested parties (executor -> driver). Auto-resolves the rate sheet via RateSheetMapping1 for the requested driver unless body.rate_sheet_id is provided. PPD is on-chrt-executor only — TGs with an off-chrt executor are 400'd. No DB writes — operator can iterate freely. To commit, call from_rate_sheet/create_for_provider_pay_driver/v1 then attach_lig_to_provider_pay_driver/v1. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[executor_org_operators] | (TaskGroupQuoteForProviderPayDriverClientReq) -> (TaskGroupQuoteResp)
-
-