@revenexx/node 0.0.2 → 0.1.1

package/dist/services/inventories-reservations.d.ts

@@ -0,0 +1,424 @@
+import { Client } from '../client.js';
+import { Models } from '../models.js';
+import { InventoriesReservationsListStatus } from '../enums/inventories-reservations-list-status.js';
+import '../query.js';
+import '../enums/address-type-row-tone.js';
+import '../enums/address-type-row-create-request-tone.js';
+import '../enums/address-type-row-update-request-tone.js';
+import '../enums/approval-rule-approver-type.js';
+import '../enums/approval-rule-condition.js';
+import '../enums/approval-rule-effect.js';
+import '../enums/approval-rule-create-request-approver-type.js';
+import '../enums/approval-rule-create-request-condition.js';
+import '../enums/approval-rule-create-request-effect.js';
+import '../enums/approval-rule-update-request-approver-type.js';
+import '../enums/approval-rule-update-request-condition.js';
+import '../enums/approval-rule-update-request-effect.js';
+import '../enums/assets-source.js';
+import '../enums/attribute-value-bucket.js';
+import '../enums/auth-mail-source.js';
+import '../enums/recovery-mail-source.js';
+import '../enums/registration-status.js';
+import '../enums/budget-change-reason.js';
+import '../enums/budget-movement-result-status.js';
+import '../enums/cart-status.js';
+import '../enums/cart-merge-strategy.js';
+import '../enums/cart-price-snapshot-mode.js';
+import '../enums/cart-io-format.js';
+import '../enums/cart-export-format.js';
+import '../enums/cart-item-type.js';
+import '../enums/cart-vocabulary-tone.js';
+import '../enums/cart-vocabulary-name.js';
+import '../enums/cart-vocabulary-source.js';
+import '../enums/cart-vocabulary-ref-name.js';
+import '../enums/categories-rule-match.js';
+import '../enums/category-rule-operator.js';
+import '../enums/category-rule-match.js';
+import '../enums/channel-status.js';
+import '../enums/channel-unassigned-visibility.js';
+import '../enums/channel-unresolved-reason.js';
+import '../enums/channel-context-source.js';
+import '../enums/channel-inactive-behavior.js';
+import '../enums/channel-policy-source.js';
+import '../enums/channel-policy-tenant-default.js';
+import '../enums/channel-unassigned-policy.js';
+import '../enums/channel-type-tone.js';
+import '../enums/channel-visibility-reason.js';
+import '../enums/channel-vocabulary-tone.js';
+import '../enums/channel-vocabulary-name.js';
+import '../enums/channel-vocabulary-source.js';
+import '../enums/channel-vocabulary-ref-name.js';
+import '../enums/contact-registration-status.js';
+import '../enums/contact-status.js';
+import '../enums/contact-activity-kind.js';
+import '../enums/contact-create-request-registration-status.js';
+import '../enums/contact-event-kind-tone.js';
+import '../enums/contact-event-kind-create-request-tone.js';
+import '../enums/contact-event-kind-update-request-tone.js';
+import '../enums/contact-update-request-registration-status.js';
+import '../enums/cost-center-budget-type.js';
+import '../enums/cost-center-restriction-type.js';
+import '../enums/cost-center-restriction-create-request-type.js';
+import '../enums/cost-center-restriction-update-request-type.js';
+import '../enums/payment-fee-type.js';
+import '../enums/payment-method-kind.js';
+import '../enums/form-status.js';
+import '../enums/form-submission-status.js';
+import '../enums/form-notify-source.js';
+import '../enums/form-submission-prune-request-status.js';
+import '../enums/forms-vocabulary-tone.js';
+import '../enums/forms-vocabulary-name.js';
+import '../enums/forms-vocabulary-summary-name.js';
+import '../enums/inventory-vocabulary-default-tone.js';
+import '../enums/inventory-vocabulary-source.js';
+import '../enums/cart-io-apply-mode.js';
+import '../enums/cart-io-direction.js';
+import '../enums/cart-io-entity.js';
+import '../enums/io-profile-resource-apply-mode.js';
+import '../enums/io-profile-resource-direction.js';
+import '../enums/lifecycle-stage-tone.js';
+import '../enums/lifecycle-stage-create-request-tone.js';
+import '../enums/lifecycle-stage-update-request-tone.js';
+import '../enums/location-type.js';
+import '../enums/market-status.js';
+import '../enums/market-default-locale-source.js';
+import '../enums/market-locale-fallback.js';
+import '../enums/market-locale-granularity.js';
+import '../enums/market-pricing-source.js';
+import '../enums/market-tax-basis.js';
+import '../enums/market-readiness-check-id.js';
+import '../enums/market-readiness-severity.js';
+import '../enums/markets-vocabulary-tone.js';
+import '../enums/markets-vocabulary-name.js';
+import '../enums/markets-vocabulary-source.js';
+import '../enums/markets-vocabulary-summary-name.js';
+import '../enums/order-fulfillment-status.js';
+import '../enums/order-payment-status.js';
+import '../enums/order-status.js';
+import '../enums/order-cancellation-scope.js';
+import '../enums/order-comment-visibility.js';
+import '../enums/order-item-type.js';
+import '../enums/order-list-kind-tone.js';
+import '../enums/order-list-kind-row-tone.js';
+import '../enums/order-list-cart-mode.js';
+import '../enums/order-list-vocabulary-default-tone.js';
+import '../enums/order-list-vocabulary-name.js';
+import '../enums/order-list-vocabulary-source.js';
+import '../enums/order-list-vocabulary-tone.js';
+import '../enums/order-return-status.js';
+import '../enums/order-return-settlement.js';
+import '../enums/order-return-refusal.js';
+import '../enums/order-vocabulary-tone.js';
+import '../enums/order-vocabulary-name.js';
+import '../enums/order-vocabulary-source.js';
+import '../enums/order-vocabulary-summary-name.js';
+import '../enums/order-resolution-stage.js';
+import '../enums/organization-status.js';
+import '../enums/page-status.js';
+import '../enums/pages-vocabulary-app.js';
+import '../enums/pages-vocabulary-tone.js';
+import '../enums/pages-vocabulary-name.js';
+import '../enums/pages-vocabulary-source.js';
+import '../enums/pages-vocabulary-index-app.js';
+import '../enums/payment-dunning-stage.js';
+import '../enums/payment-failure-code.js';
+import '../enums/payment-status.js';
+import '../enums/payment-term-tone.js';
+import '../enums/payment-term-create-request-tone.js';
+import '../enums/payment-term-update-request-tone.js';
+import '../enums/payment-vocabulary-tone.js';
+import '../enums/pending-approval-approver-type.js';
+import '../enums/pending-approval-status.js';
+import '../enums/price-ending-rule.js';
+import '../enums/price-entries-adjust-response-rounding.js';
+import '../enums/price-entries-adjust-response-rounding-mode.js';
+import '../enums/price-entries-bulk-mode.js';
+import '../enums/price-rounding-mode.js';
+import '../enums/price-entry-type.js';
+import '../enums/price-list-status.js';
+import '../enums/price-list-tax-basis.js';
+import '../enums/price-currency-source.js';
+import '../enums/price-list-tiebreak.js';
+import '../enums/price-tax-inclusive-default.js';
+import '../enums/price-tax-unresolved-reason.js';
+import '../enums/price-tax-market-source.js';
+import '../enums/price-vocabulary-tone.js';
+import '../enums/price-vocabulary-name.js';
+import '../enums/price-vocabulary-source.js';
+import '../enums/price-vocabulary-ref-name.js';
+import '../enums/product-categories-source.js';
+import '../enums/product-grid-column-source.js';
+import '../enums/product-label-source.js';
+import '../enums/product-label-attribute-source.js';
+import '../enums/products-kind.js';
+import '../enums/purchase-request-status.js';
+import '../enums/purchase-request-event-name.js';
+import '../enums/purchase-request-item-type.js';
+import '../enums/purchase-request-item-create-request-type.js';
+import '../enums/purchase-request-item-update-request-type.js';
+import '../enums/reorder-point-source.js';
+import '../enums/reservation-status.js';
+import '../enums/price-on-request-reason.js';
+import '../enums/price-tax-basis.js';
+import '../enums/price-tax-basis-source.js';
+import '../enums/role-catalog-response-source.js';
+import '../enums/segment-rule-match.js';
+import '../enums/segment-member-source.js';
+import '../enums/segment-rule-operator.js';
+import '../enums/segment-rule-preview-request-rule-match.js';
+import '../enums/segment-rule-preview-request-target.js';
+import '../enums/segment-rule-preview-response-rule-match.js';
+import '../enums/segment-rule-preview-response-target.js';
+import '../enums/segment-rules-target.js';
+import '../enums/shipping-carrier-status.js';
+import '../enums/shipping-method-matrix-basis.js';
+import '../enums/shipping-method-pricing-type.js';
+import '../enums/shipping-carrier-source.js';
+import '../enums/shipping-rate-pricing-type.js';
+import '../enums/shipping-tax-source.js';
+import '../enums/shipping-free-above-basis.js';
+import '../enums/shipping-rates-basis-matrix-basis-default.js';
+import '../enums/shipping-service-level-create-request-tone.js';
+import '../enums/shipping-service-level-row-tone.js';
+import '../enums/shipping-service-level-update-request-tone.js';
+import '../enums/shipping-tax-unresolved-reason.js';
+import '../enums/shipping-tax-market-source.js';
+import '../enums/shipping-tax-context-via.js';
+import '../enums/shipping-tracking-carrier-status.js';
+import '../enums/shipping-vocabulary-default-tone.js';
+import '../enums/shipping-vocabulary-source.js';
+import '../enums/shipping-vocabulary-tone.js';
+import '../enums/shipping-weight-unit-create-request-tone.js';
+import '../enums/shipping-weight-unit-row-tone.js';
+import '../enums/shipping-weight-unit-update-request-tone.js';
+import '../enums/stock-movement-type.js';
+import '../enums/store-asset-request-visibility.js';
+import '../enums/submit-item-type.js';
+import '../enums/submit-result-outcome.js';
+import '../enums/validation-failed-response-status.js';
+import '../enums/vocabulary-default-tone.js';
+import '../enums/vocabulary-source.js';
+import '../enums/vocabulary-tone.js';
+import '../enums/attribute-boolean-status.js';
+import '../enums/attribute-datetime-status.js';
+import '../enums/attribute-email-status.js';
+import '../enums/attribute-enum-status.js';
+import '../enums/attribute-float-status.js';
+import '../enums/attribute-integer-status.js';
+import '../enums/attribute-ip-status.js';
+import '../enums/attribute-line-status.js';
+import '../enums/attribute-longtext-status.js';
+import '../enums/attribute-mediumtext-status.js';
+import '../enums/attribute-point-status.js';
+import '../enums/attribute-polygon-status.js';
+import '../enums/attribute-relationship-status.js';
+import '../enums/attribute-string-status.js';
+import '../enums/attribute-text-status.js';
+import '../enums/attribute-url-status.js';
+import '../enums/attribute-varchar-status.js';
+import '../enums/column-boolean-status.js';
+import '../enums/column-datetime-status.js';
+import '../enums/column-email-status.js';
+import '../enums/column-enum-status.js';
+import '../enums/column-float-status.js';
+import '../enums/column-integer-status.js';
+import '../enums/column-ip-status.js';
+import '../enums/column-line-status.js';
+import '../enums/column-longtext-status.js';
+import '../enums/column-mediumtext-status.js';
+import '../enums/column-point-status.js';
+import '../enums/column-polygon-status.js';
+import '../enums/column-relationship-status.js';
+import '../enums/column-string-status.js';
+import '../enums/column-text-status.js';
+import '../enums/column-url-status.js';
+import '../enums/column-varchar-status.js';
+import '../enums/database-type.js';
+import '../enums/deployment-status.js';
+import '../enums/execution-status.js';
+import '../enums/execution-trigger.js';
+import '../enums/health-antivirus-status.js';
+import '../enums/health-status-status.js';
+import '../enums/index-status.js';
+import '../enums/message-2-status.js';
+
+declare class InventoriesReservations {
+    client: Client;
+    constructor(client: Client);
+    /**
+     * Call this when the goods leave the building, and not before. Reserving only promised them — `reserved` went up and `on_hand` did not move, because the stock was still on the shelf; committing is the moment they are gone, so it lowers BOTH on each stock row and writes one `shipment` booking per hold, with a SIGNED negative quantity, as the ledger's record that they left. It takes the whole `order_ref` and every hold still active on it: there is no partial commit and no per-line id, so a part shipment means reserving the parts separately in the first place. It is also final — 'committed' ends the lifecycle and nothing moves a hold out of it, so goods coming back are POST /inventories/restock (a new receipt), never an undo of this. An order with nothing active is a 422 rather than a quiet zero, because it means the hold was already released or already shipped; /release answers the same situation with a 200 on purpose, since cancelling twice is harmless and shipping twice is not.
+     *
+     * @param {string} params.orderRef - The order this hold belongs to. The caller supplies it — this app mints nothing — and it is the handle POST /inventories/release and POST /inventories/commit act on, so it has to be the same string the order carries elsewhere. At least one character (CHECK `length(order_ref) > 0`). Not unique: an order holds one reservation per item, and they are released or committed together. Every ACTIVE hold under this reference ships: `on_hand` and `reserved` both fall and a `shipment` booking is written for each. Unlike release, committing an order that has nothing active is a 422 — it means the hold was already released or already shipped, and shipping twice is worth saying out loud.
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     */
+    inventoriesCommit(params: {
+        orderRef: string;
+    }): Promise<{}>;
+    /**
+     * Call this when the goods leave the building, and not before. Reserving only promised them — `reserved` went up and `on_hand` did not move, because the stock was still on the shelf; committing is the moment they are gone, so it lowers BOTH on each stock row and writes one `shipment` booking per hold, with a SIGNED negative quantity, as the ledger's record that they left. It takes the whole `order_ref` and every hold still active on it: there is no partial commit and no per-line id, so a part shipment means reserving the parts separately in the first place. It is also final — 'committed' ends the lifecycle and nothing moves a hold out of it, so goods coming back are POST /inventories/restock (a new receipt), never an undo of this. An order with nothing active is a 422 rather than a quiet zero, because it means the hold was already released or already shipped; /release answers the same situation with a 200 on purpose, since cancelling twice is harmless and shipping twice is not.
+     *
+     * @param {string} orderRef - The order this hold belongs to. The caller supplies it — this app mints nothing — and it is the handle POST /inventories/release and POST /inventories/commit act on, so it has to be the same string the order carries elsewhere. At least one character (CHECK `length(order_ref) > 0`). Not unique: an order holds one reservation per item, and they are released or committed together. Every ACTIVE hold under this reference ships: `on_hand` and `reserved` both fall and a `shipment` booking is written for each. Unlike release, committing an order that has nothing active is a 422 — it means the hold was already released or already shipped, and shipping twice is worth saying out loud.
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    inventoriesCommit(orderRef: string): Promise<{}>;
+    /**
+     * The cancellation end of the reserve → commit | release lifecycle: it takes an `order_ref`, ends every hold still active on it, gives the stock back and writes a 'release' booking for each one, exactly like the expiry sweeper. Idempotent: an order with nothing active answers released:0 — which is why it is a 200 and not the 422 commit answers.
+     *
+     * @param {string} params.orderRef - The order this hold belongs to. The caller supplies it — this app mints nothing — and it is the handle POST /inventories/release and POST /inventories/commit act on, so it has to be the same string the order carries elsewhere. At least one character (CHECK `length(order_ref) > 0`). Not unique: an order holds one reservation per item, and they are released or committed together. Every ACTIVE hold under this reference is given back; ones already committed or released are left alone. A reference no reservation carries releases nothing and answers `released: 0` — not an error, which is what makes a retried cancellation safe.
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     */
+    inventoriesRelease(params: {
+        orderRef: string;
+    }): Promise<{}>;
+    /**
+     * The cancellation end of the reserve → commit | release lifecycle: it takes an `order_ref`, ends every hold still active on it, gives the stock back and writes a 'release' booking for each one, exactly like the expiry sweeper. Idempotent: an order with nothing active answers released:0 — which is why it is a 200 and not the 422 commit answers.
+     *
+     * @param {string} orderRef - The order this hold belongs to. The caller supplies it — this app mints nothing — and it is the handle POST /inventories/release and POST /inventories/commit act on, so it has to be the same string the order carries elsewhere. At least one character (CHECK `length(order_ref) > 0`). Not unique: an order holds one reservation per item, and they are released or committed together. Every ACTIVE hold under this reference is given back; ones already committed or released are left alone. A reference no reservation carries releases nothing and answers `released: 0` — not an error, which is what makes a retried cancellation safe.
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    inventoriesRelease(orderRef: string): Promise<{}>;
+    /**
+     * A reservation is stock promised to an `order_ref`. It is created only by POST /inventories/reserve and moved only by /commit, /release and the expiry sweep — there is no create, update or delete route, because the lifecycle IS the API. Only an 'active' hold counts towards a stock row's `reserved`; 'released' and 'committed' rows stay for the audit trail and hold nothing. This is the answer to "what is this order actually holding" (`?order_ref=…`) and to "what is holding this stock" (`?status=active&location_id=…`) — the second is the only way to see WHY a row's `reserved` is what it is, since a stock row reports the total and never who asked for it. `expires_at` filters on an exact timestamp and not a range, so this cannot answer "what expires today"; the deadline is acted on by POST /inventories/reservations/sweep, not by reading it here.
+     *
+     * @param {number} params.limit - Page size (default 50, max 200). A larger value is clamped rather than refused.
+     * @param {number} params.offset - Row offset for pagination (default 0). Page with `page.total` and `page.hasMore`.
+     * @param {string} params.order - Sort by one column: 'column' | 'column.asc' | 'column.desc' — a bare column sorts ascending. The column has to be one this entity has; anything else is refused with 400.
+     * @param {string} params.id - Exact-match filter on `id`. The row's own id, generated by the database.
+     * @param {string} params.locationId - Exact-match filter on `location_id`. The holds served by one location.
+     * @param {string} params.productId - Exact-match filter on `product_id`. The product being held, copied from the reserve call.
+     * @param {string} params.sku - Exact-match filter on `sku`. The article number being held, copied from the reserve call.
+     * @param {number} params.quantity - Exact-match filter on `quantity`. How much is being held, ALWAYS POSITIVE — the database CHECK is `quantity > 0`, because a hold of nothing is not a hold.
+     * @param {string} params.orderRef - Exact-match filter on `order_ref`. Every hold an order carries. This is the lookup POST /inventories/release and /commit act on.
+     * @param {InventoriesReservationsListStatus} params.status - Exact-match filter on `status`. Where the hold stands in the reserve → commit | release lifecycle. Only 'active' counts towards `reserved`, so `?status=active` is the set that is really holding stock.
+     * @param {string} params.expiresAt - Exact-match filter on `expires_at`. Exact deadline, not a range — this cannot answer "what expires today". The sweeper is what acts on deadlines (POST /inventories/reservations/sweep).
+     * @param {string} params.metadata - Exact-match filter on `metadata`. Free-form, and one key this app writes itself: `backordered` — how much of this hold was not covered by stock on hand when it was taken. The WHOLE jsonb document is compared, serialized as JSON — this is equality, not a key lookup or a containment query, and a value that does not parse is answered 400.
+     * @param {string} params.createdAt - Exact-match filter on `created_at`. When the row was created.
+     * @param {string} params.updatedAt - Exact-match filter on `updated_at`. When the hold last changed — in practice, when it moved out of `active`..
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     */
+    inventoriesReservationsList(params?: {
+        limit?: number;
+        offset?: number;
+        order?: string;
+        id?: string;
+        locationId?: string;
+        productId?: string;
+        sku?: string;
+        quantity?: number;
+        orderRef?: string;
+        status?: InventoriesReservationsListStatus;
+        expiresAt?: string;
+        metadata?: string;
+        createdAt?: string;
+        updatedAt?: string;
+    }): Promise<{}>;
+    /**
+     * A reservation is stock promised to an `order_ref`. It is created only by POST /inventories/reserve and moved only by /commit, /release and the expiry sweep — there is no create, update or delete route, because the lifecycle IS the API. Only an 'active' hold counts towards a stock row's `reserved`; 'released' and 'committed' rows stay for the audit trail and hold nothing. This is the answer to "what is this order actually holding" (`?order_ref=…`) and to "what is holding this stock" (`?status=active&location_id=…`) — the second is the only way to see WHY a row's `reserved` is what it is, since a stock row reports the total and never who asked for it. `expires_at` filters on an exact timestamp and not a range, so this cannot answer "what expires today"; the deadline is acted on by POST /inventories/reservations/sweep, not by reading it here.
+     *
+     * @param {number} limit - Page size (default 50, max 200). A larger value is clamped rather than refused.
+     * @param {number} offset - Row offset for pagination (default 0). Page with `page.total` and `page.hasMore`.
+     * @param {string} order - Sort by one column: 'column' | 'column.asc' | 'column.desc' — a bare column sorts ascending. The column has to be one this entity has; anything else is refused with 400.
+     * @param {string} id - Exact-match filter on `id`. The row's own id, generated by the database.
+     * @param {string} locationId - Exact-match filter on `location_id`. The holds served by one location.
+     * @param {string} productId - Exact-match filter on `product_id`. The product being held, copied from the reserve call.
+     * @param {string} sku - Exact-match filter on `sku`. The article number being held, copied from the reserve call.
+     * @param {number} quantity - Exact-match filter on `quantity`. How much is being held, ALWAYS POSITIVE — the database CHECK is `quantity > 0`, because a hold of nothing is not a hold.
+     * @param {string} orderRef - Exact-match filter on `order_ref`. Every hold an order carries. This is the lookup POST /inventories/release and /commit act on.
+     * @param {InventoriesReservationsListStatus} status - Exact-match filter on `status`. Where the hold stands in the reserve → commit | release lifecycle. Only 'active' counts towards `reserved`, so `?status=active` is the set that is really holding stock.
+     * @param {string} expiresAt - Exact-match filter on `expires_at`. Exact deadline, not a range — this cannot answer "what expires today". The sweeper is what acts on deadlines (POST /inventories/reservations/sweep).
+     * @param {string} metadata - Exact-match filter on `metadata`. Free-form, and one key this app writes itself: `backordered` — how much of this hold was not covered by stock on hand when it was taken. The WHOLE jsonb document is compared, serialized as JSON — this is equality, not a key lookup or a containment query, and a value that does not parse is answered 400.
+     * @param {string} createdAt - Exact-match filter on `created_at`. When the row was created.
+     * @param {string} updatedAt - Exact-match filter on `updated_at`. When the hold last changed — in practice, when it moved out of `active`..
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    inventoriesReservationsList(limit?: number, offset?: number, order?: string, id?: string, locationId?: string, productId?: string, sku?: string, quantity?: number, orderRef?: string, status?: InventoriesReservationsListStatus, expiresAt?: string, metadata?: string, createdAt?: string, updatedAt?: string): Promise<{}>;
+    /**
+     * The expiry sweeper, also run by the 'expire-reservations' schedule every 15 minutes. Releases reservations past their own expires_at and — once reservation_ttl_minutes is above 0 — reservations older than that lifetime which never carried a deadline. Each release gives the stock back and writes a 'release' booking, exactly like a cancellation. Idempotent: a second run finds nothing.
+     *
+     * @param {object} params.data - Request body
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.ReservationSweepResult>}
+     */
+    inventoriesReservationsSweep(params: {
+        data: object;
+    }): Promise<Models.ReservationSweepResult>;
+    /**
+     * The expiry sweeper, also run by the 'expire-reservations' schedule every 15 minutes. Releases reservations past their own expires_at and — once reservation_ttl_minutes is above 0 — reservations older than that lifetime which never carried a deadline. Each release gives the stock back and writes a 'release' booking, exactly like a cancellation. Idempotent: a second run finds nothing.
+     *
+     * @param {object} data - Request body
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.ReservationSweepResult>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    inventoriesReservationsSweep(data: object): Promise<Models.ReservationSweepResult>;
+    /**
+     * A reservation is stock promised to an `order_ref`. It is created only by POST /inventories/reserve and moved only by /commit, /release and the expiry sweep — there is no create, update or delete route, because the lifecycle IS the API. Only an 'active' hold counts towards a stock row's `reserved`; 'released' and 'committed' rows stay for the audit trail and hold nothing. One hold, with the three facts that are not on the order it belongs to: which location it was allocated to, when it expires, and — in `metadata.backordered` — how much of it was never covered by stock, which is how a promise made under a permissive backorder policy stays visible afterwards. The id is for reading only. Every transition acts on the whole `order_ref` (/commit, /release, the sweep), so there is no route that takes this id and no way to release one line of an order on its own.
+     *
+     * @param {string} params.id - The reservation.
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.Reservation>}
+     */
+    inventoriesReservationsGet(params: {
+        id: string;
+    }): Promise<Models.Reservation>;
+    /**
+     * A reservation is stock promised to an `order_ref`. It is created only by POST /inventories/reserve and moved only by /commit, /release and the expiry sweep — there is no create, update or delete route, because the lifecycle IS the API. Only an 'active' hold counts towards a stock row's `reserved`; 'released' and 'committed' rows stay for the audit trail and hold nothing. One hold, with the three facts that are not on the order it belongs to: which location it was allocated to, when it expires, and — in `metadata.backordered` — how much of it was never covered by stock, which is how a promise made under a permissive backorder policy stays visible afterwards. The id is for reading only. Every transition acts on the whole `order_ref` (/commit, /release, the sweep), so there is no route that takes this id and no way to release one line of an order on its own.
+     *
+     * @param {string} id - The reservation.
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.Reservation>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    inventoriesReservationsGet(id: string): Promise<Models.Reservation>;
+    /**
+     * Takes a hold against an `order_ref`, and plans the whole call before writing anything, so a reservation that cannot be satisfied changes nothing. WHICH location serves an item is not the caller's to choose: the tenant's allocation_strategy decides it ('priority', walking the enabled locations by their priority; 'nearest', matching ship_to against a location's country; or 'single_location' for the whole order); backorder_policy decides what happens when none can — refuse (422), or reserve anyway and let availability go negative. expires_at defaults from reservation_ttl_minutes and the sweeper enforces it.
+     *
+     * @param {string} params.orderRef - The order this hold belongs to. The caller supplies it — this app mints nothing — and it is the handle POST /inventories/release and POST /inventories/commit act on, so it has to be the same string the order carries elsewhere. At least one character (CHECK `length(order_ref) > 0`). Not unique: an order holds one reservation per item, and they are released or committed together. Reserving twice under the same reference ADDS holds rather than replacing them — release first if you mean to replace.
+     * @param {string} params.expiresAt - When this hold lapses. The sweeper — POST /inventories/reservations/sweep, and the 'expire-reservations' schedule that runs it every 15 minutes — releases everything past this moment exactly as a cancellation would, so an abandoned checkout stops holding stock on its own. Null means the row named no deadline: it is swept on its AGE instead once `reservation_ttl_minutes` is above 0, which is what makes turning that setting on retroactive. Omit it to let the `reservation_ttl_minutes` setting stamp one (0 — its default — means no deadline at all); send one to hold this order for a window of its own, e.g. a quote that stands until Friday.
+     * @param {Models.InventoryStockItem[]} params.items - The items to hold, at most 200 in one call — a whole cart in one request. The call is planned before anything is written, so either every item is placed or nothing is.
+     * @param {string} params.locationCode - Where a BACKORDERED item is booked when no location holds a stock row for it at all — the last fallback, not the allocator: which location serves an item that IS in stock comes from `allocation_strategy`. Omitted, the `default_location_code` setting decides.
+     * @param {string} params.productId - Inline single-item form: the product to move, instead of a one-entry `items` array. The two forms are equivalent — nothing downstream knows which arrived.
+     * @param {number} params.quantity - Inline single-item form: how many to hold. Positive — the hold is expressed as a positive reservation, while the ledger booking it writes carries the negative.
+     * @param {object} params.shipTo - Where the order is going. Read ONLY when the tenant's `allocation_strategy` is 'nearest' — under 'priority' or 'single_location' it is accepted and ignored, so sending it is never wrong, it is just not always heard.
+     * @param {string} params.sku - Inline single-item form: the article number to move (instead of `product_id`).
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     */
+    inventoriesReserve(params: {
+        orderRef: string;
+        expiresAt?: string;
+        items?: Models.InventoryStockItem[];
+        locationCode?: string;
+        productId?: string;
+        quantity?: number;
+        shipTo?: object;
+        sku?: string;
+    }): Promise<{}>;
+    /**
+     * Takes a hold against an `order_ref`, and plans the whole call before writing anything, so a reservation that cannot be satisfied changes nothing. WHICH location serves an item is not the caller's to choose: the tenant's allocation_strategy decides it ('priority', walking the enabled locations by their priority; 'nearest', matching ship_to against a location's country; or 'single_location' for the whole order); backorder_policy decides what happens when none can — refuse (422), or reserve anyway and let availability go negative. expires_at defaults from reservation_ttl_minutes and the sweeper enforces it.
+     *
+     * @param {string} orderRef - The order this hold belongs to. The caller supplies it — this app mints nothing — and it is the handle POST /inventories/release and POST /inventories/commit act on, so it has to be the same string the order carries elsewhere. At least one character (CHECK `length(order_ref) > 0`). Not unique: an order holds one reservation per item, and they are released or committed together. Reserving twice under the same reference ADDS holds rather than replacing them — release first if you mean to replace.
+     * @param {string} expiresAt - When this hold lapses. The sweeper — POST /inventories/reservations/sweep, and the 'expire-reservations' schedule that runs it every 15 minutes — releases everything past this moment exactly as a cancellation would, so an abandoned checkout stops holding stock on its own. Null means the row named no deadline: it is swept on its AGE instead once `reservation_ttl_minutes` is above 0, which is what makes turning that setting on retroactive. Omit it to let the `reservation_ttl_minutes` setting stamp one (0 — its default — means no deadline at all); send one to hold this order for a window of its own, e.g. a quote that stands until Friday.
+     * @param {Models.InventoryStockItem[]} items - The items to hold, at most 200 in one call — a whole cart in one request. The call is planned before anything is written, so either every item is placed or nothing is.
+     * @param {string} locationCode - Where a BACKORDERED item is booked when no location holds a stock row for it at all — the last fallback, not the allocator: which location serves an item that IS in stock comes from `allocation_strategy`. Omitted, the `default_location_code` setting decides.
+     * @param {string} productId - Inline single-item form: the product to move, instead of a one-entry `items` array. The two forms are equivalent — nothing downstream knows which arrived.
+     * @param {number} quantity - Inline single-item form: how many to hold. Positive — the hold is expressed as a positive reservation, while the ledger booking it writes carries the negative.
+     * @param {object} shipTo - Where the order is going. Read ONLY when the tenant's `allocation_strategy` is 'nearest' — under 'priority' or 'single_location' it is accepted and ignored, so sending it is never wrong, it is just not always heard.
+     * @param {string} sku - Inline single-item form: the article number to move (instead of `product_id`).
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    inventoriesReserve(orderRef: string, expiresAt?: string, items?: Models.InventoryStockItem[], locationCode?: string, productId?: string, quantity?: number, shipTo?: object, sku?: string): Promise<{}>;
+}
+
+export { InventoriesReservations };