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<AgenticClient>	agenticClient
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
AgenticClient	agentic()
CargoClient	cargo()
boolean	deleteManyV1(OrdersDraftDeleteManyReq request)	Deletes multiple draft orders and associated entities.
boolean	deleteManyV1(OrdersDraftDeleteManyReq request, RequestOptions requestOptions)	Deletes multiple draft orders and associated entities.
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()
java.lang.String	imageToTextV1(java.io.File file, BodyPostShippingOrderDraftsImageToTextV1ShippingOrderDraftsImageToTextV1Post request)	Converts an order screenshot into lightly structured text for the AI order builder.
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.
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.
boolean	setTaskGroupOrderingV1(java.lang.String orderId, SetTaskGroupOrderingDraftReq request)	Sets the ordering of task groups within a draft order.
boolean	setTaskGroupOrderingV1(java.lang.String orderId, SetTaskGroupOrderingDraftReq request, RequestOptions requestOptions)	Sets the ordering of task groups within a draft order.
TaskClient	task()
TaskArtifactClient	taskArtifact()
TaskGroupClient	taskGroup()
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.List<OrderTypeaheadResult>	typeaheadV1(OrderDraftsTypeaheadV1Request request, RequestOptions requestOptions)	Returns distinct short_id and off_chrt_reference_id values matching the query via case-insensitive regex.
OrdersDraftUpdateRes	updateV1(java.lang.String orderId)	Updates coordinator and/or shipper org assignments for a draft order.
OrdersDraftUpdateRes	updateV1(java.lang.String orderId, OrdersDraftUpdateReq request)	Updates coordinator and/or shipper org assignments for a draft order.
OrdersDraftUpdateRes	updateV1(java.lang.String orderId, OrdersDraftUpdateReq request, RequestOptions requestOptions)	Updates coordinator and/or shipper org assignments for a draft order.
OrderDraftValidationResult	validateV1(java.lang.String orderId)	Validates the draft order for staging and returns requirement results.
OrderDraftValidationResult	validateV1(java.lang.String orderId, RequestOptions requestOptions)	Validates the draft order for staging and returns requirement results.
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

agenticClient

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

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 coordinator and/or shipper org assignments for a draft order. | (OrdersDraftUpdateReq) -> (OrdersDraftUpdateRes)

updateV1

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

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

updateV1

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

deleteManyV1

public boolean deleteManyV1(OrdersDraftDeleteManyReq request)

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

deleteManyV1

public boolean deleteManyV1(OrdersDraftDeleteManyReq request,
                            RequestOptions requestOptions)

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

imageToTextV1

public 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.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.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.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 OrderDraftValidationResult validateV1(java.lang.String orderId)

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

validateV1

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

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

agentic

public AgenticClient agentic()

taskGroup

public TaskGroupClient taskGroup()

task

public TaskClient task()

taskArtifact

public TaskArtifactClient taskArtifact()

cargo

public CargoClient cargo()

expanded

public ExpandedClient expanded()