@de./sdk 1.0.5 → 2.0.0

package/src/allend/LSP/orders.ts

@@ -6,8 +6,13 @@ import type {
 	LSPOrderGetStatusValidation,
 	LSPOrderListValidation,
 	LSPOrderGetValidation,
-	LSPOrderSubscribeValidation
+	LSPOrderSubscribeValidation,
+	LSPOrderRequeueValidation
 } from '@de./types/lsp/order/management'
+import type {
+	LSPOrderIntakeCreateValidation,
+	LSPOrderIntakeApproveValidation
+} from '@de./types/lsp/order/delivery'
 import type {
 	LSPInboundOrderCreateValidation,
 	LSPInboundOrderCompleteValidation,
@@ -44,385 +49,349 @@ import type {
 	LSPShippingOrderRefOnlyValidation,
 	LSPShippingOrderCompleteValidation
 } from '@de./types/lsp/order/shipping'
-import { qs, type Http, type Res } from '../../utils'
+import { qs, type Http, type Res, type Data } from '../../utils'
 
 // ── LSP Orders ────────────────────────────────────────────────────────────────
 
 export default class LSPOrders {
 	constructor( private http: Http ){}
 
+	// ── Rally Intake ──────────────────────────────────────────────────────────
+
+	/**
+	 * Submit a delivery order for rally dispatch.
+	 *
+	 * `batchStatus` in the reply says what the engine did with it: FORMING and
+	 * DISPATCHED mean it joined a batch, DIRECT that it was sent on its own,
+	 * and the SENDER_* values that the sender's own limits stopped it. All four
+	 * are successful submissions — only an error is a failure to submit.
+	 */
+	async create( body: LSPOrderIntakeCreateValidation['body'] ): Promise<LSPOrderIntakeCreateValidation['response']> {
+		return await this.http.request<LSPOrderIntakeCreateValidation['response']>({
+			url: '/lsp/orders',
+			method: 'POST',
+			body
+		})
+	}
+
+	/** Release an order the engine is holding for the sender's approval. */
+	async approve( reference: string ): Promise<LSPOrderIntakeApproveValidation['response']> {
+		return await this.http.request<LSPOrderIntakeApproveValidation['response']>({
+			url: `/lsp/orders/${reference}/approve`,
+			method: 'POST'
+		})
+	}
+
 	// ── Order Management ──────────────────────────────────────────────────────
 
 	async list( querystring?: LSPOrderListValidation['querystring'] ): Promise<LSPOrderListValidation['response']> {
-		const { error, message, data } = await this.http.request<Res<LSPOrderListValidation['response']>>({
+		return await this.http.request<LSPOrderListValidation['response']>({
 			url: `/lsp/orders${qs( querystring )}`,
 			method: 'GET'
 		})
-		if( error ) throw new Error( message )
-		return data
 	}
 
 	async get( reference: string ): Promise<LSPOrderGetValidation['response']> {
-		const { error, message, data } = await this.http.request<Res<LSPOrderGetValidation['response']>>({
+		return await this.http.request<LSPOrderGetValidation['response']>({
 			url: `/lsp/orders/${reference}`,
 			method: 'GET'
 		})
-		if( error ) throw new Error( message )
-		return data
 	}
 
 	async getStatus( reference: string ): Promise<LSPOrderGetStatusValidation['response']> {
-		const { error, message, data } = await this.http.request<Res<LSPOrderGetStatusValidation['response']>>({
+		return await this.http.request<LSPOrderGetStatusValidation['response']>({
 			url: `/lsp/orders/${reference}/status`,
 			method: 'GET'
 		})
-		if( error ) throw new Error( message )
-		return data
 	}
 
 	async complete( reference: string, body: LSPOrderCompleteValidation['body'] ): Promise<LSPOrderCompleteValidation['response']> {
-		const { error, message, data } = await this.http.request<Res<LSPOrderCompleteValidation['response']>>({
+		return await this.http.request<LSPOrderCompleteValidation['response']>({
 			url: `/lsp/orders/${reference}/complete`,
 			method: 'PATCH',
 			body
 		})
-		if( error ) throw new Error( message )
-		return data
+	}
+
+	/**
+	 * Put a stalled order back into a zone's dispatch queue.
+	 *
+	 * The coordinator's intervention when nothing has picked the order up —
+	 * `zoneId` is where to try next, which need not be where it started.
+	 */
+	async requeue( reference: string, body: LSPOrderRequeueValidation['body'] ): Promise<LSPOrderRequeueValidation['response']> {
+		return await this.http.request<LSPOrderRequeueValidation['response']>({
+			url: `/lsp/orders/${reference}/requeue`,
+			method: 'POST',
+			body
+		})
 	}
 
 	async cancel( reference: string, body: LSPOrderCancelValidation['body'] ): Promise<LSPOrderCancelValidation['response']> {
-		const { error, message, data } = await this.http.request<Res<LSPOrderCancelValidation['response']>>({
+		return await this.http.request<LSPOrderCancelValidation['response']>({
 			url: `/lsp/orders/${reference}/cancel`,
 			method: 'PATCH',
 			body
 		})
-		if( error ) throw new Error( message )
-		return data
 	}
 
 	async fail( reference: string, body: LSPOrderFailValidation['body'] ): Promise<LSPOrderFailValidation['response']> {
-		const { error, message, data } = await this.http.request<Res<LSPOrderFailValidation['response']>>({
+		return await this.http.request<LSPOrderFailValidation['response']>({
 			url: `/lsp/orders/${reference}/fail`,
 			method: 'PATCH',
 			body
 		})
-		if( error ) throw new Error( message )
-		return data
 	}
 
 	async updateStage( reference: string, body: LSPOrderUpdateStageValidation['body'] ): Promise<LSPOrderUpdateStageValidation['response']> {
-		const { error, message, data } = await this.http.request<Res<LSPOrderUpdateStageValidation['response']>>({
+		return await this.http.request<LSPOrderUpdateStageValidation['response']>({
 			url: `/lsp/orders/${reference}/stage`,
 			method: 'PATCH',
 			body
 		})
-		if( error ) throw new Error( message )
-		return data
 	}
 
 	async subscribe( id: string, reference: string ): Promise<LSPOrderSubscribeValidation['response']> {
-		const { error, message, data } = await this.http.request<Res<LSPOrderSubscribeValidation['response']>>({
+		return await this.http.request<LSPOrderSubscribeValidation['response']>({
 			url: `/lsp/orders/${reference}/track/subscribe`,
 			method: 'POST',
 			body: { id }
 		})
-		if( error ) throw new Error( message )
-		return data
 	}
 
 	// ── Inbound Orders ────────────────────────────────────────────────────────
 
 	async createInbound( facilityId: string, body: LSPInboundOrderCreateValidation['body'] ): Promise<LSPInboundOrderCreateValidation['response']> {
-		const { error, message, data } = await this.http.request<Res<LSPInboundOrderCreateValidation['response']>>({
+		return await this.http.request<LSPInboundOrderCreateValidation['response']>({
 			url: `/lsp/${facilityId}/inbound/create`,
 			method: 'POST',
 			body
 		})
-		if( error ) throw new Error( message )
-		return data
 	}
 
 	async completeInbound( facilityId: string, reference: string, body: LSPInboundOrderCompleteValidation['body'] ): Promise<LSPInboundOrderCompleteValidation['response']> {
-		const { error, message, data } = await this.http.request<Res<LSPInboundOrderCompleteValidation['response']>>({
+		return await this.http.request<LSPInboundOrderCompleteValidation['response']>({
 			url: `/lsp/${facilityId}/inbound/${reference}/complete`,
 			method: 'POST',
 			body
 		})
-		if( error ) throw new Error( message )
-		return data
 	}
 
 	async listInbound( facilityId: string, querystring?: LSPInboundOrderListValidation['querystring'] ): Promise<LSPInboundOrderListValidation['response']> {
-		const { error, message, data } = await this.http.request<Res<LSPInboundOrderListValidation['response']>>({
+		return await this.http.request<LSPInboundOrderListValidation['response']>({
 			url: `/lsp/${facilityId}/inbound${qs( querystring )}`,
 			method: 'GET'
 		})
-		if( error ) throw new Error( message )
-		return data
 	}
 
 	async retrieveInbound( facilityId: string, reference: string ): Promise<LSPInboundOrderRetrieveValidation['response']> {
-		const { error, message, data } = await this.http.request<Res<LSPInboundOrderRetrieveValidation['response']>>({
+		return await this.http.request<LSPInboundOrderRetrieveValidation['response']>({
 			url: `/lsp/${facilityId}/inbound/${reference}`,
 			method: 'GET'
 		})
-		if( error ) throw new Error( message )
-		return data
 	}
 
 	async updateInbound( facilityId: string, reference: string, body: LSPInboundOrderUpdateValidation['body'] ): Promise<LSPInboundOrderUpdateValidation['response']> {
-		const { error, message, data } = await this.http.request<Res<LSPInboundOrderUpdateValidation['response']>>({
+		return await this.http.request<LSPInboundOrderUpdateValidation['response']>({
 			url: `/lsp/${facilityId}/inbound/${reference}`,
 			method: 'PATCH',
 			body
 		})
-		if( error ) throw new Error( message )
-		return data
 	}
 
 	async updateInboundStatus( facilityId: string, reference: string, body: LSPInboundOrderUpdateStatusValidation['body'] ): Promise<LSPInboundOrderUpdateStatusValidation['response']> {
-		const { error, message, data } = await this.http.request<Res<LSPInboundOrderUpdateStatusValidation['response']>>({
+		return await this.http.request<LSPInboundOrderUpdateStatusValidation['response']>({
 			url: `/lsp/${facilityId}/inbound/${reference}/status`,
 			method: 'PATCH',
 			body
 		})
-		if( error ) throw new Error( message )
-		return data
 	}
 
 	async assignOrUnassignInbound( facilityId: string, reference: string, action: LSPInboundOrderAssignValidation['params']['action'], to: LSPInboundOrderAssignValidation['params']['to'], body: LSPInboundOrderAssignValidation['body'] ): Promise<LSPInboundOrderAssignValidation['response']> {
-		const { error, message, data } = await this.http.request<Res<LSPInboundOrderAssignValidation['response']>>({
+		return await this.http.request<LSPInboundOrderAssignValidation['response']>({
 			url: `/lsp/${facilityId}/inbound/${reference}/${action}/${to}`,
 			method: 'PATCH',
 			body
 		})
-		if( error ) throw new Error( message )
-		return data
 	}
 
 	// ── Tasks ─────────────────────────────────────────────────────────────────
 
 	async createTask( facilityId: string, body: LSPTaskCreateValidation['body'] ): Promise<LSPTaskCreateValidation['response']> {
-		const { error, message, data } = await this.http.request<Res<LSPTaskCreateValidation['response']>>({
+		return await this.http.request<LSPTaskCreateValidation['response']>({
 			url: `/lsp/${facilityId}/tasks/create`,
 			method: 'POST',
 			body
 		})
-		if( error ) throw new Error( message )
-		return data
 	}
 
 	async createTaskBatch( facilityId: string, body: LSPTaskBatchCreateValidation['body'] ): Promise<LSPTaskBatchCreateValidation['response']> {
-		const { error, message, data } = await this.http.request<Res<LSPTaskBatchCreateValidation['response']>>({
+		return await this.http.request<LSPTaskBatchCreateValidation['response']>({
 			url: `/lsp/${facilityId}/tasks/batch`,
 			method: 'POST',
 			body
 		})
-		if( error ) throw new Error( message )
-		return data
 	}
 
 	async completeTask( facilityId: string, reference: string, body: LSPTaskCompleteValidation['body'] ): Promise<LSPTaskCompleteValidation['response']> {
-		const { error, message, data } = await this.http.request<Res<LSPTaskCompleteValidation['response']>>({
+		return await this.http.request<LSPTaskCompleteValidation['response']>({
 			url: `/lsp/${facilityId}/tasks/${reference}/complete`,
 			method: 'POST',
 			body
 		})
-		if( error ) throw new Error( message )
-		return data
 	}
 
 	async listTasks( facilityId: string, querystring?: LSPTaskListValidation['querystring'] ): Promise<LSPTaskListValidation['response']> {
-		const { error, message, data } = await this.http.request<Res<LSPTaskListValidation['response']>>({
+		return await this.http.request<LSPTaskListValidation['response']>({
 			url: `/lsp/${facilityId}/tasks${qs( querystring )}`,
 			method: 'GET'
 		})
-		if( error ) throw new Error( message )
-		return data
 	}
 
 	async retrieveTask( facilityId: string, reference: string ): Promise<LSPTaskRetrieveValidation['response']> {
-		const { error, message, data } = await this.http.request<Res<LSPTaskRetrieveValidation['response']>>({
+		return await this.http.request<LSPTaskRetrieveValidation['response']>({
 			url: `/lsp/${facilityId}/tasks/${reference}`,
 			method: 'GET'
 		})
-		if( error ) throw new Error( message )
-		return data
 	}
 
 	async getTaskPerformance( facilityId: string, querystring: LSPTaskPerformanceValidation['querystring'] ): Promise<LSPTaskPerformanceValidation['response']> {
-		const { error, message, data } = await this.http.request<Res<LSPTaskPerformanceValidation['response']>>({
+		return await this.http.request<LSPTaskPerformanceValidation['response']>({
 			url: `/lsp/${facilityId}/tasks/metrics/performance${qs( querystring )}`,
 			method: 'GET'
 		})
-		if( error ) throw new Error( message )
-		return data
 	}
 
 	async updateTask( facilityId: string, reference: string, body: LSPTaskUpdateValidation['body'] ): Promise<LSPTaskUpdateValidation['response']> {
-		const { error, message, data } = await this.http.request<Res<LSPTaskUpdateValidation['response']>>({
+		return await this.http.request<LSPTaskUpdateValidation['response']>({
 			url: `/lsp/${facilityId}/tasks/${reference}`,
 			method: 'PATCH',
 			body
 		})
-		if( error ) throw new Error( message )
-		return data
 	}
 
 	async updateTaskStatus( facilityId: string, reference: string, body: LSPTaskUpdateStatusValidation['body'] ): Promise<LSPTaskUpdateStatusValidation['response']> {
-		const { error, message, data } = await this.http.request<Res<LSPTaskUpdateStatusValidation['response']>>({
+		return await this.http.request<LSPTaskUpdateStatusValidation['response']>({
 			url: `/lsp/${facilityId}/tasks/${reference}/status`,
 			method: 'PATCH',
 			body
 		})
-		if( error ) throw new Error( message )
-		return data
 	}
 
 	async assignOrUnassignTask( facilityId: string, reference: string, action: LSPTaskAssignValidation['params']['action'], to: LSPTaskAssignValidation['params']['to'], body: LSPTaskAssignValidation['body'] ): Promise<LSPTaskAssignValidation['response']> {
-		const { error, message, data } = await this.http.request<Res<LSPTaskAssignValidation['response']>>({
+		return await this.http.request<LSPTaskAssignValidation['response']>({
 			url: `/lsp/${facilityId}/tasks/${reference}/${action}/${to}`,
 			method: 'PATCH',
 			body
 		})
-		if( error ) throw new Error( message )
-		return data
 	}
 
 	async cancelTask( facilityId: string, reference: string, body: LSPTaskCancelValidation['body'] ): Promise<LSPTaskCancelValidation['response']> {
-		const { error, message, data } = await this.http.request<Res<LSPTaskCancelValidation['response']>>({
+		return await this.http.request<LSPTaskCancelValidation['response']>({
 			url: `/lsp/${facilityId}/tasks/${reference}/cancel`,
 			method: 'DELETE',
 			body
 		})
-		if( error ) throw new Error( message )
-		return data
 	}
 
 	// ── Shipments ─────────────────────────────────────────────────────────────
 
 	async createShipment( reference: string, body: LSPShipmentCreateValidation['body'] ): Promise<LSPShipmentCreateValidation['response']> {
-		const { error, message, data } = await this.http.request<Res<LSPShipmentCreateValidation['response']>>({
+		return await this.http.request<LSPShipmentCreateValidation['response']>({
 			url: `/lsp/orders/${reference}/shipments`,
 			method: 'POST',
 			body
 		})
-		if( error ) throw new Error( message )
-		return data
 	}
 
 	async listShipments( querystring?: LSPShipmentFetchValidation['querystring'] ): Promise<LSPShipmentFetchValidation['response']> {
-		const { error, message, data } = await this.http.request<Res<LSPShipmentFetchValidation['response']>>({
+		return await this.http.request<LSPShipmentFetchValidation['response']>({
 			url: `/lsp/shipments${qs( querystring )}`,
 			method: 'GET'
 		})
-		if( error ) throw new Error( message )
-		return data
 	}
 
 	async retrieveShipment( reference: string ): Promise<LSPShipmentRetrieveValidation['response']> {
-		const { error, message, data } = await this.http.request<Res<LSPShipmentRetrieveValidation['response']>>({
+		return await this.http.request<LSPShipmentRetrieveValidation['response']>({
 			url: `/lsp/shipments/${reference}`,
 			method: 'GET'
 		})
-		if( error ) throw new Error( message )
-		return data
 	}
 
 	async updateShipment( reference: string, body: LSPShipmentUpdateValidation['body'] ): Promise<LSPShipmentUpdateValidation['response']> {
-		const { error, message, data } = await this.http.request<Res<LSPShipmentUpdateValidation['response']>>({
+		return await this.http.request<LSPShipmentUpdateValidation['response']>({
 			url: `/lsp/shipments/${reference}`,
 			method: 'PATCH',
 			body
 		})
-		if( error ) throw new Error( message )
-		return data
 	}
 
 	async updateShipmentStatus( reference: string, body: LSPShipmentUpdateStatusValidation['body'] ): Promise<LSPShipmentUpdateStatusValidation['response']> {
-		const { error, message, data } = await this.http.request<Res<LSPShipmentUpdateStatusValidation['response']>>({
+		return await this.http.request<LSPShipmentUpdateStatusValidation['response']>({
 			url: `/lsp/shipments/${reference}/status`,
 			method: 'PATCH',
 			body
 		})
-		if( error ) throw new Error( message )
-		return data
 	}
 
 	async addShipmentPackage( reference: string, body: LSPShipmentAddPackageValidation['body'] ): Promise<LSPShipmentAddPackageValidation['response']> {
-		const { error, message, data } = await this.http.request<Res<LSPShipmentAddPackageValidation['response']>>({
+		return await this.http.request<LSPShipmentAddPackageValidation['response']>({
 			url: `/lsp/shipments/${reference}/packages`,
 			method: 'POST',
 			body
 		})
-		if( error ) throw new Error( message )
-		return data
 	}
 
 	// ── Shipping Orders ───────────────────────────────────────────────────────
 
 	async listShipping( querystring?: LSPShippingOrderListValidation['querystring'] ): Promise<LSPShippingOrderListValidation['response']> {
-		const { error, message, data } = await this.http.request<Res<LSPShippingOrderListValidation['response']>>({
+		return await this.http.request<LSPShippingOrderListValidation['response']>({
 			url: `/lsp/shipping${qs( querystring )}`,
 			method: 'GET'
 		})
-		if( error ) throw new Error( message )
-		return data
 	}
 
 	async retrieveShipping( reference: string ): Promise<LSPShippingOrderRetrieveValidation['response']> {
-		const { error, message, data } = await this.http.request<Res<LSPShippingOrderRetrieveValidation['response']>>({
+		return await this.http.request<LSPShippingOrderRetrieveValidation['response']>({
 			url: `/lsp/shipping/${reference}`,
 			method: 'GET'
 		})
-		if( error ) throw new Error( message )
-		return data
 	}
 
 	async completeShipping( reference: string, body: LSPShippingOrderCompleteValidation['body'] ): Promise<LSPShippingOrderCompleteValidation['response']> {
-		const { error, message, data } = await this.http.request<Res<LSPShippingOrderCompleteValidation['response']>>({
+		return await this.http.request<LSPShippingOrderCompleteValidation['response']>({
 			url: `/lsp/shipping/${reference}/complete`,
 			method: 'PATCH',
 			body
 		})
-		if( error ) throw new Error( message )
-		return data
 	}
 
 	async approveShipping( reference: string ): Promise<LSPShippingOrderRefOnlyValidation['response']> {
-		const { error, message, data } = await this.http.request<Res<LSPShippingOrderRefOnlyValidation['response']>>({
+		return await this.http.request<LSPShippingOrderRefOnlyValidation['response']>({
 			url: `/lsp/shipping/${reference}/approve`,
 			method: 'PATCH'
 		})
-		if( error ) throw new Error( message )
-		return data
 	}
 
 	async suspendShipping( reference: string ): Promise<LSPShippingOrderRefOnlyValidation['response']> {
-		const { error, message, data } = await this.http.request<Res<LSPShippingOrderRefOnlyValidation['response']>>({
+		return await this.http.request<LSPShippingOrderRefOnlyValidation['response']>({
 			url: `/lsp/shipping/${reference}/suspend`,
 			method: 'PATCH'
 		})
-		if( error ) throw new Error( message )
-		return data
 	}
 
 	async cancelShipping( reference: string ): Promise<LSPShippingOrderRefOnlyValidation['response']> {
-		const { error, message, data } = await this.http.request<Res<LSPShippingOrderRefOnlyValidation['response']>>({
+		return await this.http.request<LSPShippingOrderRefOnlyValidation['response']>({
 			url: `/lsp/shipping/${reference}/cancel`,
 			method: 'PATCH'
 		})
-		if( error ) throw new Error( message )
-		return data
 	}
 
 	async assignOrUnassignShipping( reference: string, action: 'assign' | 'unassign', to: 'agent' | 'operator', body: { id: string } ): Promise<LSPShippingOrderAssignOrUnassignValidation['response']> {
-		const { error, message, data } = await this.http.request<Res<LSPShippingOrderAssignOrUnassignValidation['response']>>({
+		return await this.http.request<LSPShippingOrderAssignOrUnassignValidation['response']>({
 			url: `/lsp/shipping/${reference}/${action}/${to}`,
 			method: 'PATCH',
 			body
 		})
-		if( error ) throw new Error( message )
-		return data
 	}
 }