@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';
|
|
@@ -141,6 +152,11 @@ import '../enums/product-grid-column-source.js';
|
|
|
141
152
|
import '../enums/product-label-source.js';
|
|
142
153
|
import '../enums/product-label-attribute-source.js';
|
|
143
154
|
import '../enums/products-kind.js';
|
|
155
|
+
import '../enums/purchase-request-status.js';
|
|
156
|
+
import '../enums/purchase-request-event-name.js';
|
|
157
|
+
import '../enums/purchase-request-item-type.js';
|
|
158
|
+
import '../enums/purchase-request-item-create-request-type.js';
|
|
159
|
+
import '../enums/purchase-request-item-update-request-type.js';
|
|
144
160
|
import '../enums/reorder-point-source.js';
|
|
145
161
|
import '../enums/reservation-status.js';
|
|
146
162
|
import '../enums/price-on-request-reason.js';
|
|
@@ -178,6 +194,8 @@ import '../enums/shipping-weight-unit-row-tone.js';
|
|
|
178
194
|
import '../enums/shipping-weight-unit-update-request-tone.js';
|
|
179
195
|
import '../enums/stock-movement-type.js';
|
|
180
196
|
import '../enums/store-asset-request-visibility.js';
|
|
197
|
+
import '../enums/submit-item-type.js';
|
|
198
|
+
import '../enums/submit-result-outcome.js';
|
|
181
199
|
import '../enums/validation-failed-response-status.js';
|
|
182
200
|
import '../enums/vocabulary-default-tone.js';
|
|
183
201
|
import '../enums/vocabulary-source.js';
|
|
@@ -290,13 +308,13 @@ declare class ProductsDataModel {
|
|
|
290
308
|
* @param {object} params.labels - What the asset family is called, per language tag.
|
|
291
309
|
* @param {object} params.namingConvention - How a file of this family is named, so an import can bind a file to a product without a mapping table. `source` is the product value the file name is built from, `pattern` how it is assembled, `allowed_extensions` what may be uploaded.
|
|
292
310
|
* @throws {RevenexxException}
|
|
293
|
-
* @returns {Promise<Models.
|
|
311
|
+
* @returns {Promise<Models.AssetFamilies>}
|
|
294
312
|
*/
|
|
295
313
|
productsAssetFamiliesCreate(params: {
|
|
296
314
|
code: string;
|
|
297
315
|
labels?: object;
|
|
298
316
|
namingConvention?: object;
|
|
299
|
-
}): Promise<Models.
|
|
317
|
+
}): Promise<Models.AssetFamilies>;
|
|
300
318
|
/**
|
|
301
319
|
* Creates one asset family 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.
|
|
302
320
|
*
|
|
@@ -308,10 +326,10 @@ declare class ProductsDataModel {
|
|
|
308
326
|
* @param {object} labels - What the asset family is called, per language tag.
|
|
309
327
|
* @param {object} namingConvention - How a file of this family is named, so an import can bind a file to a product without a mapping table. `source` is the product value the file name is built from, `pattern` how it is assembled, `allowed_extensions` what may be uploaded.
|
|
310
328
|
* @throws {RevenexxException}
|
|
311
|
-
* @returns {Promise<Models.
|
|
329
|
+
* @returns {Promise<Models.AssetFamilies>}
|
|
312
330
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
313
331
|
*/
|
|
314
|
-
productsAssetFamiliesCreate(code: string, labels?: object, namingConvention?: object): Promise<Models.
|
|
332
|
+
productsAssetFamiliesCreate(code: string, labels?: object, namingConvention?: object): Promise<Models.AssetFamilies>;
|
|
315
333
|
/**
|
|
316
334
|
* Deletes one asset family by id. It is a hard delete — the row is gone, and the answer is a confirmation rather than a result to branch on.
|
|
317
335
|
*
|
|
@@ -321,11 +339,11 @@ declare class ProductsDataModel {
|
|
|
321
339
|
*
|
|
322
340
|
* @param {string} params.id - The `asset_families` 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/asset_families`. An id no asset familie of this tenant carries answers 404; a malformed one answers 400 before the route is reached.
|
|
323
341
|
* @throws {RevenexxException}
|
|
324
|
-
* @returns {Promise<
|
|
342
|
+
* @returns {Promise<{}>}
|
|
325
343
|
*/
|
|
326
344
|
productsAssetFamiliesDelete(params: {
|
|
327
345
|
id: string;
|
|
328
|
-
}): Promise<
|
|
346
|
+
}): Promise<{}>;
|
|
329
347
|
/**
|
|
330
348
|
* Deletes one asset family by id. It is a hard delete — the row is gone, and the answer is a confirmation rather than a result to branch on.
|
|
331
349
|
*
|
|
@@ -335,10 +353,10 @@ declare class ProductsDataModel {
|
|
|
335
353
|
*
|
|
336
354
|
* @param {string} id - The `asset_families` 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/asset_families`. An id no asset familie of this tenant carries answers 404; a malformed one answers 400 before the route is reached.
|
|
337
355
|
* @throws {RevenexxException}
|
|
338
|
-
* @returns {Promise<
|
|
356
|
+
* @returns {Promise<{}>}
|
|
339
357
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
340
358
|
*/
|
|
341
|
-
productsAssetFamiliesDelete(id: string): Promise<
|
|
359
|
+
productsAssetFamiliesDelete(id: string): Promise<{}>;
|
|
342
360
|
/**
|
|
343
361
|
* Reads one asset family by its id — the whole row, every column, as it is stored.
|
|
344
362
|
*
|
|
@@ -350,11 +368,11 @@ declare class ProductsDataModel {
|
|
|
350
368
|
*
|
|
351
369
|
* @param {string} params.id - The `asset_families` 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/asset_families`. An id no asset familie of this tenant carries answers 404; a malformed one answers 400 before the route is reached.
|
|
352
370
|
* @throws {RevenexxException}
|
|
353
|
-
* @returns {Promise<Models.
|
|
371
|
+
* @returns {Promise<Models.AssetFamilies>}
|
|
354
372
|
*/
|
|
355
373
|
productsAssetFamiliesGet(params: {
|
|
356
374
|
id: string;
|
|
357
|
-
}): Promise<Models.
|
|
375
|
+
}): Promise<Models.AssetFamilies>;
|
|
358
376
|
/**
|
|
359
377
|
* Reads one asset family by its id — the whole row, every column, as it is stored.
|
|
360
378
|
*
|
|
@@ -366,10 +384,10 @@ declare class ProductsDataModel {
|
|
|
366
384
|
*
|
|
367
385
|
* @param {string} id - The `asset_families` 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/asset_families`. An id no asset familie of this tenant carries answers 404; a malformed one answers 400 before the route is reached.
|
|
368
386
|
* @throws {RevenexxException}
|
|
369
|
-
* @returns {Promise<Models.
|
|
387
|
+
* @returns {Promise<Models.AssetFamilies>}
|
|
370
388
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
371
389
|
*/
|
|
372
|
-
productsAssetFamiliesGet(id: string): Promise<Models.
|
|
390
|
+
productsAssetFamiliesGet(id: string): Promise<Models.AssetFamilies>;
|
|
373
391
|
/**
|
|
374
392
|
* Updates one asset family 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.
|
|
375
393
|
*
|
|
@@ -382,14 +400,14 @@ declare class ProductsDataModel {
|
|
|
382
400
|
* @param {object} params.labels - What the asset family is called, per language tag.
|
|
383
401
|
* @param {object} params.namingConvention - How a file of this family is named, so an import can bind a file to a product without a mapping table. `source` is the product value the file name is built from, `pattern` how it is assembled, `allowed_extensions` what may be uploaded.
|
|
384
402
|
* @throws {RevenexxException}
|
|
385
|
-
* @returns {Promise<Models.
|
|
403
|
+
* @returns {Promise<Models.AssetFamilies>}
|
|
386
404
|
*/
|
|
387
405
|
productsAssetFamiliesUpdate(params: {
|
|
388
406
|
id: string;
|
|
389
407
|
code?: string;
|
|
390
408
|
labels?: object;
|
|
391
409
|
namingConvention?: object;
|
|
392
|
-
}): Promise<Models.
|
|
410
|
+
}): Promise<Models.AssetFamilies>;
|
|
393
411
|
/**
|
|
394
412
|
* Updates one asset family 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.
|
|
395
413
|
*
|
|
@@ -402,10 +420,10 @@ declare class ProductsDataModel {
|
|
|
402
420
|
* @param {object} labels - What the asset family is called, per language tag.
|
|
403
421
|
* @param {object} namingConvention - How a file of this family is named, so an import can bind a file to a product without a mapping table. `source` is the product value the file name is built from, `pattern` how it is assembled, `allowed_extensions` what may be uploaded.
|
|
404
422
|
* @throws {RevenexxException}
|
|
405
|
-
* @returns {Promise<Models.
|
|
423
|
+
* @returns {Promise<Models.AssetFamilies>}
|
|
406
424
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
407
425
|
*/
|
|
408
|
-
productsAssetFamiliesUpdate(id: string, code?: string, labels?: object, namingConvention?: object): Promise<Models.
|
|
426
|
+
productsAssetFamiliesUpdate(id: string, code?: string, labels?: object, namingConvention?: object): Promise<Models.AssetFamilies>;
|
|
409
427
|
/**
|
|
410
428
|
* The KIND of relation two products can have — cross-sell, accessory, spare part, bill of materials. `is_two_way` declares the relation symmetric and `is_quantified` declares that it carries a quantity; both are declarations a client READS rather than behaviour this app performs — it stores one row per direction and never creates the mirror for you.
|
|
411
429
|
*
|
|
@@ -469,14 +487,14 @@ declare class ProductsDataModel {
|
|
|
469
487
|
* @param {boolean} params.isTwoWay - Declares the relation symmetric — an accessory of A is an accessory of B. It is a declaration a client reads: this app stores one row per direction and does not create the mirror for you.
|
|
470
488
|
* @param {object} params.labels - What the relation is called in a product form, per language tag.
|
|
471
489
|
* @throws {RevenexxException}
|
|
472
|
-
* @returns {Promise<Models.
|
|
490
|
+
* @returns {Promise<Models.AssociationTypes>}
|
|
473
491
|
*/
|
|
474
492
|
productsAssociationTypesCreate(params: {
|
|
475
493
|
code: string;
|
|
476
494
|
isQuantified?: boolean;
|
|
477
495
|
isTwoWay?: boolean;
|
|
478
496
|
labels?: object;
|
|
479
|
-
}): Promise<Models.
|
|
497
|
+
}): Promise<Models.AssociationTypes>;
|
|
480
498
|
/**
|
|
481
499
|
* Creates one association type 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.
|
|
482
500
|
*
|
|
@@ -489,10 +507,10 @@ declare class ProductsDataModel {
|
|
|
489
507
|
* @param {boolean} isTwoWay - Declares the relation symmetric — an accessory of A is an accessory of B. It is a declaration a client reads: this app stores one row per direction and does not create the mirror for you.
|
|
490
508
|
* @param {object} labels - What the relation is called in a product form, per language tag.
|
|
491
509
|
* @throws {RevenexxException}
|
|
492
|
-
* @returns {Promise<Models.
|
|
510
|
+
* @returns {Promise<Models.AssociationTypes>}
|
|
493
511
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
494
512
|
*/
|
|
495
|
-
productsAssociationTypesCreate(code: string, isQuantified?: boolean, isTwoWay?: boolean, labels?: object): Promise<Models.
|
|
513
|
+
productsAssociationTypesCreate(code: string, isQuantified?: boolean, isTwoWay?: boolean, labels?: object): Promise<Models.AssociationTypes>;
|
|
496
514
|
/**
|
|
497
515
|
* Deletes one association type by id. It is a hard delete — the row is gone, and the answer is a confirmation rather than a result to branch on.
|
|
498
516
|
*
|
|
@@ -502,11 +520,11 @@ declare class ProductsDataModel {
|
|
|
502
520
|
*
|
|
503
521
|
* @param {string} params.id - The `association_types` 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/association_types`. An id no association type of this tenant carries answers 404; a malformed one answers 400 before the route is reached.
|
|
504
522
|
* @throws {RevenexxException}
|
|
505
|
-
* @returns {Promise<
|
|
523
|
+
* @returns {Promise<{}>}
|
|
506
524
|
*/
|
|
507
525
|
productsAssociationTypesDelete(params: {
|
|
508
526
|
id: string;
|
|
509
|
-
}): Promise<
|
|
527
|
+
}): Promise<{}>;
|
|
510
528
|
/**
|
|
511
529
|
* Deletes one association type by id. It is a hard delete — the row is gone, and the answer is a confirmation rather than a result to branch on.
|
|
512
530
|
*
|
|
@@ -516,10 +534,10 @@ declare class ProductsDataModel {
|
|
|
516
534
|
*
|
|
517
535
|
* @param {string} id - The `association_types` 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/association_types`. An id no association type of this tenant carries answers 404; a malformed one answers 400 before the route is reached.
|
|
518
536
|
* @throws {RevenexxException}
|
|
519
|
-
* @returns {Promise<
|
|
537
|
+
* @returns {Promise<{}>}
|
|
520
538
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
521
539
|
*/
|
|
522
|
-
productsAssociationTypesDelete(id: string): Promise<
|
|
540
|
+
productsAssociationTypesDelete(id: string): Promise<{}>;
|
|
523
541
|
/**
|
|
524
542
|
* Reads one association type by its id — the whole row, every column, as it is stored.
|
|
525
543
|
*
|
|
@@ -531,11 +549,11 @@ declare class ProductsDataModel {
|
|
|
531
549
|
*
|
|
532
550
|
* @param {string} params.id - The `association_types` 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/association_types`. An id no association type of this tenant carries answers 404; a malformed one answers 400 before the route is reached.
|
|
533
551
|
* @throws {RevenexxException}
|
|
534
|
-
* @returns {Promise<Models.
|
|
552
|
+
* @returns {Promise<Models.AssociationTypes>}
|
|
535
553
|
*/
|
|
536
554
|
productsAssociationTypesGet(params: {
|
|
537
555
|
id: string;
|
|
538
|
-
}): Promise<Models.
|
|
556
|
+
}): Promise<Models.AssociationTypes>;
|
|
539
557
|
/**
|
|
540
558
|
* Reads one association type by its id — the whole row, every column, as it is stored.
|
|
541
559
|
*
|
|
@@ -547,10 +565,10 @@ declare class ProductsDataModel {
|
|
|
547
565
|
*
|
|
548
566
|
* @param {string} id - The `association_types` 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/association_types`. An id no association type of this tenant carries answers 404; a malformed one answers 400 before the route is reached.
|
|
549
567
|
* @throws {RevenexxException}
|
|
550
|
-
* @returns {Promise<Models.
|
|
568
|
+
* @returns {Promise<Models.AssociationTypes>}
|
|
551
569
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
552
570
|
*/
|
|
553
|
-
productsAssociationTypesGet(id: string): Promise<Models.
|
|
571
|
+
productsAssociationTypesGet(id: string): Promise<Models.AssociationTypes>;
|
|
554
572
|
/**
|
|
555
573
|
* Updates one association type 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.
|
|
556
574
|
*
|
|
@@ -564,7 +582,7 @@ declare class ProductsDataModel {
|
|
|
564
582
|
* @param {boolean} params.isTwoWay - Declares the relation symmetric — an accessory of A is an accessory of B. It is a declaration a client reads: this app stores one row per direction and does not create the mirror for you.
|
|
565
583
|
* @param {object} params.labels - What the relation is called in a product form, per language tag.
|
|
566
584
|
* @throws {RevenexxException}
|
|
567
|
-
* @returns {Promise<Models.
|
|
585
|
+
* @returns {Promise<Models.AssociationTypes>}
|
|
568
586
|
*/
|
|
569
587
|
productsAssociationTypesUpdate(params: {
|
|
570
588
|
id: string;
|
|
@@ -572,7 +590,7 @@ declare class ProductsDataModel {
|
|
|
572
590
|
isQuantified?: boolean;
|
|
573
591
|
isTwoWay?: boolean;
|
|
574
592
|
labels?: object;
|
|
575
|
-
}): Promise<Models.
|
|
593
|
+
}): Promise<Models.AssociationTypes>;
|
|
576
594
|
/**
|
|
577
595
|
* Updates one association type 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.
|
|
578
596
|
*
|
|
@@ -586,10 +604,10 @@ declare class ProductsDataModel {
|
|
|
586
604
|
* @param {boolean} isTwoWay - Declares the relation symmetric — an accessory of A is an accessory of B. It is a declaration a client reads: this app stores one row per direction and does not create the mirror for you.
|
|
587
605
|
* @param {object} labels - What the relation is called in a product form, per language tag.
|
|
588
606
|
* @throws {RevenexxException}
|
|
589
|
-
* @returns {Promise<Models.
|
|
607
|
+
* @returns {Promise<Models.AssociationTypes>}
|
|
590
608
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
591
609
|
*/
|
|
592
|
-
productsAssociationTypesUpdate(id: string, code?: string, isQuantified?: boolean, isTwoWay?: boolean, labels?: object): Promise<Models.
|
|
610
|
+
productsAssociationTypesUpdate(id: string, code?: string, isQuantified?: boolean, isTwoWay?: boolean, labels?: object): Promise<Models.AssociationTypes>;
|
|
593
611
|
/**
|
|
594
612
|
* Which fields does this family have — one ready-to-render list, not six joined tables. The catalog's SHAPE is tenant data: a product's properties are rows in `attributes`, grouped by `attribute_groups`, selected per family by `family_attributes`, with their permitted values in `attribute_options` and their variant axes in `family_variants`. Reading that shape used to mean five reads, a join, and a private `attributes.type` → input mapping in every client — and that mapping is the part that must live here, because the type list carries no CHECK by design and an integrator extends it. Answers one field list instead, ordered by group then by the family's own ordering. Without a family it answers every attribute declared for `entity_type`/`entity_ref` — the shape of a reference entity's records or an asset family, which have attributes but no family. Writes nothing.
|
|
595
613
|
*
|
|
@@ -601,7 +619,7 @@ declare class ProductsDataModel {
|
|
|
601
619
|
* @param {string} params.channel - Resolves the storage path of every scopable field, and narrows `required` to the channels the family requires the attribute in.
|
|
602
620
|
* @param {Kind} params.kind - The product kind the fields are for. 'model' locks the family's variant axes, which are set on the variants.
|
|
603
621
|
* @throws {RevenexxException}
|
|
604
|
-
* @returns {Promise<
|
|
622
|
+
* @returns {Promise<{}>}
|
|
605
623
|
*/
|
|
606
624
|
productsAttributeSchema(params?: {
|
|
607
625
|
familyId?: string;
|
|
@@ -611,7 +629,7 @@ declare class ProductsDataModel {
|
|
|
611
629
|
locale?: string;
|
|
612
630
|
channel?: string;
|
|
613
631
|
kind?: Kind;
|
|
614
|
-
}): Promise<
|
|
632
|
+
}): Promise<{}>;
|
|
615
633
|
/**
|
|
616
634
|
* Which fields does this family have — one ready-to-render list, not six joined tables. The catalog's SHAPE is tenant data: a product's properties are rows in `attributes`, grouped by `attribute_groups`, selected per family by `family_attributes`, with their permitted values in `attribute_options` and their variant axes in `family_variants`. Reading that shape used to mean five reads, a join, and a private `attributes.type` → input mapping in every client — and that mapping is the part that must live here, because the type list carries no CHECK by design and an integrator extends it. Answers one field list instead, ordered by group then by the family's own ordering. Without a family it answers every attribute declared for `entity_type`/`entity_ref` — the shape of a reference entity's records or an asset family, which have attributes but no family. Writes nothing.
|
|
617
635
|
*
|
|
@@ -623,10 +641,10 @@ declare class ProductsDataModel {
|
|
|
623
641
|
* @param {string} channel - Resolves the storage path of every scopable field, and narrows `required` to the channels the family requires the attribute in.
|
|
624
642
|
* @param {Kind} kind - The product kind the fields are for. 'model' locks the family's variant axes, which are set on the variants.
|
|
625
643
|
* @throws {RevenexxException}
|
|
626
|
-
* @returns {Promise<
|
|
644
|
+
* @returns {Promise<{}>}
|
|
627
645
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
628
646
|
*/
|
|
629
|
-
productsAttributeSchema(familyId?: string, familyCode?: string, entityType?: EntityType, entityRef?: string, locale?: string, channel?: string, kind?: Kind): Promise<
|
|
647
|
+
productsAttributeSchema(familyId?: string, familyCode?: string, entityType?: EntityType, entityRef?: string, locale?: string, channel?: string, kind?: Kind): Promise<{}>;
|
|
630
648
|
/**
|
|
631
649
|
* An attribute group is a SECTION of a product form — "Technical attributes", "Logistics" — and the thing every attribute is filed under. It carries a `position`, which is the order the sections appear in, and per-language `labels`, which is what an operator reads; the `code` is what an attribute joins on and is never shown. `GET /products/attribute-schema` already resolves a group's heading onto every field it returns, so these routes are for MANAGING the sections, not for rendering a form.
|
|
632
650
|
*
|
|
@@ -689,13 +707,13 @@ declare class ProductsDataModel {
|
|
|
689
707
|
* @param {object} params.labels - The section heading a person sees, keyed by language tag. The code is never shown to an operator; a tag nobody translated falls back to the next filled one, then to English.
|
|
690
708
|
* @param {number} params.position - Where this section sits in a form, ascending. Sections that tie keep the order the database returns them in.
|
|
691
709
|
* @throws {RevenexxException}
|
|
692
|
-
* @returns {Promise<Models.
|
|
710
|
+
* @returns {Promise<Models.AttributeGroups>}
|
|
693
711
|
*/
|
|
694
712
|
productsAttributeGroupsCreate(params: {
|
|
695
713
|
code: string;
|
|
696
714
|
labels?: object;
|
|
697
715
|
position?: number;
|
|
698
|
-
}): Promise<Models.
|
|
716
|
+
}): Promise<Models.AttributeGroups>;
|
|
699
717
|
/**
|
|
700
718
|
* Creates one attribute group 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.
|
|
701
719
|
*
|
|
@@ -707,10 +725,10 @@ declare class ProductsDataModel {
|
|
|
707
725
|
* @param {object} labels - The section heading a person sees, keyed by language tag. The code is never shown to an operator; a tag nobody translated falls back to the next filled one, then to English.
|
|
708
726
|
* @param {number} position - Where this section sits in a form, ascending. Sections that tie keep the order the database returns them in.
|
|
709
727
|
* @throws {RevenexxException}
|
|
710
|
-
* @returns {Promise<Models.
|
|
728
|
+
* @returns {Promise<Models.AttributeGroups>}
|
|
711
729
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
712
730
|
*/
|
|
713
|
-
productsAttributeGroupsCreate(code: string, labels?: object, position?: number): Promise<Models.
|
|
731
|
+
productsAttributeGroupsCreate(code: string, labels?: object, position?: number): Promise<Models.AttributeGroups>;
|
|
714
732
|
/**
|
|
715
733
|
* Deletes one attribute group by id. It is a hard delete — the row is gone, and the answer is a confirmation rather than a result to branch on.
|
|
716
734
|
*
|
|
@@ -720,11 +738,11 @@ declare class ProductsDataModel {
|
|
|
720
738
|
*
|
|
721
739
|
* @param {string} params.id - The `attribute_groups` 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/attribute_groups`. An id no attribute group of this tenant carries answers 404; a malformed one answers 400 before the route is reached.
|
|
722
740
|
* @throws {RevenexxException}
|
|
723
|
-
* @returns {Promise<
|
|
741
|
+
* @returns {Promise<{}>}
|
|
724
742
|
*/
|
|
725
743
|
productsAttributeGroupsDelete(params: {
|
|
726
744
|
id: string;
|
|
727
|
-
}): Promise<
|
|
745
|
+
}): Promise<{}>;
|
|
728
746
|
/**
|
|
729
747
|
* Deletes one attribute group by id. It is a hard delete — the row is gone, and the answer is a confirmation rather than a result to branch on.
|
|
730
748
|
*
|
|
@@ -734,10 +752,10 @@ declare class ProductsDataModel {
|
|
|
734
752
|
*
|
|
735
753
|
* @param {string} id - The `attribute_groups` 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/attribute_groups`. An id no attribute group of this tenant carries answers 404; a malformed one answers 400 before the route is reached.
|
|
736
754
|
* @throws {RevenexxException}
|
|
737
|
-
* @returns {Promise<
|
|
755
|
+
* @returns {Promise<{}>}
|
|
738
756
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
739
757
|
*/
|
|
740
|
-
productsAttributeGroupsDelete(id: string): Promise<
|
|
758
|
+
productsAttributeGroupsDelete(id: string): Promise<{}>;
|
|
741
759
|
/**
|
|
742
760
|
* Reads one attribute group by its id — the whole row, every column, as it is stored.
|
|
743
761
|
*
|
|
@@ -749,11 +767,11 @@ declare class ProductsDataModel {
|
|
|
749
767
|
*
|
|
750
768
|
* @param {string} params.id - The `attribute_groups` 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/attribute_groups`. An id no attribute group of this tenant carries answers 404; a malformed one answers 400 before the route is reached.
|
|
751
769
|
* @throws {RevenexxException}
|
|
752
|
-
* @returns {Promise<Models.
|
|
770
|
+
* @returns {Promise<Models.AttributeGroups>}
|
|
753
771
|
*/
|
|
754
772
|
productsAttributeGroupsGet(params: {
|
|
755
773
|
id: string;
|
|
756
|
-
}): Promise<Models.
|
|
774
|
+
}): Promise<Models.AttributeGroups>;
|
|
757
775
|
/**
|
|
758
776
|
* Reads one attribute group by its id — the whole row, every column, as it is stored.
|
|
759
777
|
*
|
|
@@ -765,10 +783,10 @@ declare class ProductsDataModel {
|
|
|
765
783
|
*
|
|
766
784
|
* @param {string} id - The `attribute_groups` 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/attribute_groups`. An id no attribute group of this tenant carries answers 404; a malformed one answers 400 before the route is reached.
|
|
767
785
|
* @throws {RevenexxException}
|
|
768
|
-
* @returns {Promise<Models.
|
|
786
|
+
* @returns {Promise<Models.AttributeGroups>}
|
|
769
787
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
770
788
|
*/
|
|
771
|
-
productsAttributeGroupsGet(id: string): Promise<Models.
|
|
789
|
+
productsAttributeGroupsGet(id: string): Promise<Models.AttributeGroups>;
|
|
772
790
|
/**
|
|
773
791
|
* Updates one attribute group 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.
|
|
774
792
|
*
|
|
@@ -781,14 +799,14 @@ declare class ProductsDataModel {
|
|
|
781
799
|
* @param {object} params.labels - The section heading a person sees, keyed by language tag. The code is never shown to an operator; a tag nobody translated falls back to the next filled one, then to English.
|
|
782
800
|
* @param {number} params.position - Where this section sits in a form, ascending. Sections that tie keep the order the database returns them in.
|
|
783
801
|
* @throws {RevenexxException}
|
|
784
|
-
* @returns {Promise<Models.
|
|
802
|
+
* @returns {Promise<Models.AttributeGroups>}
|
|
785
803
|
*/
|
|
786
804
|
productsAttributeGroupsUpdate(params: {
|
|
787
805
|
id: string;
|
|
788
806
|
code?: string;
|
|
789
807
|
labels?: object;
|
|
790
808
|
position?: number;
|
|
791
|
-
}): Promise<Models.
|
|
809
|
+
}): Promise<Models.AttributeGroups>;
|
|
792
810
|
/**
|
|
793
811
|
* Updates one attribute group 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.
|
|
794
812
|
*
|
|
@@ -801,10 +819,10 @@ declare class ProductsDataModel {
|
|
|
801
819
|
* @param {object} labels - The section heading a person sees, keyed by language tag. The code is never shown to an operator; a tag nobody translated falls back to the next filled one, then to English.
|
|
802
820
|
* @param {number} position - Where this section sits in a form, ascending. Sections that tie keep the order the database returns them in.
|
|
803
821
|
* @throws {RevenexxException}
|
|
804
|
-
* @returns {Promise<Models.
|
|
822
|
+
* @returns {Promise<Models.AttributeGroups>}
|
|
805
823
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
806
824
|
*/
|
|
807
|
-
productsAttributeGroupsUpdate(id: string, code?: string, labels?: object, position?: number): Promise<Models.
|
|
825
|
+
productsAttributeGroupsUpdate(id: string, code?: string, labels?: object, position?: number): Promise<Models.AttributeGroups>;
|
|
808
826
|
/**
|
|
809
827
|
* The permitted values of one select or multi-select attribute. A record stores the option's CODE and never its label, so renaming an option in every language leaves every product that picked it untouched, and `position` is the order it appears in the dropdown. `GET /products/attribute-schema` republishes these as a field's `options`, already resolved for a locale.
|
|
810
828
|
*
|
|
@@ -872,7 +890,7 @@ declare class ProductsDataModel {
|
|
|
872
890
|
* @param {number} params.position - Order in the dropdown, ascending. Options that tie keep the order the database returns them in, so give every option a position if the order matters.
|
|
873
891
|
* @param {object} params.swatch - A colour or texture chip for the picker. Null for an option that is not visual.
|
|
874
892
|
* @throws {RevenexxException}
|
|
875
|
-
* @returns {Promise<Models.
|
|
893
|
+
* @returns {Promise<Models.AttributeOptions>}
|
|
876
894
|
*/
|
|
877
895
|
productsAttributeOptionsCreate(params: {
|
|
878
896
|
attributeId: string;
|
|
@@ -880,7 +898,7 @@ declare class ProductsDataModel {
|
|
|
880
898
|
labels?: object;
|
|
881
899
|
position?: number;
|
|
882
900
|
swatch?: object;
|
|
883
|
-
}): Promise<Models.
|
|
901
|
+
}): Promise<Models.AttributeOptions>;
|
|
884
902
|
/**
|
|
885
903
|
* Creates one attribute option 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.
|
|
886
904
|
*
|
|
@@ -894,10 +912,10 @@ declare class ProductsDataModel {
|
|
|
894
912
|
* @param {number} position - Order in the dropdown, ascending. Options that tie keep the order the database returns them in, so give every option a position if the order matters.
|
|
895
913
|
* @param {object} swatch - A colour or texture chip for the picker. Null for an option that is not visual.
|
|
896
914
|
* @throws {RevenexxException}
|
|
897
|
-
* @returns {Promise<Models.
|
|
915
|
+
* @returns {Promise<Models.AttributeOptions>}
|
|
898
916
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
899
917
|
*/
|
|
900
|
-
productsAttributeOptionsCreate(attributeId: string, code: string, labels?: object, position?: number, swatch?: object): Promise<Models.
|
|
918
|
+
productsAttributeOptionsCreate(attributeId: string, code: string, labels?: object, position?: number, swatch?: object): Promise<Models.AttributeOptions>;
|
|
901
919
|
/**
|
|
902
920
|
* Deletes one attribute option by id. It is a hard delete — the row is gone, and the answer is a confirmation rather than a result to branch on.
|
|
903
921
|
*
|
|
@@ -907,11 +925,11 @@ declare class ProductsDataModel {
|
|
|
907
925
|
*
|
|
908
926
|
* @param {string} params.id - The `attribute_options` 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/attribute_options`. An id no attribute option of this tenant carries answers 404; a malformed one answers 400 before the route is reached.
|
|
909
927
|
* @throws {RevenexxException}
|
|
910
|
-
* @returns {Promise<
|
|
928
|
+
* @returns {Promise<{}>}
|
|
911
929
|
*/
|
|
912
930
|
productsAttributeOptionsDelete(params: {
|
|
913
931
|
id: string;
|
|
914
|
-
}): Promise<
|
|
932
|
+
}): Promise<{}>;
|
|
915
933
|
/**
|
|
916
934
|
* Deletes one attribute option by id. It is a hard delete — the row is gone, and the answer is a confirmation rather than a result to branch on.
|
|
917
935
|
*
|
|
@@ -921,10 +939,10 @@ declare class ProductsDataModel {
|
|
|
921
939
|
*
|
|
922
940
|
* @param {string} id - The `attribute_options` 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/attribute_options`. An id no attribute option of this tenant carries answers 404; a malformed one answers 400 before the route is reached.
|
|
923
941
|
* @throws {RevenexxException}
|
|
924
|
-
* @returns {Promise<
|
|
942
|
+
* @returns {Promise<{}>}
|
|
925
943
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
926
944
|
*/
|
|
927
|
-
productsAttributeOptionsDelete(id: string): Promise<
|
|
945
|
+
productsAttributeOptionsDelete(id: string): Promise<{}>;
|
|
928
946
|
/**
|
|
929
947
|
* Reads one attribute option by its id — the whole row, every column, as it is stored.
|
|
930
948
|
*
|
|
@@ -936,11 +954,11 @@ declare class ProductsDataModel {
|
|
|
936
954
|
*
|
|
937
955
|
* @param {string} params.id - The `attribute_options` 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/attribute_options`. An id no attribute option of this tenant carries answers 404; a malformed one answers 400 before the route is reached.
|
|
938
956
|
* @throws {RevenexxException}
|
|
939
|
-
* @returns {Promise<Models.
|
|
957
|
+
* @returns {Promise<Models.AttributeOptions>}
|
|
940
958
|
*/
|
|
941
959
|
productsAttributeOptionsGet(params: {
|
|
942
960
|
id: string;
|
|
943
|
-
}): Promise<Models.
|
|
961
|
+
}): Promise<Models.AttributeOptions>;
|
|
944
962
|
/**
|
|
945
963
|
* Reads one attribute option by its id — the whole row, every column, as it is stored.
|
|
946
964
|
*
|
|
@@ -952,10 +970,10 @@ declare class ProductsDataModel {
|
|
|
952
970
|
*
|
|
953
971
|
* @param {string} id - The `attribute_options` 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/attribute_options`. An id no attribute option of this tenant carries answers 404; a malformed one answers 400 before the route is reached.
|
|
954
972
|
* @throws {RevenexxException}
|
|
955
|
-
* @returns {Promise<Models.
|
|
973
|
+
* @returns {Promise<Models.AttributeOptions>}
|
|
956
974
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
957
975
|
*/
|
|
958
|
-
productsAttributeOptionsGet(id: string): Promise<Models.
|
|
976
|
+
productsAttributeOptionsGet(id: string): Promise<Models.AttributeOptions>;
|
|
959
977
|
/**
|
|
960
978
|
* Updates one attribute option 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.
|
|
961
979
|
*
|
|
@@ -970,7 +988,7 @@ declare class ProductsDataModel {
|
|
|
970
988
|
* @param {number} params.position - Order in the dropdown, ascending. Options that tie keep the order the database returns them in, so give every option a position if the order matters.
|
|
971
989
|
* @param {object} params.swatch - A colour or texture chip for the picker. Null for an option that is not visual.
|
|
972
990
|
* @throws {RevenexxException}
|
|
973
|
-
* @returns {Promise<Models.
|
|
991
|
+
* @returns {Promise<Models.AttributeOptions>}
|
|
974
992
|
*/
|
|
975
993
|
productsAttributeOptionsUpdate(params: {
|
|
976
994
|
id: string;
|
|
@@ -979,7 +997,7 @@ declare class ProductsDataModel {
|
|
|
979
997
|
labels?: object;
|
|
980
998
|
position?: number;
|
|
981
999
|
swatch?: object;
|
|
982
|
-
}): Promise<Models.
|
|
1000
|
+
}): Promise<Models.AttributeOptions>;
|
|
983
1001
|
/**
|
|
984
1002
|
* Updates one attribute option 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.
|
|
985
1003
|
*
|
|
@@ -994,10 +1012,10 @@ declare class ProductsDataModel {
|
|
|
994
1012
|
* @param {number} position - Order in the dropdown, ascending. Options that tie keep the order the database returns them in, so give every option a position if the order matters.
|
|
995
1013
|
* @param {object} swatch - A colour or texture chip for the picker. Null for an option that is not visual.
|
|
996
1014
|
* @throws {RevenexxException}
|
|
997
|
-
* @returns {Promise<Models.
|
|
1015
|
+
* @returns {Promise<Models.AttributeOptions>}
|
|
998
1016
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
999
1017
|
*/
|
|
1000
|
-
productsAttributeOptionsUpdate(id: string, attributeId?: string, code?: string, labels?: object, position?: number, swatch?: object): Promise<Models.
|
|
1018
|
+
productsAttributeOptionsUpdate(id: string, attributeId?: string, code?: string, labels?: object, position?: number, swatch?: object): Promise<Models.AttributeOptions>;
|
|
1001
1019
|
/**
|
|
1002
1020
|
* An attribute is one property a record can carry, and in an attribute-driven PIM it is a ROW rather than a column: giving the catalog a "net weight" is a create here, not a migration. Its own flags decide everything downstream — `localizable` and `scopable` pick which of the four `attribute_values` buckets its values are written to, `type` picks the editor that renders it, `usable_in_grid` and `is_filterable` are what the product grid reads. `entity_type`/`entity_ref` say which kind of record carries it: a product, one reference entity's records, one asset family, or a category.
|
|
1003
1021
|
*
|
|
@@ -1104,7 +1122,7 @@ declare class ProductsDataModel {
|
|
|
1104
1122
|
* @param {boolean} params.usableInGrid - Show this attribute as a COLUMN in the product grid. `GET /products/grid` returns a column definition and a per-row value for exactly these.
|
|
1105
1123
|
* @param {object} params.validation - Limits a value has to satisfy, as a flat object. The seven keys a client can act on are `min`, `max`, `min_length`, `max_length`, `pattern`, `min_items`, `max_items` — `GET /products/attribute-schema` republishes those and leaves anything else the tenant stored untouched.
|
|
1106
1124
|
* @throws {RevenexxException}
|
|
1107
|
-
* @returns {Promise<Models.
|
|
1125
|
+
* @returns {Promise<Models.Attributes>}
|
|
1108
1126
|
*/
|
|
1109
1127
|
productsAttributesCreate(params: {
|
|
1110
1128
|
code: string;
|
|
@@ -1121,7 +1139,7 @@ declare class ProductsDataModel {
|
|
|
1121
1139
|
scopable?: boolean;
|
|
1122
1140
|
usableInGrid?: boolean;
|
|
1123
1141
|
validation?: object;
|
|
1124
|
-
}): Promise<Models.
|
|
1142
|
+
}): Promise<Models.Attributes>;
|
|
1125
1143
|
/**
|
|
1126
1144
|
* Creates one attribute 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.
|
|
1127
1145
|
*
|
|
@@ -1144,10 +1162,10 @@ declare class ProductsDataModel {
|
|
|
1144
1162
|
* @param {boolean} usableInGrid - Show this attribute as a COLUMN in the product grid. `GET /products/grid` returns a column definition and a per-row value for exactly these.
|
|
1145
1163
|
* @param {object} validation - Limits a value has to satisfy, as a flat object. The seven keys a client can act on are `min`, `max`, `min_length`, `max_length`, `pattern`, `min_items`, `max_items` — `GET /products/attribute-schema` republishes those and leaves anything else the tenant stored untouched.
|
|
1146
1164
|
* @throws {RevenexxException}
|
|
1147
|
-
* @returns {Promise<Models.
|
|
1165
|
+
* @returns {Promise<Models.Attributes>}
|
|
1148
1166
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1149
1167
|
*/
|
|
1150
|
-
productsAttributesCreate(code: string, type: string, config?: object, entityRef?: string, entityType?: string, groupId?: string, isFilterable?: boolean, isUnique?: boolean, labels?: object, localizable?: boolean, position?: number, scopable?: boolean, usableInGrid?: boolean, validation?: object): Promise<Models.
|
|
1168
|
+
productsAttributesCreate(code: string, type: string, config?: object, entityRef?: string, entityType?: string, groupId?: string, isFilterable?: boolean, isUnique?: boolean, labels?: object, localizable?: boolean, position?: number, scopable?: boolean, usableInGrid?: boolean, validation?: object): Promise<Models.Attributes>;
|
|
1151
1169
|
/**
|
|
1152
1170
|
* Deletes one attribute by id. It is a hard delete — the row is gone, and the answer is a confirmation rather than a result to branch on.
|
|
1153
1171
|
*
|
|
@@ -1157,11 +1175,11 @@ declare class ProductsDataModel {
|
|
|
1157
1175
|
*
|
|
1158
1176
|
* @param {string} params.id - The `attributes` 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/attributes`. An id no attribute of this tenant carries answers 404; a malformed one answers 400 before the route is reached.
|
|
1159
1177
|
* @throws {RevenexxException}
|
|
1160
|
-
* @returns {Promise<
|
|
1178
|
+
* @returns {Promise<{}>}
|
|
1161
1179
|
*/
|
|
1162
1180
|
productsAttributesDelete(params: {
|
|
1163
1181
|
id: string;
|
|
1164
|
-
}): Promise<
|
|
1182
|
+
}): Promise<{}>;
|
|
1165
1183
|
/**
|
|
1166
1184
|
* Deletes one attribute by id. It is a hard delete — the row is gone, and the answer is a confirmation rather than a result to branch on.
|
|
1167
1185
|
*
|
|
@@ -1171,10 +1189,10 @@ declare class ProductsDataModel {
|
|
|
1171
1189
|
*
|
|
1172
1190
|
* @param {string} id - The `attributes` 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/attributes`. An id no attribute of this tenant carries answers 404; a malformed one answers 400 before the route is reached.
|
|
1173
1191
|
* @throws {RevenexxException}
|
|
1174
|
-
* @returns {Promise<
|
|
1192
|
+
* @returns {Promise<{}>}
|
|
1175
1193
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1176
1194
|
*/
|
|
1177
|
-
productsAttributesDelete(id: string): Promise<
|
|
1195
|
+
productsAttributesDelete(id: string): Promise<{}>;
|
|
1178
1196
|
/**
|
|
1179
1197
|
* Reads one attribute by its id — the whole row, every column, as it is stored.
|
|
1180
1198
|
*
|
|
@@ -1186,11 +1204,11 @@ declare class ProductsDataModel {
|
|
|
1186
1204
|
*
|
|
1187
1205
|
* @param {string} params.id - The `attributes` 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/attributes`. An id no attribute of this tenant carries answers 404; a malformed one answers 400 before the route is reached.
|
|
1188
1206
|
* @throws {RevenexxException}
|
|
1189
|
-
* @returns {Promise<Models.
|
|
1207
|
+
* @returns {Promise<Models.Attributes>}
|
|
1190
1208
|
*/
|
|
1191
1209
|
productsAttributesGet(params: {
|
|
1192
1210
|
id: string;
|
|
1193
|
-
}): Promise<Models.
|
|
1211
|
+
}): Promise<Models.Attributes>;
|
|
1194
1212
|
/**
|
|
1195
1213
|
* Reads one attribute by its id — the whole row, every column, as it is stored.
|
|
1196
1214
|
*
|
|
@@ -1202,10 +1220,10 @@ declare class ProductsDataModel {
|
|
|
1202
1220
|
*
|
|
1203
1221
|
* @param {string} id - The `attributes` 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/attributes`. An id no attribute of this tenant carries answers 404; a malformed one answers 400 before the route is reached.
|
|
1204
1222
|
* @throws {RevenexxException}
|
|
1205
|
-
* @returns {Promise<Models.
|
|
1223
|
+
* @returns {Promise<Models.Attributes>}
|
|
1206
1224
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1207
1225
|
*/
|
|
1208
|
-
productsAttributesGet(id: string): Promise<Models.
|
|
1226
|
+
productsAttributesGet(id: string): Promise<Models.Attributes>;
|
|
1209
1227
|
/**
|
|
1210
1228
|
* Updates one attribute 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.
|
|
1211
1229
|
*
|
|
@@ -1229,7 +1247,7 @@ declare class ProductsDataModel {
|
|
|
1229
1247
|
* @param {boolean} params.usableInGrid - Show this attribute as a COLUMN in the product grid. `GET /products/grid` returns a column definition and a per-row value for exactly these.
|
|
1230
1248
|
* @param {object} params.validation - Limits a value has to satisfy, as a flat object. The seven keys a client can act on are `min`, `max`, `min_length`, `max_length`, `pattern`, `min_items`, `max_items` — `GET /products/attribute-schema` republishes those and leaves anything else the tenant stored untouched.
|
|
1231
1249
|
* @throws {RevenexxException}
|
|
1232
|
-
* @returns {Promise<Models.
|
|
1250
|
+
* @returns {Promise<Models.Attributes>}
|
|
1233
1251
|
*/
|
|
1234
1252
|
productsAttributesUpdate(params: {
|
|
1235
1253
|
id: string;
|
|
@@ -1247,7 +1265,7 @@ declare class ProductsDataModel {
|
|
|
1247
1265
|
type?: string;
|
|
1248
1266
|
usableInGrid?: boolean;
|
|
1249
1267
|
validation?: object;
|
|
1250
|
-
}): Promise<Models.
|
|
1268
|
+
}): Promise<Models.Attributes>;
|
|
1251
1269
|
/**
|
|
1252
1270
|
* Updates one attribute 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.
|
|
1253
1271
|
*
|
|
@@ -1271,10 +1289,10 @@ declare class ProductsDataModel {
|
|
|
1271
1289
|
* @param {boolean} usableInGrid - Show this attribute as a COLUMN in the product grid. `GET /products/grid` returns a column definition and a per-row value for exactly these.
|
|
1272
1290
|
* @param {object} validation - Limits a value has to satisfy, as a flat object. The seven keys a client can act on are `min`, `max`, `min_length`, `max_length`, `pattern`, `min_items`, `max_items` — `GET /products/attribute-schema` republishes those and leaves anything else the tenant stored untouched.
|
|
1273
1291
|
* @throws {RevenexxException}
|
|
1274
|
-
* @returns {Promise<Models.
|
|
1292
|
+
* @returns {Promise<Models.Attributes>}
|
|
1275
1293
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1276
1294
|
*/
|
|
1277
|
-
productsAttributesUpdate(id: string, code?: string, config?: object, entityRef?: string, entityType?: string, groupId?: string, isFilterable?: boolean, isUnique?: boolean, labels?: object, localizable?: boolean, position?: number, scopable?: boolean, type?: string, usableInGrid?: boolean, validation?: object): Promise<Models.
|
|
1295
|
+
productsAttributesUpdate(id: string, code?: string, config?: object, entityRef?: string, entityType?: string, groupId?: string, isFilterable?: boolean, isUnique?: boolean, labels?: object, localizable?: boolean, position?: number, scopable?: boolean, type?: string, usableInGrid?: boolean, validation?: object): Promise<Models.Attributes>;
|
|
1278
1296
|
/**
|
|
1279
1297
|
* A family decides WHICH attributes a product has — the set is `family_attributes`, and every family-driven surface follows from it. It also names which attribute carries the display name (`label_attribute`) and which carries the main image. A product with no family has no required attributes at all, so its completeness cannot be measured and its name never resolves past the SKU; `POST /products/{id}/family` is the call that ends that state.
|
|
1280
1298
|
*
|
|
@@ -1341,14 +1359,14 @@ declare class ProductsDataModel {
|
|
|
1341
1359
|
* @param {string} params.labelAttribute - Which attribute CODE carries the display name of a product in this family. A product's name is an attribute, not a column, and which attribute it is, is per family. Null falls back to the `default_label_attribute` setting and then to the conventional `name`.
|
|
1342
1360
|
* @param {object} params.labels - What the family is called, per language tag — the name an operator picks from, while the code is what everything else joins on.
|
|
1343
1361
|
* @throws {RevenexxException}
|
|
1344
|
-
* @returns {Promise<Models.
|
|
1362
|
+
* @returns {Promise<Models.Families>}
|
|
1345
1363
|
*/
|
|
1346
1364
|
productsFamiliesCreate(params: {
|
|
1347
1365
|
code: string;
|
|
1348
1366
|
imageAttribute?: string;
|
|
1349
1367
|
labelAttribute?: string;
|
|
1350
1368
|
labels?: object;
|
|
1351
|
-
}): Promise<Models.
|
|
1369
|
+
}): Promise<Models.Families>;
|
|
1352
1370
|
/**
|
|
1353
1371
|
* Creates one family 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.
|
|
1354
1372
|
*
|
|
@@ -1361,10 +1379,10 @@ declare class ProductsDataModel {
|
|
|
1361
1379
|
* @param {string} labelAttribute - Which attribute CODE carries the display name of a product in this family. A product's name is an attribute, not a column, and which attribute it is, is per family. Null falls back to the `default_label_attribute` setting and then to the conventional `name`.
|
|
1362
1380
|
* @param {object} labels - What the family is called, per language tag — the name an operator picks from, while the code is what everything else joins on.
|
|
1363
1381
|
* @throws {RevenexxException}
|
|
1364
|
-
* @returns {Promise<Models.
|
|
1382
|
+
* @returns {Promise<Models.Families>}
|
|
1365
1383
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1366
1384
|
*/
|
|
1367
|
-
productsFamiliesCreate(code: string, imageAttribute?: string, labelAttribute?: string, labels?: object): Promise<Models.
|
|
1385
|
+
productsFamiliesCreate(code: string, imageAttribute?: string, labelAttribute?: string, labels?: object): Promise<Models.Families>;
|
|
1368
1386
|
/**
|
|
1369
1387
|
* Deletes one family by id. It is a hard delete — the row is gone, and the answer is a confirmation rather than a result to branch on.
|
|
1370
1388
|
*
|
|
@@ -1374,11 +1392,11 @@ declare class ProductsDataModel {
|
|
|
1374
1392
|
*
|
|
1375
1393
|
* @param {string} params.id - The `families` 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/families`. An id no familie of this tenant carries answers 404; a malformed one answers 400 before the route is reached.
|
|
1376
1394
|
* @throws {RevenexxException}
|
|
1377
|
-
* @returns {Promise<
|
|
1395
|
+
* @returns {Promise<{}>}
|
|
1378
1396
|
*/
|
|
1379
1397
|
productsFamiliesDelete(params: {
|
|
1380
1398
|
id: string;
|
|
1381
|
-
}): Promise<
|
|
1399
|
+
}): Promise<{}>;
|
|
1382
1400
|
/**
|
|
1383
1401
|
* Deletes one family by id. It is a hard delete — the row is gone, and the answer is a confirmation rather than a result to branch on.
|
|
1384
1402
|
*
|
|
@@ -1388,10 +1406,10 @@ declare class ProductsDataModel {
|
|
|
1388
1406
|
*
|
|
1389
1407
|
* @param {string} id - The `families` 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/families`. An id no familie of this tenant carries answers 404; a malformed one answers 400 before the route is reached.
|
|
1390
1408
|
* @throws {RevenexxException}
|
|
1391
|
-
* @returns {Promise<
|
|
1409
|
+
* @returns {Promise<{}>}
|
|
1392
1410
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1393
1411
|
*/
|
|
1394
|
-
productsFamiliesDelete(id: string): Promise<
|
|
1412
|
+
productsFamiliesDelete(id: string): Promise<{}>;
|
|
1395
1413
|
/**
|
|
1396
1414
|
* Reads one family by its id — the whole row, every column, as it is stored.
|
|
1397
1415
|
*
|
|
@@ -1403,11 +1421,11 @@ declare class ProductsDataModel {
|
|
|
1403
1421
|
*
|
|
1404
1422
|
* @param {string} params.id - The `families` 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/families`. An id no familie of this tenant carries answers 404; a malformed one answers 400 before the route is reached.
|
|
1405
1423
|
* @throws {RevenexxException}
|
|
1406
|
-
* @returns {Promise<Models.
|
|
1424
|
+
* @returns {Promise<Models.Families>}
|
|
1407
1425
|
*/
|
|
1408
1426
|
productsFamiliesGet(params: {
|
|
1409
1427
|
id: string;
|
|
1410
|
-
}): Promise<Models.
|
|
1428
|
+
}): Promise<Models.Families>;
|
|
1411
1429
|
/**
|
|
1412
1430
|
* Reads one family by its id — the whole row, every column, as it is stored.
|
|
1413
1431
|
*
|
|
@@ -1419,10 +1437,10 @@ declare class ProductsDataModel {
|
|
|
1419
1437
|
*
|
|
1420
1438
|
* @param {string} id - The `families` 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/families`. An id no familie of this tenant carries answers 404; a malformed one answers 400 before the route is reached.
|
|
1421
1439
|
* @throws {RevenexxException}
|
|
1422
|
-
* @returns {Promise<Models.
|
|
1440
|
+
* @returns {Promise<Models.Families>}
|
|
1423
1441
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1424
1442
|
*/
|
|
1425
|
-
productsFamiliesGet(id: string): Promise<Models.
|
|
1443
|
+
productsFamiliesGet(id: string): Promise<Models.Families>;
|
|
1426
1444
|
/**
|
|
1427
1445
|
* Updates one family 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.
|
|
1428
1446
|
*
|
|
@@ -1436,7 +1454,7 @@ declare class ProductsDataModel {
|
|
|
1436
1454
|
* @param {string} params.labelAttribute - Which attribute CODE carries the display name of a product in this family. A product's name is an attribute, not a column, and which attribute it is, is per family. Null falls back to the `default_label_attribute` setting and then to the conventional `name`.
|
|
1437
1455
|
* @param {object} params.labels - What the family is called, per language tag — the name an operator picks from, while the code is what everything else joins on.
|
|
1438
1456
|
* @throws {RevenexxException}
|
|
1439
|
-
* @returns {Promise<Models.
|
|
1457
|
+
* @returns {Promise<Models.Families>}
|
|
1440
1458
|
*/
|
|
1441
1459
|
productsFamiliesUpdate(params: {
|
|
1442
1460
|
id: string;
|
|
@@ -1444,7 +1462,7 @@ declare class ProductsDataModel {
|
|
|
1444
1462
|
imageAttribute?: string;
|
|
1445
1463
|
labelAttribute?: string;
|
|
1446
1464
|
labels?: object;
|
|
1447
|
-
}): Promise<Models.
|
|
1465
|
+
}): Promise<Models.Families>;
|
|
1448
1466
|
/**
|
|
1449
1467
|
* Updates one family 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.
|
|
1450
1468
|
*
|
|
@@ -1458,10 +1476,10 @@ declare class ProductsDataModel {
|
|
|
1458
1476
|
* @param {string} labelAttribute - Which attribute CODE carries the display name of a product in this family. A product's name is an attribute, not a column, and which attribute it is, is per family. Null falls back to the `default_label_attribute` setting and then to the conventional `name`.
|
|
1459
1477
|
* @param {object} labels - What the family is called, per language tag — the name an operator picks from, while the code is what everything else joins on.
|
|
1460
1478
|
* @throws {RevenexxException}
|
|
1461
|
-
* @returns {Promise<Models.
|
|
1479
|
+
* @returns {Promise<Models.Families>}
|
|
1462
1480
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1463
1481
|
*/
|
|
1464
|
-
productsFamiliesUpdate(id: string, code?: string, imageAttribute?: string, labelAttribute?: string, labels?: object): Promise<Models.
|
|
1482
|
+
productsFamiliesUpdate(id: string, code?: string, imageAttribute?: string, labelAttribute?: string, labels?: object): Promise<Models.Families>;
|
|
1465
1483
|
/**
|
|
1466
1484
|
* One link between a family and an attribute — the row that puts an attribute INTO a family's form. It carries the family's own ordering of that attribute, which overrides the attribute's default position, and `is_required`, which is the flag `POST /products/{id}/completeness` measures and nothing else reads. `required_channels` narrows "required" to named channels; null or empty means required EVERYWHERE, not nowhere.
|
|
1467
1485
|
*
|
|
@@ -1529,7 +1547,7 @@ declare class ProductsDataModel {
|
|
|
1529
1547
|
* @param {number} params.position - The family's own ordering of this attribute, which overrides the attribute's default `position` in this family's form.
|
|
1530
1548
|
* @param {object} params.requiredChannels - Narrows `is_required` to named channels. NULL or an empty list means required EVERYWHERE, not nowhere — that is how every required link in the wild is stored, and reading an empty list as "nowhere" reports a fully configured family as demanding nothing.
|
|
1531
1549
|
* @throws {RevenexxException}
|
|
1532
|
-
* @returns {Promise<Models.
|
|
1550
|
+
* @returns {Promise<Models.FamilyAttributes>}
|
|
1533
1551
|
*/
|
|
1534
1552
|
productsFamilyAttributesCreate(params: {
|
|
1535
1553
|
attributeId: string;
|
|
@@ -1537,7 +1555,7 @@ declare class ProductsDataModel {
|
|
|
1537
1555
|
isRequired?: boolean;
|
|
1538
1556
|
position?: number;
|
|
1539
1557
|
requiredChannels?: object;
|
|
1540
|
-
}): Promise<Models.
|
|
1558
|
+
}): Promise<Models.FamilyAttributes>;
|
|
1541
1559
|
/**
|
|
1542
1560
|
* Creates one family attribute 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.
|
|
1543
1561
|
*
|
|
@@ -1551,10 +1569,10 @@ declare class ProductsDataModel {
|
|
|
1551
1569
|
* @param {number} position - The family's own ordering of this attribute, which overrides the attribute's default `position` in this family's form.
|
|
1552
1570
|
* @param {object} requiredChannels - Narrows `is_required` to named channels. NULL or an empty list means required EVERYWHERE, not nowhere — that is how every required link in the wild is stored, and reading an empty list as "nowhere" reports a fully configured family as demanding nothing.
|
|
1553
1571
|
* @throws {RevenexxException}
|
|
1554
|
-
* @returns {Promise<Models.
|
|
1572
|
+
* @returns {Promise<Models.FamilyAttributes>}
|
|
1555
1573
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1556
1574
|
*/
|
|
1557
|
-
productsFamilyAttributesCreate(attributeId: string, familyId: string, isRequired?: boolean, position?: number, requiredChannels?: object): Promise<Models.
|
|
1575
|
+
productsFamilyAttributesCreate(attributeId: string, familyId: string, isRequired?: boolean, position?: number, requiredChannels?: object): Promise<Models.FamilyAttributes>;
|
|
1558
1576
|
/**
|
|
1559
1577
|
* Deletes one family attribute by id. It is a hard delete — the row is gone, and the answer is a confirmation rather than a result to branch on.
|
|
1560
1578
|
*
|
|
@@ -1564,11 +1582,11 @@ declare class ProductsDataModel {
|
|
|
1564
1582
|
*
|
|
1565
1583
|
* @param {string} params.id - The `family_attributes` 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/family_attributes`. An id no family attribute of this tenant carries answers 404; a malformed one answers 400 before the route is reached.
|
|
1566
1584
|
* @throws {RevenexxException}
|
|
1567
|
-
* @returns {Promise<
|
|
1585
|
+
* @returns {Promise<{}>}
|
|
1568
1586
|
*/
|
|
1569
1587
|
productsFamilyAttributesDelete(params: {
|
|
1570
1588
|
id: string;
|
|
1571
|
-
}): Promise<
|
|
1589
|
+
}): Promise<{}>;
|
|
1572
1590
|
/**
|
|
1573
1591
|
* Deletes one family attribute by id. It is a hard delete — the row is gone, and the answer is a confirmation rather than a result to branch on.
|
|
1574
1592
|
*
|
|
@@ -1578,10 +1596,10 @@ declare class ProductsDataModel {
|
|
|
1578
1596
|
*
|
|
1579
1597
|
* @param {string} id - The `family_attributes` 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/family_attributes`. An id no family attribute of this tenant carries answers 404; a malformed one answers 400 before the route is reached.
|
|
1580
1598
|
* @throws {RevenexxException}
|
|
1581
|
-
* @returns {Promise<
|
|
1599
|
+
* @returns {Promise<{}>}
|
|
1582
1600
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1583
1601
|
*/
|
|
1584
|
-
productsFamilyAttributesDelete(id: string): Promise<
|
|
1602
|
+
productsFamilyAttributesDelete(id: string): Promise<{}>;
|
|
1585
1603
|
/**
|
|
1586
1604
|
* Reads one family attribute by its id — the whole row, every column, as it is stored.
|
|
1587
1605
|
*
|
|
@@ -1593,11 +1611,11 @@ declare class ProductsDataModel {
|
|
|
1593
1611
|
*
|
|
1594
1612
|
* @param {string} params.id - The `family_attributes` 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/family_attributes`. An id no family attribute of this tenant carries answers 404; a malformed one answers 400 before the route is reached.
|
|
1595
1613
|
* @throws {RevenexxException}
|
|
1596
|
-
* @returns {Promise<Models.
|
|
1614
|
+
* @returns {Promise<Models.FamilyAttributes>}
|
|
1597
1615
|
*/
|
|
1598
1616
|
productsFamilyAttributesGet(params: {
|
|
1599
1617
|
id: string;
|
|
1600
|
-
}): Promise<Models.
|
|
1618
|
+
}): Promise<Models.FamilyAttributes>;
|
|
1601
1619
|
/**
|
|
1602
1620
|
* Reads one family attribute by its id — the whole row, every column, as it is stored.
|
|
1603
1621
|
*
|
|
@@ -1609,10 +1627,10 @@ declare class ProductsDataModel {
|
|
|
1609
1627
|
*
|
|
1610
1628
|
* @param {string} id - The `family_attributes` 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/family_attributes`. An id no family attribute of this tenant carries answers 404; a malformed one answers 400 before the route is reached.
|
|
1611
1629
|
* @throws {RevenexxException}
|
|
1612
|
-
* @returns {Promise<Models.
|
|
1630
|
+
* @returns {Promise<Models.FamilyAttributes>}
|
|
1613
1631
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1614
1632
|
*/
|
|
1615
|
-
productsFamilyAttributesGet(id: string): Promise<Models.
|
|
1633
|
+
productsFamilyAttributesGet(id: string): Promise<Models.FamilyAttributes>;
|
|
1616
1634
|
/**
|
|
1617
1635
|
* Updates one family attribute 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.
|
|
1618
1636
|
*
|
|
@@ -1627,7 +1645,7 @@ declare class ProductsDataModel {
|
|
|
1627
1645
|
* @param {number} params.position - The family's own ordering of this attribute, which overrides the attribute's default `position` in this family's form.
|
|
1628
1646
|
* @param {object} params.requiredChannels - Narrows `is_required` to named channels. NULL or an empty list means required EVERYWHERE, not nowhere — that is how every required link in the wild is stored, and reading an empty list as "nowhere" reports a fully configured family as demanding nothing.
|
|
1629
1647
|
* @throws {RevenexxException}
|
|
1630
|
-
* @returns {Promise<Models.
|
|
1648
|
+
* @returns {Promise<Models.FamilyAttributes>}
|
|
1631
1649
|
*/
|
|
1632
1650
|
productsFamilyAttributesUpdate(params: {
|
|
1633
1651
|
id: string;
|
|
@@ -1636,7 +1654,7 @@ declare class ProductsDataModel {
|
|
|
1636
1654
|
isRequired?: boolean;
|
|
1637
1655
|
position?: number;
|
|
1638
1656
|
requiredChannels?: object;
|
|
1639
|
-
}): Promise<Models.
|
|
1657
|
+
}): Promise<Models.FamilyAttributes>;
|
|
1640
1658
|
/**
|
|
1641
1659
|
* Updates one family attribute 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.
|
|
1642
1660
|
*
|
|
@@ -1651,10 +1669,10 @@ declare class ProductsDataModel {
|
|
|
1651
1669
|
* @param {number} position - The family's own ordering of this attribute, which overrides the attribute's default `position` in this family's form.
|
|
1652
1670
|
* @param {object} requiredChannels - Narrows `is_required` to named channels. NULL or an empty list means required EVERYWHERE, not nowhere — that is how every required link in the wild is stored, and reading an empty list as "nowhere" reports a fully configured family as demanding nothing.
|
|
1653
1671
|
* @throws {RevenexxException}
|
|
1654
|
-
* @returns {Promise<Models.
|
|
1672
|
+
* @returns {Promise<Models.FamilyAttributes>}
|
|
1655
1673
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1656
1674
|
*/
|
|
1657
|
-
productsFamilyAttributesUpdate(id: string, attributeId?: string, familyId?: string, isRequired?: boolean, position?: number, requiredChannels?: object): Promise<Models.
|
|
1675
|
+
productsFamilyAttributesUpdate(id: string, attributeId?: string, familyId?: string, isRequired?: boolean, position?: number, requiredChannels?: object): Promise<Models.FamilyAttributes>;
|
|
1658
1676
|
/**
|
|
1659
1677
|
* A variant structure of a family: the attribute axes a product model splits its variants on — colour, then size. A product follows one through `family_variant_id`, and an attribute named as an axis becomes read-only on the model and is set on each variant instead, which is what `GET /products/attribute-schema` reports as `readonly_reason`. Two axis shapes are in the wild and both are read: a bare list of codes, or one entry per level.
|
|
1660
1678
|
*
|
|
@@ -1721,14 +1739,14 @@ declare class ProductsDataModel {
|
|
|
1721
1739
|
* @param {object} params.axes - The attribute codes a product model splits its variants on. Two shapes are in the wild and both are read: a bare list of codes, or one entry per level, outermost first — `[{"level": 1, "axes": ["colour"]}, {"level": 2, "axes": ["size"]}]`. An attribute named here is READ-ONLY on the model and set on each variant, which is what `AttributeField.readonly_reason` reports.
|
|
1722
1740
|
* @param {object} params.labels - What the variant structure is called, per language tag.
|
|
1723
1741
|
* @throws {RevenexxException}
|
|
1724
|
-
* @returns {Promise<Models.
|
|
1742
|
+
* @returns {Promise<Models.FamilyVariants>}
|
|
1725
1743
|
*/
|
|
1726
1744
|
productsFamilyVariantsCreate(params: {
|
|
1727
1745
|
code: string;
|
|
1728
1746
|
familyId: string;
|
|
1729
1747
|
axes?: object;
|
|
1730
1748
|
labels?: object;
|
|
1731
|
-
}): Promise<Models.
|
|
1749
|
+
}): Promise<Models.FamilyVariants>;
|
|
1732
1750
|
/**
|
|
1733
1751
|
* Creates one family variant 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.
|
|
1734
1752
|
*
|
|
@@ -1741,10 +1759,10 @@ declare class ProductsDataModel {
|
|
|
1741
1759
|
* @param {object} axes - The attribute codes a product model splits its variants on. Two shapes are in the wild and both are read: a bare list of codes, or one entry per level, outermost first — `[{"level": 1, "axes": ["colour"]}, {"level": 2, "axes": ["size"]}]`. An attribute named here is READ-ONLY on the model and set on each variant, which is what `AttributeField.readonly_reason` reports.
|
|
1742
1760
|
* @param {object} labels - What the variant structure is called, per language tag.
|
|
1743
1761
|
* @throws {RevenexxException}
|
|
1744
|
-
* @returns {Promise<Models.
|
|
1762
|
+
* @returns {Promise<Models.FamilyVariants>}
|
|
1745
1763
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1746
1764
|
*/
|
|
1747
|
-
productsFamilyVariantsCreate(code: string, familyId: string, axes?: object, labels?: object): Promise<Models.
|
|
1765
|
+
productsFamilyVariantsCreate(code: string, familyId: string, axes?: object, labels?: object): Promise<Models.FamilyVariants>;
|
|
1748
1766
|
/**
|
|
1749
1767
|
* Deletes one family variant by id. It is a hard delete — the row is gone, and the answer is a confirmation rather than a result to branch on.
|
|
1750
1768
|
*
|
|
@@ -1754,11 +1772,11 @@ declare class ProductsDataModel {
|
|
|
1754
1772
|
*
|
|
1755
1773
|
* @param {string} params.id - The `family_variants` 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/family_variants`. An id no family variant of this tenant carries answers 404; a malformed one answers 400 before the route is reached.
|
|
1756
1774
|
* @throws {RevenexxException}
|
|
1757
|
-
* @returns {Promise<
|
|
1775
|
+
* @returns {Promise<{}>}
|
|
1758
1776
|
*/
|
|
1759
1777
|
productsFamilyVariantsDelete(params: {
|
|
1760
1778
|
id: string;
|
|
1761
|
-
}): Promise<
|
|
1779
|
+
}): Promise<{}>;
|
|
1762
1780
|
/**
|
|
1763
1781
|
* Deletes one family variant by id. It is a hard delete — the row is gone, and the answer is a confirmation rather than a result to branch on.
|
|
1764
1782
|
*
|
|
@@ -1768,10 +1786,10 @@ declare class ProductsDataModel {
|
|
|
1768
1786
|
*
|
|
1769
1787
|
* @param {string} id - The `family_variants` 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/family_variants`. An id no family variant of this tenant carries answers 404; a malformed one answers 400 before the route is reached.
|
|
1770
1788
|
* @throws {RevenexxException}
|
|
1771
|
-
* @returns {Promise<
|
|
1789
|
+
* @returns {Promise<{}>}
|
|
1772
1790
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1773
1791
|
*/
|
|
1774
|
-
productsFamilyVariantsDelete(id: string): Promise<
|
|
1792
|
+
productsFamilyVariantsDelete(id: string): Promise<{}>;
|
|
1775
1793
|
/**
|
|
1776
1794
|
* Reads one family variant by its id — the whole row, every column, as it is stored.
|
|
1777
1795
|
*
|
|
@@ -1783,11 +1801,11 @@ declare class ProductsDataModel {
|
|
|
1783
1801
|
*
|
|
1784
1802
|
* @param {string} params.id - The `family_variants` 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/family_variants`. An id no family variant of this tenant carries answers 404; a malformed one answers 400 before the route is reached.
|
|
1785
1803
|
* @throws {RevenexxException}
|
|
1786
|
-
* @returns {Promise<Models.
|
|
1804
|
+
* @returns {Promise<Models.FamilyVariants>}
|
|
1787
1805
|
*/
|
|
1788
1806
|
productsFamilyVariantsGet(params: {
|
|
1789
1807
|
id: string;
|
|
1790
|
-
}): Promise<Models.
|
|
1808
|
+
}): Promise<Models.FamilyVariants>;
|
|
1791
1809
|
/**
|
|
1792
1810
|
* Reads one family variant by its id — the whole row, every column, as it is stored.
|
|
1793
1811
|
*
|
|
@@ -1799,10 +1817,10 @@ declare class ProductsDataModel {
|
|
|
1799
1817
|
*
|
|
1800
1818
|
* @param {string} id - The `family_variants` 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/family_variants`. An id no family variant of this tenant carries answers 404; a malformed one answers 400 before the route is reached.
|
|
1801
1819
|
* @throws {RevenexxException}
|
|
1802
|
-
* @returns {Promise<Models.
|
|
1820
|
+
* @returns {Promise<Models.FamilyVariants>}
|
|
1803
1821
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1804
1822
|
*/
|
|
1805
|
-
productsFamilyVariantsGet(id: string): Promise<Models.
|
|
1823
|
+
productsFamilyVariantsGet(id: string): Promise<Models.FamilyVariants>;
|
|
1806
1824
|
/**
|
|
1807
1825
|
* Updates one family variant 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.
|
|
1808
1826
|
*
|
|
@@ -1816,7 +1834,7 @@ declare class ProductsDataModel {
|
|
|
1816
1834
|
* @param {string} params.familyId - The family this variant structure belongs to. A family may carry several, and a product names the one it follows through `family_variant_id`.
|
|
1817
1835
|
* @param {object} params.labels - What the variant structure is called, per language tag.
|
|
1818
1836
|
* @throws {RevenexxException}
|
|
1819
|
-
* @returns {Promise<Models.
|
|
1837
|
+
* @returns {Promise<Models.FamilyVariants>}
|
|
1820
1838
|
*/
|
|
1821
1839
|
productsFamilyVariantsUpdate(params: {
|
|
1822
1840
|
id: string;
|
|
@@ -1824,7 +1842,7 @@ declare class ProductsDataModel {
|
|
|
1824
1842
|
code?: string;
|
|
1825
1843
|
familyId?: string;
|
|
1826
1844
|
labels?: object;
|
|
1827
|
-
}): Promise<Models.
|
|
1845
|
+
}): Promise<Models.FamilyVariants>;
|
|
1828
1846
|
/**
|
|
1829
1847
|
* Updates one family variant 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.
|
|
1830
1848
|
*
|
|
@@ -1838,10 +1856,10 @@ declare class ProductsDataModel {
|
|
|
1838
1856
|
* @param {string} familyId - The family this variant structure belongs to. A family may carry several, and a product names the one it follows through `family_variant_id`.
|
|
1839
1857
|
* @param {object} labels - What the variant structure is called, per language tag.
|
|
1840
1858
|
* @throws {RevenexxException}
|
|
1841
|
-
* @returns {Promise<Models.
|
|
1859
|
+
* @returns {Promise<Models.FamilyVariants>}
|
|
1842
1860
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1843
1861
|
*/
|
|
1844
|
-
productsFamilyVariantsUpdate(id: string, axes?: object, code?: string, familyId?: string, labels?: object): Promise<Models.
|
|
1862
|
+
productsFamilyVariantsUpdate(id: string, axes?: object, code?: string, familyId?: string, labels?: object): Promise<Models.FamilyVariants>;
|
|
1845
1863
|
/**
|
|
1846
1864
|
* A family of units and the standard one they all convert to — weight in kilograms, length in metres. A `measure` attribute names one and then offers exactly that family's units, and each unit's `convert_factor` is what makes two values recorded in different units comparable at all.
|
|
1847
1865
|
*
|
|
@@ -1908,14 +1926,14 @@ declare class ProductsDataModel {
|
|
|
1908
1926
|
* @param {object} params.labels - What the measurement family is called, per language tag.
|
|
1909
1927
|
* @param {object} params.units - The units this family offers. `convert_factor` multiplies a value into `standard_unit`, so a gram is 0.001 kilograms; `symbol` is what a form prints next to the number.
|
|
1910
1928
|
* @throws {RevenexxException}
|
|
1911
|
-
* @returns {Promise<Models.
|
|
1929
|
+
* @returns {Promise<Models.MeasurementFamilies>}
|
|
1912
1930
|
*/
|
|
1913
1931
|
productsMeasurementFamiliesCreate(params: {
|
|
1914
1932
|
code: string;
|
|
1915
1933
|
standardUnit: string;
|
|
1916
1934
|
labels?: object;
|
|
1917
1935
|
units?: object;
|
|
1918
|
-
}): Promise<Models.
|
|
1936
|
+
}): Promise<Models.MeasurementFamilies>;
|
|
1919
1937
|
/**
|
|
1920
1938
|
* Creates one measurement family 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.
|
|
1921
1939
|
*
|
|
@@ -1928,10 +1946,10 @@ declare class ProductsDataModel {
|
|
|
1928
1946
|
* @param {object} labels - What the measurement family is called, per language tag.
|
|
1929
1947
|
* @param {object} units - The units this family offers. `convert_factor` multiplies a value into `standard_unit`, so a gram is 0.001 kilograms; `symbol` is what a form prints next to the number.
|
|
1930
1948
|
* @throws {RevenexxException}
|
|
1931
|
-
* @returns {Promise<Models.
|
|
1949
|
+
* @returns {Promise<Models.MeasurementFamilies>}
|
|
1932
1950
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1933
1951
|
*/
|
|
1934
|
-
productsMeasurementFamiliesCreate(code: string, standardUnit: string, labels?: object, units?: object): Promise<Models.
|
|
1952
|
+
productsMeasurementFamiliesCreate(code: string, standardUnit: string, labels?: object, units?: object): Promise<Models.MeasurementFamilies>;
|
|
1935
1953
|
/**
|
|
1936
1954
|
* Deletes one measurement family by id. It is a hard delete — the row is gone, and the answer is a confirmation rather than a result to branch on.
|
|
1937
1955
|
*
|
|
@@ -1941,11 +1959,11 @@ declare class ProductsDataModel {
|
|
|
1941
1959
|
*
|
|
1942
1960
|
* @param {string} params.id - The `measurement_families` 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/measurement_families`. An id no measurement familie of this tenant carries answers 404; a malformed one answers 400 before the route is reached.
|
|
1943
1961
|
* @throws {RevenexxException}
|
|
1944
|
-
* @returns {Promise<
|
|
1962
|
+
* @returns {Promise<{}>}
|
|
1945
1963
|
*/
|
|
1946
1964
|
productsMeasurementFamiliesDelete(params: {
|
|
1947
1965
|
id: string;
|
|
1948
|
-
}): Promise<
|
|
1966
|
+
}): Promise<{}>;
|
|
1949
1967
|
/**
|
|
1950
1968
|
* Deletes one measurement family by id. It is a hard delete — the row is gone, and the answer is a confirmation rather than a result to branch on.
|
|
1951
1969
|
*
|
|
@@ -1955,10 +1973,10 @@ declare class ProductsDataModel {
|
|
|
1955
1973
|
*
|
|
1956
1974
|
* @param {string} id - The `measurement_families` 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/measurement_families`. An id no measurement familie of this tenant carries answers 404; a malformed one answers 400 before the route is reached.
|
|
1957
1975
|
* @throws {RevenexxException}
|
|
1958
|
-
* @returns {Promise<
|
|
1976
|
+
* @returns {Promise<{}>}
|
|
1959
1977
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1960
1978
|
*/
|
|
1961
|
-
productsMeasurementFamiliesDelete(id: string): Promise<
|
|
1979
|
+
productsMeasurementFamiliesDelete(id: string): Promise<{}>;
|
|
1962
1980
|
/**
|
|
1963
1981
|
* Reads one measurement family by its id — the whole row, every column, as it is stored.
|
|
1964
1982
|
*
|
|
@@ -1970,11 +1988,11 @@ declare class ProductsDataModel {
|
|
|
1970
1988
|
*
|
|
1971
1989
|
* @param {string} params.id - The `measurement_families` 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/measurement_families`. An id no measurement familie of this tenant carries answers 404; a malformed one answers 400 before the route is reached.
|
|
1972
1990
|
* @throws {RevenexxException}
|
|
1973
|
-
* @returns {Promise<Models.
|
|
1991
|
+
* @returns {Promise<Models.MeasurementFamilies>}
|
|
1974
1992
|
*/
|
|
1975
1993
|
productsMeasurementFamiliesGet(params: {
|
|
1976
1994
|
id: string;
|
|
1977
|
-
}): Promise<Models.
|
|
1995
|
+
}): Promise<Models.MeasurementFamilies>;
|
|
1978
1996
|
/**
|
|
1979
1997
|
* Reads one measurement family by its id — the whole row, every column, as it is stored.
|
|
1980
1998
|
*
|
|
@@ -1986,10 +2004,10 @@ declare class ProductsDataModel {
|
|
|
1986
2004
|
*
|
|
1987
2005
|
* @param {string} id - The `measurement_families` 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/measurement_families`. An id no measurement familie of this tenant carries answers 404; a malformed one answers 400 before the route is reached.
|
|
1988
2006
|
* @throws {RevenexxException}
|
|
1989
|
-
* @returns {Promise<Models.
|
|
2007
|
+
* @returns {Promise<Models.MeasurementFamilies>}
|
|
1990
2008
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1991
2009
|
*/
|
|
1992
|
-
productsMeasurementFamiliesGet(id: string): Promise<Models.
|
|
2010
|
+
productsMeasurementFamiliesGet(id: string): Promise<Models.MeasurementFamilies>;
|
|
1993
2011
|
/**
|
|
1994
2012
|
* Updates one measurement family 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.
|
|
1995
2013
|
*
|
|
@@ -2003,7 +2021,7 @@ declare class ProductsDataModel {
|
|
|
2003
2021
|
* @param {string} params.standardUnit - The unit every value of this family is converted to before it is compared or sorted — the unit each `convert_factor` is relative to.
|
|
2004
2022
|
* @param {object} params.units - The units this family offers. `convert_factor` multiplies a value into `standard_unit`, so a gram is 0.001 kilograms; `symbol` is what a form prints next to the number.
|
|
2005
2023
|
* @throws {RevenexxException}
|
|
2006
|
-
* @returns {Promise<Models.
|
|
2024
|
+
* @returns {Promise<Models.MeasurementFamilies>}
|
|
2007
2025
|
*/
|
|
2008
2026
|
productsMeasurementFamiliesUpdate(params: {
|
|
2009
2027
|
id: string;
|
|
@@ -2011,7 +2029,7 @@ declare class ProductsDataModel {
|
|
|
2011
2029
|
labels?: object;
|
|
2012
2030
|
standardUnit?: string;
|
|
2013
2031
|
units?: object;
|
|
2014
|
-
}): Promise<Models.
|
|
2032
|
+
}): Promise<Models.MeasurementFamilies>;
|
|
2015
2033
|
/**
|
|
2016
2034
|
* Updates one measurement family 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.
|
|
2017
2035
|
*
|
|
@@ -2025,10 +2043,10 @@ declare class ProductsDataModel {
|
|
|
2025
2043
|
* @param {string} standardUnit - The unit every value of this family is converted to before it is compared or sorted — the unit each `convert_factor` is relative to.
|
|
2026
2044
|
* @param {object} units - The units this family offers. `convert_factor` multiplies a value into `standard_unit`, so a gram is 0.001 kilograms; `symbol` is what a form prints next to the number.
|
|
2027
2045
|
* @throws {RevenexxException}
|
|
2028
|
-
* @returns {Promise<Models.
|
|
2046
|
+
* @returns {Promise<Models.MeasurementFamilies>}
|
|
2029
2047
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
2030
2048
|
*/
|
|
2031
|
-
productsMeasurementFamiliesUpdate(id: string, code?: string, labels?: object, standardUnit?: string, units?: object): Promise<Models.
|
|
2049
|
+
productsMeasurementFamiliesUpdate(id: string, code?: string, labels?: object, standardUnit?: string, units?: object): Promise<Models.MeasurementFamilies>;
|
|
2032
2050
|
}
|
|
2033
2051
|
|
|
2034
2052
|
export { ProductsDataModel };
|