Class AsyncTaskGroupClient


  • public class AsyncTaskGroupClient
    extends java.lang.Object
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.concurrent.CompletableFuture<java.lang.Boolean> addExecutorV1​(java.lang.String taskGroupId)
      Assigns an executor organization to a draft task group.
      java.util.concurrent.CompletableFuture<java.lang.Boolean> addExecutorV1​(java.lang.String taskGroupId, OrderDraftAddExecutorReq request)
      Assigns an executor organization to a draft task group.
      java.util.concurrent.CompletableFuture<java.lang.Boolean> addExecutorV1​(java.lang.String taskGroupId, OrderDraftAddExecutorReq request, RequestOptions requestOptions)
      Assigns an executor organization to a draft task group.
      java.util.concurrent.CompletableFuture<java.lang.String> addV1​(OrderDraftAddTaskGroupReq request)
      Adds a task group to an existing order draft.
      java.util.concurrent.CompletableFuture<java.lang.String> addV1​(OrderDraftAddTaskGroupReq request, RequestOptions requestOptions)
      Adds a task group to an existing order draft.
      java.util.concurrent.CompletableFuture<java.lang.Boolean> deleteV1​(java.lang.String taskGroupId)
      Deletes a task group and all associated entities (tasks, task artifacts, S3 metadata).
      java.util.concurrent.CompletableFuture<java.lang.Boolean> deleteV1​(java.lang.String taskGroupId, RequestOptions requestOptions)
      Deletes a task group and all associated entities (tasks, task artifacts, S3 metadata).
      java.util.concurrent.CompletableFuture<java.lang.Boolean> removeDriverV1​(java.lang.String taskGroupId)
      Clears the driver on a draft task group.
      java.util.concurrent.CompletableFuture<java.lang.Boolean> removeDriverV1​(java.lang.String taskGroupId, RequestOptions requestOptions)
      Clears the driver on a draft task group.
      java.util.concurrent.CompletableFuture<java.lang.Boolean> removeExecutorV1​(java.lang.String taskGroupId)
      Clears the executor, driver, and PPP/PPD billing attachments from a draft task group.
      java.util.concurrent.CompletableFuture<java.lang.Boolean> removeExecutorV1​(java.lang.String taskGroupId, RequestOptions requestOptions)
      Clears the executor, driver, and PPP/PPD billing attachments from a draft task group.
      java.util.concurrent.CompletableFuture<java.lang.Boolean> setFlightInfoV1​(java.lang.String taskGroupId, SetFlightInfoReq request)
      Replaces the ordered list of flights on a draft task group.
      java.util.concurrent.CompletableFuture<java.lang.Boolean> setFlightInfoV1​(java.lang.String taskGroupId, SetFlightInfoReq request, RequestOptions requestOptions)
      Replaces the ordered list of flights on a draft task group.
      java.util.concurrent.CompletableFuture<java.lang.Boolean> setRateSheetsV1​(java.lang.String taskGroupId)
      Sets rate sheet IDs on a draft task group.
      java.util.concurrent.CompletableFuture<java.lang.Boolean> setRateSheetsV1​(java.lang.String taskGroupId, SetRateSheetsReq request)
      Sets rate sheet IDs on a draft task group.
      java.util.concurrent.CompletableFuture<java.lang.Boolean> setRateSheetsV1​(java.lang.String taskGroupId, SetRateSheetsReq request, RequestOptions requestOptions)
      Sets rate sheet IDs on a draft task group.
      java.util.concurrent.CompletableFuture<java.lang.Boolean> setTaskOrderingV1​(java.lang.String taskGroupId, SetTaskOrderingDraftReq request)
      Sets the ordering of tasks within a draft task group.
      java.util.concurrent.CompletableFuture<java.lang.Boolean> setTaskOrderingV1​(java.lang.String taskGroupId, SetTaskOrderingDraftReq request, RequestOptions requestOptions)
      Sets the ordering of tasks within a draft task group.
      java.util.concurrent.CompletableFuture<java.lang.Boolean> setVehicleTypeV1​(java.lang.String taskGroupId)
      Sets the vehicle type on a draft task group.
      java.util.concurrent.CompletableFuture<java.lang.Boolean> setVehicleTypeV1​(java.lang.String taskGroupId, SetVehicleTypeReq request)
      Sets the vehicle type on a draft task group.
      java.util.concurrent.CompletableFuture<java.lang.Boolean> setVehicleTypeV1​(java.lang.String taskGroupId, SetVehicleTypeReq request, RequestOptions requestOptions)
      Sets the vehicle type on a draft task group.
      java.util.concurrent.CompletableFuture<java.lang.Boolean> updateDriverV1​(java.lang.String taskGroupId, OrderDraftUpdateDriverReq request)
      Assigns or swaps the driver on a draft task group.
      java.util.concurrent.CompletableFuture<java.lang.Boolean> updateDriverV1​(java.lang.String taskGroupId, OrderDraftUpdateDriverReq request, RequestOptions requestOptions)
      Assigns or swaps the driver on a draft task group.
      AsyncRawTaskGroupClient 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
    • Constructor Detail

      • AsyncTaskGroupClient

        public AsyncTaskGroupClient​(ClientOptions clientOptions)
    • Method Detail

      • addV1

        public java.util.concurrent.CompletableFuture<java.lang.String> addV1​(OrderDraftAddTaskGroupReq request)
        Adds a task group to an existing order draft. The task group is created without an executor; use draft assignment routes to assign executor or driver before staging. | (OrderDraftAddTaskGroupReq) -> (PydanticObjectId)
      • addV1

        public java.util.concurrent.CompletableFuture<java.lang.String> addV1​(OrderDraftAddTaskGroupReq request,
                                                                              RequestOptions requestOptions)
        Adds a task group to an existing order draft. The task group is created without an executor; use draft assignment routes to assign executor or driver before staging. | (OrderDraftAddTaskGroupReq) -> (PydanticObjectId)
      • setFlightInfoV1

        public java.util.concurrent.CompletableFuture<java.lang.Boolean> setFlightInfoV1​(java.lang.String taskGroupId,
                                                                                         SetFlightInfoReq request)
        Replaces the ordered list of flights on a draft task group. | (SetFlightInfoReq) -> (bool)
      • setFlightInfoV1

        public java.util.concurrent.CompletableFuture<java.lang.Boolean> setFlightInfoV1​(java.lang.String taskGroupId,
                                                                                         SetFlightInfoReq request,
                                                                                         RequestOptions requestOptions)
        Replaces the ordered list of flights on a draft task group. | (SetFlightInfoReq) -> (bool)
      • setVehicleTypeV1

        public java.util.concurrent.CompletableFuture<java.lang.Boolean> setVehicleTypeV1​(java.lang.String taskGroupId)
        Sets the vehicle type on a draft task group. | authz_personas=[draft_creator_org_operator] | (SetVehicleTypeReq) -> (bool)
      • setVehicleTypeV1

        public java.util.concurrent.CompletableFuture<java.lang.Boolean> setVehicleTypeV1​(java.lang.String taskGroupId,
                                                                                          SetVehicleTypeReq request)
        Sets the vehicle type on a draft task group. | authz_personas=[draft_creator_org_operator] | (SetVehicleTypeReq) -> (bool)
      • setVehicleTypeV1

        public java.util.concurrent.CompletableFuture<java.lang.Boolean> setVehicleTypeV1​(java.lang.String taskGroupId,
                                                                                          SetVehicleTypeReq request,
                                                                                          RequestOptions requestOptions)
        Sets the vehicle type on a draft task group. | authz_personas=[draft_creator_org_operator] | (SetVehicleTypeReq) -> (bool)
      • addExecutorV1

        public java.util.concurrent.CompletableFuture<java.lang.Boolean> addExecutorV1​(java.lang.String taskGroupId)
        Assigns an executor organization to a draft task group. Coordinator-only; provider-provider direct assignments require auto-assign consent. | authz_personas=[task_group_coordinator_operators] | (OrderDraftAddExecutorReq) -> (bool)
      • addExecutorV1

        public java.util.concurrent.CompletableFuture<java.lang.Boolean> addExecutorV1​(java.lang.String taskGroupId,
                                                                                       OrderDraftAddExecutorReq request)
        Assigns an executor organization to a draft task group. Coordinator-only; provider-provider direct assignments require auto-assign consent. | authz_personas=[task_group_coordinator_operators] | (OrderDraftAddExecutorReq) -> (bool)
      • addExecutorV1

        public java.util.concurrent.CompletableFuture<java.lang.Boolean> addExecutorV1​(java.lang.String taskGroupId,
                                                                                       OrderDraftAddExecutorReq request,
                                                                                       RequestOptions requestOptions)
        Assigns an executor organization to a draft task group. Coordinator-only; provider-provider direct assignments require auto-assign consent. | authz_personas=[task_group_coordinator_operators] | (OrderDraftAddExecutorReq) -> (bool)
      • removeExecutorV1

        public java.util.concurrent.CompletableFuture<java.lang.Boolean> removeExecutorV1​(java.lang.String taskGroupId)
        Clears the executor, driver, and PPP/PPD billing attachments from a draft task group. Coordinator-only; executor Cases are preserved. | authz_personas=[task_group_coordinator_operators] | () -> (bool)
      • removeExecutorV1

        public java.util.concurrent.CompletableFuture<java.lang.Boolean> removeExecutorV1​(java.lang.String taskGroupId,
                                                                                          RequestOptions requestOptions)
        Clears the executor, driver, and PPP/PPD billing attachments from a draft task group. Coordinator-only; executor Cases are preserved. | authz_personas=[task_group_coordinator_operators] | () -> (bool)
      • updateDriverV1

        public java.util.concurrent.CompletableFuture<java.lang.Boolean> updateDriverV1​(java.lang.String taskGroupId,
                                                                                        OrderDraftUpdateDriverReq request)
        Assigns or swaps the driver on a draft task group. Only the executor org may assign drivers. | authz_personas=[executor_org_operators] | (OrderDraftUpdateDriverReq) -> (bool)
      • updateDriverV1

        public java.util.concurrent.CompletableFuture<java.lang.Boolean> updateDriverV1​(java.lang.String taskGroupId,
                                                                                        OrderDraftUpdateDriverReq request,
                                                                                        RequestOptions requestOptions)
        Assigns or swaps the driver on a draft task group. Only the executor org may assign drivers. | authz_personas=[executor_org_operators] | (OrderDraftUpdateDriverReq) -> (bool)
      • removeDriverV1

        public java.util.concurrent.CompletableFuture<java.lang.Boolean> removeDriverV1​(java.lang.String taskGroupId)
        Clears the driver on a draft task group. Only the executor org may remove drivers. | authz_personas=[executor_org_operators] | () -> (bool)
      • removeDriverV1

        public java.util.concurrent.CompletableFuture<java.lang.Boolean> removeDriverV1​(java.lang.String taskGroupId,
                                                                                        RequestOptions requestOptions)
        Clears the driver on a draft task group. Only the executor org may remove drivers. | authz_personas=[executor_org_operators] | () -> (bool)
      • setTaskOrderingV1

        public java.util.concurrent.CompletableFuture<java.lang.Boolean> setTaskOrderingV1​(java.lang.String taskGroupId,
                                                                                           SetTaskOrderingDraftReq request)
        Sets the ordering of tasks within a draft task group. Must provide all task IDs with no duplicates. | (SetTaskOrderingDraftReq) -> (bool)
      • setTaskOrderingV1

        public java.util.concurrent.CompletableFuture<java.lang.Boolean> setTaskOrderingV1​(java.lang.String taskGroupId,
                                                                                           SetTaskOrderingDraftReq request,
                                                                                           RequestOptions requestOptions)
        Sets the ordering of tasks within a draft task group. Must provide all task IDs with no duplicates. | (SetTaskOrderingDraftReq) -> (bool)
      • setRateSheetsV1

        public java.util.concurrent.CompletableFuture<java.lang.Boolean> setRateSheetsV1​(java.lang.String taskGroupId)
        Sets rate sheet IDs on a draft task group. Forwarder mode (SPF/FPC) and direct shipper mode (SPC) are mutually exclusive. CPD is independent. | (SetRateSheetsReq) -> (bool)
      • setRateSheetsV1

        public java.util.concurrent.CompletableFuture<java.lang.Boolean> setRateSheetsV1​(java.lang.String taskGroupId,
                                                                                         SetRateSheetsReq request)
        Sets rate sheet IDs on a draft task group. Forwarder mode (SPF/FPC) and direct shipper mode (SPC) are mutually exclusive. CPD is independent. | (SetRateSheetsReq) -> (bool)
      • setRateSheetsV1

        public java.util.concurrent.CompletableFuture<java.lang.Boolean> setRateSheetsV1​(java.lang.String taskGroupId,
                                                                                         SetRateSheetsReq request,
                                                                                         RequestOptions requestOptions)
        Sets rate sheet IDs on a draft task group. Forwarder mode (SPF/FPC) and direct shipper mode (SPC) are mutually exclusive. CPD is independent. | (SetRateSheetsReq) -> (bool)
      • deleteV1

        public java.util.concurrent.CompletableFuture<java.lang.Boolean> deleteV1​(java.lang.String taskGroupId)
        Deletes a task group and all associated entities (tasks, task artifacts, S3 metadata). The task group must belong to a DRAFT order. | () -> (bool)
      • deleteV1

        public java.util.concurrent.CompletableFuture<java.lang.Boolean> deleteV1​(java.lang.String taskGroupId,
                                                                                  RequestOptions requestOptions)
        Deletes a task group and all associated entities (tasks, task artifacts, S3 metadata). The task group must belong to a DRAFT order. | () -> (bool)