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

Class RawOrderDraftsClient

java.lang.Object

com.chrt.api.resources.shipping.orderdrafts.RawOrderDraftsClient

public class RawOrderDraftsClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientOptions	clientOptions

Constructor Summary

Constructors

Constructor	Description
RawOrderDraftsClient(ClientOptions clientOptions)

Method Summary

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

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

RawOrderDraftsClient

public RawOrderDraftsClient(ClientOptions clientOptions)

Method Detail

newV1

public ChrtApiHttpResponse<OrdersNewDraftRes> newV1()

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

newV1

public ChrtApiHttpResponse<OrdersNewDraftRes> newV1(OrdersNewDraftReq request)

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

newV1

public ChrtApiHttpResponse<OrdersNewDraftRes> newV1(OrdersNewDraftReq request,
                                                    RequestOptions requestOptions)

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

updateV1

public ChrtApiHttpResponse<OrdersDraftUpdateRes> updateV1(java.lang.String orderId)

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

updateV1

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

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

updateV1

public ChrtApiHttpResponse<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 ChrtApiHttpResponse<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 ChrtApiHttpResponse<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 ChrtApiHttpResponse<java.lang.Boolean> deleteV1(java.lang.String orderId)

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

deleteV1

public ChrtApiHttpResponse<java.lang.Boolean> deleteV1(java.lang.String orderId,
                                                       RequestOptions requestOptions)

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

deleteManyV1

public ChrtApiHttpResponse<java.lang.Boolean> deleteManyV1(OrdersDraftDeleteManyReq request)

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

deleteManyV1

public ChrtApiHttpResponse<java.lang.Boolean> deleteManyV1(OrdersDraftDeleteManyReq request,
                                                           RequestOptions requestOptions)

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

imageToTextV1

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

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

validateV1

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

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