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

Class AsyncExpandedClient

java.lang.Object

com.chrt.api.resources.shipping.orders.expanded.AsyncExpandedClient

public class AsyncExpandedClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientOptions	clientOptions

Constructor Summary

Constructors

Constructor	Description
AsyncExpandedClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
java.util.concurrent.CompletableFuture<OrderExpanded>	forForwarderOperatorsV1(java.lang.String orderIdOrShortId)	Retrieves an expanded order with optional related data for forwarder operators.
java.util.concurrent.CompletableFuture<OrderExpanded>	forForwarderOperatorsV1(java.lang.String orderIdOrShortId, OrderAndTaskGroupExpandedReq request)	Retrieves an expanded order with optional related data for forwarder operators.
java.util.concurrent.CompletableFuture<OrderExpanded>	forForwarderOperatorsV1(java.lang.String orderIdOrShortId, OrderAndTaskGroupExpandedReq request, RequestOptions requestOptions)	Retrieves an expanded order with optional related data for forwarder operators.
java.util.concurrent.CompletableFuture<OrderExpanded>	forShipperOperatorsV1(java.lang.String orderIdOrShortId)	Retrieves an expanded order with optional related data for shipper operators.
java.util.concurrent.CompletableFuture<OrderExpanded>	forShipperOperatorsV1(java.lang.String orderIdOrShortId, OrderAndTaskGroupExpandedReq request)	Retrieves an expanded order with optional related data for shipper operators.
java.util.concurrent.CompletableFuture<OrderExpanded>	forShipperOperatorsV1(java.lang.String orderIdOrShortId, OrderAndTaskGroupExpandedReq request, RequestOptions requestOptions)	Retrieves an expanded order with optional related data for shipper operators.
java.util.concurrent.CompletableFuture<OrdersExpandedListRes>	listForForwarderOperatorsV1(ExpandedListForForwarderOperatorsV1Request request)	Lists expanded orders for forwarder operators with filtering, sorting, pagination, and optional search.
java.util.concurrent.CompletableFuture<OrdersExpandedListRes>	listForForwarderOperatorsV1(ExpandedListForForwarderOperatorsV1Request request, RequestOptions requestOptions)	Lists expanded orders for forwarder operators with filtering, sorting, pagination, and optional search.
java.util.concurrent.CompletableFuture<OrdersExpandedListRes>	listForShipperOperatorsV1(ExpandedListForShipperOperatorsV1Request request)	Lists expanded orders for shipper operators with filtering, sorting, pagination, and optional search.
java.util.concurrent.CompletableFuture<OrdersExpandedListRes>	listForShipperOperatorsV1(ExpandedListForShipperOperatorsV1Request request, RequestOptions requestOptions)	Lists expanded orders for shipper operators with filtering, sorting, pagination, and optional search.
java.util.concurrent.CompletableFuture<java.util.List<java.lang.String>>	typeaheadV1(ExpandedTypeaheadV1Request request)	Returns distinct order short_id values matching the query via case-insensitive regex.
java.util.concurrent.CompletableFuture<java.util.List<java.lang.String>>	typeaheadV1(ExpandedTypeaheadV1Request request, RequestOptions requestOptions)	Returns distinct order short_id values matching the query via case-insensitive regex.
AsyncRawExpandedClient	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

AsyncExpandedClient

public AsyncExpandedClient(ClientOptions clientOptions)

Method Detail

withRawResponse

public AsyncRawExpandedClient withRawResponse()

Get responses with HTTP metadata like headers

forShipperOperatorsV1

public java.util.concurrent.CompletableFuture<OrderExpanded> forShipperOperatorsV1(java.lang.String orderIdOrShortId)

Retrieves an expanded order with optional related data for shipper operators. | authz_personas=[shipper_org_operators] | (OrderAndTaskGroupExpandedReq) -> (OrderExpanded)

forShipperOperatorsV1

public java.util.concurrent.CompletableFuture<OrderExpanded> forShipperOperatorsV1(java.lang.String orderIdOrShortId,
                                                                                   OrderAndTaskGroupExpandedReq request)

Retrieves an expanded order with optional related data for shipper operators. | authz_personas=[shipper_org_operators] | (OrderAndTaskGroupExpandedReq) -> (OrderExpanded)

forShipperOperatorsV1

public java.util.concurrent.CompletableFuture<OrderExpanded> forShipperOperatorsV1(java.lang.String orderIdOrShortId,
                                                                                   OrderAndTaskGroupExpandedReq request,
                                                                                   RequestOptions requestOptions)

Retrieves an expanded order with optional related data for shipper operators. | authz_personas=[shipper_org_operators] | (OrderAndTaskGroupExpandedReq) -> (OrderExpanded)

forForwarderOperatorsV1

public java.util.concurrent.CompletableFuture<OrderExpanded> forForwarderOperatorsV1(java.lang.String orderIdOrShortId)

Retrieves an expanded order with optional related data for forwarder operators. | authz_personas=[forwarder_org_operators] | (OrderAndTaskGroupExpandedReq) -> (OrderExpanded)

forForwarderOperatorsV1

public java.util.concurrent.CompletableFuture<OrderExpanded> forForwarderOperatorsV1(java.lang.String orderIdOrShortId,
                                                                                     OrderAndTaskGroupExpandedReq request)

Retrieves an expanded order with optional related data for forwarder operators. | authz_personas=[forwarder_org_operators] | (OrderAndTaskGroupExpandedReq) -> (OrderExpanded)

forForwarderOperatorsV1

public java.util.concurrent.CompletableFuture<OrderExpanded> forForwarderOperatorsV1(java.lang.String orderIdOrShortId,
                                                                                     OrderAndTaskGroupExpandedReq request,
                                                                                     RequestOptions requestOptions)

Retrieves an expanded order with optional related data for forwarder operators. | authz_personas=[forwarder_org_operators] | (OrderAndTaskGroupExpandedReq) -> (OrderExpanded)

listForForwarderOperatorsV1

public java.util.concurrent.CompletableFuture<OrdersExpandedListRes> listForForwarderOperatorsV1(ExpandedListForForwarderOperatorsV1Request request)

Lists expanded orders for forwarder operators with filtering, sorting, pagination, and optional search. | authz: allowed_org_types=[forwarder], min_org_role=operator | (OrderAndTaskGroupExpandedReq) -> (OrdersExpandedListRes)

listForForwarderOperatorsV1

public java.util.concurrent.CompletableFuture<OrdersExpandedListRes> listForForwarderOperatorsV1(ExpandedListForForwarderOperatorsV1Request request,
                                                                                                 RequestOptions requestOptions)

Lists expanded orders for forwarder operators with filtering, sorting, pagination, and optional search. | authz: allowed_org_types=[forwarder], min_org_role=operator | (OrderAndTaskGroupExpandedReq) -> (OrdersExpandedListRes)

listForShipperOperatorsV1

public java.util.concurrent.CompletableFuture<OrdersExpandedListRes> listForShipperOperatorsV1(ExpandedListForShipperOperatorsV1Request request)

Lists expanded orders for shipper operators with filtering, sorting, pagination, and optional search. | authz: allowed_org_types=[shipper], min_org_role=operator | (OrderAndTaskGroupExpandedReq) -> (OrdersExpandedListRes)

listForShipperOperatorsV1

public java.util.concurrent.CompletableFuture<OrdersExpandedListRes> listForShipperOperatorsV1(ExpandedListForShipperOperatorsV1Request request,
                                                                                               RequestOptions requestOptions)

Lists expanded orders for shipper operators with filtering, sorting, pagination, and optional search. | authz: allowed_org_types=[shipper], min_org_role=operator | (OrderAndTaskGroupExpandedReq) -> (OrdersExpandedListRes)

typeaheadV1

public java.util.concurrent.CompletableFuture<java.util.List<java.lang.String>> typeaheadV1(ExpandedTypeaheadV1Request request)

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

typeaheadV1

public java.util.concurrent.CompletableFuture<java.util.List<java.lang.String>> typeaheadV1(ExpandedTypeaheadV1Request request,
                                                                                            RequestOptions requestOptions)

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