Package com.chrt.api.resources.operations.cases

Class CasesClient

java.lang.Object

com.chrt.api.resources.operations.cases.CasesClient

public class CasesClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientOptions	clientOptions
protected java.util.function.Supplier<S3ObjectsClient>	s3ObjectsClient

Constructor Summary

Constructors

Constructor	Description
CasesClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
boolean	addMessageV1(java.lang.String caseId, CaseAddMessageReq request)	Appends a message to a case.
boolean	addMessageV1(java.lang.String caseId, CaseAddMessageReq request, RequestOptions requestOptions)	Appends a message to a case.
boolean	assignV1(java.lang.String caseId, CaseAssignReq request)	Adds operator(s) to a case.
boolean	assignV1(java.lang.String caseId, CaseAssignReq request, RequestOptions requestOptions)	Adds operator(s) to a case.
boolean	deleteMessageV1(java.lang.String caseId, java.lang.String messageId)	Deletes a message from a case.
boolean	deleteMessageV1(java.lang.String caseId, java.lang.String messageId, RequestOptions requestOptions)	Deletes a message from a case.
Case1	getByOrderRefV1(java.lang.String orderRef)	Retrieves the case for a given order ID, short ID, or off-chrt reference ID.
Case1	getByOrderRefV1(java.lang.String orderRef, RequestOptions requestOptions)	Retrieves the case for a given order ID, short ID, or off-chrt reference ID.
Case1	getByOrderShortIdV1(java.lang.String orderShortId)	Retrieves the case for a given order short ID.
Case1	getByOrderShortIdV1(java.lang.String orderShortId, RequestOptions requestOptions)	Retrieves the case for a given order short ID.
Case1	getByOrderV1(java.lang.String orderId)	Retrieves the case for a given shipping order.
Case1	getByOrderV1(java.lang.String orderId, RequestOptions requestOptions)	Retrieves the case for a given shipping order.
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.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.
Case1	getV1(java.lang.String caseId)	Retrieves a single case.
Case1	getV1(java.lang.String caseId, RequestOptions requestOptions)	Retrieves a single case.
CaseListRes	listV1()	Lists cases for the caller's organization with filtering, sorting, and pagination.
CaseListRes	listV1(CasesListV1Request request)	Lists cases for the caller's organization with filtering, sorting, and pagination.
CaseListRes	listV1(CasesListV1Request request, RequestOptions requestOptions)	Lists cases for the caller's organization with filtering, sorting, and pagination.
S3ObjectsClient	s3Objects()
boolean	unassignV1(java.lang.String caseId, CaseUnassignReq request)	Removes operator(s) from a case.
boolean	unassignV1(java.lang.String caseId, CaseUnassignReq request, RequestOptions requestOptions)	Removes operator(s) from a case.
boolean	updateV1(java.lang.String caseId)	Updates a case's department_id.
boolean	updateV1(java.lang.String caseId, CaseClientUpdate1 request)	Updates a case's department_id.
boolean	updateV1(java.lang.String caseId, CaseClientUpdate1 request, RequestOptions requestOptions)	Updates a case's department_id.
RawCasesClient	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

s3ObjectsClient

protected final java.util.function.Supplier<S3ObjectsClient> s3ObjectsClient

Constructor Detail

CasesClient

public CasesClient(ClientOptions clientOptions)

Method Detail

withRawResponse

public RawCasesClient withRawResponse()

Get responses with HTTP metadata like headers

listV1

public CaseListRes listV1()

Lists cases for the caller's organization with filtering, sorting, and pagination. | authz: min_org_role=operator | () -> (CaseListRes)

listV1

public CaseListRes listV1(CasesListV1Request request)

Lists cases for the caller's organization with filtering, sorting, and pagination. | authz: min_org_role=operator | () -> (CaseListRes)

listV1

public 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 Case1 getV1(java.lang.String caseId)

Retrieves a single case. | authz: min_org_role=operator | () -> (Case1)

getV1

public Case1 getV1(java.lang.String caseId,
                   RequestOptions requestOptions)

Retrieves a single case. | authz: min_org_role=operator | () -> (Case1)

updateV1

public boolean updateV1(java.lang.String caseId)

Updates a case's department_id. | authz: min_org_role=operator | (CaseClientUpdate1) -> (bool)

updateV1

public boolean updateV1(java.lang.String caseId,
                        CaseClientUpdate1 request)

Updates a case's department_id. | authz: min_org_role=operator | (CaseClientUpdate1) -> (bool)

updateV1

public 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 Case1 getByOrderV1(java.lang.String orderId)

Retrieves the case for a given shipping order. | authz: min_org_role=operator | () -> (Case1)

getByOrderV1

public Case1 getByOrderV1(java.lang.String orderId,
                          RequestOptions requestOptions)

Retrieves the case for a given shipping order. | authz: min_org_role=operator | () -> (Case1)

getByOrderRefV1

public 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 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 Case1 getByOrderShortIdV1(java.lang.String orderShortId)

Retrieves the case for a given order short ID. | authz: min_org_role=operator | () -> (Case1)

getByOrderShortIdV1

public 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.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.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 boolean assignV1(java.lang.String caseId,
                        CaseAssignReq request)

Adds operator(s) to a case. | authz: min_org_role=operator | (CaseAssignReq) -> (bool)

assignV1

public 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 boolean unassignV1(java.lang.String caseId,
                          CaseUnassignReq request)

Removes operator(s) from a case. | authz: min_org_role=operator | (CaseUnassignReq) -> (bool)

unassignV1

public 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 boolean addMessageV1(java.lang.String caseId,
                            CaseAddMessageReq request)

Appends a message to a case. | authz: min_org_role=operator | (CaseAddMessageReq) -> (bool)

addMessageV1

public 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 boolean deleteMessageV1(java.lang.String caseId,
                               java.lang.String messageId)

Deletes a message from a case. | authz: min_org_role=operator | () -> (bool)

deleteMessageV1

public boolean deleteMessageV1(java.lang.String caseId,
                               java.lang.String messageId,
                               RequestOptions requestOptions)

Deletes a message from a case. | authz: min_org_role=operator | () -> (bool)

s3Objects

public S3ObjectsClient s3Objects()