Package com.chrt.api.resources.shipping.orderschedules

Class OrderSchedulesClient

java.lang.Object

com.chrt.api.resources.shipping.orderschedules.OrderSchedulesClient

public class OrderSchedulesClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientOptions	clientOptions
protected java.util.function.Supplier<DraftClient>	draftClient
protected java.util.function.Supplier<OrderManifestClient>	orderManifestClient

Constructor Summary

Constructors

Constructor	Description
OrderSchedulesClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
OrderScheduleAboutRes	aboutV1(java.lang.String orderScheduleId)	Retrieves the generated order count and live orchestrator status from Temporal.
OrderScheduleAboutRes	aboutV1(java.lang.String orderScheduleId, RequestOptions requestOptions)	Retrieves the generated order count and live orchestrator status from Temporal.
boolean	activateV1(java.lang.String orderScheduleId)	Validates a draft order schedule, creates its Temporal orchestrator schedule, and activates it.
boolean	activateV1(java.lang.String orderScheduleId, RequestOptions requestOptions)	Validates a draft order schedule, creates its Temporal orchestrator schedule, and activates it.
boolean	archiveV1(java.lang.String orderScheduleId)	Archives an order schedule and deletes its Temporal schedule, preventing future runs.
boolean	archiveV1(java.lang.String orderScheduleId, RequestOptions requestOptions)	Archives an order schedule and deletes its Temporal schedule, preventing future runs.
DraftClient	draft()
OrderSchedule1	getByIdV1(java.lang.String orderScheduleId)	Retrieves an order schedule by ID.
OrderSchedule1	getByIdV1(java.lang.String orderScheduleId, RequestOptions requestOptions)	Retrieves an order schedule by ID.
OrderScheduleListRes	listV1()	Lists order schedules for the caller's organization with filtering, sorting, and pagination.
OrderScheduleListRes	listV1(OrderSchedulesListV1Request request)	Lists order schedules for the caller's organization with filtering, sorting, and pagination.
OrderScheduleListRes	listV1(OrderSchedulesListV1Request request, RequestOptions requestOptions)	Lists order schedules for the caller's organization with filtering, sorting, and pagination.
OrderManifestClient	orderManifest()
boolean	pauseV1(java.lang.String orderScheduleId)	Pauses an active order schedule.
boolean	pauseV1(java.lang.String orderScheduleId, RequestOptions requestOptions)	Pauses an active order schedule.
boolean	syncWithOrchestratorV1(java.lang.String orderScheduleId)	Re-syncs the Temporal schedule to match the order schedule's intended status.
boolean	syncWithOrchestratorV1(java.lang.String orderScheduleId, RequestOptions requestOptions)	Re-syncs the Temporal schedule to match the order schedule's intended status.
boolean	takeOwnershipV1(java.lang.String orderScheduleId)	Transfers order schedule workflow ownership to the caller.
boolean	takeOwnershipV1(java.lang.String orderScheduleId, RequestOptions requestOptions)	Transfers order schedule workflow ownership to the caller.
boolean	triggerV1(java.lang.String orderScheduleId)	Triggers an order schedule immediately.
boolean	triggerV1(java.lang.String orderScheduleId, RequestOptions requestOptions)	Triggers an order schedule immediately.
boolean	unpauseV1(java.lang.String orderScheduleId)	Unpauses a paused order schedule.
boolean	unpauseV1(java.lang.String orderScheduleId, RequestOptions requestOptions)	Unpauses a paused order schedule.
RawOrderSchedulesClient	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

draftClient

protected final java.util.function.Supplier<DraftClient> draftClient

orderManifestClient

protected final java.util.function.Supplier<OrderManifestClient> orderManifestClient

Constructor Detail

OrderSchedulesClient

public OrderSchedulesClient(ClientOptions clientOptions)

Method Detail

withRawResponse

public RawOrderSchedulesClient withRawResponse()

Get responses with HTTP metadata like headers

listV1

public OrderScheduleListRes listV1()

Lists order schedules for the caller's organization with filtering, sorting, and pagination. | authz: min_org_role=operator | () -> (OrderScheduleListRes)

listV1

public OrderScheduleListRes listV1(OrderSchedulesListV1Request request)

Lists order schedules for the caller's organization with filtering, sorting, and pagination. | authz: min_org_role=operator | () -> (OrderScheduleListRes)

listV1

public OrderScheduleListRes listV1(OrderSchedulesListV1Request request,
                                   RequestOptions requestOptions)

Lists order schedules for the caller's organization with filtering, sorting, and pagination. | authz: min_org_role=operator | () -> (OrderScheduleListRes)

getByIdV1

public OrderSchedule1 getByIdV1(java.lang.String orderScheduleId)

Retrieves an order schedule by ID. | authz: min_org_role=operator | () -> (OrderSchedule1)

getByIdV1

public OrderSchedule1 getByIdV1(java.lang.String orderScheduleId,
                                RequestOptions requestOptions)

Retrieves an order schedule by ID. | authz: min_org_role=operator | () -> (OrderSchedule1)

aboutV1

public OrderScheduleAboutRes aboutV1(java.lang.String orderScheduleId)

Retrieves the generated order count and live orchestrator status from Temporal. | authz: min_org_role=operator | () -> (OrderScheduleAboutRes)

aboutV1

public OrderScheduleAboutRes aboutV1(java.lang.String orderScheduleId,
                                     RequestOptions requestOptions)

Retrieves the generated order count and live orchestrator status from Temporal. | authz: min_org_role=operator | () -> (OrderScheduleAboutRes)

activateV1

public boolean activateV1(java.lang.String orderScheduleId)

Validates a draft order schedule, creates its Temporal orchestrator schedule, and activates it. | authz: min_org_role=operator | () -> (bool)

activateV1

public boolean activateV1(java.lang.String orderScheduleId,
                          RequestOptions requestOptions)

Validates a draft order schedule, creates its Temporal orchestrator schedule, and activates it. | authz: min_org_role=operator | () -> (bool)

triggerV1

public boolean triggerV1(java.lang.String orderScheduleId)

Triggers an order schedule immediately. | authz: min_org_role=operator | () -> (bool)

triggerV1

public boolean triggerV1(java.lang.String orderScheduleId,
                         RequestOptions requestOptions)

Triggers an order schedule immediately. | authz: min_org_role=operator | () -> (bool)

pauseV1

public boolean pauseV1(java.lang.String orderScheduleId)

Pauses an active order schedule. | authz: min_org_role=operator | () -> (bool)

pauseV1

public boolean pauseV1(java.lang.String orderScheduleId,
                       RequestOptions requestOptions)

Pauses an active order schedule. | authz: min_org_role=operator | () -> (bool)

unpauseV1

public boolean unpauseV1(java.lang.String orderScheduleId)

Unpauses a paused order schedule. | authz: min_org_role=operator | () -> (bool)

unpauseV1

public boolean unpauseV1(java.lang.String orderScheduleId,
                         RequestOptions requestOptions)

Unpauses a paused order schedule. | authz: min_org_role=operator | () -> (bool)

takeOwnershipV1

public boolean takeOwnershipV1(java.lang.String orderScheduleId)

Transfers order schedule workflow ownership to the caller. | authz: min_org_role=operator | () -> (bool)

takeOwnershipV1

public boolean takeOwnershipV1(java.lang.String orderScheduleId,
                               RequestOptions requestOptions)

Transfers order schedule workflow ownership to the caller. | authz: min_org_role=operator | () -> (bool)

archiveV1

public boolean archiveV1(java.lang.String orderScheduleId)

Archives an order schedule and deletes its Temporal schedule, preventing future runs. | authz: min_org_role=operator | () -> (bool)

archiveV1

public boolean archiveV1(java.lang.String orderScheduleId,
                         RequestOptions requestOptions)

Archives an order schedule and deletes its Temporal schedule, preventing future runs. | authz: min_org_role=operator | () -> (bool)

syncWithOrchestratorV1

public boolean syncWithOrchestratorV1(java.lang.String orderScheduleId)

Re-syncs the Temporal schedule to match the order schedule's intended status. | authz: min_org_role=operator | () -> (bool)

syncWithOrchestratorV1

public boolean syncWithOrchestratorV1(java.lang.String orderScheduleId,
                                      RequestOptions requestOptions)

Re-syncs the Temporal schedule to match the order schedule's intended status. | authz: min_org_role=operator | () -> (bool)

draft

public DraftClient draft()

orderManifest

public OrderManifestClient orderManifest()