comicstockmcp 0.0.2

package/resources/suppliers/orders/creation.mjs

@@ -0,0 +1,35 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../../../core/resource.mjs";
+import { path } from "../../../internal/utils/path.mjs";
+export class Creation extends APIResource {
+    /**
+     * Returns all comic issues that have at least one supplier quote, paginated. Each
+     * issue includes its available stock per condition and the latest quote per
+     * supplier per condition.
+     *
+     * If `issueIds` is provided (e.g. from the Dashboard Low Stock flow), those issues
+     * are returned first and pre-selected in the UI.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.suppliers.orders.creation.listIssues();
+     * ```
+     */
+    listIssues(query = {}, options) {
+        return this._client.get('/api/Suppliers/orders/creation/issues', { query, ...options });
+    }
+    /**
+     * Get a single issue with quotes for the order creation wizard
+     *
+     * @example
+     * ```ts
+     * const supplierCreateOrderItems =
+     *   await client.suppliers.orders.creation.retrieveIssue(0);
+     * ```
+     */
+    retrieveIssue(issueID, options) {
+        return this._client.get(path `/api/Suppliers/orders/creation/issue/${issueID}`, options);
+    }
+}
+//# sourceMappingURL=creation.mjs.map

package/resources/suppliers/orders/creation.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"creation.mjs","sourceRoot":"","sources":["../../../src/resources/suppliers/orders/creation.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;;;;OAaG;IACH,UAAU,CACR,QAAqD,EAAE,EACvD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,uCAAuC,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1F,CAAC;IAED;;;;;;;;OAQG;IACH,aAAa,CAAC,OAAe,EAAE,OAAwB;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,wCAAwC,OAAO,EAAE,EAAE,OAAO,CAAC,CAAC;IAC1F,CAAC;CACF"}

package/resources/suppliers/orders/index.d.mts

@@ -0,0 +1,3 @@
+export { Creation, type SupplierCreateOrderItems, type CreationListIssuesResponse, type CreationListIssuesParams, } from "./creation.mjs";
+export { Orders, type SupplierOrderDetail, type SupplierPaymentSummary, type OrderListResponse, type OrderStatusCountsResponse, type OrderCreateParams, type OrderUpdateParams, type OrderListParams, type OrderRecordPaymentParams, } from "./orders.mjs";
+//# sourceMappingURL=index.d.mts.map

package/resources/suppliers/orders/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../../src/resources/suppliers/orders/index.ts"],"names":[],"mappings":"OAEO,EACL,QAAQ,EACR,KAAK,wBAAwB,EAC7B,KAAK,0BAA0B,EAC/B,KAAK,wBAAwB,GAC9B;OACM,EACL,MAAM,EACN,KAAK,mBAAmB,EACxB,KAAK,sBAAsB,EAC3B,KAAK,iBAAiB,EACtB,KAAK,yBAAyB,EAC9B,KAAK,iBAAiB,EACtB,KAAK,iBAAiB,EACtB,KAAK,eAAe,EACpB,KAAK,wBAAwB,GAC9B"}

package/resources/suppliers/orders/index.d.ts

@@ -0,0 +1,3 @@
+export { Creation, type SupplierCreateOrderItems, type CreationListIssuesResponse, type CreationListIssuesParams, } from "./creation.js";
+export { Orders, type SupplierOrderDetail, type SupplierPaymentSummary, type OrderListResponse, type OrderStatusCountsResponse, type OrderCreateParams, type OrderUpdateParams, type OrderListParams, type OrderRecordPaymentParams, } from "./orders.js";
+//# sourceMappingURL=index.d.ts.map

package/resources/suppliers/orders/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/resources/suppliers/orders/index.ts"],"names":[],"mappings":"OAEO,EACL,QAAQ,EACR,KAAK,wBAAwB,EAC7B,KAAK,0BAA0B,EAC/B,KAAK,wBAAwB,GAC9B;OACM,EACL,MAAM,EACN,KAAK,mBAAmB,EACxB,KAAK,sBAAsB,EAC3B,KAAK,iBAAiB,EACtB,KAAK,yBAAyB,EAC9B,KAAK,iBAAiB,EACtB,KAAK,iBAAiB,EACtB,KAAK,eAAe,EACpB,KAAK,wBAAwB,GAC9B"}

package/resources/suppliers/orders/index.js

@@ -0,0 +1,9 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Orders = exports.Creation = void 0;
+var creation_1 = require("./creation.js");
+Object.defineProperty(exports, "Creation", { enumerable: true, get: function () { return creation_1.Creation; } });
+var orders_1 = require("./orders.js");
+Object.defineProperty(exports, "Orders", { enumerable: true, get: function () { return orders_1.Orders; } });
+//# sourceMappingURL=index.js.map

package/resources/suppliers/orders/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/resources/suppliers/orders/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,0CAKoB;AAJlB,oGAAA,QAAQ,OAAA;AAKV,sCAUkB;AAThB,gGAAA,MAAM,OAAA"}

package/resources/suppliers/orders/index.mjs

@@ -0,0 +1,4 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+export { Creation, } from "./creation.mjs";
+export { Orders, } from "./orders.mjs";
+//# sourceMappingURL=index.mjs.map

package/resources/suppliers/orders/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../../src/resources/suppliers/orders/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EACL,QAAQ,GAIT;OACM,EACL,MAAM,GASP"}

package/resources/suppliers/orders/orders.d.mts

@@ -0,0 +1,263 @@
+import { APIResource } from "../../../core/resource.mjs";
+import * as CreationAPI from "./creation.mjs";
+import { Creation, CreationListIssuesParams, CreationListIssuesResponse, SupplierCreateOrderItems } from "./creation.mjs";
+import { APIPromise } from "../../../core/api-promise.mjs";
+import { RequestOptions } from "../../../internal/request-options.mjs";
+export declare class Orders extends APIResource {
+    creation: CreationAPI.Creation;
+    /**
+     * Creates a supplier order with status `Drafted`. Called once per supplier from
+     * the order creation wizard (Step 2). The client groups selected quotes by
+     * `supplierId` and calls this endpoint in parallel via `forkJoin`.
+     *
+     * **State machine entry point:** Drafted → Ordered → In Transit → Delivered
+     *
+     * @example
+     * ```ts
+     * const supplierOrderDetail =
+     *   await client.suppliers.orders.create();
+     * ```
+     */
+    create(body: OrderCreateParams, options?: RequestOptions): APIPromise<SupplierOrderDetail>;
+    /**
+     * Get a single supplier order by ID
+     *
+     * @example
+     * ```ts
+     * const supplierOrderDetail =
+     *   await client.suppliers.orders.retrieve(0);
+     * ```
+     */
+    retrieve(orderID: number, options?: RequestOptions): APIPromise<SupplierOrderDetail>;
+    /**
+     * Advances the order through the state machine or records shipment details.
+     *
+     * **Allowed transitions:**
+     *
+     * - `Ordered → In Transit` (requires `shippedReference` and `shipmentDate`)
+     * - `Ordered → Cancelled`
+     * - `In Transit → Delivered` (requires actual `shipmentDate`)
+     * - `In Transit → Damaged` (requires `damageComment`)
+     *
+     * @example
+     * ```ts
+     * await client.suppliers.orders.update(0);
+     * ```
+     */
+    update(orderID: number, body: OrderUpdateParams, options?: RequestOptions): APIPromise<void>;
+    /**
+     * Returns all supplier orders. Optionally filter by status string (e.g. 'Drafted',
+     * 'Ordered', 'In Transit', 'Delivered') and search by supplier name.
+     *
+     * @example
+     * ```ts
+     * const orders = await client.suppliers.orders.list();
+     * ```
+     */
+    list(query?: OrderListParams | null | undefined, options?: RequestOptions): APIPromise<OrderListResponse>;
+    /**
+     * Transitions a supplier order from `Drafted` to `Ordered`, indicating that the
+     * purchase order has been sent to the supplier.
+     *
+     * @example
+     * ```ts
+     * await client.suppliers.orders.confirm(0);
+     * ```
+     */
+    confirm(orderID: number, options?: RequestOptions): APIPromise<void>;
+    /**
+     * Creates a payment record linked to a supplier order. One order can have at most
+     * one payment. Typically called after the supplier invoice is settled.
+     *
+     * @example
+     * ```ts
+     * const supplierPaymentSummary =
+     *   await client.suppliers.orders.recordPayment(0);
+     * ```
+     */
+    recordPayment(orderID: number, body: OrderRecordPaymentParams, options?: RequestOptions): APIPromise<SupplierPaymentSummary>;
+    /**
+     * Returns a map of `{ status: count }` for all supplier orders. Used by the
+     * Suppliers page tab badges.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.suppliers.orders.statusCounts();
+     * ```
+     */
+    statusCounts(options?: RequestOptions): APIPromise<OrderStatusCountsResponse>;
+}
+/**
+ * Full detail for a supplier restock order including summary, payment, and line
+ * items.
+ */
+export interface SupplierOrderDetail {
+    items?: Array<SupplierOrderDetail.Item> | null;
+    /**
+     * Summary of a payment made to a supplier for a restock order.
+     */
+    payment?: SupplierPaymentSummary;
+    /**
+     * Summary fields for a supplier restock order.
+     */
+    supplierOrderSummary?: SupplierOrderDetail.SupplierOrderSummary;
+}
+export declare namespace SupplierOrderDetail {
+    /**
+     * A line item in a supplier restock order.
+     */
+    interface Item {
+        condition?: string | null;
+        issueTitle?: string | null;
+        /**
+         * unitPrice × quantity.
+         */
+        itemTotalPrice?: number;
+        quantity?: number;
+        stockItemId?: number;
+        /**
+         * Price per unit from the supplier quote.
+         */
+        unitPrice?: number;
+    }
+    /**
+     * Summary fields for a supplier restock order.
+     */
+    interface SupplierOrderSummary {
+        comment?: string | null;
+        /**
+         * Current status in the state machine: Drafted | Ordered | In Transit | Delivered
+         * | Cancelled | Damaged.
+         */
+        deliveryStatus?: string | null;
+        orderDate?: string;
+        orderId?: number;
+        /**
+         * Expected or actual shipment date (YYYY-MM-DD).
+         */
+        shipmentDate?: string | null;
+        /**
+         * Supplier shipment tracking reference.
+         */
+        shippedReference?: string | null;
+        supplierId?: number;
+        supplierName?: string | null;
+        total?: number;
+    }
+}
+/**
+ * Summary of a payment made to a supplier for a restock order.
+ */
+export interface SupplierPaymentSummary {
+    paymentId?: number;
+    paymentReference?: string | null;
+    processedDate?: string | null;
+    status?: string | null;
+    supplierName?: string | null;
+    total?: number;
+}
+/**
+ * Paginated result wrapping SupplierOrderDetailDto items.
+ */
+export interface OrderListResponse {
+    items?: Array<SupplierOrderDetail> | null;
+    page?: number;
+    pageSize?: number;
+    totalCount?: number;
+    totalPages?: number;
+}
+export type OrderStatusCountsResponse = {
+    [key: string]: number;
+};
+export interface OrderCreateParams {
+    /**
+     * Optional order-level note.
+     */
+    comment?: string | null;
+    /**
+     * One or more line items (stock item + quantity + unit price).
+     */
+    lineItems?: Array<OrderCreateParams.LineItem> | null;
+    /**
+     * Date the order is raised (ISO 8601).
+     */
+    orderDate?: string;
+    /**
+     * Supplier to place the order with.
+     */
+    supplierId?: number;
+}
+export declare namespace OrderCreateParams {
+    /**
+     * A single line item in the CreateSupplierOrderDTO request.
+     */
+    interface LineItem {
+        quantity?: number;
+        /**
+         * StockItem (issue + condition) to order.
+         */
+        stockItemId?: number;
+        /**
+         * Agreed unit price from the supplier quote.
+         */
+        unitPrice?: number;
+    }
+}
+export interface OrderUpdateParams {
+    /**
+     * Required when transitioning to Damaged.
+     */
+    damageComment?: string | null;
+    /**
+     * New delivery status. Allowed: In Transit | Delivered | Cancelled | Damaged.
+     */
+    deliveryStatus?: string | null;
+    /**
+     * Expected shipment date (In Transit) or actual delivery date (Delivered). Format:
+     * YYYY-MM-DD.
+     */
+    shipmentDate?: string | null;
+    /**
+     * Required when transitioning to In Transit.
+     */
+    shippedReference?: string | null;
+}
+export interface OrderListParams {
+    /**
+     * 1-based page number.
+     */
+    page?: number;
+    /**
+     * Records per page.
+     */
+    pageSize?: number;
+    /**
+     * Search matched against supplier name.
+     */
+    searchTerm?: string;
+    /**
+     * Filter by delivery status. Allowed values: `Drafted`, `Ordered`, `In Transit`,
+     * `Delivered`, `Cancelled`, `Damaged`.
+     */
+    status?: string;
+}
+export interface OrderRecordPaymentParams {
+    /**
+     * Bank or EFT reference number.
+     */
+    paymentReference?: string | null;
+    /**
+     * Date the payment was processed (ISO 8601).
+     */
+    processedDate?: string;
+    /**
+     * Total amount paid.
+     */
+    total?: number;
+}
+export declare namespace Orders {
+    export { type SupplierOrderDetail as SupplierOrderDetail, type SupplierPaymentSummary as SupplierPaymentSummary, type OrderListResponse as OrderListResponse, type OrderStatusCountsResponse as OrderStatusCountsResponse, type OrderCreateParams as OrderCreateParams, type OrderUpdateParams as OrderUpdateParams, type OrderListParams as OrderListParams, type OrderRecordPaymentParams as OrderRecordPaymentParams, };
+    export { Creation as Creation, type SupplierCreateOrderItems as SupplierCreateOrderItems, type CreationListIssuesResponse as CreationListIssuesResponse, type CreationListIssuesParams as CreationListIssuesParams, };
+}
+//# sourceMappingURL=orders.d.mts.map

package/resources/suppliers/orders/orders.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"orders.d.mts","sourceRoot":"","sources":["../../../src/resources/suppliers/orders/orders.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,WAAW;OAChB,EACL,QAAQ,EACR,wBAAwB,EACxB,0BAA0B,EAC1B,wBAAwB,EACzB;OACM,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAGzB,qBAAa,MAAO,SAAQ,WAAW;IACrC,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAA0C;IAExE;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,IAAI,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mBAAmB,CAAC;IAI1F;;;;;;;;OAQG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mBAAmB,CAAC;IAIpF;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAQ5F;;;;;;;;OAQG;IACH,IAAI,CACF,KAAK,GAAE,eAAe,GAAG,IAAI,GAAG,SAAc,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iBAAiB,CAAC;IAIhC;;;;;;;;OAQG;IACH,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAOpE;;;;;;;;;OASG;IACH,aAAa,CACX,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,wBAAwB,EAC9B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,sBAAsB,CAAC;IAIrC;;;;;;;;;OASG;IACH,YAAY,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,yBAAyB,CAAC;CAG9E;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,KAAK,CAAC,EAAE,KAAK,CAAC,mBAAmB,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;IAE/C;;OAEG;IACH,OAAO,CAAC,EAAE,sBAAsB,CAAC;IAEjC;;OAEG;IACH,oBAAoB,CAAC,EAAE,mBAAmB,CAAC,oBAAoB,CAAC;CACjE;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;OAEG;IACH,UAAiB,IAAI;QACnB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;WAEG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC;QAExB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB;IAED;;OAEG;IACH,UAAiB,oBAAoB;QACnC,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;;WAGG;QACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE/B,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B;;WAEG;QACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEjC,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,KAAK,CAAC,EAAE,KAAK,CAAC,mBAAmB,CAAC,GAAG,IAAI,CAAC;IAE1C,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,MAAM,yBAAyB,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;CAAE,CAAC;AAElE,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,SAAS,CAAC,EAAE,KAAK,CAAC,iBAAiB,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC;IAErD;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,yBAAiB,iBAAiB,CAAC;IACjC;;OAEG;IACH,UAAiB,QAAQ;QACvB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB;CACF;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAClC;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAID,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;IAEF,OAAO,EACL,QAAQ,IAAI,QAAQ,EACpB,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH"}

package/resources/suppliers/orders/orders.d.ts

@@ -0,0 +1,263 @@
+import { APIResource } from "../../../core/resource.js";
+import * as CreationAPI from "./creation.js";
+import { Creation, CreationListIssuesParams, CreationListIssuesResponse, SupplierCreateOrderItems } from "./creation.js";
+import { APIPromise } from "../../../core/api-promise.js";
+import { RequestOptions } from "../../../internal/request-options.js";
+export declare class Orders extends APIResource {
+    creation: CreationAPI.Creation;
+    /**
+     * Creates a supplier order with status `Drafted`. Called once per supplier from
+     * the order creation wizard (Step 2). The client groups selected quotes by
+     * `supplierId` and calls this endpoint in parallel via `forkJoin`.
+     *
+     * **State machine entry point:** Drafted → Ordered → In Transit → Delivered
+     *
+     * @example
+     * ```ts
+     * const supplierOrderDetail =
+     *   await client.suppliers.orders.create();
+     * ```
+     */
+    create(body: OrderCreateParams, options?: RequestOptions): APIPromise<SupplierOrderDetail>;
+    /**
+     * Get a single supplier order by ID
+     *
+     * @example
+     * ```ts
+     * const supplierOrderDetail =
+     *   await client.suppliers.orders.retrieve(0);
+     * ```
+     */
+    retrieve(orderID: number, options?: RequestOptions): APIPromise<SupplierOrderDetail>;
+    /**
+     * Advances the order through the state machine or records shipment details.
+     *
+     * **Allowed transitions:**
+     *
+     * - `Ordered → In Transit` (requires `shippedReference` and `shipmentDate`)
+     * - `Ordered → Cancelled`
+     * - `In Transit → Delivered` (requires actual `shipmentDate`)
+     * - `In Transit → Damaged` (requires `damageComment`)
+     *
+     * @example
+     * ```ts
+     * await client.suppliers.orders.update(0);
+     * ```
+     */
+    update(orderID: number, body: OrderUpdateParams, options?: RequestOptions): APIPromise<void>;
+    /**
+     * Returns all supplier orders. Optionally filter by status string (e.g. 'Drafted',
+     * 'Ordered', 'In Transit', 'Delivered') and search by supplier name.
+     *
+     * @example
+     * ```ts
+     * const orders = await client.suppliers.orders.list();
+     * ```
+     */
+    list(query?: OrderListParams | null | undefined, options?: RequestOptions): APIPromise<OrderListResponse>;
+    /**
+     * Transitions a supplier order from `Drafted` to `Ordered`, indicating that the
+     * purchase order has been sent to the supplier.
+     *
+     * @example
+     * ```ts
+     * await client.suppliers.orders.confirm(0);
+     * ```
+     */
+    confirm(orderID: number, options?: RequestOptions): APIPromise<void>;
+    /**
+     * Creates a payment record linked to a supplier order. One order can have at most
+     * one payment. Typically called after the supplier invoice is settled.
+     *
+     * @example
+     * ```ts
+     * const supplierPaymentSummary =
+     *   await client.suppliers.orders.recordPayment(0);
+     * ```
+     */
+    recordPayment(orderID: number, body: OrderRecordPaymentParams, options?: RequestOptions): APIPromise<SupplierPaymentSummary>;
+    /**
+     * Returns a map of `{ status: count }` for all supplier orders. Used by the
+     * Suppliers page tab badges.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.suppliers.orders.statusCounts();
+     * ```
+     */
+    statusCounts(options?: RequestOptions): APIPromise<OrderStatusCountsResponse>;
+}
+/**
+ * Full detail for a supplier restock order including summary, payment, and line
+ * items.
+ */
+export interface SupplierOrderDetail {
+    items?: Array<SupplierOrderDetail.Item> | null;
+    /**
+     * Summary of a payment made to a supplier for a restock order.
+     */
+    payment?: SupplierPaymentSummary;
+    /**
+     * Summary fields for a supplier restock order.
+     */
+    supplierOrderSummary?: SupplierOrderDetail.SupplierOrderSummary;
+}
+export declare namespace SupplierOrderDetail {
+    /**
+     * A line item in a supplier restock order.
+     */
+    interface Item {
+        condition?: string | null;
+        issueTitle?: string | null;
+        /**
+         * unitPrice × quantity.
+         */
+        itemTotalPrice?: number;
+        quantity?: number;
+        stockItemId?: number;
+        /**
+         * Price per unit from the supplier quote.
+         */
+        unitPrice?: number;
+    }
+    /**
+     * Summary fields for a supplier restock order.
+     */
+    interface SupplierOrderSummary {
+        comment?: string | null;
+        /**
+         * Current status in the state machine: Drafted | Ordered | In Transit | Delivered
+         * | Cancelled | Damaged.
+         */
+        deliveryStatus?: string | null;
+        orderDate?: string;
+        orderId?: number;
+        /**
+         * Expected or actual shipment date (YYYY-MM-DD).
+         */
+        shipmentDate?: string | null;
+        /**
+         * Supplier shipment tracking reference.
+         */
+        shippedReference?: string | null;
+        supplierId?: number;
+        supplierName?: string | null;
+        total?: number;
+    }
+}
+/**
+ * Summary of a payment made to a supplier for a restock order.
+ */
+export interface SupplierPaymentSummary {
+    paymentId?: number;
+    paymentReference?: string | null;
+    processedDate?: string | null;
+    status?: string | null;
+    supplierName?: string | null;
+    total?: number;
+}
+/**
+ * Paginated result wrapping SupplierOrderDetailDto items.
+ */
+export interface OrderListResponse {
+    items?: Array<SupplierOrderDetail> | null;
+    page?: number;
+    pageSize?: number;
+    totalCount?: number;
+    totalPages?: number;
+}
+export type OrderStatusCountsResponse = {
+    [key: string]: number;
+};
+export interface OrderCreateParams {
+    /**
+     * Optional order-level note.
+     */
+    comment?: string | null;
+    /**
+     * One or more line items (stock item + quantity + unit price).
+     */
+    lineItems?: Array<OrderCreateParams.LineItem> | null;
+    /**
+     * Date the order is raised (ISO 8601).
+     */
+    orderDate?: string;
+    /**
+     * Supplier to place the order with.
+     */
+    supplierId?: number;
+}
+export declare namespace OrderCreateParams {
+    /**
+     * A single line item in the CreateSupplierOrderDTO request.
+     */
+    interface LineItem {
+        quantity?: number;
+        /**
+         * StockItem (issue + condition) to order.
+         */
+        stockItemId?: number;
+        /**
+         * Agreed unit price from the supplier quote.
+         */
+        unitPrice?: number;
+    }
+}
+export interface OrderUpdateParams {
+    /**
+     * Required when transitioning to Damaged.
+     */
+    damageComment?: string | null;
+    /**
+     * New delivery status. Allowed: In Transit | Delivered | Cancelled | Damaged.
+     */
+    deliveryStatus?: string | null;
+    /**
+     * Expected shipment date (In Transit) or actual delivery date (Delivered). Format:
+     * YYYY-MM-DD.
+     */
+    shipmentDate?: string | null;
+    /**
+     * Required when transitioning to In Transit.
+     */
+    shippedReference?: string | null;
+}
+export interface OrderListParams {
+    /**
+     * 1-based page number.
+     */
+    page?: number;
+    /**
+     * Records per page.
+     */
+    pageSize?: number;
+    /**
+     * Search matched against supplier name.
+     */
+    searchTerm?: string;
+    /**
+     * Filter by delivery status. Allowed values: `Drafted`, `Ordered`, `In Transit`,
+     * `Delivered`, `Cancelled`, `Damaged`.
+     */
+    status?: string;
+}
+export interface OrderRecordPaymentParams {
+    /**
+     * Bank or EFT reference number.
+     */
+    paymentReference?: string | null;
+    /**
+     * Date the payment was processed (ISO 8601).
+     */
+    processedDate?: string;
+    /**
+     * Total amount paid.
+     */
+    total?: number;
+}
+export declare namespace Orders {
+    export { type SupplierOrderDetail as SupplierOrderDetail, type SupplierPaymentSummary as SupplierPaymentSummary, type OrderListResponse as OrderListResponse, type OrderStatusCountsResponse as OrderStatusCountsResponse, type OrderCreateParams as OrderCreateParams, type OrderUpdateParams as OrderUpdateParams, type OrderListParams as OrderListParams, type OrderRecordPaymentParams as OrderRecordPaymentParams, };
+    export { Creation as Creation, type SupplierCreateOrderItems as SupplierCreateOrderItems, type CreationListIssuesResponse as CreationListIssuesResponse, type CreationListIssuesParams as CreationListIssuesParams, };
+}
+//# sourceMappingURL=orders.d.ts.map

package/resources/suppliers/orders/orders.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"orders.d.ts","sourceRoot":"","sources":["../../../src/resources/suppliers/orders/orders.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,WAAW;OAChB,EACL,QAAQ,EACR,wBAAwB,EACxB,0BAA0B,EAC1B,wBAAwB,EACzB;OACM,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAGzB,qBAAa,MAAO,SAAQ,WAAW;IACrC,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAA0C;IAExE;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,IAAI,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mBAAmB,CAAC;IAI1F;;;;;;;;OAQG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mBAAmB,CAAC;IAIpF;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAQ5F;;;;;;;;OAQG;IACH,IAAI,CACF,KAAK,GAAE,eAAe,GAAG,IAAI,GAAG,SAAc,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iBAAiB,CAAC;IAIhC;;;;;;;;OAQG;IACH,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAOpE;;;;;;;;;OASG;IACH,aAAa,CACX,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,wBAAwB,EAC9B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,sBAAsB,CAAC;IAIrC;;;;;;;;;OASG;IACH,YAAY,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,yBAAyB,CAAC;CAG9E;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,KAAK,CAAC,EAAE,KAAK,CAAC,mBAAmB,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;IAE/C;;OAEG;IACH,OAAO,CAAC,EAAE,sBAAsB,CAAC;IAEjC;;OAEG;IACH,oBAAoB,CAAC,EAAE,mBAAmB,CAAC,oBAAoB,CAAC;CACjE;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;OAEG;IACH,UAAiB,IAAI;QACnB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;WAEG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC;QAExB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB;IAED;;OAEG;IACH,UAAiB,oBAAoB;QACnC,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;;WAGG;QACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE/B,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B;;WAEG;QACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEjC,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,KAAK,CAAC,EAAE,KAAK,CAAC,mBAAmB,CAAC,GAAG,IAAI,CAAC;IAE1C,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,MAAM,yBAAyB,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;CAAE,CAAC;AAElE,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,SAAS,CAAC,EAAE,KAAK,CAAC,iBAAiB,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC;IAErD;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,yBAAiB,iBAAiB,CAAC;IACjC;;OAEG;IACH,UAAiB,QAAQ;QACvB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB;CACF;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAClC;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAID,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;IAEF,OAAO,EACL,QAAQ,IAAI,QAAQ,EACpB,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH"}