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.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> removeCourierOrgV1​(java.lang.String taskGroupId)
      Removes the courier organization from a draft task group (sets courier_org_id to null).
      java.util.concurrent.CompletableFuture<java.lang.Boolean> removeCourierOrgV1​(java.lang.String taskGroupId, RequestOptions requestOptions)
      Removes the courier organization from a draft task group (sets courier_org_id to null).
      java.util.concurrent.CompletableFuture<java.lang.Boolean> setFlightInfoV1​(java.lang.String taskGroupId)
      Sets the flight number and/or fa_flight_ids on a draft task group.
      java.util.concurrent.CompletableFuture<java.lang.Boolean> setFlightInfoV1​(java.lang.String taskGroupId, SetFlightInfoReq request)
      Sets the flight number and/or fa_flight_ids on a draft task group.
      java.util.concurrent.CompletableFuture<java.lang.Boolean> setFlightInfoV1​(java.lang.String taskGroupId, SetFlightInfoReq request, RequestOptions requestOptions)
      Sets the flight number and/or fa_flight_ids 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> setServiceTypeV1​(java.lang.String taskGroupId, SetServiceTypeReq request)
      Sets the service type on a draft task group.
      java.util.concurrent.CompletableFuture<java.lang.Boolean> setServiceTypeV1​(java.lang.String taskGroupId, SetServiceTypeReq request, RequestOptions requestOptions)
      Sets the service type 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> updateCourierOrgV1​(java.lang.String taskGroupId, UpdateCourierOrgDraftReq request)
      Updates the courier organization assigned to a draft task group.
      java.util.concurrent.CompletableFuture<java.lang.Boolean> updateCourierOrgV1​(java.lang.String taskGroupId, UpdateCourierOrgDraftReq request, RequestOptions requestOptions)
      Updates the courier organization assigned to 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. Validates order is in DRAFT status and owned by caller. | (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. Validates order is in DRAFT status and owned by caller. | (OrderDraftAddTaskGroupReq) -> (PydanticObjectId)
      • setFlightInfoV1

        public java.util.concurrent.CompletableFuture<java.lang.Boolean> setFlightInfoV1​(java.lang.String taskGroupId)
        Sets the flight number and/or fa_flight_ids on a draft task group. | (SetFlightInfoReq) -> (bool)
      • setFlightInfoV1

        public java.util.concurrent.CompletableFuture<java.lang.Boolean> setFlightInfoV1​(java.lang.String taskGroupId,
                                                                                         SetFlightInfoReq request)
        Sets the flight number and/or fa_flight_ids 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)
        Sets the flight number and/or fa_flight_ids on a draft task group. | (SetFlightInfoReq) -> (bool)
      • updateCourierOrgV1

        public java.util.concurrent.CompletableFuture<java.lang.Boolean> updateCourierOrgV1​(java.lang.String taskGroupId,
                                                                                            UpdateCourierOrgDraftReq request)
        Updates the courier organization assigned to a draft task group. | (UpdateCourierOrgDraftReq) -> (bool)
      • updateCourierOrgV1

        public java.util.concurrent.CompletableFuture<java.lang.Boolean> updateCourierOrgV1​(java.lang.String taskGroupId,
                                                                                            UpdateCourierOrgDraftReq request,
                                                                                            RequestOptions requestOptions)
        Updates the courier organization assigned to a draft task group. | (UpdateCourierOrgDraftReq) -> (bool)
      • removeCourierOrgV1

        public java.util.concurrent.CompletableFuture<java.lang.Boolean> removeCourierOrgV1​(java.lang.String taskGroupId)
        Removes the courier organization from a draft task group (sets courier_org_id to null). | () -> (bool)
      • removeCourierOrgV1

        public java.util.concurrent.CompletableFuture<java.lang.Boolean> removeCourierOrgV1​(java.lang.String taskGroupId,
                                                                                            RequestOptions requestOptions)
        Removes the courier organization from a draft task group (sets courier_org_id to null). | () -> (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)
      • setServiceTypeV1

        public java.util.concurrent.CompletableFuture<java.lang.Boolean> setServiceTypeV1​(java.lang.String taskGroupId,
                                                                                          SetServiceTypeReq request)
        Sets the service type on a draft task group. Can only be set when task group is in DRAFT status. | (SetServiceTypeReq) -> (bool)
      • setServiceTypeV1

        public java.util.concurrent.CompletableFuture<java.lang.Boolean> setServiceTypeV1​(java.lang.String taskGroupId,
                                                                                          SetServiceTypeReq request,
                                                                                          RequestOptions requestOptions)
        Sets the service type on a draft task group. Can only be set when task group is in DRAFT status. | (SetServiceTypeReq) -> (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)