Package com.chrt.api.resources.shipping.orderdrafts

Class OrderDraftsClient

java.lang.Object

com.chrt.api.resources.shipping.orderdrafts.OrderDraftsClient

public class OrderDraftsClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected java.util.function.Supplier<CargoClient>	cargoClient
protected ClientOptions	clientOptions
protected java.util.function.Supplier<ExpandedClient>	expandedClient
protected java.util.function.Supplier<TaskArtifactClient>	taskArtifactClient
protected java.util.function.Supplier<TaskClient>	taskClient
protected java.util.function.Supplier<TaskGroupClient>	taskGroupClient

Constructor Summary

Constructors

Constructor	Description
OrderDraftsClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
CargoClient	cargo()
boolean	deleteV1(java.lang.String orderId)	Deletes a draft order and all associated entities.
boolean	deleteV1(java.lang.String orderId, RequestOptions requestOptions)	Deletes a draft order and all associated entities.
ExpandedClient	expanded()
OrdersNewDraftRes	newV1()	Creates a new draft order with org assignments based on caller's organization type.
OrdersNewDraftRes	newV1(OrdersNewDraftReq request)	Creates a new draft order with org assignments based on caller's organization type.
OrdersNewDraftRes	newV1(OrdersNewDraftReq request, RequestOptions requestOptions)	Creates a new draft order with org assignments based on caller's organization type.
TaskClient	task()
TaskArtifactClient	taskArtifact()
TaskGroupClient	taskGroup()
OrdersDraftUpdateRes	updateV1(java.lang.String orderId)	Updates forwarder and/or shipper org assignments for a draft order.
OrdersDraftUpdateRes	updateV1(java.lang.String orderId, OrdersDraftUpdateReq request)	Updates forwarder and/or shipper org assignments for a draft order.
OrdersDraftUpdateRes	updateV1(java.lang.String orderId, OrdersDraftUpdateReq request, RequestOptions requestOptions)	Updates forwarder and/or shipper org assignments for a draft order.
OrderDraftValidationResult	validateV1(java.lang.String orderId)	Validates the draft order for staging and returns all issues found.
OrderDraftValidationResult	validateV1(java.lang.String orderId, RequestOptions requestOptions)	Validates the draft order for staging and returns all issues found.
RawOrderDraftsClient	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

taskGroupClient

protected final java.util.function.Supplier<TaskGroupClient> taskGroupClient

taskClient

protected final java.util.function.Supplier<TaskClient> taskClient

taskArtifactClient

protected final java.util.function.Supplier<TaskArtifactClient> taskArtifactClient

cargoClient

protected final java.util.function.Supplier<CargoClient> cargoClient

expandedClient

protected final java.util.function.Supplier<ExpandedClient> expandedClient

Constructor Detail

OrderDraftsClient

public OrderDraftsClient(ClientOptions clientOptions)

Method Detail

withRawResponse

public RawOrderDraftsClient withRawResponse()

Get responses with HTTP metadata like headers

newV1

public OrdersNewDraftRes newV1()

Creates a new draft order with org assignments based on caller's organization type. | (OrdersNewDraftReq) -> (OrdersNewDraftRes)

newV1

public OrdersNewDraftRes newV1(OrdersNewDraftReq request)

Creates a new draft order with org assignments based on caller's organization type. | (OrdersNewDraftReq) -> (OrdersNewDraftRes)

newV1

public OrdersNewDraftRes newV1(OrdersNewDraftReq request,
                               RequestOptions requestOptions)

Creates a new draft order with org assignments based on caller's organization type. | (OrdersNewDraftReq) -> (OrdersNewDraftRes)

updateV1

public OrdersDraftUpdateRes updateV1(java.lang.String orderId)

Updates forwarder and/or shipper org assignments for a draft order. | (OrdersDraftUpdateReq) -> (OrdersDraftUpdateRes)

updateV1

public OrdersDraftUpdateRes updateV1(java.lang.String orderId,
                                     OrdersDraftUpdateReq request)

Updates forwarder and/or shipper org assignments for a draft order. | (OrdersDraftUpdateReq) -> (OrdersDraftUpdateRes)

updateV1

public OrdersDraftUpdateRes updateV1(java.lang.String orderId,
                                     OrdersDraftUpdateReq request,
                                     RequestOptions requestOptions)

Updates forwarder and/or shipper org assignments for a draft order. | (OrdersDraftUpdateReq) -> (OrdersDraftUpdateRes)

deleteV1

public boolean deleteV1(java.lang.String orderId)

Deletes a draft order and all associated entities. | () -> (bool)

deleteV1

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

Deletes a draft order and all associated entities. | () -> (bool)

validateV1

public OrderDraftValidationResult validateV1(java.lang.String orderId)

Validates the draft order for staging and returns all issues found. | () -> (OrderDraftValidationResult)

validateV1

public OrderDraftValidationResult validateV1(java.lang.String orderId,
                                             RequestOptions requestOptions)

Validates the draft order for staging and returns all issues found. | () -> (OrderDraftValidationResult)

taskGroup

public TaskGroupClient taskGroup()

task

public TaskClient task()

taskArtifact

public TaskArtifactClient taskArtifact()

cargo

public CargoClient cargo()

expanded

public ExpandedClient expanded()