@revenexx/node 0.1.1 → 0.2.0

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

@@ -3,6 +3,9 @@ import { Models } from '../models.js';
 import { InventoriesLocationsListType } from '../enums/inventories-locations-list-type.js';
 import { LocationType } from '../enums/location-type.js';
 import '../query.js';
+import '../enums/accept-line-decision.js';
+import '../enums/accept-result-origin.js';
+import '../enums/accept-result-status.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';
@@ -16,12 +19,23 @@ 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/assignment-role-tone.js';
+import '../enums/assignment-role-create-request-tone.js';
+import '../enums/assignment-role-update-request-tone.js';
+import '../enums/attach-request-direction.js';
+import '../enums/attach-request-visibility.js';
 import '../enums/attribute-value-bucket.js';
 import '../enums/auth-mail-source.js';
+import '../enums/auth-mfa-challenge-request-factor.js';
 import '../enums/recovery-mail-source.js';
 import '../enums/registration-status.js';
+import '../enums/availability-state-tone.js';
+import '../enums/banner-draft-layout.js';
+import '../enums/banner-draft-update-request-layout.js';
 import '../enums/budget-change-reason.js';
 import '../enums/budget-movement-result-status.js';
+import '../enums/budget-release-scope.js';
+import '../enums/budget-release-status.js';
 import '../enums/cart-status.js';
 import '../enums/cart-merge-strategy.js';
 import '../enums/cart-price-snapshot-mode.js';
@@ -49,18 +63,44 @@ 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/consent-record-action.js';
+import '../enums/consent-record-surface.js';
+import '../enums/consent-record-create-request-action.js';
+import '../enums/consent-record-create-request-surface.js';
+import '../enums/consent-vocabulary-source.js';
+import '../enums/contact-order-approval-mode.js';
 import '../enums/contact-registration-status.js';
 import '../enums/contact-status.js';
 import '../enums/contact-activity-kind.js';
+import '../enums/order-approval-mode.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/contact-point-kind-tone.js';
+import '../enums/contact-point-kind-create-request-tone.js';
+import '../enums/contact-point-kind-update-request-tone.js';
+import '../enums/cookie-kind.js';
+import '../enums/cookie-create-request-kind.js';
+import '../enums/cookie-update-request-kind.js';
 import '../enums/cost-center-budget-type.js';
+import '../enums/cost-center-create-request-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/cost-center-update-request-budget-type.js';
+import '../enums/cost-centers-vocabulary-tone.js';
+import '../enums/cost-centers-vocabulary-name.js';
+import '../enums/cost-centers-vocabulary-source.js';
+import '../enums/cost-centers-vocabulary-summary-name.js';
+import '../enums/direct-order-status.js';
+import '../enums/document-source.js';
+import '../enums/document-visibility.js';
+import '../enums/document-kind-tone.js';
+import '../enums/document-vocabulary-default-tone.js';
+import '../enums/document-vocabulary-name.js';
+import '../enums/document-vocabulary-source.js';
+import '../enums/document-vocabulary-tone.js';
 import '../enums/payment-fee-type.js';
 import '../enums/payment-method-kind.js';
 import '../enums/form-status.js';
@@ -70,6 +110,7 @@ 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-receive-warning-code.js';
 import '../enums/inventory-vocabulary-default-tone.js';
 import '../enums/inventory-vocabulary-source.js';
 import '../enums/cart-io-apply-mode.js';
@@ -77,6 +118,7 @@ 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/inventory-unorderable-reason.js';
 import '../enums/lifecycle-stage-tone.js';
 import '../enums/lifecycle-stage-create-request-tone.js';
 import '../enums/lifecycle-stage-update-request-tone.js';
@@ -92,28 +134,40 @@ 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/note-request-visibility.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-discount-target.js';
+import '../enums/order-discount-effect-kind.js';
+import '../enums/order-discount-placement.js';
+import '../enums/order-discount-source.js';
+import '../enums/order-discount-value-type.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-skip-reason.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-refund-mode.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-return-refusal.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-credit-limit-mode.js';
+import '../enums/organization-shipping-advice.js';
 import '../enums/organization-status.js';
+import '../enums/credit-limit-mode.js';
+import '../enums/shipping-advice.js';
 import '../enums/page-status.js';
 import '../enums/pages-vocabulary-app.js';
 import '../enums/pages-vocabulary-tone.js';
@@ -135,6 +189,7 @@ 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-line-price-reason.js';
 import '../enums/price-list-status.js';
 import '../enums/price-list-tax-basis.js';
 import '../enums/price-currency-source.js';
@@ -146,22 +201,86 @@ 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/procurement-vocabulary-default-tone.js';
+import '../enums/procurement-vocabulary-name.js';
+import '../enums/procurement-vocabulary-source.js';
+import '../enums/procurement-vocabulary-summary-name.js';
+import '../enums/procurement-vocabulary-value-tone.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/promotion-condition-match.js';
+import '../enums/promotion-reach.js';
+import '../enums/promotion-recurrence-kind.js';
+import '../enums/promotion-return-behaviour.js';
+import '../enums/promotion-status.js';
+import '../enums/promotion-bundle-allocation.js';
+import '../enums/promotion-bundle-patch-allocation.js';
+import '../enums/promotion-bundle-write-allocation.js';
+import '../enums/promotion-condition-kind.js';
+import '../enums/promotion-condition-match-mode.js';
+import '../enums/promotion-condition-patch-kind.js';
+import '../enums/promotion-condition-patch-match-mode.js';
+import '../enums/promotion-condition-write-kind.js';
+import '../enums/promotion-condition-write-match-mode.js';
+import '../enums/promotion-effect-kind.js';
+import '../enums/promotion-effect-target-scope.js';
+import '../enums/promotion-effect-unit-choice.js';
+import '../enums/promotion-effect-value-type.js';
+import '../enums/promotion-effect-patch-kind.js';
+import '../enums/promotion-effect-patch-target-scope.js';
+import '../enums/promotion-effect-patch-unit-choice.js';
+import '../enums/promotion-effect-patch-value-type.js';
+import '../enums/promotion-effect-write-kind.js';
+import '../enums/promotion-effect-write-target-scope.js';
+import '../enums/promotion-effect-write-unit-choice.js';
+import '../enums/promotion-effect-write-value-type.js';
+import '../enums/promotion-patch-condition-match.js';
+import '../enums/promotion-patch-reach.js';
+import '../enums/promotion-patch-recurrence-kind.js';
+import '../enums/promotion-patch-return-behaviour.js';
+import '../enums/promotion-patch-status.js';
+import '../enums/promotion-release-request-reason.js';
+import '../enums/promotion-write-condition-match.js';
+import '../enums/promotion-write-reach.js';
+import '../enums/promotion-write-recurrence-kind.js';
+import '../enums/promotion-write-return-behaviour.js';
+import '../enums/promotion-write-status.js';
+import '../enums/punchout-entry-probe-result-entry-probe-status.js';
+import '../enums/punchout-entry-test-result-protocol.js';
+import '../enums/punchout-field-mapping-import-request-protocol.js';
+import '../enums/punchout-return-preview-protocol.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/purpose-legal-basis.js';
+import '../enums/purpose-create-request-legal-basis.js';
+import '../enums/purpose-update-request-legal-basis.js';
+import '../enums/quote-origin.js';
+import '../enums/quote-status.js';
+import '../enums/quote-attachment-direction.js';
+import '../enums/quote-attachment-visibility.js';
+import '../enums/quote-detail-origin.js';
+import '../enums/quote-detail-status.js';
+import '../enums/quote-event-visibility.js';
+import '../enums/quote-item-decision.js';
+import '../enums/quote-item-price-reason.js';
+import '../enums/quote-line-input-price-reason.js';
+import '../enums/redemption-state.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/sales-rep-vocabulary-default-tone.js';
+import '../enums/sales-rep-vocabulary-source.js';
+import '../enums/seed-request-mode.js';
+import '../enums/seed-result-mode.js';
 import '../enums/segment-rule-match.js';
 import '../enums/segment-member-source.js';
 import '../enums/segment-rule-operator.js';
@@ -191,14 +310,35 @@ 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/stacking-group-mode.js';
+import '../enums/stacking-group-patch-mode.js';
+import '../enums/stacking-group-write-mode.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/tag-manager-container-check-reason.js';
+import '../enums/tag-manager-marketing-tag-kind.js';
+import '../enums/tag-manager-marketing-tag-load.js';
+import '../enums/tag-manager-marketing-tag-input-kind.js';
+import '../enums/tag-manager-marketing-tag-input-load.js';
+import '../enums/tag-manager-trigger-kind.js';
+import '../enums/tag-manager-trigger-input-kind.js';
+import '../enums/tag-manager-variable-kind.js';
+import '../enums/tag-manager-variable-input-kind.js';
 import '../enums/validation-failed-response-status.js';
+import '../enums/vendor-legal-basis-override.js';
+import '../enums/vendor-create-request-legal-basis-override.js';
+import '../enums/vendor-update-request-legal-basis-override.js';
 import '../enums/vocabulary-default-tone.js';
 import '../enums/vocabulary-source.js';
 import '../enums/vocabulary-tone.js';
+import '../enums/voucher-status.js';
+import '../enums/voucher-batch-status.js';
+import '../enums/voucher-batch-patch-status.js';
+import '../enums/voucher-batch-write-status.js';
+import '../enums/voucher-patch-status.js';
+import '../enums/voucher-write-status.js';
 import '../enums/attribute-boolean-status.js';
 import '../enums/attribute-datetime-status.js';
 import '../enums/attribute-email-status.js';
@@ -260,6 +400,10 @@ declare class InventoriesLocations {
      * @param {boolean} params.enabled - Exact-match filter on `enabled`. Only enabled locations are ever served by availability or reserve, so `true` is the operational subset.
      * @param {string} params.address - Exact-match filter on `address`. Where the location physically is. 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.metadata - Exact-match filter on `metadata`. Free-form data the tenant keeps on the location — an ERP site number, a contact, a cut-off time. 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.externalId - Exact-match filter on `external_id`. The key this row has in the system that OWNS it.
+     * @param {string} params.externalRefs - Exact-match filter on `external_refs`. Every OTHER system that knows this row, keyed by system name. 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.sourceSyncedAt - Exact-match filter on `source_synced_at`. When this row was last confirmed against its source.
+     * @param {string} params.sourceData - Exact-match filter on `source_data`. What the source said about this row, kept as it said it. 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 row was last written.
      * @throws {RevenexxException}
@@ -278,6 +422,10 @@ declare class InventoriesLocations {
         enabled?: boolean;
         address?: string;
         metadata?: string;
+        externalId?: string;
+        externalRefs?: string;
+        sourceSyncedAt?: string;
+        sourceData?: string;
         createdAt?: string;
         updatedAt?: string;
     }): Promise<{}>;
@@ -296,15 +444,19 @@ declare class InventoriesLocations {
      * @param {boolean} enabled - Exact-match filter on `enabled`. Only enabled locations are ever served by availability or reserve, so `true` is the operational subset.
      * @param {string} address - Exact-match filter on `address`. Where the location physically is. 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} metadata - Exact-match filter on `metadata`. Free-form data the tenant keeps on the location — an ERP site number, a contact, a cut-off time. 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} externalId - Exact-match filter on `external_id`. The key this row has in the system that OWNS it.
+     * @param {string} externalRefs - Exact-match filter on `external_refs`. Every OTHER system that knows this row, keyed by system name. 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} sourceSyncedAt - Exact-match filter on `source_synced_at`. When this row was last confirmed against its source.
+     * @param {string} sourceData - Exact-match filter on `source_data`. What the source said about this row, kept as it said it. 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 row was last written.
      * @throws {RevenexxException}
      * @returns {Promise<{}>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    inventoriesLocationsList(limit?: number, offset?: number, order?: string, id?: string, code?: string, name?: string, labels?: string, type?: InventoriesLocationsListType, priority?: number, enabled?: boolean, address?: string, metadata?: string, createdAt?: string, updatedAt?: string): Promise<{}>;
+    inventoriesLocationsList(limit?: number, offset?: number, order?: string, id?: string, code?: string, name?: string, labels?: string, type?: InventoriesLocationsListType, priority?: number, enabled?: boolean, address?: string, metadata?: string, externalId?: string, externalRefs?: string, sourceSyncedAt?: string, sourceData?: string, createdAt?: string, updatedAt?: string): Promise<{}>;
     /**
-     * Registers a new place stock can be kept, and `type` says what kind of place it is: a warehouse of your own, a store whose shop floor a click-and-collect order draws on, a dropship supplier whose stock this row only tracks, or a virtual bucket that is not a building at all — pre-orders, consignment, a quarantine shelf. A create cannot omit `code` and `name`; every other column is optional or defaulted by the database. Two rows of this tenant may not share `code` — that is the 409, and it answers an update that moves a row onto a sibling's value exactly as it answers a second insert. A new location starts EMPTY and creating one moves nothing: stock arrives through POST /inventories/receive, or is transferred by two adjustments, one negative at the old location and one positive here. Mind the two columns that are not decoration — `priority` decides where a reservation is served from before `type` ever does (nothing branches on `type`), and `enabled` defaults to true, so a location created for a warehouse that has not opened yet starts being offered by availability and reserve immediately.
+     * Registers a new place stock can be kept, and `type` says what kind of place it is: a warehouse of your own, a store whose shop floor a click-and-collect order draws on, a dropship supplier whose stock this row only tracks, or a virtual bucket that is not a building at all — pre-orders, consignment, a quarantine shelf. A create cannot omit `code` and `name`; every other column is optional or defaulted by the database. Two rows of this tenant may not share `code` and `external_id` — that is the 409, and it answers an update that moves a row onto a sibling's value exactly as it answers a second insert. A new location starts EMPTY and creating one moves nothing: stock arrives through POST /inventories/receive, or is transferred by two adjustments, one negative at the old location and one positive here. Mind the two columns that are not decoration — `priority` decides where a reservation is served from before `type` ever does (nothing branches on `type`), and `enabled` defaults to true, so a location created for a warehouse that has not opened yet starts being offered by availability and reserve immediately.
      *
      * @param {string} params.code - The location's stable identifier, and the name every stock call uses instead of an id: `location_code` on receive / adjust / restock / reserve, and the `default_location_code` setting. Unique per tenant, at least one character (CHECK `length(code) > 0`). Every tenant starts with `main` — POST /inventories/locations/defaults seeds it and the app.installed event runs the same seed — so `main` is the one code that resolves everywhere.
      * @param {string} params.name - What the place is called for an operator, in the tenant's working language. At least one character (CHECK `length(name) > 0`). It is a label only: nothing addresses a location by name.
@@ -328,7 +480,7 @@ declare class InventoriesLocations {
         type?: LocationType;
     }): Promise<Models.Location>;
     /**
-     * Registers a new place stock can be kept, and `type` says what kind of place it is: a warehouse of your own, a store whose shop floor a click-and-collect order draws on, a dropship supplier whose stock this row only tracks, or a virtual bucket that is not a building at all — pre-orders, consignment, a quarantine shelf. A create cannot omit `code` and `name`; every other column is optional or defaulted by the database. Two rows of this tenant may not share `code` — that is the 409, and it answers an update that moves a row onto a sibling's value exactly as it answers a second insert. A new location starts EMPTY and creating one moves nothing: stock arrives through POST /inventories/receive, or is transferred by two adjustments, one negative at the old location and one positive here. Mind the two columns that are not decoration — `priority` decides where a reservation is served from before `type` ever does (nothing branches on `type`), and `enabled` defaults to true, so a location created for a warehouse that has not opened yet starts being offered by availability and reserve immediately.
+     * Registers a new place stock can be kept, and `type` says what kind of place it is: a warehouse of your own, a store whose shop floor a click-and-collect order draws on, a dropship supplier whose stock this row only tracks, or a virtual bucket that is not a building at all — pre-orders, consignment, a quarantine shelf. A create cannot omit `code` and `name`; every other column is optional or defaulted by the database. Two rows of this tenant may not share `code` and `external_id` — that is the 409, and it answers an update that moves a row onto a sibling's value exactly as it answers a second insert. A new location starts EMPTY and creating one moves nothing: stock arrives through POST /inventories/receive, or is transferred by two adjustments, one negative at the old location and one positive here. Mind the two columns that are not decoration — `priority` decides where a reservation is served from before `type` ever does (nothing branches on `type`), and `enabled` defaults to true, so a location created for a warehouse that has not opened yet starts being offered by availability and reserve immediately.
      *
      * @param {string} code - The location's stable identifier, and the name every stock call uses instead of an id: `location_code` on receive / adjust / restock / reserve, and the `default_location_code` setting. Unique per tenant, at least one character (CHECK `length(code) > 0`). Every tenant starts with `main` — POST /inventories/locations/defaults seeds it and the app.installed event runs the same seed — so `main` is the one code that resolves everywhere.
      * @param {string} name - What the place is called for an operator, in the tenant's working language. At least one character (CHECK `length(name) > 0`). It is a label only: nothing addresses a location by name.
@@ -344,7 +496,7 @@ declare class InventoriesLocations {
      */
     inventoriesLocationsCreate(code: string, name: string, address?: object, enabled?: boolean, labels?: object, metadata?: object, priority?: number, type?: LocationType): Promise<Models.Location>;
     /**
-     * Gives a tenant its first location, `main`, so the stock calls have somewhere to book into: `receive`, `adjust` and `restock` fall back to the `default_location_code` setting when a caller names no `location_code`, and a tenant with no location at all answers 400 on its first receipt. The platform already runs this on `app.installed`, so calling it by hand is the repair for an install that predates the event or a `main` somebody deleted. Idempotent by CODE, not by contents: a location already carrying that code is reported under `existing` and is NOT touched, so a renamed or disabled `main` stays renamed and disabled. It creates nothing else and never removes a location.
+     * Gives a tenant the two sets it cannot start without. First its first location, `main`, so the stock calls have somewhere to book into: `receive`, `adjust` and `restock` fall back to the `default_location_code` setting when a caller names no `location_code`, and a tenant with no location at all answers 400 on its first receipt. Then the four availability states this app ships with, reported under `availability_states` and kept out of the two lists above because a state is not a location. The platform already runs this on `app.installed`, so calling it by hand is the repair for an install that predates the event or a `main` somebody deleted. Idempotent by CODE, not by contents: a row already carrying that code is reported under `existing` and is NOT touched, so a renamed or disabled `main` stays renamed and disabled and a state whose `orderable` a merchant corrected keeps the correction. It creates nothing else and never removes anything.
      *
      * @throws {RevenexxException}
      * @returns {Promise<{}>}
@@ -389,7 +541,7 @@ declare class InventoriesLocations {
      */
     inventoriesLocationsGet(id: string): Promise<Models.Location>;
     /**
-     * Partial update: send the fields that change. The one with consequences is `enabled` — setting it to false is how a location is taken out of service WITHOUT losing anything. Availability and reserve stop looking at it, so its stock stops being sellable, while every stock row, ledger booking and reservation that points at it survives untouched and comes back the moment it is enabled again. That is the reversible alternative to DELETE, which is not reversible at all. Changing `code` is the other sharp edge: rows keep their `location_id` so nothing moves, but every caller that names the old code in `location_code` starts getting 400 "unknown location". Two rows of this tenant may not share `code` — that is the 409, and it answers an update that moves a row onto a sibling's value exactly as it answers a second insert.
+     * Partial update: send the fields that change. The one with consequences is `enabled` — setting it to false is how a location is taken out of service WITHOUT losing anything. Availability and reserve stop looking at it, so its stock stops being sellable, while every stock row, ledger booking and reservation that points at it survives untouched and comes back the moment it is enabled again. That is the reversible alternative to DELETE, which is not reversible at all. Changing `code` is the other sharp edge: rows keep their `location_id` so nothing moves, but every caller that names the old code in `location_code` starts getting 400 "unknown location". Two rows of this tenant may not share `code` and `external_id` — that is the 409, and it answers an update that moves a row onto a sibling's value exactly as it answers a second insert.
      *
      * @param {string} params.id - The location.
      * @param {object} params.address - Where the location physically is. Free-form, and one key is READ: `country`, an ISO country code, which POST /inventories/reserve compares (case-insensitively) against `ship_to.country` when `allocation_strategy` is 'nearest' — that is what stops a German order pulling from the US warehouse because it happens to sort first. The keys the cockpit form writes are `street`, `postal_code`, `city`, `country`; anything else a tenant stores is kept and ignored.
@@ -415,7 +567,7 @@ declare class InventoriesLocations {
         type?: LocationType;
     }): Promise<Models.Location>;
     /**
-     * Partial update: send the fields that change. The one with consequences is `enabled` — setting it to false is how a location is taken out of service WITHOUT losing anything. Availability and reserve stop looking at it, so its stock stops being sellable, while every stock row, ledger booking and reservation that points at it survives untouched and comes back the moment it is enabled again. That is the reversible alternative to DELETE, which is not reversible at all. Changing `code` is the other sharp edge: rows keep their `location_id` so nothing moves, but every caller that names the old code in `location_code` starts getting 400 "unknown location". Two rows of this tenant may not share `code` — that is the 409, and it answers an update that moves a row onto a sibling's value exactly as it answers a second insert.
+     * Partial update: send the fields that change. The one with consequences is `enabled` — setting it to false is how a location is taken out of service WITHOUT losing anything. Availability and reserve stop looking at it, so its stock stops being sellable, while every stock row, ledger booking and reservation that points at it survives untouched and comes back the moment it is enabled again. That is the reversible alternative to DELETE, which is not reversible at all. Changing `code` is the other sharp edge: rows keep their `location_id` so nothing moves, but every caller that names the old code in `location_code` starts getting 400 "unknown location". Two rows of this tenant may not share `code` and `external_id` — that is the 409, and it answers an update that moves a row onto a sibling's value exactly as it answers a second insert.
      *
      * @param {string} id - The location.
      * @param {object} address - Where the location physically is. Free-form, and one key is READ: `country`, an ISO country code, which POST /inventories/reserve compares (case-insensitively) against `ship_to.country` when `allocation_strategy` is 'nearest' — that is what stops a German order pulling from the US warehouse because it happens to sort first. The keys the cockpit form writes are `street`, `postal_code`, `city`, `country`; anything else a tenant stores is kept and ignored.

package/dist/services/inventories-locations.js

@@ -24,8 +24,12 @@ class InventoriesLocations {
         enabled: rest[8],
         address: rest[9],
         metadata: rest[10],
-        createdAt: rest[11],
-        updatedAt: rest[12]
+        externalId: rest[11],
+        externalRefs: rest[12],
+        sourceSyncedAt: rest[13],
+        sourceData: rest[14],
+        createdAt: rest[15],
+        updatedAt: rest[16]
       };
     }
     const limit = params.limit;
@@ -40,6 +44,10 @@ class InventoriesLocations {
     const enabled = params.enabled;
     const address = params.address;
     const metadata = params.metadata;
+    const externalId = params.externalId;
+    const externalRefs = params.externalRefs;
+    const sourceSyncedAt = params.sourceSyncedAt;
+    const sourceData = params.sourceData;
     const createdAt = params.createdAt;
     const updatedAt = params.updatedAt;
     const apiPath = "/v1/inventories/locations";
@@ -80,6 +88,18 @@ class InventoriesLocations {
     if (typeof metadata !== "undefined") {
       apiPayload["metadata"] = metadata;
     }
+    if (typeof externalId !== "undefined") {
+      apiPayload["external_id"] = externalId;
+    }
+    if (typeof externalRefs !== "undefined") {
+      apiPayload["external_refs"] = externalRefs;
+    }
+    if (typeof sourceSyncedAt !== "undefined") {
+      apiPayload["source_synced_at"] = sourceSyncedAt;
+    }
+    if (typeof sourceData !== "undefined") {
+      apiPayload["source_data"] = sourceData;
+    }
     if (typeof createdAt !== "undefined") {
       apiPayload["created_at"] = createdAt;
     }
@@ -163,7 +183,7 @@ class InventoriesLocations {
     );
   }
   /**
-   * Gives a tenant its first location, `main`, so the stock calls have somewhere to book into: `receive`, `adjust` and `restock` fall back to the `default_location_code` setting when a caller names no `location_code`, and a tenant with no location at all answers 400 on its first receipt. The platform already runs this on `app.installed`, so calling it by hand is the repair for an install that predates the event or a `main` somebody deleted. Idempotent by CODE, not by contents: a location already carrying that code is reported under `existing` and is NOT touched, so a renamed or disabled `main` stays renamed and disabled. It creates nothing else and never removes a location.
+   * Gives a tenant the two sets it cannot start without. First its first location, `main`, so the stock calls have somewhere to book into: `receive`, `adjust` and `restock` fall back to the `default_location_code` setting when a caller names no `location_code`, and a tenant with no location at all answers 400 on its first receipt. Then the four availability states this app ships with, reported under `availability_states` and kept out of the two lists above because a state is not a location. The platform already runs this on `app.installed`, so calling it by hand is the repair for an install that predates the event or a `main` somebody deleted. Idempotent by CODE, not by contents: a row already carrying that code is reported under `existing` and is NOT touched, so a renamed or disabled `main` stays renamed and disabled and a state whose `orderable` a merchant corrected keeps the correction. It creates nothing else and never removes anything.
    *
    * @throws {RevenexxException}
    * @returns {Promise<{}>}