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

Class AsyncOrderDraftsClient

java.lang.Object

com.chrt.api.resources.shipping.orderdrafts.AsyncOrderDraftsClient

public class AsyncOrderDraftsClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected java.util.function.Supplier<AsyncAgenticClient>	agenticClient
protected java.util.function.Supplier<AsyncCargoClient>	cargoClient
protected ClientOptions	clientOptions
protected java.util.function.Supplier<AsyncExpandedClient>	expandedClient
protected java.util.function.Supplier<AsyncTaskArtifactClient>	taskArtifactClient
protected java.util.function.Supplier<AsyncTaskClient>	taskClient
protected java.util.function.Supplier<AsyncTaskGroupClient>	taskGroupClient

Constructor Summary

Constructors

Constructor	Description
AsyncOrderDraftsClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
AsyncAgenticClient	agentic()
AsyncCargoClient	cargo()
java.util.concurrent.CompletableFuture<java.lang.Boolean>	deleteManyV1(OrdersDraftDeleteManyReq request)	Deletes multiple draft orders and associated entities.
java.util.concurrent.CompletableFuture<java.lang.Boolean>	deleteManyV1(OrdersDraftDeleteManyReq request, RequestOptions requestOptions)	Deletes multiple draft orders and associated entities.
java.util.concurrent.CompletableFuture<java.lang.Boolean>	deleteV1(java.lang.String orderId)	Deletes a draft order and all associated entities.
java.util.concurrent.CompletableFuture<java.lang.Boolean>	deleteV1(java.lang.String orderId, RequestOptions requestOptions)	Deletes a draft order and all associated entities.
AsyncExpandedClient	expanded()
java.util.concurrent.CompletableFuture<java.lang.String>	imageToTextV1(java.io.File file, BodyPostShippingOrderDraftsImageToTextV1ShippingOrderDraftsImageToTextV1Post request)	Converts an order screenshot into lightly structured text for the AI order builder.
java.util.concurrent.CompletableFuture<java.lang.String>	imageToTextV1(java.io.File file, BodyPostShippingOrderDraftsImageToTextV1ShippingOrderDraftsImageToTextV1Post request, RequestOptions requestOptions)	Converts an order screenshot into lightly structured text for the AI order builder.
java.util.concurrent.CompletableFuture<OrdersNewDraftRes>	newV1()	Creates a new draft order with org assignments based on caller's organization type.
java.util.concurrent.CompletableFuture<OrdersNewDraftRes>	newV1(OrdersNewDraftReq request)	Creates a new draft order with org assignments based on caller's organization type.
java.util.concurrent.CompletableFuture<OrdersNewDraftRes>	newV1(OrdersNewDraftReq request, RequestOptions requestOptions)	Creates a new draft order with org assignments based on caller's organization type.
java.util.concurrent.CompletableFuture<java.lang.Boolean>	setTaskGroupOrderingV1(java.lang.String orderId, SetTaskGroupOrderingDraftReq request)	Sets the ordering of task groups within a draft order.
java.util.concurrent.CompletableFuture<java.lang.Boolean>	setTaskGroupOrderingV1(java.lang.String orderId, SetTaskGroupOrderingDraftReq request, RequestOptions requestOptions)	Sets the ordering of task groups within a draft order.
AsyncTaskClient	task()
AsyncTaskArtifactClient	taskArtifact()
AsyncTaskGroupClient	taskGroup()
java.util.concurrent.CompletableFuture<java.util.List<OrderTypeaheadResult>>	typeaheadV1(OrderDraftsTypeaheadV1Request 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(OrderDraftsTypeaheadV1Request request, RequestOptions requestOptions)	Returns distinct short_id and off_chrt_reference_id values matching the query via case-insensitive regex.
java.util.concurrent.CompletableFuture<OrdersDraftUpdateRes>	updateV1(java.lang.String orderId)	Updates coordinator and/or shipper org assignments for a draft order.
java.util.concurrent.CompletableFuture<OrdersDraftUpdateRes>	updateV1(java.lang.String orderId, OrdersDraftUpdateReq request)	Updates coordinator and/or shipper org assignments for a draft order.
java.util.concurrent.CompletableFuture<OrdersDraftUpdateRes>	updateV1(java.lang.String orderId, OrdersDraftUpdateReq request, RequestOptions requestOptions)	Updates coordinator and/or shipper org assignments for a draft order.
java.util.concurrent.CompletableFuture<OrderDraftValidationResult>	validateV1(java.lang.String orderId)	Validates the draft order for staging and returns requirement results.
java.util.concurrent.CompletableFuture<OrderDraftValidationResult>	validateV1(java.lang.String orderId, RequestOptions requestOptions)	Validates the draft order for staging and returns requirement results.
AsyncRawOrderDraftsClient	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

agenticClient

protected final java.util.function.Supplier<AsyncAgenticClient> agenticClient

taskGroupClient

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

taskClient

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

taskArtifactClient

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

cargoClient

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

expandedClient

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

Constructor Detail

AsyncOrderDraftsClient

public AsyncOrderDraftsClient(ClientOptions clientOptions)

Method Detail

withRawResponse

public AsyncRawOrderDraftsClient withRawResponse()

Get responses with HTTP metadata like headers

newV1

public java.util.concurrent.CompletableFuture<OrdersNewDraftRes> newV1()

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

newV1

public java.util.concurrent.CompletableFuture<OrdersNewDraftRes> newV1(OrdersNewDraftReq request)

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

newV1

public java.util.concurrent.CompletableFuture<OrdersNewDraftRes> newV1(OrdersNewDraftReq request,
                                                                       RequestOptions requestOptions)

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

updateV1

public java.util.concurrent.CompletableFuture<OrdersDraftUpdateRes> updateV1(java.lang.String orderId)

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

updateV1

public java.util.concurrent.CompletableFuture<OrdersDraftUpdateRes> updateV1(java.lang.String orderId,
                                                                             OrdersDraftUpdateReq request)

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

updateV1

public java.util.concurrent.CompletableFuture<OrdersDraftUpdateRes> updateV1(java.lang.String orderId,
                                                                             OrdersDraftUpdateReq request,
                                                                             RequestOptions requestOptions)

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

setTaskGroupOrderingV1

public java.util.concurrent.CompletableFuture<java.lang.Boolean> setTaskGroupOrderingV1(java.lang.String orderId,
                                                                                        SetTaskGroupOrderingDraftReq request)

Sets the ordering of task groups within a draft order. Must provide all task group IDs with no duplicates. | (SetTaskGroupOrderingDraftReq) -> (bool)

setTaskGroupOrderingV1

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

Sets the ordering of task groups within a draft order. Must provide all task group IDs with no duplicates. | (SetTaskGroupOrderingDraftReq) -> (bool)

deleteV1

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

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

deleteV1

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

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

deleteManyV1

public java.util.concurrent.CompletableFuture<java.lang.Boolean> deleteManyV1(OrdersDraftDeleteManyReq request)

Deletes multiple draft orders and associated entities. | (OrdersDraftDeleteManyReq) -> (bool)

deleteManyV1

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

Deletes multiple draft orders and associated entities. | (OrdersDraftDeleteManyReq) -> (bool)

imageToTextV1

public java.util.concurrent.CompletableFuture<java.lang.String> imageToTextV1(java.io.File file,
                                                                              BodyPostShippingOrderDraftsImageToTextV1ShippingOrderDraftsImageToTextV1Post request)

Converts an order screenshot into lightly structured text for the AI order builder. | (UploadFile) -> (str)

imageToTextV1

public java.util.concurrent.CompletableFuture<java.lang.String> imageToTextV1(java.io.File file,
                                                                              BodyPostShippingOrderDraftsImageToTextV1ShippingOrderDraftsImageToTextV1Post request,
                                                                              RequestOptions requestOptions)

Converts an order screenshot into lightly structured text for the AI order builder. | (UploadFile) -> (str)

typeaheadV1

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

Returns distinct short_id and off_chrt_reference_id values matching the query via case-insensitive regex. Searches draft orders created by the caller's org. | authz: min_org_role=operator | () -> (list[OrderTypeaheadResult])

typeaheadV1

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

Returns distinct short_id and off_chrt_reference_id values matching the query via case-insensitive regex. Searches draft orders created by the caller's org. | authz: min_org_role=operator | () -> (list[OrderTypeaheadResult])

validateV1

public java.util.concurrent.CompletableFuture<OrderDraftValidationResult> validateV1(java.lang.String orderId)

Validates the draft order for staging and returns requirement results. | () -> (OrderDraftValidationResult)

validateV1

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

Validates the draft order for staging and returns requirement results. | () -> (OrderDraftValidationResult)

agentic

public AsyncAgenticClient agentic()

taskGroup

public AsyncTaskGroupClient taskGroup()

task

public AsyncTaskClient task()

taskArtifact

public AsyncTaskArtifactClient taskArtifact()

cargo

public AsyncCargoClient cargo()

expanded

public AsyncExpandedClient expanded()