Package com.chrt.api.resources.shipping.orders

Class AsyncOrdersClient

java.lang.Object

com.chrt.api.resources.shipping.orders.AsyncOrdersClient

public class AsyncOrdersClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientOptions	clientOptions
protected java.util.function.Supplier<AsyncExpandedClient>	expandedClient

Constructor Summary

Constructors

Constructor	Description
AsyncOrdersClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
java.util.concurrent.CompletableFuture<java.lang.Boolean>	cancelManyV1(OrdersCancelManyReq request)	Cancels multiple orders and their non-terminal child entities in a transaction.
java.util.concurrent.CompletableFuture<java.lang.Boolean>	cancelManyV1(OrdersCancelManyReq request, RequestOptions requestOptions)	Cancels multiple orders and their non-terminal child entities in a transaction.
java.util.concurrent.CompletableFuture<java.lang.Boolean>	cancelV1(java.lang.String orderId)	Cancels an order and non-terminal child entities in a transaction.
java.util.concurrent.CompletableFuture<java.lang.Boolean>	cancelV1(java.lang.String orderId, RequestOptions requestOptions)	Cancels an order and non-terminal child entities in a transaction.
AsyncExpandedClient	expanded()
java.util.concurrent.CompletableFuture<java.lang.Boolean>	stageV1(java.lang.String orderId)	Validates a draft order and stages all related entities in a transaction.
java.util.concurrent.CompletableFuture<java.lang.Boolean>	stageV1(java.lang.String orderId, RequestOptions requestOptions)	Validates a draft order and stages all related entities in a transaction.
java.util.concurrent.CompletableFuture<java.util.List<OrderTypeaheadResult>>	typeaheadV1(OrdersTypeaheadV1Request request)	Returns distinct short_id and off_chrt_reference_id values matching the query via case-insensitive regex.
java.util.concurrent.CompletableFuture<java.util.List<OrderTypeaheadResult>>	typeaheadV1(OrdersTypeaheadV1Request request, RequestOptions requestOptions)	Returns distinct short_id and off_chrt_reference_id values matching the query via case-insensitive regex.
java.util.concurrent.CompletableFuture<OrdersUpdateOffChrtReferenceIdRes>	updateOffChrtReferenceIdV1(java.lang.String orderId)	Updates off_chrt_reference_id on a non-draft order.
java.util.concurrent.CompletableFuture<OrdersUpdateOffChrtReferenceIdRes>	updateOffChrtReferenceIdV1(java.lang.String orderId, OrdersUpdateOffChrtReferenceIdReq request)	Updates off_chrt_reference_id on a non-draft order.
java.util.concurrent.CompletableFuture<OrdersUpdateOffChrtReferenceIdRes>	updateOffChrtReferenceIdV1(java.lang.String orderId, OrdersUpdateOffChrtReferenceIdReq request, RequestOptions requestOptions)	Updates off_chrt_reference_id on a non-draft order.
AsyncRawOrdersClient	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

expandedClient

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

Constructor Detail

AsyncOrdersClient

public AsyncOrdersClient(ClientOptions clientOptions)

Method Detail

withRawResponse

public AsyncRawOrdersClient withRawResponse()

Get responses with HTTP metadata like headers

typeaheadV1

public java.util.concurrent.CompletableFuture<java.util.List<OrderTypeaheadResult>> typeaheadV1(OrdersTypeaheadV1Request request)

Returns distinct short_id and off_chrt_reference_id values matching the query via case-insensitive regex. Searches non-draft orders visible to the caller's org. | authz: allowed_org_types=[provider, shipper], min_org_role=operator | () -> (list[OrderTypeaheadResult])

typeaheadV1

public java.util.concurrent.CompletableFuture<java.util.List<OrderTypeaheadResult>> typeaheadV1(OrdersTypeaheadV1Request request,
                                                                                                RequestOptions requestOptions)

Returns distinct short_id and off_chrt_reference_id values matching the query via case-insensitive regex. Searches non-draft orders visible to the caller's org. | authz: allowed_org_types=[provider, shipper], min_org_role=operator | () -> (list[OrderTypeaheadResult])

stageV1

public java.util.concurrent.CompletableFuture<java.lang.Boolean> stageV1(java.lang.String orderId)

Validates a draft order and stages all related entities in a transaction. | () -> (bool)

stageV1

public java.util.concurrent.CompletableFuture<java.lang.Boolean> stageV1(java.lang.String orderId,
                                                                         RequestOptions requestOptions)

Validates a draft order and stages all related entities in a transaction. | () -> (bool)

updateOffChrtReferenceIdV1

public java.util.concurrent.CompletableFuture<OrdersUpdateOffChrtReferenceIdRes> updateOffChrtReferenceIdV1(java.lang.String orderId)

Updates off_chrt_reference_id on a non-draft order. | authz_personas=[order_creator_org_operators] | (OrdersUpdateOffChrtReferenceIdReq) -> (OrdersUpdateOffChrtReferenceIdRes)

updateOffChrtReferenceIdV1

public java.util.concurrent.CompletableFuture<OrdersUpdateOffChrtReferenceIdRes> updateOffChrtReferenceIdV1(java.lang.String orderId,
                                                                                                            OrdersUpdateOffChrtReferenceIdReq request)

Updates off_chrt_reference_id on a non-draft order. | authz_personas=[order_creator_org_operators] | (OrdersUpdateOffChrtReferenceIdReq) -> (OrdersUpdateOffChrtReferenceIdRes)

updateOffChrtReferenceIdV1

public java.util.concurrent.CompletableFuture<OrdersUpdateOffChrtReferenceIdRes> updateOffChrtReferenceIdV1(java.lang.String orderId,
                                                                                                            OrdersUpdateOffChrtReferenceIdReq request,
                                                                                                            RequestOptions requestOptions)

Updates off_chrt_reference_id on a non-draft order. | authz_personas=[order_creator_org_operators] | (OrdersUpdateOffChrtReferenceIdReq) -> (OrdersUpdateOffChrtReferenceIdRes)

cancelV1

public java.util.concurrent.CompletableFuture<java.lang.Boolean> cancelV1(java.lang.String orderId)

Cancels an order and non-terminal child entities in a transaction. | authz_personas=[lig_owner_operators] | () -> (bool)

cancelV1

public java.util.concurrent.CompletableFuture<java.lang.Boolean> cancelV1(java.lang.String orderId,
                                                                          RequestOptions requestOptions)

Cancels an order and non-terminal child entities in a transaction. | authz_personas=[lig_owner_operators] | () -> (bool)

cancelManyV1

public java.util.concurrent.CompletableFuture<java.lang.Boolean> cancelManyV1(OrdersCancelManyReq request)

Cancels multiple orders and their non-terminal child entities in a transaction. | authz_personas=[lig_owner_operators] | (OrdersCancelManyReq) -> (bool)

cancelManyV1

public java.util.concurrent.CompletableFuture<java.lang.Boolean> cancelManyV1(OrdersCancelManyReq request,
                                                                              RequestOptions requestOptions)

Cancels multiple orders and their non-terminal child entities in a transaction. | authz_personas=[lig_owner_operators] | (OrdersCancelManyReq) -> (bool)

expanded

public AsyncExpandedClient expanded()