@revenexx/node 0.1.0 → 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -0
- package/dist/client.d.mts +25 -0
- package/dist/client.d.ts +25 -0
- package/dist/client.js +39 -18
- package/dist/client.js.map +1 -1
- package/dist/client.mjs +35 -14
- package/dist/client.mjs.map +1 -1
- package/dist/enums/approval-rule-approver-type.d.mts +7 -0
- package/dist/enums/approval-rule-approver-type.d.ts +7 -0
- package/dist/enums/approval-rule-approver-type.js +12 -0
- package/dist/enums/approval-rule-approver-type.js.map +1 -0
- package/dist/enums/approval-rule-approver-type.mjs +11 -0
- package/dist/enums/approval-rule-approver-type.mjs.map +1 -0
- package/dist/enums/approval-rule-condition.d.mts +10 -0
- package/dist/enums/approval-rule-condition.d.ts +10 -0
- package/dist/enums/approval-rule-condition.js +15 -0
- package/dist/enums/approval-rule-condition.js.map +1 -0
- package/dist/enums/approval-rule-condition.mjs +14 -0
- package/dist/enums/approval-rule-condition.mjs.map +1 -0
- package/dist/enums/approval-rule-create-request-approver-type.d.mts +7 -0
- package/dist/enums/approval-rule-create-request-approver-type.d.ts +7 -0
- package/dist/enums/approval-rule-create-request-approver-type.js +12 -0
- package/dist/enums/approval-rule-create-request-approver-type.js.map +1 -0
- package/dist/enums/approval-rule-create-request-approver-type.mjs +11 -0
- package/dist/enums/approval-rule-create-request-approver-type.mjs.map +1 -0
- package/dist/enums/approval-rule-create-request-condition.d.mts +10 -0
- package/dist/enums/approval-rule-create-request-condition.d.ts +10 -0
- package/dist/enums/approval-rule-create-request-condition.js +15 -0
- package/dist/enums/approval-rule-create-request-condition.js.map +1 -0
- package/dist/enums/approval-rule-create-request-condition.mjs +14 -0
- package/dist/enums/approval-rule-create-request-condition.mjs.map +1 -0
- package/dist/enums/approval-rule-create-request-effect.d.mts +7 -0
- package/dist/enums/approval-rule-create-request-effect.d.ts +7 -0
- package/dist/enums/approval-rule-create-request-effect.js +12 -0
- package/dist/enums/approval-rule-create-request-effect.js.map +1 -0
- package/dist/enums/approval-rule-create-request-effect.mjs +11 -0
- package/dist/enums/approval-rule-create-request-effect.mjs.map +1 -0
- package/dist/enums/approval-rule-effect.d.mts +7 -0
- package/dist/enums/approval-rule-effect.d.ts +7 -0
- package/dist/enums/approval-rule-effect.js +12 -0
- package/dist/enums/approval-rule-effect.js.map +1 -0
- package/dist/enums/approval-rule-effect.mjs +11 -0
- package/dist/enums/approval-rule-effect.mjs.map +1 -0
- package/dist/enums/approval-rule-update-request-approver-type.d.mts +7 -0
- package/dist/enums/approval-rule-update-request-approver-type.d.ts +7 -0
- package/dist/enums/approval-rule-update-request-approver-type.js +12 -0
- package/dist/enums/approval-rule-update-request-approver-type.js.map +1 -0
- package/dist/enums/approval-rule-update-request-approver-type.mjs +11 -0
- package/dist/enums/approval-rule-update-request-approver-type.mjs.map +1 -0
- package/dist/enums/approval-rule-update-request-condition.d.mts +10 -0
- package/dist/enums/approval-rule-update-request-condition.d.ts +10 -0
- package/dist/enums/approval-rule-update-request-condition.js +15 -0
- package/dist/enums/approval-rule-update-request-condition.js.map +1 -0
- package/dist/enums/approval-rule-update-request-condition.mjs +14 -0
- package/dist/enums/approval-rule-update-request-condition.mjs.map +1 -0
- package/dist/enums/approval-rule-update-request-effect.d.mts +7 -0
- package/dist/enums/approval-rule-update-request-effect.d.ts +7 -0
- package/dist/enums/approval-rule-update-request-effect.js +12 -0
- package/dist/enums/approval-rule-update-request-effect.js.map +1 -0
- package/dist/enums/approval-rule-update-request-effect.mjs +11 -0
- package/dist/enums/approval-rule-update-request-effect.mjs.map +1 -0
- package/dist/enums/approver-type.d.mts +7 -0
- package/dist/enums/approver-type.d.ts +7 -0
- package/dist/enums/approver-type.js +12 -0
- package/dist/enums/approver-type.js.map +1 -0
- package/dist/enums/approver-type.mjs +11 -0
- package/dist/enums/approver-type.mjs.map +1 -0
- package/dist/enums/condition.d.mts +10 -0
- package/dist/enums/condition.d.ts +10 -0
- package/dist/enums/condition.js +15 -0
- package/dist/enums/condition.js.map +1 -0
- package/dist/enums/condition.mjs +14 -0
- package/dist/enums/condition.mjs.map +1 -0
- package/dist/enums/effect.d.mts +7 -0
- package/dist/enums/effect.d.ts +7 -0
- package/dist/enums/effect.js +12 -0
- package/dist/enums/effect.js.map +1 -0
- package/dist/enums/effect.mjs +11 -0
- package/dist/enums/effect.mjs.map +1 -0
- package/dist/enums/pending-approval-approver-type.d.mts +7 -0
- package/dist/enums/pending-approval-approver-type.d.ts +7 -0
- package/dist/enums/pending-approval-approver-type.js +12 -0
- package/dist/enums/pending-approval-approver-type.js.map +1 -0
- package/dist/enums/pending-approval-approver-type.mjs +11 -0
- package/dist/enums/pending-approval-approver-type.mjs.map +1 -0
- package/dist/enums/pending-approval-status.d.mts +7 -0
- package/dist/enums/pending-approval-status.d.ts +7 -0
- package/dist/enums/pending-approval-status.js +12 -0
- package/dist/enums/pending-approval-status.js.map +1 -0
- package/dist/enums/pending-approval-status.mjs +11 -0
- package/dist/enums/pending-approval-status.mjs.map +1 -0
- package/dist/enums/procurement-purchase-request-items-create-type.d.mts +7 -0
- package/dist/enums/procurement-purchase-request-items-create-type.d.ts +7 -0
- package/dist/enums/procurement-purchase-request-items-create-type.js +12 -0
- package/dist/enums/procurement-purchase-request-items-create-type.js.map +1 -0
- package/dist/enums/procurement-purchase-request-items-create-type.mjs +11 -0
- package/dist/enums/procurement-purchase-request-items-create-type.mjs.map +1 -0
- package/dist/enums/purchase-request-event-name.d.mts +12 -0
- package/dist/enums/purchase-request-event-name.d.ts +12 -0
- package/dist/enums/purchase-request-event-name.js +17 -0
- package/dist/enums/purchase-request-event-name.js.map +1 -0
- package/dist/enums/purchase-request-event-name.mjs +16 -0
- package/dist/enums/purchase-request-event-name.mjs.map +1 -0
- package/dist/enums/purchase-request-item-create-request-type.d.mts +7 -0
- package/dist/enums/purchase-request-item-create-request-type.d.ts +7 -0
- package/dist/enums/purchase-request-item-create-request-type.js +12 -0
- package/dist/enums/purchase-request-item-create-request-type.js.map +1 -0
- package/dist/enums/purchase-request-item-create-request-type.mjs +11 -0
- package/dist/enums/purchase-request-item-create-request-type.mjs.map +1 -0
- package/dist/enums/purchase-request-item-type.d.mts +7 -0
- package/dist/enums/purchase-request-item-type.d.ts +7 -0
- package/dist/enums/purchase-request-item-type.js +12 -0
- package/dist/enums/purchase-request-item-type.js.map +1 -0
- package/dist/enums/purchase-request-item-type.mjs +11 -0
- package/dist/enums/purchase-request-item-type.mjs.map +1 -0
- package/dist/enums/purchase-request-item-update-request-type.d.mts +7 -0
- package/dist/enums/purchase-request-item-update-request-type.d.ts +7 -0
- package/dist/enums/purchase-request-item-update-request-type.js +12 -0
- package/dist/enums/purchase-request-item-update-request-type.js.map +1 -0
- package/dist/enums/purchase-request-item-update-request-type.mjs +11 -0
- package/dist/enums/purchase-request-item-update-request-type.mjs.map +1 -0
- package/dist/enums/purchase-request-status.d.mts +9 -0
- package/dist/enums/purchase-request-status.d.ts +9 -0
- package/dist/enums/purchase-request-status.js +14 -0
- package/dist/enums/purchase-request-status.js.map +1 -0
- package/dist/enums/purchase-request-status.mjs +13 -0
- package/dist/enums/purchase-request-status.mjs.map +1 -0
- package/dist/enums/submit-item-type.d.mts +7 -0
- package/dist/enums/submit-item-type.d.ts +7 -0
- package/dist/enums/submit-item-type.js +12 -0
- package/dist/enums/submit-item-type.js.map +1 -0
- package/dist/enums/submit-item-type.mjs +11 -0
- package/dist/enums/submit-item-type.mjs.map +1 -0
- package/dist/enums/submit-result-outcome.d.mts +9 -0
- package/dist/enums/submit-result-outcome.d.ts +9 -0
- package/dist/enums/submit-result-outcome.js +14 -0
- package/dist/enums/submit-result-outcome.js.map +1 -0
- package/dist/enums/submit-result-outcome.mjs +13 -0
- package/dist/enums/submit-result-outcome.mjs.map +1 -0
- package/dist/index.d.mts +23 -0
- package/dist/index.d.ts +23 -0
- package/dist/index.js +115 -0
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +23 -0
- package/dist/index.mjs.map +1 -1
- package/dist/inputFile.js +1 -2
- package/dist/inputFile.js.map +1 -1
- package/dist/inputFile.mjs +0 -1
- package/dist/inputFile.mjs.map +1 -1
- package/dist/models.d.mts +1027 -36
- package/dist/models.d.ts +1027 -36
- package/dist/operator.js +243 -204
- package/dist/operator.js.map +1 -1
- package/dist/operator.mjs +242 -203
- package/dist/operator.mjs.map +1 -1
- package/dist/permission.js +58 -48
- package/dist/permission.js.map +1 -1
- package/dist/permission.mjs +58 -48
- package/dist/permission.mjs.map +1 -1
- package/dist/query.js +525 -422
- package/dist/query.js.map +1 -1
- package/dist/query.mjs +524 -421
- package/dist/query.mjs.map +1 -1
- package/dist/services/apps.d.mts +18 -0
- package/dist/services/apps.d.ts +18 -0
- package/dist/services/avatars.d.mts +18 -0
- package/dist/services/avatars.d.ts +18 -0
- package/dist/services/carts-io.d.mts +46 -28
- package/dist/services/carts-io.d.ts +46 -28
- package/dist/services/carts-io.js.map +1 -1
- package/dist/services/carts-io.mjs.map +1 -1
- package/dist/services/carts-items.d.mts +42 -24
- package/dist/services/carts-items.d.ts +42 -24
- package/dist/services/carts-items.js.map +1 -1
- package/dist/services/carts-items.mjs.map +1 -1
- package/dist/services/carts.d.mts +70 -52
- package/dist/services/carts.d.ts +70 -52
- package/dist/services/carts.js.map +1 -1
- package/dist/services/carts.mjs.map +1 -1
- package/dist/services/channels.d.mts +64 -46
- package/dist/services/channels.d.ts +64 -46
- package/dist/services/channels.js +1 -1
- package/dist/services/channels.js.map +1 -1
- package/dist/services/channels.mjs +1 -1
- package/dist/services/channels.mjs.map +1 -1
- package/dist/services/cost-centers.d.mts +18 -0
- package/dist/services/cost-centers.d.ts +18 -0
- package/dist/services/customers-contacts.d.mts +62 -44
- package/dist/services/customers-contacts.d.ts +62 -44
- package/dist/services/customers-contacts.js.map +1 -1
- package/dist/services/customers-contacts.mjs.map +1 -1
- package/dist/services/customers-organizations.d.mts +58 -40
- package/dist/services/customers-organizations.d.ts +58 -40
- package/dist/services/customers-organizations.js.map +1 -1
- package/dist/services/customers-organizations.mjs.map +1 -1
- package/dist/services/customers-roles.d.mts +26 -8
- package/dist/services/customers-roles.d.ts +26 -8
- package/dist/services/customers-roles.js.map +1 -1
- package/dist/services/customers-roles.mjs.map +1 -1
- package/dist/services/customers-segments.d.mts +62 -44
- package/dist/services/customers-segments.d.ts +62 -44
- package/dist/services/customers-segments.js.map +1 -1
- package/dist/services/customers-segments.mjs.map +1 -1
- package/dist/services/customers-value-lists.d.mts +90 -72
- package/dist/services/customers-value-lists.d.ts +90 -72
- package/dist/services/customers-value-lists.js.map +1 -1
- package/dist/services/customers-value-lists.mjs.map +1 -1
- package/dist/services/customers.d.mts +78 -60
- package/dist/services/customers.d.ts +78 -60
- package/dist/services/customers.js.map +1 -1
- package/dist/services/customers.mjs.map +1 -1
- package/dist/services/events.d.mts +18 -0
- package/dist/services/events.d.ts +18 -0
- package/dist/services/forms.d.mts +66 -48
- package/dist/services/forms.d.ts +66 -48
- package/dist/services/forms.js.map +1 -1
- package/dist/services/forms.mjs.map +1 -1
- package/dist/services/health.d.mts +18 -0
- package/dist/services/health.d.ts +18 -0
- package/dist/services/inventories-locations.d.mts +38 -20
- package/dist/services/inventories-locations.d.ts +38 -20
- package/dist/services/inventories-locations.js.map +1 -1
- package/dist/services/inventories-locations.mjs.map +1 -1
- package/dist/services/inventories-reservations.d.mts +38 -20
- package/dist/services/inventories-reservations.d.ts +38 -20
- package/dist/services/inventories-reservations.js.map +1 -1
- package/dist/services/inventories-reservations.mjs.map +1 -1
- package/dist/services/inventories-stock.d.mts +70 -52
- package/dist/services/inventories-stock.d.ts +70 -52
- package/dist/services/inventories-stock.js.map +1 -1
- package/dist/services/inventories-stock.mjs.map +1 -1
- package/dist/services/io.d.mts +66 -48
- package/dist/services/io.d.ts +66 -48
- package/dist/services/io.js +2 -2
- package/dist/services/io.js.map +1 -1
- package/dist/services/io.mjs +2 -2
- package/dist/services/io.mjs.map +1 -1
- package/dist/services/locale.d.mts +18 -0
- package/dist/services/locale.d.ts +18 -0
- package/dist/services/markets.d.mts +122 -104
- package/dist/services/markets.d.ts +122 -104
- package/dist/services/markets.js.map +1 -1
- package/dist/services/markets.mjs.map +1 -1
- package/dist/services/messaging.d.mts +194 -176
- package/dist/services/messaging.d.ts +194 -176
- package/dist/services/messaging.js +3 -3
- package/dist/services/messaging.js.map +1 -1
- package/dist/services/messaging.mjs +3 -3
- package/dist/services/messaging.mjs.map +1 -1
- package/dist/services/orderlists.d.mts +96 -78
- package/dist/services/orderlists.d.ts +96 -78
- package/dist/services/orderlists.js +1 -1
- package/dist/services/orderlists.js.map +1 -1
- package/dist/services/orderlists.mjs +1 -1
- package/dist/services/orderlists.mjs.map +1 -1
- package/dist/services/orders.d.mts +114 -96
- package/dist/services/orders.d.ts +114 -96
- package/dist/services/orders.js.map +1 -1
- package/dist/services/orders.mjs.map +1 -1
- package/dist/services/pages-collaboration.d.mts +34 -16
- package/dist/services/pages-collaboration.d.ts +34 -16
- package/dist/services/pages-collaboration.js.map +1 -1
- package/dist/services/pages-collaboration.mjs.map +1 -1
- package/dist/services/pages-delivery.d.mts +26 -8
- package/dist/services/pages-delivery.d.ts +26 -8
- package/dist/services/pages-delivery.js.map +1 -1
- package/dist/services/pages-delivery.mjs.map +1 -1
- package/dist/services/pages-editor.d.mts +34 -16
- package/dist/services/pages-editor.d.ts +34 -16
- package/dist/services/pages-editor.js.map +1 -1
- package/dist/services/pages-editor.mjs.map +1 -1
- package/dist/services/pages.d.mts +82 -64
- package/dist/services/pages.d.ts +82 -64
- package/dist/services/pages.js.map +1 -1
- package/dist/services/pages.mjs.map +1 -1
- package/dist/services/payments-ledger.d.mts +54 -36
- package/dist/services/payments-ledger.d.ts +54 -36
- package/dist/services/payments-ledger.js.map +1 -1
- package/dist/services/payments-ledger.mjs.map +1 -1
- package/dist/services/payments-methods.d.mts +34 -16
- package/dist/services/payments-methods.d.ts +34 -16
- package/dist/services/payments-methods.js.map +1 -1
- package/dist/services/payments-methods.mjs.map +1 -1
- package/dist/services/payments-providers.d.mts +38 -20
- package/dist/services/payments-providers.d.ts +38 -20
- package/dist/services/payments-providers.js.map +1 -1
- package/dist/services/payments-providers.mjs.map +1 -1
- package/dist/services/prices.d.mts +86 -68
- package/dist/services/prices.d.ts +86 -68
- package/dist/services/prices.js.map +1 -1
- package/dist/services/prices.mjs.map +1 -1
- package/dist/services/procurement.d.mts +991 -0
- package/dist/services/procurement.d.ts +991 -0
- package/dist/services/procurement.js +1185 -0
- package/dist/services/procurement.js.map +1 -0
- package/dist/services/procurement.mjs +1184 -0
- package/dist/services/procurement.mjs.map +1 -0
- package/dist/services/products-assets.d.mts +34 -16
- package/dist/services/products-assets.d.ts +34 -16
- package/dist/services/products-assets.js.map +1 -1
- package/dist/services/products-assets.mjs.map +1 -1
- package/dist/services/products-categories.d.mts +66 -48
- package/dist/services/products-categories.d.ts +66 -48
- package/dist/services/products-categories.js.map +1 -1
- package/dist/services/products-categories.mjs.map +1 -1
- package/dist/services/products-data-model.d.mts +166 -148
- package/dist/services/products-data-model.d.ts +166 -148
- package/dist/services/products-data-model.js.map +1 -1
- package/dist/services/products-data-model.mjs.map +1 -1
- package/dist/services/products-references.d.mts +50 -32
- package/dist/services/products-references.d.ts +50 -32
- package/dist/services/products-references.js.map +1 -1
- package/dist/services/products-references.mjs.map +1 -1
- package/dist/services/products.d.mts +70 -52
- package/dist/services/products.d.ts +70 -52
- package/dist/services/products.js.map +1 -1
- package/dist/services/products.mjs.map +1 -1
- package/dist/services/search.d.mts +40 -22
- package/dist/services/search.d.ts +40 -22
- package/dist/services/search.js +1 -1
- package/dist/services/search.js.map +1 -1
- package/dist/services/search.mjs +1 -1
- package/dist/services/search.mjs.map +1 -1
- package/dist/services/settings.d.mts +18 -0
- package/dist/services/settings.d.ts +18 -0
- package/dist/services/shipping-carriers.d.mts +42 -24
- package/dist/services/shipping-carriers.d.ts +42 -24
- package/dist/services/shipping-carriers.js.map +1 -1
- package/dist/services/shipping-carriers.mjs.map +1 -1
- package/dist/services/shipping-methods.d.mts +70 -52
- package/dist/services/shipping-methods.d.ts +70 -52
- package/dist/services/shipping-methods.js.map +1 -1
- package/dist/services/shipping-methods.mjs.map +1 -1
- package/dist/services/shipping-value-lists.d.mts +62 -44
- package/dist/services/shipping-value-lists.d.ts +62 -44
- package/dist/services/shipping-value-lists.js.map +1 -1
- package/dist/services/shipping-value-lists.mjs.map +1 -1
- package/dist/services/sites.d.mts +18 -0
- package/dist/services/sites.d.ts +18 -0
- package/dist/services/storage.d.mts +18 -0
- package/dist/services/storage.d.ts +18 -0
- package/package.json +6 -3
|
@@ -6,6 +6,15 @@ import '../query.js';
|
|
|
6
6
|
import '../enums/address-type-row-tone.js';
|
|
7
7
|
import '../enums/address-type-row-create-request-tone.js';
|
|
8
8
|
import '../enums/address-type-row-update-request-tone.js';
|
|
9
|
+
import '../enums/approval-rule-approver-type.js';
|
|
10
|
+
import '../enums/approval-rule-condition.js';
|
|
11
|
+
import '../enums/approval-rule-effect.js';
|
|
12
|
+
import '../enums/approval-rule-create-request-approver-type.js';
|
|
13
|
+
import '../enums/approval-rule-create-request-condition.js';
|
|
14
|
+
import '../enums/approval-rule-create-request-effect.js';
|
|
15
|
+
import '../enums/approval-rule-update-request-approver-type.js';
|
|
16
|
+
import '../enums/approval-rule-update-request-condition.js';
|
|
17
|
+
import '../enums/approval-rule-update-request-effect.js';
|
|
9
18
|
import '../enums/assets-source.js';
|
|
10
19
|
import '../enums/attribute-value-bucket.js';
|
|
11
20
|
import '../enums/auth-mail-source.js';
|
|
@@ -119,6 +128,8 @@ import '../enums/payment-term-tone.js';
|
|
|
119
128
|
import '../enums/payment-term-create-request-tone.js';
|
|
120
129
|
import '../enums/payment-term-update-request-tone.js';
|
|
121
130
|
import '../enums/payment-vocabulary-tone.js';
|
|
131
|
+
import '../enums/pending-approval-approver-type.js';
|
|
132
|
+
import '../enums/pending-approval-status.js';
|
|
122
133
|
import '../enums/price-ending-rule.js';
|
|
123
134
|
import '../enums/price-entries-adjust-response-rounding.js';
|
|
124
135
|
import '../enums/price-entries-adjust-response-rounding-mode.js';
|
|
@@ -140,6 +151,11 @@ import '../enums/product-categories-source.js';
|
|
|
140
151
|
import '../enums/product-grid-column-source.js';
|
|
141
152
|
import '../enums/product-label-source.js';
|
|
142
153
|
import '../enums/product-label-attribute-source.js';
|
|
154
|
+
import '../enums/purchase-request-status.js';
|
|
155
|
+
import '../enums/purchase-request-event-name.js';
|
|
156
|
+
import '../enums/purchase-request-item-type.js';
|
|
157
|
+
import '../enums/purchase-request-item-create-request-type.js';
|
|
158
|
+
import '../enums/purchase-request-item-update-request-type.js';
|
|
143
159
|
import '../enums/reorder-point-source.js';
|
|
144
160
|
import '../enums/reservation-status.js';
|
|
145
161
|
import '../enums/price-on-request-reason.js';
|
|
@@ -177,6 +193,8 @@ import '../enums/shipping-weight-unit-row-tone.js';
|
|
|
177
193
|
import '../enums/shipping-weight-unit-update-request-tone.js';
|
|
178
194
|
import '../enums/stock-movement-type.js';
|
|
179
195
|
import '../enums/store-asset-request-visibility.js';
|
|
196
|
+
import '../enums/submit-item-type.js';
|
|
197
|
+
import '../enums/submit-result-outcome.js';
|
|
180
198
|
import '../enums/validation-failed-response-status.js';
|
|
181
199
|
import '../enums/vocabulary-default-tone.js';
|
|
182
200
|
import '../enums/vocabulary-source.js';
|
|
@@ -341,7 +359,7 @@ Written only by `POST /products/{id}/completeness` and by `POST /products/{id}/f
|
|
|
341
359
|
It exists because a PIM import (Akeneo, BMEcat) carries these in one blob keyed by association type code, and the column lets that document round-trip instead of being dropped. The database enforces no shape on it, so what a reader finds is whatever the importer wrote; the example is the conventional form.
|
|
342
360
|
* @param {string} params.taxClass - The tax class key the prices app resolves a VAT rate from. Free text here — the vocabulary belongs to the app that prices, and `POST /products/batch` exists to hand exactly this column to it in bulk.
|
|
343
361
|
* @throws {RevenexxException}
|
|
344
|
-
* @returns {Promise<Models.
|
|
362
|
+
* @returns {Promise<Models.Products>}
|
|
345
363
|
*/
|
|
346
364
|
productsCreate(params: {
|
|
347
365
|
sku: string;
|
|
@@ -355,7 +373,7 @@ It exists because a PIM import (Akeneo, BMEcat) carries these in one blob keyed
|
|
|
355
373
|
parentId?: string;
|
|
356
374
|
quantifiedAssociations?: object;
|
|
357
375
|
taxClass?: string;
|
|
358
|
-
}): Promise<Models.
|
|
376
|
+
}): Promise<Models.Products>;
|
|
359
377
|
/**
|
|
360
378
|
* Creates one product and answers 201 with the stored row, including the id and the timestamps the database filled in — a client never sends an id, it reads one back and uses it in the path of every later call.
|
|
361
379
|
*
|
|
@@ -396,10 +414,10 @@ Written only by `POST /products/{id}/completeness` and by `POST /products/{id}/f
|
|
|
396
414
|
It exists because a PIM import (Akeneo, BMEcat) carries these in one blob keyed by association type code, and the column lets that document round-trip instead of being dropped. The database enforces no shape on it, so what a reader finds is whatever the importer wrote; the example is the conventional form.
|
|
397
415
|
* @param {string} taxClass - The tax class key the prices app resolves a VAT rate from. Free text here — the vocabulary belongs to the app that prices, and `POST /products/batch` exists to hand exactly this column to it in bulk.
|
|
398
416
|
* @throws {RevenexxException}
|
|
399
|
-
* @returns {Promise<Models.
|
|
417
|
+
* @returns {Promise<Models.Products>}
|
|
400
418
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
401
419
|
*/
|
|
402
|
-
productsCreate(sku: string, attributeValues?: object, completeness?: object, deletedAt?: string, enabled?: boolean, familyId?: string, familyVariantId?: string, kind?: ProductsKind, parentId?: string, quantifiedAssociations?: object, taxClass?: string): Promise<Models.
|
|
420
|
+
productsCreate(sku: string, attributeValues?: object, completeness?: object, deletedAt?: string, enabled?: boolean, familyId?: string, familyVariantId?: string, kind?: ProductsKind, parentId?: string, quantifiedAssociations?: object, taxClass?: string): Promise<Models.Products>;
|
|
403
421
|
/**
|
|
404
422
|
* Answers four fields — id, sku, tax_class and the resolved display name — for a list of ids and/or SKUs in ONE call. It exists for the app on the other side of a product reference: the prices app holds SKUs and needs a tax class, a feed builder holds ids and needs names, and neither should page through the catalog or fire a request per line. Ask by either identifier or both; the two are unioned and a product named twice comes back once.
|
|
405
423
|
*
|
|
@@ -439,7 +457,7 @@ It exists because a PIM import (Akeneo, BMEcat) carries these in one blob keyed
|
|
|
439
457
|
* @param {boolean} params.enabled - Restrict to enabled or disabled products.
|
|
440
458
|
* @param {string} params.familyId - Restrict to one family. A family id that does not exist is not an error here — it simply matches nothing.
|
|
441
459
|
* @throws {RevenexxException}
|
|
442
|
-
* @returns {Promise<
|
|
460
|
+
* @returns {Promise<{}>}
|
|
443
461
|
*/
|
|
444
462
|
productsGrid(params?: {
|
|
445
463
|
limit?: number;
|
|
@@ -449,7 +467,7 @@ It exists because a PIM import (Akeneo, BMEcat) carries these in one blob keyed
|
|
|
449
467
|
kind?: Kind;
|
|
450
468
|
enabled?: boolean;
|
|
451
469
|
familyId?: string;
|
|
452
|
-
}): Promise<
|
|
470
|
+
}): Promise<{}>;
|
|
453
471
|
/**
|
|
454
472
|
* The list a merchant can actually scan, as opposed to `GET /products`, which answers SKUs and a jsonb blob. Every row arrives already flattened: its resolved display name and where that name came from, its family code, its stored completeness, and the value of every attribute the catalog marks `usable_in_grid` — no join, no second call. `q` is a case-insensitive substring of the stored `label` column, which falls back to the SKU, so one box finds a product by either. Soft-deleted products are excluded here, unlike `GET /products`.
|
|
455
473
|
*
|
|
@@ -463,10 +481,10 @@ It exists because a PIM import (Akeneo, BMEcat) carries these in one blob keyed
|
|
|
463
481
|
* @param {boolean} enabled - Restrict to enabled or disabled products.
|
|
464
482
|
* @param {string} familyId - Restrict to one family. A family id that does not exist is not an error here — it simply matches nothing.
|
|
465
483
|
* @throws {RevenexxException}
|
|
466
|
-
* @returns {Promise<
|
|
484
|
+
* @returns {Promise<{}>}
|
|
467
485
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
468
486
|
*/
|
|
469
|
-
productsGrid(limit?: number, offset?: number, order?: string, q?: string, kind?: Kind, enabled?: boolean, familyId?: string): Promise<
|
|
487
|
+
productsGrid(limit?: number, offset?: number, order?: string, q?: string, kind?: Kind, enabled?: boolean, familyId?: string): Promise<{}>;
|
|
470
488
|
/**
|
|
471
489
|
* What is this product CALLED? A product's name is an attribute rather than a column, and which attribute it is, is per family — so no plain read can answer it. This resolves up to 500 products at once, by id and/or SKU: it reads families.label_attribute (falling back to the default_label_attribute setting, then to the conventional `name`) and looks the value up through the scoped attribute_values document — common, then locale_specific in the label_locales order, then the channel buckets.
|
|
472
490
|
*
|
|
@@ -475,12 +493,12 @@ It exists because a PIM import (Akeneo, BMEcat) carries these in one blob keyed
|
|
|
475
493
|
* @param {string[]} params.ids - Product ids to name. At most 500.
|
|
476
494
|
* @param {string[]} params.skus - Product SKUs to name. At most 500.
|
|
477
495
|
* @throws {RevenexxException}
|
|
478
|
-
* @returns {Promise<
|
|
496
|
+
* @returns {Promise<{}>}
|
|
479
497
|
*/
|
|
480
498
|
productsLabels(params?: {
|
|
481
499
|
ids?: string[];
|
|
482
500
|
skus?: string[];
|
|
483
|
-
}): Promise<
|
|
501
|
+
}): Promise<{}>;
|
|
484
502
|
/**
|
|
485
503
|
* What is this product CALLED? A product's name is an attribute rather than a column, and which attribute it is, is per family — so no plain read can answer it. This resolves up to 500 products at once, by id and/or SKU: it reads families.label_attribute (falling back to the default_label_attribute setting, then to the conventional `name`) and looks the value up through the scoped attribute_values document — common, then locale_specific in the label_locales order, then the channel buckets.
|
|
486
504
|
*
|
|
@@ -489,10 +507,10 @@ It exists because a PIM import (Akeneo, BMEcat) carries these in one blob keyed
|
|
|
489
507
|
* @param {string[]} ids - Product ids to name. At most 500.
|
|
490
508
|
* @param {string[]} skus - Product SKUs to name. At most 500.
|
|
491
509
|
* @throws {RevenexxException}
|
|
492
|
-
* @returns {Promise<
|
|
510
|
+
* @returns {Promise<{}>}
|
|
493
511
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
494
512
|
*/
|
|
495
|
-
productsLabels(ids?: string[], skus?: string[]): Promise<
|
|
513
|
+
productsLabels(ids?: string[], skus?: string[]): Promise<{}>;
|
|
496
514
|
/**
|
|
497
515
|
* One relation from one product to another, of a declared type: this drill's accessories, this bundle's parts, this article's cross-sells. `quantity` is the number in "this bundle contains 4 casters" and is meaningful only when the association type carries `is_quantified`. This relational surface is the one this app serves; the `products.quantified_associations` column is an importer's blob that no route here reads or writes.
|
|
498
516
|
*
|
|
@@ -560,7 +578,7 @@ It exists because a PIM import (Akeneo, BMEcat) carries these in one blob keyed
|
|
|
560
578
|
* @param {number} params.position - Order in which the targets are shown, ascending.
|
|
561
579
|
* @param {number} params.quantity - How many of the target belong to the source — the 4 in "this bundle contains 4 casters". Only meaningful when the association type carries `is_quantified`; null on an ordinary cross-sell.
|
|
562
580
|
* @throws {RevenexxException}
|
|
563
|
-
* @returns {Promise<Models.
|
|
581
|
+
* @returns {Promise<Models.ProductAssociations>}
|
|
564
582
|
*/
|
|
565
583
|
productsProductAssociationsCreate(params: {
|
|
566
584
|
associationTypeId: string;
|
|
@@ -568,7 +586,7 @@ It exists because a PIM import (Akeneo, BMEcat) carries these in one blob keyed
|
|
|
568
586
|
targetProductId: string;
|
|
569
587
|
position?: number;
|
|
570
588
|
quantity?: number;
|
|
571
|
-
}): Promise<Models.
|
|
589
|
+
}): Promise<Models.ProductAssociations>;
|
|
572
590
|
/**
|
|
573
591
|
* Creates one product association and answers 201 with the stored row, including the id and the timestamps the database filled in — a client never sends an id, it reads one back and uses it in the path of every later call.
|
|
574
592
|
*
|
|
@@ -582,10 +600,10 @@ It exists because a PIM import (Akeneo, BMEcat) carries these in one blob keyed
|
|
|
582
600
|
* @param {number} position - Order in which the targets are shown, ascending.
|
|
583
601
|
* @param {number} quantity - How many of the target belong to the source — the 4 in "this bundle contains 4 casters". Only meaningful when the association type carries `is_quantified`; null on an ordinary cross-sell.
|
|
584
602
|
* @throws {RevenexxException}
|
|
585
|
-
* @returns {Promise<Models.
|
|
603
|
+
* @returns {Promise<Models.ProductAssociations>}
|
|
586
604
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
587
605
|
*/
|
|
588
|
-
productsProductAssociationsCreate(associationTypeId: string, productId: string, targetProductId: string, position?: number, quantity?: number): Promise<Models.
|
|
606
|
+
productsProductAssociationsCreate(associationTypeId: string, productId: string, targetProductId: string, position?: number, quantity?: number): Promise<Models.ProductAssociations>;
|
|
589
607
|
/**
|
|
590
608
|
* Deletes one product association by id. It is a hard delete — the row is gone, and the answer is a confirmation rather than a result to branch on.
|
|
591
609
|
*
|
|
@@ -595,11 +613,11 @@ It exists because a PIM import (Akeneo, BMEcat) carries these in one blob keyed
|
|
|
595
613
|
*
|
|
596
614
|
* @param {string} params.id - The `product_associations` row to address, by id. It names a row THIS TENANT holds, so no example is published — a uuid this app invented would document a call that answers 404, and a real one would be another tenant's data. Read one from `GET /v1/products/product_associations`. An id no product association of this tenant carries answers 404; a malformed one answers 400 before the route is reached.
|
|
597
615
|
* @throws {RevenexxException}
|
|
598
|
-
* @returns {Promise<
|
|
616
|
+
* @returns {Promise<{}>}
|
|
599
617
|
*/
|
|
600
618
|
productsProductAssociationsDelete(params: {
|
|
601
619
|
id: string;
|
|
602
|
-
}): Promise<
|
|
620
|
+
}): Promise<{}>;
|
|
603
621
|
/**
|
|
604
622
|
* Deletes one product association by id. It is a hard delete — the row is gone, and the answer is a confirmation rather than a result to branch on.
|
|
605
623
|
*
|
|
@@ -609,10 +627,10 @@ It exists because a PIM import (Akeneo, BMEcat) carries these in one blob keyed
|
|
|
609
627
|
*
|
|
610
628
|
* @param {string} id - The `product_associations` row to address, by id. It names a row THIS TENANT holds, so no example is published — a uuid this app invented would document a call that answers 404, and a real one would be another tenant's data. Read one from `GET /v1/products/product_associations`. An id no product association of this tenant carries answers 404; a malformed one answers 400 before the route is reached.
|
|
611
629
|
* @throws {RevenexxException}
|
|
612
|
-
* @returns {Promise<
|
|
630
|
+
* @returns {Promise<{}>}
|
|
613
631
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
614
632
|
*/
|
|
615
|
-
productsProductAssociationsDelete(id: string): Promise<
|
|
633
|
+
productsProductAssociationsDelete(id: string): Promise<{}>;
|
|
616
634
|
/**
|
|
617
635
|
* Reads one product association by its id — the whole row, every column, as it is stored.
|
|
618
636
|
*
|
|
@@ -624,11 +642,11 @@ It exists because a PIM import (Akeneo, BMEcat) carries these in one blob keyed
|
|
|
624
642
|
*
|
|
625
643
|
* @param {string} params.id - The `product_associations` row to address, by id. It names a row THIS TENANT holds, so no example is published — a uuid this app invented would document a call that answers 404, and a real one would be another tenant's data. Read one from `GET /v1/products/product_associations`. An id no product association of this tenant carries answers 404; a malformed one answers 400 before the route is reached.
|
|
626
644
|
* @throws {RevenexxException}
|
|
627
|
-
* @returns {Promise<Models.
|
|
645
|
+
* @returns {Promise<Models.ProductAssociations>}
|
|
628
646
|
*/
|
|
629
647
|
productsProductAssociationsGet(params: {
|
|
630
648
|
id: string;
|
|
631
|
-
}): Promise<Models.
|
|
649
|
+
}): Promise<Models.ProductAssociations>;
|
|
632
650
|
/**
|
|
633
651
|
* Reads one product association by its id — the whole row, every column, as it is stored.
|
|
634
652
|
*
|
|
@@ -640,10 +658,10 @@ It exists because a PIM import (Akeneo, BMEcat) carries these in one blob keyed
|
|
|
640
658
|
*
|
|
641
659
|
* @param {string} id - The `product_associations` row to address, by id. It names a row THIS TENANT holds, so no example is published — a uuid this app invented would document a call that answers 404, and a real one would be another tenant's data. Read one from `GET /v1/products/product_associations`. An id no product association of this tenant carries answers 404; a malformed one answers 400 before the route is reached.
|
|
642
660
|
* @throws {RevenexxException}
|
|
643
|
-
* @returns {Promise<Models.
|
|
661
|
+
* @returns {Promise<Models.ProductAssociations>}
|
|
644
662
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
645
663
|
*/
|
|
646
|
-
productsProductAssociationsGet(id: string): Promise<Models.
|
|
664
|
+
productsProductAssociationsGet(id: string): Promise<Models.ProductAssociations>;
|
|
647
665
|
/**
|
|
648
666
|
* Updates one product association by id. A partial patch: the body names only the columns to change and every column it leaves out keeps its current value, so there is no read-modify-write and no way to blank a field by forgetting it.
|
|
649
667
|
*
|
|
@@ -658,7 +676,7 @@ It exists because a PIM import (Akeneo, BMEcat) carries these in one blob keyed
|
|
|
658
676
|
* @param {number} params.quantity - How many of the target belong to the source — the 4 in "this bundle contains 4 casters". Only meaningful when the association type carries `is_quantified`; null on an ordinary cross-sell.
|
|
659
677
|
* @param {string} params.targetProductId - The product the relation points at — the accessory, the spare part, the cross-sell.
|
|
660
678
|
* @throws {RevenexxException}
|
|
661
|
-
* @returns {Promise<Models.
|
|
679
|
+
* @returns {Promise<Models.ProductAssociations>}
|
|
662
680
|
*/
|
|
663
681
|
productsProductAssociationsUpdate(params: {
|
|
664
682
|
id: string;
|
|
@@ -667,7 +685,7 @@ It exists because a PIM import (Akeneo, BMEcat) carries these in one blob keyed
|
|
|
667
685
|
productId?: string;
|
|
668
686
|
quantity?: number;
|
|
669
687
|
targetProductId?: string;
|
|
670
|
-
}): Promise<Models.
|
|
688
|
+
}): Promise<Models.ProductAssociations>;
|
|
671
689
|
/**
|
|
672
690
|
* Updates one product association by id. A partial patch: the body names only the columns to change and every column it leaves out keeps its current value, so there is no read-modify-write and no way to blank a field by forgetting it.
|
|
673
691
|
*
|
|
@@ -682,10 +700,10 @@ It exists because a PIM import (Akeneo, BMEcat) carries these in one blob keyed
|
|
|
682
700
|
* @param {number} quantity - How many of the target belong to the source — the 4 in "this bundle contains 4 casters". Only meaningful when the association type carries `is_quantified`; null on an ordinary cross-sell.
|
|
683
701
|
* @param {string} targetProductId - The product the relation points at — the accessory, the spare part, the cross-sell.
|
|
684
702
|
* @throws {RevenexxException}
|
|
685
|
-
* @returns {Promise<Models.
|
|
703
|
+
* @returns {Promise<Models.ProductAssociations>}
|
|
686
704
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
687
705
|
*/
|
|
688
|
-
productsProductAssociationsUpdate(id: string, associationTypeId?: string, position?: number, productId?: string, quantity?: number, targetProductId?: string): Promise<Models.
|
|
706
|
+
productsProductAssociationsUpdate(id: string, associationTypeId?: string, position?: number, productId?: string, quantity?: number, targetProductId?: string): Promise<Models.ProductAssociations>;
|
|
689
707
|
/**
|
|
690
708
|
* The index of the enums this app ENFORCES — `product-kinds`, `membership-sources`, `rule-matches`, `asset-sources` — served by the app that owns the CHECK constraint each one is parsed out of, so a UI never has to keep its own copy of a status map and watch it drift. Names and titles only: fetch one by name for its values, badge tones and descriptions.
|
|
691
709
|
*
|
|
@@ -700,20 +718,20 @@ It exists because a PIM import (Akeneo, BMEcat) carries these in one blob keyed
|
|
|
700
718
|
*
|
|
701
719
|
* @param {string} params.name - The vocabulary name, as listed by GET /products/vocabularies.
|
|
702
720
|
* @throws {RevenexxException}
|
|
703
|
-
* @returns {Promise<
|
|
721
|
+
* @returns {Promise<{}>}
|
|
704
722
|
*/
|
|
705
723
|
productsVocabulariesGet(params: {
|
|
706
724
|
name: string;
|
|
707
|
-
}): Promise<
|
|
725
|
+
}): Promise<{}>;
|
|
708
726
|
/**
|
|
709
727
|
* One vocabulary with every value it admits, each with a title, a description and the badge tone a UI should paint it in. The value set is parsed out of the CHECK constraint in schema.json, so what is served IS what is enforced. Labels are curated on top and can only add words and colour — a permitted value nobody labelled still appears, titled from its own key.
|
|
710
728
|
*
|
|
711
729
|
* @param {string} name - The vocabulary name, as listed by GET /products/vocabularies.
|
|
712
730
|
* @throws {RevenexxException}
|
|
713
|
-
* @returns {Promise<
|
|
731
|
+
* @returns {Promise<{}>}
|
|
714
732
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
715
733
|
*/
|
|
716
|
-
productsVocabulariesGet(name: string): Promise<
|
|
734
|
+
productsVocabulariesGet(name: string): Promise<{}>;
|
|
717
735
|
/**
|
|
718
736
|
* Deletes one product by id. It is a hard delete — the row is gone, and the answer is a confirmation rather than a result to branch on.
|
|
719
737
|
*
|
|
@@ -723,11 +741,11 @@ It exists because a PIM import (Akeneo, BMEcat) carries these in one blob keyed
|
|
|
723
741
|
*
|
|
724
742
|
* @param {string} params.id - The `products` row to address, by id. It names a row THIS TENANT holds, so no example is published — a uuid this app invented would document a call that answers 404, and a real one would be another tenant's data. Read one from `GET /v1/products`. An id no product of this tenant carries answers 404; a malformed one answers 400 before the route is reached.
|
|
725
743
|
* @throws {RevenexxException}
|
|
726
|
-
* @returns {Promise<
|
|
744
|
+
* @returns {Promise<{}>}
|
|
727
745
|
*/
|
|
728
746
|
productsDelete(params: {
|
|
729
747
|
id: string;
|
|
730
|
-
}): Promise<
|
|
748
|
+
}): Promise<{}>;
|
|
731
749
|
/**
|
|
732
750
|
* Deletes one product by id. It is a hard delete — the row is gone, and the answer is a confirmation rather than a result to branch on.
|
|
733
751
|
*
|
|
@@ -737,10 +755,10 @@ It exists because a PIM import (Akeneo, BMEcat) carries these in one blob keyed
|
|
|
737
755
|
*
|
|
738
756
|
* @param {string} id - The `products` row to address, by id. It names a row THIS TENANT holds, so no example is published — a uuid this app invented would document a call that answers 404, and a real one would be another tenant's data. Read one from `GET /v1/products`. An id no product of this tenant carries answers 404; a malformed one answers 400 before the route is reached.
|
|
739
757
|
* @throws {RevenexxException}
|
|
740
|
-
* @returns {Promise<
|
|
758
|
+
* @returns {Promise<{}>}
|
|
741
759
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
742
760
|
*/
|
|
743
|
-
productsDelete(id: string): Promise<
|
|
761
|
+
productsDelete(id: string): Promise<{}>;
|
|
744
762
|
/**
|
|
745
763
|
* Reads one product by its id — the whole row, every column, as it is stored.
|
|
746
764
|
*
|
|
@@ -750,11 +768,11 @@ It exists because a PIM import (Akeneo, BMEcat) carries these in one blob keyed
|
|
|
750
768
|
*
|
|
751
769
|
* @param {string} params.id - The `products` row to address, by id. It names a row THIS TENANT holds, so no example is published — a uuid this app invented would document a call that answers 404, and a real one would be another tenant's data. Read one from `GET /v1/products`. An id no product of this tenant carries answers 404; a malformed one answers 400 before the route is reached.
|
|
752
770
|
* @throws {RevenexxException}
|
|
753
|
-
* @returns {Promise<Models.
|
|
771
|
+
* @returns {Promise<Models.Products>}
|
|
754
772
|
*/
|
|
755
773
|
productsGet(params: {
|
|
756
774
|
id: string;
|
|
757
|
-
}): Promise<Models.
|
|
775
|
+
}): Promise<Models.Products>;
|
|
758
776
|
/**
|
|
759
777
|
* Reads one product by its id — the whole row, every column, as it is stored.
|
|
760
778
|
*
|
|
@@ -764,10 +782,10 @@ It exists because a PIM import (Akeneo, BMEcat) carries these in one blob keyed
|
|
|
764
782
|
*
|
|
765
783
|
* @param {string} id - The `products` row to address, by id. It names a row THIS TENANT holds, so no example is published — a uuid this app invented would document a call that answers 404, and a real one would be another tenant's data. Read one from `GET /v1/products`. An id no product of this tenant carries answers 404; a malformed one answers 400 before the route is reached.
|
|
766
784
|
* @throws {RevenexxException}
|
|
767
|
-
* @returns {Promise<Models.
|
|
785
|
+
* @returns {Promise<Models.Products>}
|
|
768
786
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
769
787
|
*/
|
|
770
|
-
productsGet(id: string): Promise<Models.
|
|
788
|
+
productsGet(id: string): Promise<Models.Products>;
|
|
771
789
|
/**
|
|
772
790
|
* Updates one product by id. A partial patch: the body names only the columns to change and every column it leaves out keeps its current value, so there is no read-modify-write and no way to blank a field by forgetting it.
|
|
773
791
|
*
|
|
@@ -809,7 +827,7 @@ It exists because a PIM import (Akeneo, BMEcat) carries these in one blob keyed
|
|
|
809
827
|
* @param {string} params.sku - The merchant's own article number — unique per tenant, and the value every integration (ERP, shop, feed, price list) joins on. The one identifier a person types, and the fallback this app shows when the catalog holds no name.
|
|
810
828
|
* @param {string} params.taxClass - The tax class key the prices app resolves a VAT rate from. Free text here — the vocabulary belongs to the app that prices, and `POST /products/batch` exists to hand exactly this column to it in bulk.
|
|
811
829
|
* @throws {RevenexxException}
|
|
812
|
-
* @returns {Promise<Models.
|
|
830
|
+
* @returns {Promise<Models.Products>}
|
|
813
831
|
*/
|
|
814
832
|
productsUpdate(params: {
|
|
815
833
|
id: string;
|
|
@@ -824,7 +842,7 @@ It exists because a PIM import (Akeneo, BMEcat) carries these in one blob keyed
|
|
|
824
842
|
quantifiedAssociations?: object;
|
|
825
843
|
sku?: string;
|
|
826
844
|
taxClass?: string;
|
|
827
|
-
}): Promise<Models.
|
|
845
|
+
}): Promise<Models.Products>;
|
|
828
846
|
/**
|
|
829
847
|
* Updates one product by id. A partial patch: the body names only the columns to change and every column it leaves out keeps its current value, so there is no read-modify-write and no way to blank a field by forgetting it.
|
|
830
848
|
*
|
|
@@ -866,32 +884,32 @@ It exists because a PIM import (Akeneo, BMEcat) carries these in one blob keyed
|
|
|
866
884
|
* @param {string} sku - The merchant's own article number — unique per tenant, and the value every integration (ERP, shop, feed, price list) joins on. The one identifier a person types, and the fallback this app shows when the catalog holds no name.
|
|
867
885
|
* @param {string} taxClass - The tax class key the prices app resolves a VAT rate from. Free text here — the vocabulary belongs to the app that prices, and `POST /products/batch` exists to hand exactly this column to it in bulk.
|
|
868
886
|
* @throws {RevenexxException}
|
|
869
|
-
* @returns {Promise<Models.
|
|
887
|
+
* @returns {Promise<Models.Products>}
|
|
870
888
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
871
889
|
*/
|
|
872
|
-
productsUpdate(id: string, attributeValues?: object, completeness?: object, deletedAt?: string, enabled?: boolean, familyId?: string, familyVariantId?: string, kind?: ProductsKind, parentId?: string, quantifiedAssociations?: object, sku?: string, taxClass?: string): Promise<Models.
|
|
890
|
+
productsUpdate(id: string, attributeValues?: object, completeness?: object, deletedAt?: string, enabled?: boolean, familyId?: string, familyVariantId?: string, kind?: ProductsKind, parentId?: string, quantifiedAssociations?: object, sku?: string, taxClass?: string): Promise<Models.Products>;
|
|
873
891
|
/**
|
|
874
892
|
* How much of what its family REQUIRES does this product actually carry — the number a merchandiser works down. products.completeness is jsonb that nothing had ever written. This computes it from family_attributes (is_required) against the product's own scoped attribute_values and stores the result. A product with no family answers 400 rather than an invented 0 % — it has nothing to be measured against.
|
|
875
893
|
*
|
|
876
894
|
* @param {string} params.id - The `products` row to address, by id. It names a row THIS TENANT holds, so no example is published — a uuid this app invented would document a call that answers 404, and a real one would be another tenant's data. Read one from `GET /v1/products`. An id no product of this tenant carries answers 404; a malformed one answers 400 before the route is reached.
|
|
877
895
|
* @param {object} params.data - Request body
|
|
878
896
|
* @throws {RevenexxException}
|
|
879
|
-
* @returns {Promise<
|
|
897
|
+
* @returns {Promise<{}>}
|
|
880
898
|
*/
|
|
881
899
|
productsCompleteness(params: {
|
|
882
900
|
id: string;
|
|
883
901
|
data: object;
|
|
884
|
-
}): Promise<
|
|
902
|
+
}): Promise<{}>;
|
|
885
903
|
/**
|
|
886
904
|
* How much of what its family REQUIRES does this product actually carry — the number a merchandiser works down. products.completeness is jsonb that nothing had ever written. This computes it from family_attributes (is_required) against the product's own scoped attribute_values and stores the result. A product with no family answers 400 rather than an invented 0 % — it has nothing to be measured against.
|
|
887
905
|
*
|
|
888
906
|
* @param {string} id - The `products` row to address, by id. It names a row THIS TENANT holds, so no example is published — a uuid this app invented would document a call that answers 404, and a real one would be another tenant's data. Read one from `GET /v1/products`. An id no product of this tenant carries answers 404; a malformed one answers 400 before the route is reached.
|
|
889
907
|
* @param {object} data - Request body
|
|
890
908
|
* @throws {RevenexxException}
|
|
891
|
-
* @returns {Promise<
|
|
909
|
+
* @returns {Promise<{}>}
|
|
892
910
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
893
911
|
*/
|
|
894
|
-
productsCompleteness(id: string, data: object): Promise<
|
|
912
|
+
productsCompleteness(id: string, data: object): Promise<{}>;
|
|
895
913
|
/**
|
|
896
914
|
* Names the family in the body — by `family_id` or by `family_code`, whichever the caller holds — and computes the product's completeness in the same call. The step every family-driven surface waits on: a product with no family has no required attributes, so its completeness cannot be computed and its family's label attribute never resolves. Assigning the family recomputes and STORES products.completeness immediately, so the metadata cannot go stale between the two operations.
|
|
897
915
|
*
|
|
@@ -899,13 +917,13 @@ It exists because a PIM import (Akeneo, BMEcat) carries these in one blob keyed
|
|
|
899
917
|
* @param {string} params.familyCode - Alternative to family_id — a `families.code` this tenant holds, from `GET /products/families`. No example: a code is tenant data, and any value published here names a family somebody does not have.
|
|
900
918
|
* @param {string} params.familyId - The family to assign.
|
|
901
919
|
* @throws {RevenexxException}
|
|
902
|
-
* @returns {Promise<
|
|
920
|
+
* @returns {Promise<{}>}
|
|
903
921
|
*/
|
|
904
922
|
productsFamilyAssign(params: {
|
|
905
923
|
id: string;
|
|
906
924
|
familyCode?: string;
|
|
907
925
|
familyId?: string;
|
|
908
|
-
}): Promise<
|
|
926
|
+
}): Promise<{}>;
|
|
909
927
|
/**
|
|
910
928
|
* Names the family in the body — by `family_id` or by `family_code`, whichever the caller holds — and computes the product's completeness in the same call. The step every family-driven surface waits on: a product with no family has no required attributes, so its completeness cannot be computed and its family's label attribute never resolves. Assigning the family recomputes and STORES products.completeness immediately, so the metadata cannot go stale between the two operations.
|
|
911
929
|
*
|
|
@@ -913,10 +931,10 @@ It exists because a PIM import (Akeneo, BMEcat) carries these in one blob keyed
|
|
|
913
931
|
* @param {string} familyCode - Alternative to family_id — a `families.code` this tenant holds, from `GET /products/families`. No example: a code is tenant data, and any value published here names a family somebody does not have.
|
|
914
932
|
* @param {string} familyId - The family to assign.
|
|
915
933
|
* @throws {RevenexxException}
|
|
916
|
-
* @returns {Promise<
|
|
934
|
+
* @returns {Promise<{}>}
|
|
917
935
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
918
936
|
*/
|
|
919
|
-
productsFamilyAssign(id: string, familyCode?: string, familyId?: string): Promise<
|
|
937
|
+
productsFamilyAssign(id: string, familyCode?: string, familyId?: string): Promise<{}>;
|
|
920
938
|
}
|
|
921
939
|
|
|
922
940
|
export { Products };
|