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 ClientOptionsclientOptions
-
Constructor Summary
Constructors Constructor Description CargoClient(ClientOptions clientOptions)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.StringaddV1(OrderDraftAddCargoReq request)Adds a cargo item to an existing draft order.java.lang.StringaddV1(OrderDraftAddCargoReq request, RequestOptions requestOptions)Adds a cargo item to an existing draft order.booleanassociateWithTaskV1(OrderDraftAssociateCargoWithTaskReq request)Associates existing cargo with a task in a draft order.booleanassociateWithTaskV1(OrderDraftAssociateCargoWithTaskReq request, RequestOptions requestOptions)Associates existing cargo with a task in a draft order.booleandeleteV1(java.lang.String cargoId)Deletes a cargo item from a draft order and removes references from associated tasksbooleandeleteV1(java.lang.String cargoId, RequestOptions requestOptions)Deletes a cargo item from a draft order and removes references from associated tasksjava.lang.StringupdateV1(OrderDraftUpdateCargoReq request)Updates a cargo item in an existing draft order.java.lang.StringupdateV1(OrderDraftUpdateCargoReq request, RequestOptions requestOptions)Updates a cargo item in an existing draft order.RawCargoClientwithRawResponse()Get responses with HTTP metadata like headers
-
-
-
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.
-
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.
-
associateWithTaskV1
public boolean associateWithTaskV1(OrderDraftAssociateCargoWithTaskReq request)
Associates existing cargo with a task in a draft order.
-
associateWithTaskV1
public boolean associateWithTaskV1(OrderDraftAssociateCargoWithTaskReq request, RequestOptions requestOptions)
Associates existing cargo with a task in a draft order.
-
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.
-
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.
-
deleteV1
public boolean deleteV1(java.lang.String cargoId)
Deletes a cargo item from a draft order and removes references from associated tasks
-
deleteV1
public boolean deleteV1(java.lang.String cargoId, RequestOptions requestOptions)Deletes a cargo item from a draft order and removes references from associated tasks
-
-