Package com.chrt.api.resources.orderdrafts.cargo

Class CargoClient

java.lang.Object

com.chrt.api.resources.orderdrafts.cargo.CargoClient

public class CargoClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientOptions	clientOptions

Constructor Summary

Constructors

Constructor	Description
CargoClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
java.lang.String	addV1(OrderDraftAddCargoReq request)	Adds a cargo item to an existing draft order.
java.lang.String	addV1(OrderDraftAddCargoReq request, RequestOptions requestOptions)	Adds a cargo item to an existing draft order.
boolean	associateWithTaskV1(OrderDraftAssociateCargoWithTaskReq request)	Associates existing cargo with a task in a draft order.
boolean	associateWithTaskV1(OrderDraftAssociateCargoWithTaskReq request, RequestOptions requestOptions)	Associates existing cargo with a task in a draft order.
boolean	deleteV1(java.lang.String cargoId)	Deletes a cargo item from a draft order and removes references from associated tasks.
boolean	deleteV1(java.lang.String cargoId, RequestOptions requestOptions)	Deletes a cargo item from a draft order and removes references from associated tasks.
java.lang.String	updateV1(OrderDraftUpdateCargoReq request)	Updates a cargo item in an existing draft order.
java.lang.String	updateV1(OrderDraftUpdateCargoReq request, RequestOptions requestOptions)	Updates a cargo item in an existing draft order.
RawCargoClient	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

Constructor Detail

CargoClient

public CargoClient(ClientOptions clientOptions)

Method Detail

withRawResponse

public RawCargoClient withRawResponse()

Get responses with HTTP metadata like headers

addV1

public java.lang.String addV1(OrderDraftAddCargoReq request)

Adds a cargo item to an existing draft order. Validates order is in DRAFT status and owned by caller. | (OrderDraftAddCargoReq) -> (PydanticObjectId)

addV1

public java.lang.String addV1(OrderDraftAddCargoReq request,
                              RequestOptions requestOptions)

Adds a cargo item to an existing draft order. Validates order is in DRAFT status and owned by caller. | (OrderDraftAddCargoReq) -> (PydanticObjectId)

associateWithTaskV1

public boolean associateWithTaskV1(OrderDraftAssociateCargoWithTaskReq request)

Associates existing cargo with a task in a draft order. | (OrderDraftAssociateCargoWithTaskReq) -> (bool)

associateWithTaskV1

public boolean associateWithTaskV1(OrderDraftAssociateCargoWithTaskReq request,
                                   RequestOptions requestOptions)

Associates existing cargo with a task in a draft order. | (OrderDraftAssociateCargoWithTaskReq) -> (bool)

updateV1

public java.lang.String updateV1(OrderDraftUpdateCargoReq request)

Updates a cargo item in an existing draft order. Validates order is in DRAFT status and owned by caller. | (OrderDraftUpdateCargoReq) -> (PydanticObjectId)

updateV1

public java.lang.String updateV1(OrderDraftUpdateCargoReq request,
                                 RequestOptions requestOptions)

Updates a cargo item in an existing draft order. Validates order is in DRAFT status and owned by caller. | (OrderDraftUpdateCargoReq) -> (PydanticObjectId)

deleteV1

public boolean deleteV1(java.lang.String cargoId)

Deletes a cargo item from a draft order and removes references from associated tasks. | () -> (bool)

deleteV1

public boolean deleteV1(java.lang.String cargoId,
                        RequestOptions requestOptions)

Deletes a cargo item from a draft order and removes references from associated tasks. | () -> (bool)