Class AsyncCasesClient


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

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.concurrent.CompletableFuture<java.lang.Boolean> addMessageV1​(java.lang.String caseId, CaseAddMessageReq request)
      Appends a message to a case.
      java.util.concurrent.CompletableFuture<java.lang.Boolean> addMessageV1​(java.lang.String caseId, CaseAddMessageReq request, RequestOptions requestOptions)
      Appends a message to a case.
      java.util.concurrent.CompletableFuture<java.lang.Boolean> assignV1​(java.lang.String caseId, CaseAssignReq request)
      Adds operator(s) to a case.
      java.util.concurrent.CompletableFuture<java.lang.Boolean> assignV1​(java.lang.String caseId, CaseAssignReq request, RequestOptions requestOptions)
      Adds operator(s) to a case.
      java.util.concurrent.CompletableFuture<java.lang.Boolean> deleteMessageV1​(java.lang.String caseId, java.lang.String messageId)
      Deletes a message from a case.
      java.util.concurrent.CompletableFuture<java.lang.Boolean> deleteMessageV1​(java.lang.String caseId, java.lang.String messageId, RequestOptions requestOptions)
      Deletes a message from a case.
      java.util.concurrent.CompletableFuture<Case1> getByOrderRefV1​(java.lang.String orderRef)
      Retrieves the case for a given order ID, short ID, or off-chrt reference ID.
      java.util.concurrent.CompletableFuture<Case1> getByOrderRefV1​(java.lang.String orderRef, RequestOptions requestOptions)
      Retrieves the case for a given order ID, short ID, or off-chrt reference ID.
      java.util.concurrent.CompletableFuture<Case1> getByOrderShortIdV1​(java.lang.String orderShortId)
      Retrieves the case for a given order short ID.
      java.util.concurrent.CompletableFuture<Case1> getByOrderShortIdV1​(java.lang.String orderShortId, RequestOptions requestOptions)
      Retrieves the case for a given order short ID.
      java.util.concurrent.CompletableFuture<Case1> getByOrderV1​(java.lang.String orderId)
      Retrieves the case for a given shipping order.
      java.util.concurrent.CompletableFuture<Case1> getByOrderV1​(java.lang.String orderId, RequestOptions requestOptions)
      Retrieves the case for a given shipping order.
      java.util.concurrent.CompletableFuture<java.util.Optional<java.lang.String>> getSuggestedDepartmentV1​(java.lang.String caseId)
      Returns the department this case's order would map to from the shipper connection — a non-binding default for the UI.
      java.util.concurrent.CompletableFuture<java.util.Optional<java.lang.String>> getSuggestedDepartmentV1​(java.lang.String caseId, RequestOptions requestOptions)
      Returns the department this case's order would map to from the shipper connection — a non-binding default for the UI.
      java.util.concurrent.CompletableFuture<Case1> getV1​(java.lang.String caseId)
      Retrieves a single case.
      java.util.concurrent.CompletableFuture<Case1> getV1​(java.lang.String caseId, RequestOptions requestOptions)
      Retrieves a single case.
      java.util.concurrent.CompletableFuture<CaseListRes> listV1()
      Lists cases for the caller's organization with filtering, sorting, and pagination.
      java.util.concurrent.CompletableFuture<CaseListRes> listV1​(CasesListV1Request request)
      Lists cases for the caller's organization with filtering, sorting, and pagination.
      java.util.concurrent.CompletableFuture<CaseListRes> listV1​(CasesListV1Request request, RequestOptions requestOptions)
      Lists cases for the caller's organization with filtering, sorting, and pagination.
      AsyncS3ObjectsClient s3Objects()  
      java.util.concurrent.CompletableFuture<java.lang.Boolean> unassignV1​(java.lang.String caseId, CaseUnassignReq request)
      Removes operator(s) from a case.
      java.util.concurrent.CompletableFuture<java.lang.Boolean> unassignV1​(java.lang.String caseId, CaseUnassignReq request, RequestOptions requestOptions)
      Removes operator(s) from a case.
      java.util.concurrent.CompletableFuture<java.lang.Boolean> updateV1​(java.lang.String caseId)
      Updates a case's department_id.
      java.util.concurrent.CompletableFuture<java.lang.Boolean> updateV1​(java.lang.String caseId, CaseClientUpdate1 request)
      Updates a case's department_id.
      java.util.concurrent.CompletableFuture<java.lang.Boolean> updateV1​(java.lang.String caseId, CaseClientUpdate1 request, RequestOptions requestOptions)
      Updates a case's department_id.
      AsyncRawCasesClient 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

      • AsyncCasesClient

        public AsyncCasesClient​(ClientOptions clientOptions)
    • Method Detail

      • withRawResponse

        public AsyncRawCasesClient withRawResponse()
        Get responses with HTTP metadata like headers
      • listV1

        public java.util.concurrent.CompletableFuture<CaseListRes> listV1()
        Lists cases for the caller's organization with filtering, sorting, and pagination. | authz: min_org_role=operator | () -> (CaseListRes)
      • listV1

        public java.util.concurrent.CompletableFuture<CaseListRes> listV1​(CasesListV1Request request)
        Lists cases for the caller's organization with filtering, sorting, and pagination. | authz: min_org_role=operator | () -> (CaseListRes)
      • listV1

        public java.util.concurrent.CompletableFuture<CaseListRes> listV1​(CasesListV1Request request,
                                                                          RequestOptions requestOptions)
        Lists cases for the caller's organization with filtering, sorting, and pagination. | authz: min_org_role=operator | () -> (CaseListRes)
      • getV1

        public java.util.concurrent.CompletableFuture<Case1> getV1​(java.lang.String caseId)
        Retrieves a single case. | authz: min_org_role=operator | () -> (Case1)
      • getV1

        public java.util.concurrent.CompletableFuture<Case1> getV1​(java.lang.String caseId,
                                                                   RequestOptions requestOptions)
        Retrieves a single case. | authz: min_org_role=operator | () -> (Case1)
      • updateV1

        public java.util.concurrent.CompletableFuture<java.lang.Boolean> updateV1​(java.lang.String caseId)
        Updates a case's department_id. | authz: min_org_role=operator | (CaseClientUpdate1) -> (bool)
      • updateV1

        public java.util.concurrent.CompletableFuture<java.lang.Boolean> updateV1​(java.lang.String caseId,
                                                                                  CaseClientUpdate1 request)
        Updates a case's department_id. | authz: min_org_role=operator | (CaseClientUpdate1) -> (bool)
      • updateV1

        public java.util.concurrent.CompletableFuture<java.lang.Boolean> updateV1​(java.lang.String caseId,
                                                                                  CaseClientUpdate1 request,
                                                                                  RequestOptions requestOptions)
        Updates a case's department_id. | authz: min_org_role=operator | (CaseClientUpdate1) -> (bool)
      • getByOrderV1

        public java.util.concurrent.CompletableFuture<Case1> getByOrderV1​(java.lang.String orderId)
        Retrieves the case for a given shipping order. | authz: min_org_role=operator | () -> (Case1)
      • getByOrderV1

        public java.util.concurrent.CompletableFuture<Case1> getByOrderV1​(java.lang.String orderId,
                                                                          RequestOptions requestOptions)
        Retrieves the case for a given shipping order. | authz: min_org_role=operator | () -> (Case1)
      • getByOrderRefV1

        public java.util.concurrent.CompletableFuture<Case1> getByOrderRefV1​(java.lang.String orderRef)
        Retrieves the case for a given order ID, short ID, or off-chrt reference ID. | authz: min_org_role=operator | () -> (Case1)
      • getByOrderRefV1

        public java.util.concurrent.CompletableFuture<Case1> getByOrderRefV1​(java.lang.String orderRef,
                                                                             RequestOptions requestOptions)
        Retrieves the case for a given order ID, short ID, or off-chrt reference ID. | authz: min_org_role=operator | () -> (Case1)
      • getByOrderShortIdV1

        public java.util.concurrent.CompletableFuture<Case1> getByOrderShortIdV1​(java.lang.String orderShortId)
        Retrieves the case for a given order short ID. | authz: min_org_role=operator | () -> (Case1)
      • getByOrderShortIdV1

        public java.util.concurrent.CompletableFuture<Case1> getByOrderShortIdV1​(java.lang.String orderShortId,
                                                                                 RequestOptions requestOptions)
        Retrieves the case for a given order short ID. | authz: min_org_role=operator | () -> (Case1)
      • getSuggestedDepartmentV1

        public java.util.concurrent.CompletableFuture<java.util.Optional<java.lang.String>> getSuggestedDepartmentV1​(java.lang.String caseId)
        Returns the department this case's order would map to from the shipper connection — a non-binding default for the UI. Department is never auto-applied; the frontend applies it explicitly via the update route. | authz: min_org_role=operator | () -> (PydanticObjectId | None)
      • getSuggestedDepartmentV1

        public java.util.concurrent.CompletableFuture<java.util.Optional<java.lang.String>> getSuggestedDepartmentV1​(java.lang.String caseId,
                                                                                                                     RequestOptions requestOptions)
        Returns the department this case's order would map to from the shipper connection — a non-binding default for the UI. Department is never auto-applied; the frontend applies it explicitly via the update route. | authz: min_org_role=operator | () -> (PydanticObjectId | None)
      • assignV1

        public java.util.concurrent.CompletableFuture<java.lang.Boolean> assignV1​(java.lang.String caseId,
                                                                                  CaseAssignReq request)
        Adds operator(s) to a case. | authz: min_org_role=operator | (CaseAssignReq) -> (bool)
      • assignV1

        public java.util.concurrent.CompletableFuture<java.lang.Boolean> assignV1​(java.lang.String caseId,
                                                                                  CaseAssignReq request,
                                                                                  RequestOptions requestOptions)
        Adds operator(s) to a case. | authz: min_org_role=operator | (CaseAssignReq) -> (bool)
      • unassignV1

        public java.util.concurrent.CompletableFuture<java.lang.Boolean> unassignV1​(java.lang.String caseId,
                                                                                    CaseUnassignReq request)
        Removes operator(s) from a case. | authz: min_org_role=operator | (CaseUnassignReq) -> (bool)
      • unassignV1

        public java.util.concurrent.CompletableFuture<java.lang.Boolean> unassignV1​(java.lang.String caseId,
                                                                                    CaseUnassignReq request,
                                                                                    RequestOptions requestOptions)
        Removes operator(s) from a case. | authz: min_org_role=operator | (CaseUnassignReq) -> (bool)
      • addMessageV1

        public java.util.concurrent.CompletableFuture<java.lang.Boolean> addMessageV1​(java.lang.String caseId,
                                                                                      CaseAddMessageReq request)
        Appends a message to a case. | authz: min_org_role=operator | (CaseAddMessageReq) -> (bool)
      • addMessageV1

        public java.util.concurrent.CompletableFuture<java.lang.Boolean> addMessageV1​(java.lang.String caseId,
                                                                                      CaseAddMessageReq request,
                                                                                      RequestOptions requestOptions)
        Appends a message to a case. | authz: min_org_role=operator | (CaseAddMessageReq) -> (bool)
      • deleteMessageV1

        public java.util.concurrent.CompletableFuture<java.lang.Boolean> deleteMessageV1​(java.lang.String caseId,
                                                                                         java.lang.String messageId)
        Deletes a message from a case. | authz: min_org_role=operator | () -> (bool)
      • deleteMessageV1

        public java.util.concurrent.CompletableFuture<java.lang.Boolean> deleteMessageV1​(java.lang.String caseId,
                                                                                         java.lang.String messageId,
                                                                                         RequestOptions requestOptions)
        Deletes a message from a case. | authz: min_org_role=operator | () -> (bool)