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

Class ExpandedClient

java.lang.Object

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

public class ExpandedClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientOptions	clientOptions

Constructor Summary

Constructors

Constructor	Description
ExpandedClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
OrderExpanded	forCoordinatorOperatorsV1(java.lang.String orderRef)	Retrieves an expanded order with optional related data for coordinator operators (the provider org coordinating the order).
OrderExpanded	forCoordinatorOperatorsV1(java.lang.String orderRef, OrderAndTaskGroupExpandedReq request)	Retrieves an expanded order with optional related data for coordinator operators (the provider org coordinating the order).
OrderExpanded	forCoordinatorOperatorsV1(java.lang.String orderRef, OrderAndTaskGroupExpandedReq request, RequestOptions requestOptions)	Retrieves an expanded order with optional related data for coordinator operators (the provider org coordinating the order).
OrderExpanded	forShipperOperatorsV1(java.lang.String orderRef)	Retrieves an expanded order with optional related data for shipper operators.
OrderExpanded	forShipperOperatorsV1(java.lang.String orderRef, OrderAndTaskGroupExpandedReq request)	Retrieves an expanded order with optional related data for shipper operators.
OrderExpanded	forShipperOperatorsV1(java.lang.String orderRef, OrderAndTaskGroupExpandedReq request, RequestOptions requestOptions)	Retrieves an expanded order with optional related data for shipper operators.
OrdersExpandedListRes	listForCoordinatorOperatorsV1(ExpandedListForCoordinatorOperatorsV1Request request)	Lists expanded orders where the caller's provider org is the coordinator.
OrdersExpandedListRes	listForCoordinatorOperatorsV1(ExpandedListForCoordinatorOperatorsV1Request request, RequestOptions requestOptions)	Lists expanded orders where the caller's provider org is the coordinator.
OrdersExpandedListRes	listForShipperOperatorsV1(ExpandedListForShipperOperatorsV1Request request)	Lists expanded orders for shipper operators with filtering, sorting, pagination, and optional search.
OrdersExpandedListRes	listForShipperOperatorsV1(ExpandedListForShipperOperatorsV1Request request, RequestOptions requestOptions)	Lists expanded orders for shipper operators with filtering, sorting, pagination, and optional search.
RawExpandedClient	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

ExpandedClient

public ExpandedClient(ClientOptions clientOptions)

Method Detail

withRawResponse

public RawExpandedClient withRawResponse()

Get responses with HTTP metadata like headers

forShipperOperatorsV1

public OrderExpanded forShipperOperatorsV1(java.lang.String orderRef)

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

forShipperOperatorsV1

public OrderExpanded forShipperOperatorsV1(java.lang.String orderRef,
                                           OrderAndTaskGroupExpandedReq request)

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

forShipperOperatorsV1

public OrderExpanded forShipperOperatorsV1(java.lang.String orderRef,
                                           OrderAndTaskGroupExpandedReq request,
                                           RequestOptions requestOptions)

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

forCoordinatorOperatorsV1

public OrderExpanded forCoordinatorOperatorsV1(java.lang.String orderRef)

Retrieves an expanded order with optional related data for coordinator operators (the provider org coordinating the order). | authz_personas=[coordinator_org_operators] | (OrderAndTaskGroupExpandedReq) -> (OrderExpanded)

forCoordinatorOperatorsV1

public OrderExpanded forCoordinatorOperatorsV1(java.lang.String orderRef,
                                               OrderAndTaskGroupExpandedReq request)

Retrieves an expanded order with optional related data for coordinator operators (the provider org coordinating the order). | authz_personas=[coordinator_org_operators] | (OrderAndTaskGroupExpandedReq) -> (OrderExpanded)

forCoordinatorOperatorsV1

public OrderExpanded forCoordinatorOperatorsV1(java.lang.String orderRef,
                                               OrderAndTaskGroupExpandedReq request,
                                               RequestOptions requestOptions)

Retrieves an expanded order with optional related data for coordinator operators (the provider org coordinating the order). | authz_personas=[coordinator_org_operators] | (OrderAndTaskGroupExpandedReq) -> (OrderExpanded)

listForCoordinatorOperatorsV1

public OrdersExpandedListRes listForCoordinatorOperatorsV1(ExpandedListForCoordinatorOperatorsV1Request request)

Lists expanded orders where the caller's provider org is the coordinator. Filtering, sorting, pagination, optional search. | authz: allowed_org_types=[provider], min_org_role=operator | (OrderAndTaskGroupExpandedReq) -> (OrdersExpandedListRes)

listForCoordinatorOperatorsV1

public OrdersExpandedListRes listForCoordinatorOperatorsV1(ExpandedListForCoordinatorOperatorsV1Request request,
                                                           RequestOptions requestOptions)

Lists expanded orders where the caller's provider org is the coordinator. Filtering, sorting, pagination, optional search. | authz: allowed_org_types=[provider], min_org_role=operator | (OrderAndTaskGroupExpandedReq) -> (OrdersExpandedListRes)

listForShipperOperatorsV1

public 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 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)