@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
|
@@ -10,6 +10,15 @@ import '../query.mjs';
|
|
|
10
10
|
import '../enums/address-type-row-tone.mjs';
|
|
11
11
|
import '../enums/address-type-row-create-request-tone.mjs';
|
|
12
12
|
import '../enums/address-type-row-update-request-tone.mjs';
|
|
13
|
+
import '../enums/approval-rule-approver-type.mjs';
|
|
14
|
+
import '../enums/approval-rule-condition.mjs';
|
|
15
|
+
import '../enums/approval-rule-effect.mjs';
|
|
16
|
+
import '../enums/approval-rule-create-request-approver-type.mjs';
|
|
17
|
+
import '../enums/approval-rule-create-request-condition.mjs';
|
|
18
|
+
import '../enums/approval-rule-create-request-effect.mjs';
|
|
19
|
+
import '../enums/approval-rule-update-request-approver-type.mjs';
|
|
20
|
+
import '../enums/approval-rule-update-request-condition.mjs';
|
|
21
|
+
import '../enums/approval-rule-update-request-effect.mjs';
|
|
13
22
|
import '../enums/assets-source.mjs';
|
|
14
23
|
import '../enums/attribute-value-bucket.mjs';
|
|
15
24
|
import '../enums/auth-mail-source.mjs';
|
|
@@ -123,6 +132,8 @@ import '../enums/payment-term-tone.mjs';
|
|
|
123
132
|
import '../enums/payment-term-create-request-tone.mjs';
|
|
124
133
|
import '../enums/payment-term-update-request-tone.mjs';
|
|
125
134
|
import '../enums/payment-vocabulary-tone.mjs';
|
|
135
|
+
import '../enums/pending-approval-approver-type.mjs';
|
|
136
|
+
import '../enums/pending-approval-status.mjs';
|
|
126
137
|
import '../enums/price-entries-adjust-response-rounding.mjs';
|
|
127
138
|
import '../enums/price-entries-adjust-response-rounding-mode.mjs';
|
|
128
139
|
import '../enums/price-rounding-mode.mjs';
|
|
@@ -140,6 +151,11 @@ import '../enums/product-grid-column-source.mjs';
|
|
|
140
151
|
import '../enums/product-label-source.mjs';
|
|
141
152
|
import '../enums/product-label-attribute-source.mjs';
|
|
142
153
|
import '../enums/products-kind.mjs';
|
|
154
|
+
import '../enums/purchase-request-status.mjs';
|
|
155
|
+
import '../enums/purchase-request-event-name.mjs';
|
|
156
|
+
import '../enums/purchase-request-item-type.mjs';
|
|
157
|
+
import '../enums/purchase-request-item-create-request-type.mjs';
|
|
158
|
+
import '../enums/purchase-request-item-update-request-type.mjs';
|
|
143
159
|
import '../enums/reorder-point-source.mjs';
|
|
144
160
|
import '../enums/reservation-status.mjs';
|
|
145
161
|
import '../enums/price-on-request-reason.mjs';
|
|
@@ -177,6 +193,8 @@ import '../enums/shipping-weight-unit-row-tone.mjs';
|
|
|
177
193
|
import '../enums/shipping-weight-unit-update-request-tone.mjs';
|
|
178
194
|
import '../enums/stock-movement-type.mjs';
|
|
179
195
|
import '../enums/store-asset-request-visibility.mjs';
|
|
196
|
+
import '../enums/submit-item-type.mjs';
|
|
197
|
+
import '../enums/submit-result-outcome.mjs';
|
|
180
198
|
import '../enums/validation-failed-response-status.mjs';
|
|
181
199
|
import '../enums/vocabulary-default-tone.mjs';
|
|
182
200
|
import '../enums/vocabulary-source.mjs';
|
|
@@ -256,7 +274,7 @@ declare class Prices {
|
|
|
256
274
|
* @param {number} params.offset - Row offset for pagination (default 0).
|
|
257
275
|
* @param {string} params.order - Sort by one column: 'column' | 'column.asc' | 'column.desc'. A bare column sorts ascending. Anything else is refused with 400.
|
|
258
276
|
* @throws {RevenexxException}
|
|
259
|
-
* @returns {Promise<
|
|
277
|
+
* @returns {Promise<{}>}
|
|
260
278
|
*/
|
|
261
279
|
pricesListsList(params?: {
|
|
262
280
|
id?: string;
|
|
@@ -280,7 +298,7 @@ declare class Prices {
|
|
|
280
298
|
limit?: number;
|
|
281
299
|
offset?: number;
|
|
282
300
|
order?: string;
|
|
283
|
-
}): Promise<
|
|
301
|
+
}): Promise<{}>;
|
|
284
302
|
/**
|
|
285
303
|
* One page of the tenant's price list HEADERS — code, currency, tax basis, status, priority, validity window, buyer scope and the default flag. Never the prices themselves: those are a separate page per list (`GET /prices/lists/{list_id}/entries`).
|
|
286
304
|
*
|
|
@@ -310,10 +328,10 @@ declare class Prices {
|
|
|
310
328
|
* @param {number} offset - Row offset for pagination (default 0).
|
|
311
329
|
* @param {string} order - Sort by one column: 'column' | 'column.asc' | 'column.desc'. A bare column sorts ascending. Anything else is refused with 400.
|
|
312
330
|
* @throws {RevenexxException}
|
|
313
|
-
* @returns {Promise<
|
|
331
|
+
* @returns {Promise<{}>}
|
|
314
332
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
315
333
|
*/
|
|
316
|
-
pricesListsList(id?: string, code?: string, name?: string, description?: string, currency?: string, status?: PriceListStatus, priority?: number, isDefault?: boolean, taxBasis?: PriceListTaxBasis, taxIncluded?: boolean, requiresAuth?: boolean, contactId?: string, organizationId?: string, channelId?: string, validFrom?: string, validUntil?: string, createdAt?: string, updatedAt?: string, limit?: number, offset?: number, order?: string): Promise<
|
|
334
|
+
pricesListsList(id?: string, code?: string, name?: string, description?: string, currency?: string, status?: PriceListStatus, priority?: number, isDefault?: boolean, taxBasis?: PriceListTaxBasis, taxIncluded?: boolean, requiresAuth?: boolean, contactId?: string, organizationId?: string, channelId?: string, validFrom?: string, validUntil?: string, createdAt?: string, updatedAt?: string, limit?: number, offset?: number, order?: string): Promise<{}>;
|
|
317
335
|
/**
|
|
318
336
|
* Opens an empty book, and states in one row the four things that decide whether it will ever price anything: its currency, its priority within a specificity group, its validity window, and its buyer scope (contact, organization or channel — leave all three empty for a list open to everyone).
|
|
319
337
|
*
|
|
@@ -343,7 +361,7 @@ declare class Prices {
|
|
|
343
361
|
* @param {string} params.validFrom - Start of the validity window of the WHOLE list (ISO 8601); null = open-ended. Outside it the list is not a candidate at all.
|
|
344
362
|
* @param {string} params.validUntil - End of the validity window of the whole list; null = open-ended. Lets a season expire on its own instead of being deactivated by hand.
|
|
345
363
|
* @throws {RevenexxException}
|
|
346
|
-
* @returns {Promise<Models.
|
|
364
|
+
* @returns {Promise<Models.PriceList>}
|
|
347
365
|
*/
|
|
348
366
|
pricesListsCreate(params: {
|
|
349
367
|
code: string;
|
|
@@ -363,7 +381,7 @@ declare class Prices {
|
|
|
363
381
|
taxIncluded?: boolean;
|
|
364
382
|
validFrom?: string;
|
|
365
383
|
validUntil?: string;
|
|
366
|
-
}): Promise<Models.
|
|
384
|
+
}): Promise<Models.PriceList>;
|
|
367
385
|
/**
|
|
368
386
|
* Opens an empty book, and states in one row the four things that decide whether it will ever price anything: its currency, its priority within a specificity group, its validity window, and its buyer scope (contact, organization or channel — leave all three empty for a list open to everyone).
|
|
369
387
|
*
|
|
@@ -393,10 +411,10 @@ declare class Prices {
|
|
|
393
411
|
* @param {string} validFrom - Start of the validity window of the WHOLE list (ISO 8601); null = open-ended. Outside it the list is not a candidate at all.
|
|
394
412
|
* @param {string} validUntil - End of the validity window of the whole list; null = open-ended. Lets a season expire on its own instead of being deactivated by hand.
|
|
395
413
|
* @throws {RevenexxException}
|
|
396
|
-
* @returns {Promise<Models.
|
|
414
|
+
* @returns {Promise<Models.PriceList>}
|
|
397
415
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
398
416
|
*/
|
|
399
|
-
pricesListsCreate(code: string, name: string, channelId?: string, contactId?: string, currency?: string, description?: string, isDefault?: boolean, labels?: object, metadata?: object, organizationId?: string, priority?: number, requiresAuth?: boolean, status?: PriceListStatus, taxBasis?: PriceListTaxBasis, taxIncluded?: boolean, validFrom?: string, validUntil?: string): Promise<Models.
|
|
417
|
+
pricesListsCreate(code: string, name: string, channelId?: string, contactId?: string, currency?: string, description?: string, isDefault?: boolean, labels?: object, metadata?: object, organizationId?: string, priority?: number, requiresAuth?: boolean, status?: PriceListStatus, taxBasis?: PriceListTaxBasis, taxIncluded?: boolean, validFrom?: string, validUntil?: string): Promise<Models.PriceList>;
|
|
400
418
|
/**
|
|
401
419
|
* Gives a tenant the one open list every tenant needs, so nothing has to exist before the first price can be written. Almost nobody calls it: the app runs it by itself on `app.installed`, and the route is the manual re-run — for a tenant installed before that hook existed, or one whose standard list was deleted. Because it is idempotent it is also safe to call from a provisioning script that cannot know which of the two is the case.
|
|
402
420
|
*
|
|
@@ -417,11 +435,11 @@ declare class Prices {
|
|
|
417
435
|
*
|
|
418
436
|
* @param {string} params.id - The price list, by id.
|
|
419
437
|
* @throws {RevenexxException}
|
|
420
|
-
* @returns {Promise<Models.
|
|
438
|
+
* @returns {Promise<Models.PriceDeleted>}
|
|
421
439
|
*/
|
|
422
440
|
pricesListsDelete(params: {
|
|
423
441
|
id: string;
|
|
424
|
-
}): Promise<Models.
|
|
442
|
+
}): Promise<Models.PriceDeleted>;
|
|
425
443
|
/**
|
|
426
444
|
* Deletes the list AND every price in it. `price_entries.price_list_id` references this row ON DELETE CASCADE, so the entries go in the same statement: nothing asks, nothing blocks, a book of 40 000 prices deletes exactly as fast as an empty one, and the answer is a bare `{deleted, id}` that never says how many prices went with it.
|
|
427
445
|
*
|
|
@@ -431,29 +449,29 @@ declare class Prices {
|
|
|
431
449
|
*
|
|
432
450
|
* @param {string} id - The price list, by id.
|
|
433
451
|
* @throws {RevenexxException}
|
|
434
|
-
* @returns {Promise<Models.
|
|
452
|
+
* @returns {Promise<Models.PriceDeleted>}
|
|
435
453
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
436
454
|
*/
|
|
437
|
-
pricesListsDelete(id: string): Promise<Models.
|
|
455
|
+
pricesListsDelete(id: string): Promise<Models.PriceDeleted>;
|
|
438
456
|
/**
|
|
439
457
|
* The list HEADER, never its prices: currency, tax basis, buyer scope, priority, validity window and the default flag — the settings that decide WHETHER this list prices a given buyer, before any amount is looked at. Its entries are a separate page (`GET /prices/lists/{list_id}/entries`), because a price book runs to thousands of rows and no read of a list should carry them. This is the admin view and it reads the base table rather than the market-scoped one the resolve call uses, so a list that is invisible in the active market is still returned here.
|
|
440
458
|
*
|
|
441
459
|
* @param {string} params.id - The price list, by id.
|
|
442
460
|
* @throws {RevenexxException}
|
|
443
|
-
* @returns {Promise<Models.
|
|
461
|
+
* @returns {Promise<Models.PriceList>}
|
|
444
462
|
*/
|
|
445
463
|
pricesListsGet(params: {
|
|
446
464
|
id: string;
|
|
447
|
-
}): Promise<Models.
|
|
465
|
+
}): Promise<Models.PriceList>;
|
|
448
466
|
/**
|
|
449
467
|
* The list HEADER, never its prices: currency, tax basis, buyer scope, priority, validity window and the default flag — the settings that decide WHETHER this list prices a given buyer, before any amount is looked at. Its entries are a separate page (`GET /prices/lists/{list_id}/entries`), because a price book runs to thousands of rows and no read of a list should carry them. This is the admin view and it reads the base table rather than the market-scoped one the resolve call uses, so a list that is invisible in the active market is still returned here.
|
|
450
468
|
*
|
|
451
469
|
* @param {string} id - The price list, by id.
|
|
452
470
|
* @throws {RevenexxException}
|
|
453
|
-
* @returns {Promise<Models.
|
|
471
|
+
* @returns {Promise<Models.PriceList>}
|
|
454
472
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
455
473
|
*/
|
|
456
|
-
pricesListsGet(id: string): Promise<Models.
|
|
474
|
+
pricesListsGet(id: string): Promise<Models.PriceList>;
|
|
457
475
|
/**
|
|
458
476
|
* A partial update: send only what changes, omitted fields keep their value, and a payload with no updatable column at all is refused rather than answered with an unchanged row. There is no draft and no publish step — the next resolve call reads what this one wrote.
|
|
459
477
|
*
|
|
@@ -480,7 +498,7 @@ declare class Prices {
|
|
|
480
498
|
* @param {string} params.validFrom - Start of the validity window of the WHOLE list (ISO 8601); null = open-ended. Outside it the list is not a candidate at all.
|
|
481
499
|
* @param {string} params.validUntil - End of the validity window of the whole list; null = open-ended. Lets a season expire on its own instead of being deactivated by hand.
|
|
482
500
|
* @throws {RevenexxException}
|
|
483
|
-
* @returns {Promise<Models.
|
|
501
|
+
* @returns {Promise<Models.PriceList>}
|
|
484
502
|
*/
|
|
485
503
|
pricesListsUpdate(params: {
|
|
486
504
|
id: string;
|
|
@@ -501,7 +519,7 @@ declare class Prices {
|
|
|
501
519
|
taxIncluded?: boolean;
|
|
502
520
|
validFrom?: string;
|
|
503
521
|
validUntil?: string;
|
|
504
|
-
}): Promise<Models.
|
|
522
|
+
}): Promise<Models.PriceList>;
|
|
505
523
|
/**
|
|
506
524
|
* A partial update: send only what changes, omitted fields keep their value, and a payload with no updatable column at all is refused rather than answered with an unchanged row. There is no draft and no publish step — the next resolve call reads what this one wrote.
|
|
507
525
|
*
|
|
@@ -528,10 +546,10 @@ declare class Prices {
|
|
|
528
546
|
* @param {string} validFrom - Start of the validity window of the WHOLE list (ISO 8601); null = open-ended. Outside it the list is not a candidate at all.
|
|
529
547
|
* @param {string} validUntil - End of the validity window of the whole list; null = open-ended. Lets a season expire on its own instead of being deactivated by hand.
|
|
530
548
|
* @throws {RevenexxException}
|
|
531
|
-
* @returns {Promise<Models.
|
|
549
|
+
* @returns {Promise<Models.PriceList>}
|
|
532
550
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
533
551
|
*/
|
|
534
|
-
pricesListsUpdate(id: string, channelId?: string, code?: string, contactId?: string, currency?: string, description?: string, isDefault?: boolean, labels?: object, metadata?: object, name?: string, organizationId?: string, priority?: number, requiresAuth?: boolean, status?: PriceListStatus, taxBasis?: PriceListTaxBasis, taxIncluded?: boolean, validFrom?: string, validUntil?: string): Promise<Models.
|
|
552
|
+
pricesListsUpdate(id: string, channelId?: string, code?: string, contactId?: string, currency?: string, description?: string, isDefault?: boolean, labels?: object, metadata?: object, name?: string, organizationId?: string, priority?: number, requiresAuth?: boolean, status?: PriceListStatus, taxBasis?: PriceListTaxBasis, taxIncluded?: boolean, validFrom?: string, validUntil?: string): Promise<Models.PriceList>;
|
|
535
553
|
/**
|
|
536
554
|
* The prices inside one list, a page at a time. An entry is a rung rather than "the price of a product": it carries a quantity threshold, an amount and a unit, its own validity window, and — where the answer is deliberately no number at all — an `on_request` marker instead of one. So this page is where the quantity tiers, the promo windows and the "ask us" markers of a book are read.
|
|
537
555
|
*
|
|
@@ -553,7 +571,7 @@ declare class Prices {
|
|
|
553
571
|
* @param {number} params.offset - Row offset for pagination (default 0).
|
|
554
572
|
* @param {string} params.order - Sort by one column: 'column' | 'column.asc' | 'column.desc'. A bare column sorts ascending. Anything else is refused with 400.
|
|
555
573
|
* @throws {RevenexxException}
|
|
556
|
-
* @returns {Promise<
|
|
574
|
+
* @returns {Promise<{}>}
|
|
557
575
|
*/
|
|
558
576
|
pricesEntriesList(params: {
|
|
559
577
|
listId: string;
|
|
@@ -571,7 +589,7 @@ declare class Prices {
|
|
|
571
589
|
limit?: number;
|
|
572
590
|
offset?: number;
|
|
573
591
|
order?: string;
|
|
574
|
-
}): Promise<
|
|
592
|
+
}): Promise<{}>;
|
|
575
593
|
/**
|
|
576
594
|
* The prices inside one list, a page at a time. An entry is a rung rather than "the price of a product": it carries a quantity threshold, an amount and a unit, its own validity window, and — where the answer is deliberately no number at all — an `on_request` marker instead of one. So this page is where the quantity tiers, the promo windows and the "ask us" markers of a book are read.
|
|
577
595
|
*
|
|
@@ -593,10 +611,10 @@ declare class Prices {
|
|
|
593
611
|
* @param {number} offset - Row offset for pagination (default 0).
|
|
594
612
|
* @param {string} order - Sort by one column: 'column' | 'column.asc' | 'column.desc'. A bare column sorts ascending. Anything else is refused with 400.
|
|
595
613
|
* @throws {RevenexxException}
|
|
596
|
-
* @returns {Promise<
|
|
614
|
+
* @returns {Promise<{}>}
|
|
597
615
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
598
616
|
*/
|
|
599
|
-
pricesEntriesList(listId: string, id?: string, productId?: string, sku?: string, priceType?: PriceEntryType, quantityMin?: number, unitPrice?: number, unit?: string, validFrom?: string, validUntil?: string, createdAt?: string, updatedAt?: string, limit?: number, offset?: number, order?: string): Promise<
|
|
617
|
+
pricesEntriesList(listId: string, id?: string, productId?: string, sku?: string, priceType?: PriceEntryType, quantityMin?: number, unitPrice?: number, unit?: string, validFrom?: string, validUntil?: string, createdAt?: string, updatedAt?: string, limit?: number, offset?: number, order?: string): Promise<{}>;
|
|
600
618
|
/**
|
|
601
619
|
* Adds ONE rung to one item's quantity ladder in this list. The only thing an entry must have is an identity — `product_id` or `sku`, which the row CHECK enforces; everything else defaults, and one of those defaults deserves a warning.
|
|
602
620
|
*
|
|
@@ -617,7 +635,7 @@ declare class Prices {
|
|
|
617
635
|
* @param {string} params.validFrom - Start of this entry’s own validity (ISO 8601) — how a promo price is expressed: a second rung, live only for its window. null = open-ended.
|
|
618
636
|
* @param {string} params.validUntil - End of this entry’s own validity; null = open-ended. Outside it the rung is skipped and the ladder resolves as if it were not there.
|
|
619
637
|
* @throws {RevenexxException}
|
|
620
|
-
* @returns {Promise<Models.
|
|
638
|
+
* @returns {Promise<Models.PriceEntry>}
|
|
621
639
|
*/
|
|
622
640
|
pricesEntriesCreate(params: {
|
|
623
641
|
listId: string;
|
|
@@ -630,7 +648,7 @@ declare class Prices {
|
|
|
630
648
|
unitPrice?: number;
|
|
631
649
|
validFrom?: string;
|
|
632
650
|
validUntil?: string;
|
|
633
|
-
}): Promise<Models.
|
|
651
|
+
}): Promise<Models.PriceEntry>;
|
|
634
652
|
/**
|
|
635
653
|
* Adds ONE rung to one item's quantity ladder in this list. The only thing an entry must have is an identity — `product_id` or `sku`, which the row CHECK enforces; everything else defaults, and one of those defaults deserves a warning.
|
|
636
654
|
*
|
|
@@ -651,10 +669,10 @@ declare class Prices {
|
|
|
651
669
|
* @param {string} validFrom - Start of this entry’s own validity (ISO 8601) — how a promo price is expressed: a second rung, live only for its window. null = open-ended.
|
|
652
670
|
* @param {string} validUntil - End of this entry’s own validity; null = open-ended. Outside it the rung is skipped and the ladder resolves as if it were not there.
|
|
653
671
|
* @throws {RevenexxException}
|
|
654
|
-
* @returns {Promise<Models.
|
|
672
|
+
* @returns {Promise<Models.PriceEntry>}
|
|
655
673
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
656
674
|
*/
|
|
657
|
-
pricesEntriesCreate(listId: string, metadata?: object, priceType?: PriceEntryType, productId?: string, quantityMin?: number, sku?: string, unit?: string, unitPrice?: number, validFrom?: string, validUntil?: string): Promise<Models.
|
|
675
|
+
pricesEntriesCreate(listId: string, metadata?: object, priceType?: PriceEntryType, productId?: string, quantityMin?: number, sku?: string, unit?: string, unitPrice?: number, validFrom?: string, validUntil?: string): Promise<Models.PriceEntry>;
|
|
658
676
|
/**
|
|
659
677
|
* Set semantics over the WHOLE list, not over one item: every entry of the list is deleted and the payload becomes the complete new book. It exists for the two callers that genuinely hold the whole book in hand — the Cockpit's table editor, whose save is this call, and a small import. `entries: []` is a legal payload and empties the list — the items it priced then resolve from the next candidate list, or come back `on_request`.
|
|
660
678
|
*
|
|
@@ -665,12 +683,12 @@ declare class Prices {
|
|
|
665
683
|
* @param {string} params.listId - The price list the entries belong to. An id no list in this tenant has answers 404 rather than an empty page.
|
|
666
684
|
* @param {Models.PriceEntryReplaceItem[]} params.entries - The complete new entry set (set semantics).
|
|
667
685
|
* @throws {RevenexxException}
|
|
668
|
-
* @returns {Promise<Models.
|
|
686
|
+
* @returns {Promise<Models.PriceEntriesReplaceResponse>}
|
|
669
687
|
*/
|
|
670
688
|
pricesEntriesReplace(params: {
|
|
671
689
|
listId: string;
|
|
672
690
|
entries: Models.PriceEntryReplaceItem[];
|
|
673
|
-
}): Promise<Models.
|
|
691
|
+
}): Promise<Models.PriceEntriesReplaceResponse>;
|
|
674
692
|
/**
|
|
675
693
|
* Set semantics over the WHOLE list, not over one item: every entry of the list is deleted and the payload becomes the complete new book. It exists for the two callers that genuinely hold the whole book in hand — the Cockpit's table editor, whose save is this call, and a small import. `entries: []` is a legal payload and empties the list — the items it priced then resolve from the next candidate list, or come back `on_request`.
|
|
676
694
|
*
|
|
@@ -681,10 +699,10 @@ declare class Prices {
|
|
|
681
699
|
* @param {string} listId - The price list the entries belong to. An id no list in this tenant has answers 404 rather than an empty page.
|
|
682
700
|
* @param {Models.PriceEntryReplaceItem[]} entries - The complete new entry set (set semantics).
|
|
683
701
|
* @throws {RevenexxException}
|
|
684
|
-
* @returns {Promise<Models.
|
|
702
|
+
* @returns {Promise<Models.PriceEntriesReplaceResponse>}
|
|
685
703
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
686
704
|
*/
|
|
687
|
-
pricesEntriesReplace(listId: string, entries: Models.PriceEntryReplaceItem[]): Promise<Models.
|
|
705
|
+
pricesEntriesReplace(listId: string, entries: Models.PriceEntryReplaceItem[]): Promise<Models.PriceEntriesReplaceResponse>;
|
|
688
706
|
/**
|
|
689
707
|
* Moves every priced entry of the list at once, in whichever of the two ways a merchant thinks about a price change: `percent` for a relative one (5 raises everything by 5 %) or `amount` for a flat one added to every unit price. One or the other, never both, and `sku_prefix` narrows the change to part of the book. On-request entries are never touched, because a percentage of "ask us" is not a number.
|
|
690
708
|
*
|
|
@@ -697,7 +715,7 @@ declare class Prices {
|
|
|
697
715
|
* @param {PriceEndingRule} params.rounding - Ending the computed prices snap to (nearest match). Omit to use the tenant's bulk_adjust_rounding setting.
|
|
698
716
|
* @param {string} params.skuPrefix - Restrict the change to entries whose SKU starts with this (a prefix, case-sensitive, no wildcards). Entries identified only by product_id never match a prefix. Omit to change the whole list.
|
|
699
717
|
* @throws {RevenexxException}
|
|
700
|
-
* @returns {Promise<Models.
|
|
718
|
+
* @returns {Promise<Models.PriceEntriesAdjustResponse>}
|
|
701
719
|
*/
|
|
702
720
|
pricesEntriesAdjust(params: {
|
|
703
721
|
listId: string;
|
|
@@ -706,7 +724,7 @@ declare class Prices {
|
|
|
706
724
|
percent?: number;
|
|
707
725
|
rounding?: PriceEndingRule;
|
|
708
726
|
skuPrefix?: string;
|
|
709
|
-
}): Promise<Models.
|
|
727
|
+
}): Promise<Models.PriceEntriesAdjustResponse>;
|
|
710
728
|
/**
|
|
711
729
|
* Moves every priced entry of the list at once, in whichever of the two ways a merchant thinks about a price change: `percent` for a relative one (5 raises everything by 5 %) or `amount` for a flat one added to every unit price. One or the other, never both, and `sku_prefix` narrows the change to part of the book. On-request entries are never touched, because a percentage of "ask us" is not a number.
|
|
712
730
|
*
|
|
@@ -719,10 +737,10 @@ declare class Prices {
|
|
|
719
737
|
* @param {PriceEndingRule} rounding - Ending the computed prices snap to (nearest match). Omit to use the tenant's bulk_adjust_rounding setting.
|
|
720
738
|
* @param {string} skuPrefix - Restrict the change to entries whose SKU starts with this (a prefix, case-sensitive, no wildcards). Entries identified only by product_id never match a prefix. Omit to change the whole list.
|
|
721
739
|
* @throws {RevenexxException}
|
|
722
|
-
* @returns {Promise<Models.
|
|
740
|
+
* @returns {Promise<Models.PriceEntriesAdjustResponse>}
|
|
723
741
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
724
742
|
*/
|
|
725
|
-
pricesEntriesAdjust(listId: string, amount?: number, dryRun?: boolean, percent?: number, rounding?: PriceEndingRule, skuPrefix?: string): Promise<Models.
|
|
743
|
+
pricesEntriesAdjust(listId: string, amount?: number, dryRun?: boolean, percent?: number, rounding?: PriceEndingRule, skuPrefix?: string): Promise<Models.PriceEntriesAdjustResponse>;
|
|
726
744
|
/**
|
|
727
745
|
* Adds entries to a list without wiping it, and UPSERTS rather than inserts: a row naming a rung the list already has (same product_id/sku AND quantity_min) updates that rung, so re-running an import corrects prices instead of duplicating the ladder. `mode: 'append'` keeps the old insert-everything behaviour. Inserts go out as one PostgREST bulk write per 1000 rows.
|
|
728
746
|
*
|
|
@@ -732,13 +750,13 @@ declare class Prices {
|
|
|
732
750
|
* @param {Models.PriceEntryReplaceItem[]} params.entries - At most 5000 rows per call — send a large book in chunks.
|
|
733
751
|
* @param {PriceEntriesBulkMode} params.mode - Default 'upsert': a row naming a rung the list already has (same product/sku AND quantity_min) updates it. 'append' always inserts — a re-run then duplicates the ladder, which is what makes an ambiguous tier table.
|
|
734
752
|
* @throws {RevenexxException}
|
|
735
|
-
* @returns {Promise<Models.
|
|
753
|
+
* @returns {Promise<Models.PriceEntriesBulkResponse>}
|
|
736
754
|
*/
|
|
737
755
|
pricesEntriesBulk(params: {
|
|
738
756
|
listId: string;
|
|
739
757
|
entries: Models.PriceEntryReplaceItem[];
|
|
740
758
|
mode?: PriceEntriesBulkMode;
|
|
741
|
-
}): Promise<Models.
|
|
759
|
+
}): Promise<Models.PriceEntriesBulkResponse>;
|
|
742
760
|
/**
|
|
743
761
|
* Adds entries to a list without wiping it, and UPSERTS rather than inserts: a row naming a rung the list already has (same product_id/sku AND quantity_min) updates that rung, so re-running an import corrects prices instead of duplicating the ladder. `mode: 'append'` keeps the old insert-everything behaviour. Inserts go out as one PostgREST bulk write per 1000 rows.
|
|
744
762
|
*
|
|
@@ -748,10 +766,10 @@ declare class Prices {
|
|
|
748
766
|
* @param {Models.PriceEntryReplaceItem[]} entries - At most 5000 rows per call — send a large book in chunks.
|
|
749
767
|
* @param {PriceEntriesBulkMode} mode - Default 'upsert': a row naming a rung the list already has (same product/sku AND quantity_min) updates it. 'append' always inserts — a re-run then duplicates the ladder, which is what makes an ambiguous tier table.
|
|
750
768
|
* @throws {RevenexxException}
|
|
751
|
-
* @returns {Promise<Models.
|
|
769
|
+
* @returns {Promise<Models.PriceEntriesBulkResponse>}
|
|
752
770
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
753
771
|
*/
|
|
754
|
-
pricesEntriesBulk(listId: string, entries: Models.PriceEntryReplaceItem[], mode?: PriceEntriesBulkMode): Promise<Models.
|
|
772
|
+
pricesEntriesBulk(listId: string, entries: Models.PriceEntryReplaceItem[], mode?: PriceEntriesBulkMode): Promise<Models.PriceEntriesBulkResponse>;
|
|
755
773
|
/**
|
|
756
774
|
* Writes a whole quantity-tier ladder (Staffelpreise) for ONE item in one call, instead of typing a rung at a time. Tiers are a flat quantity_min column on purpose — the ladder IS the set of entries sharing an identity, and resolve returns it sorted as one array. What was missing was the gesture: "19.90 from 1, 5 % off per tier at 10 and 50". Prices are rounded and snapped exactly as a bulk adjust is.
|
|
757
775
|
*
|
|
@@ -765,7 +783,7 @@ declare class Prices {
|
|
|
765
783
|
* @param {string} params.sku - The item the ladder prices (alternative to product_id).
|
|
766
784
|
* @param {string} params.unit - Unit of measure carried onto every generated tier. Free text, neither validated nor converted.
|
|
767
785
|
* @throws {RevenexxException}
|
|
768
|
-
* @returns {Promise<Models.
|
|
786
|
+
* @returns {Promise<Models.PriceEntriesLadderResponse>}
|
|
769
787
|
*/
|
|
770
788
|
pricesEntriesLadder(params: {
|
|
771
789
|
listId: string;
|
|
@@ -777,7 +795,7 @@ declare class Prices {
|
|
|
777
795
|
rounding?: PriceEndingRule;
|
|
778
796
|
sku?: string;
|
|
779
797
|
unit?: string;
|
|
780
|
-
}): Promise<Models.
|
|
798
|
+
}): Promise<Models.PriceEntriesLadderResponse>;
|
|
781
799
|
/**
|
|
782
800
|
* Writes a whole quantity-tier ladder (Staffelpreise) for ONE item in one call, instead of typing a rung at a time. Tiers are a flat quantity_min column on purpose — the ladder IS the set of entries sharing an identity, and resolve returns it sorted as one array. What was missing was the gesture: "19.90 from 1, 5 % off per tier at 10 and 50". Prices are rounded and snapped exactly as a bulk adjust is.
|
|
783
801
|
*
|
|
@@ -791,10 +809,10 @@ declare class Prices {
|
|
|
791
809
|
* @param {string} sku - The item the ladder prices (alternative to product_id).
|
|
792
810
|
* @param {string} unit - Unit of measure carried onto every generated tier. Free text, neither validated nor converted.
|
|
793
811
|
* @throws {RevenexxException}
|
|
794
|
-
* @returns {Promise<Models.
|
|
812
|
+
* @returns {Promise<Models.PriceEntriesLadderResponse>}
|
|
795
813
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
796
814
|
*/
|
|
797
|
-
pricesEntriesLadder(listId: string, basePrice: number, discountPercent?: number, productId?: string, quantities?: number[], replace?: boolean, rounding?: PriceEndingRule, sku?: string, unit?: string): Promise<Models.
|
|
815
|
+
pricesEntriesLadder(listId: string, basePrice: number, discountPercent?: number, productId?: string, quantities?: number[], replace?: boolean, rounding?: PriceEndingRule, sku?: string, unit?: string): Promise<Models.PriceEntriesLadderResponse>;
|
|
798
816
|
/**
|
|
799
817
|
* Removes ONE rung. The item keeps its other rungs and stays priced — which is exactly what makes the lowest rung the dangerous one to delete.
|
|
800
818
|
*
|
|
@@ -805,12 +823,12 @@ declare class Prices {
|
|
|
805
823
|
* @param {string} params.listId - The price list the entries belong to. An id no list in this tenant has answers 404 rather than an empty page.
|
|
806
824
|
* @param {string} params.id - The price entry, by id. An entry that belongs to a different list answers 404.
|
|
807
825
|
* @throws {RevenexxException}
|
|
808
|
-
* @returns {Promise<Models.
|
|
826
|
+
* @returns {Promise<Models.PriceDeleted>}
|
|
809
827
|
*/
|
|
810
828
|
pricesEntriesDelete(params: {
|
|
811
829
|
listId: string;
|
|
812
830
|
id: string;
|
|
813
|
-
}): Promise<Models.
|
|
831
|
+
}): Promise<Models.PriceDeleted>;
|
|
814
832
|
/**
|
|
815
833
|
* Removes ONE rung. The item keeps its other rungs and stays priced — which is exactly what makes the lowest rung the dangerous one to delete.
|
|
816
834
|
*
|
|
@@ -821,32 +839,32 @@ declare class Prices {
|
|
|
821
839
|
* @param {string} listId - The price list the entries belong to. An id no list in this tenant has answers 404 rather than an empty page.
|
|
822
840
|
* @param {string} id - The price entry, by id. An entry that belongs to a different list answers 404.
|
|
823
841
|
* @throws {RevenexxException}
|
|
824
|
-
* @returns {Promise<Models.
|
|
842
|
+
* @returns {Promise<Models.PriceDeleted>}
|
|
825
843
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
826
844
|
*/
|
|
827
|
-
pricesEntriesDelete(listId: string, id: string): Promise<Models.
|
|
845
|
+
pricesEntriesDelete(listId: string, id: string): Promise<Models.PriceDeleted>;
|
|
828
846
|
/**
|
|
829
847
|
* One rung of one ladder, exactly as stored — nothing is rounded, converted or taxed on the way out. `unit_price` is per ONE unit of `unit`, in the LIST's currency and on the LIST's tax basis; the entry itself carries neither, which is why a rung read on its own is not yet a price you can show a buyer. `POST /prices/resolve` is what turns it into one: it picks the rung that applies to a quantity, names the basis, and adds the net/gross pair and the tax rate. The id is checked against the list in the path, so an entry belonging to another list answers 404 rather than being read through the wrong parent.
|
|
830
848
|
*
|
|
831
849
|
* @param {string} params.listId - The price list the entries belong to. An id no list in this tenant has answers 404 rather than an empty page.
|
|
832
850
|
* @param {string} params.id - The price entry, by id. An entry that belongs to a different list answers 404.
|
|
833
851
|
* @throws {RevenexxException}
|
|
834
|
-
* @returns {Promise<Models.
|
|
852
|
+
* @returns {Promise<Models.PriceEntry>}
|
|
835
853
|
*/
|
|
836
854
|
pricesEntriesGet(params: {
|
|
837
855
|
listId: string;
|
|
838
856
|
id: string;
|
|
839
|
-
}): Promise<Models.
|
|
857
|
+
}): Promise<Models.PriceEntry>;
|
|
840
858
|
/**
|
|
841
859
|
* One rung of one ladder, exactly as stored — nothing is rounded, converted or taxed on the way out. `unit_price` is per ONE unit of `unit`, in the LIST's currency and on the LIST's tax basis; the entry itself carries neither, which is why a rung read on its own is not yet a price you can show a buyer. `POST /prices/resolve` is what turns it into one: it picks the rung that applies to a quantity, names the basis, and adds the net/gross pair and the tax rate. The id is checked against the list in the path, so an entry belonging to another list answers 404 rather than being read through the wrong parent.
|
|
842
860
|
*
|
|
843
861
|
* @param {string} listId - The price list the entries belong to. An id no list in this tenant has answers 404 rather than an empty page.
|
|
844
862
|
* @param {string} id - The price entry, by id. An entry that belongs to a different list answers 404.
|
|
845
863
|
* @throws {RevenexxException}
|
|
846
|
-
* @returns {Promise<Models.
|
|
864
|
+
* @returns {Promise<Models.PriceEntry>}
|
|
847
865
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
848
866
|
*/
|
|
849
|
-
pricesEntriesGet(listId: string, id: string): Promise<Models.
|
|
867
|
+
pricesEntriesGet(listId: string, id: string): Promise<Models.PriceEntry>;
|
|
850
868
|
/**
|
|
851
869
|
* A partial update of one rung: send only what changes, a payload with no updatable column at all is refused, and the next resolve call reads what this one wrote.
|
|
852
870
|
*
|
|
@@ -866,7 +884,7 @@ declare class Prices {
|
|
|
866
884
|
* @param {string} params.validFrom - Start of this entry’s own validity (ISO 8601) — how a promo price is expressed: a second rung, live only for its window. null = open-ended.
|
|
867
885
|
* @param {string} params.validUntil - End of this entry’s own validity; null = open-ended. Outside it the rung is skipped and the ladder resolves as if it were not there.
|
|
868
886
|
* @throws {RevenexxException}
|
|
869
|
-
* @returns {Promise<Models.
|
|
887
|
+
* @returns {Promise<Models.PriceEntry>}
|
|
870
888
|
*/
|
|
871
889
|
pricesEntriesUpdate(params: {
|
|
872
890
|
listId: string;
|
|
@@ -880,7 +898,7 @@ declare class Prices {
|
|
|
880
898
|
unitPrice?: number;
|
|
881
899
|
validFrom?: string;
|
|
882
900
|
validUntil?: string;
|
|
883
|
-
}): Promise<Models.
|
|
901
|
+
}): Promise<Models.PriceEntry>;
|
|
884
902
|
/**
|
|
885
903
|
* A partial update of one rung: send only what changes, a payload with no updatable column at all is refused, and the next resolve call reads what this one wrote.
|
|
886
904
|
*
|
|
@@ -900,10 +918,10 @@ declare class Prices {
|
|
|
900
918
|
* @param {string} validFrom - Start of this entry’s own validity (ISO 8601) — how a promo price is expressed: a second rung, live only for its window. null = open-ended.
|
|
901
919
|
* @param {string} validUntil - End of this entry’s own validity; null = open-ended. Outside it the rung is skipped and the ladder resolves as if it were not there.
|
|
902
920
|
* @throws {RevenexxException}
|
|
903
|
-
* @returns {Promise<Models.
|
|
921
|
+
* @returns {Promise<Models.PriceEntry>}
|
|
904
922
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
905
923
|
*/
|
|
906
|
-
pricesEntriesUpdate(listId: string, id: string, metadata?: object, priceType?: PriceEntryType, productId?: string, quantityMin?: number, sku?: string, unit?: string, unitPrice?: number, validFrom?: string, validUntil?: string): Promise<Models.
|
|
924
|
+
pricesEntriesUpdate(listId: string, id: string, metadata?: object, priceType?: PriceEntryType, productId?: string, quantityMin?: number, sku?: string, unit?: string, unitPrice?: number, validFrom?: string, validUntil?: string): Promise<Models.PriceEntry>;
|
|
907
925
|
/**
|
|
908
926
|
* Promotes this list AND demotes whoever held the flag, in one call. The flag is a single answer, not a per-row opinion: resolution uses it as the last tie-break, so two defaults leave the winner to row order and none leaves a tie unsettled. Promote-then-demote as two PATCHes from a client produces exactly those two states whenever the second call does not land.
|
|
909
927
|
*
|
|
@@ -912,12 +930,12 @@ declare class Prices {
|
|
|
912
930
|
* @param {string} params.listId - The price list the entries belong to. An id no list in this tenant has answers 404 rather than an empty page.
|
|
913
931
|
* @param {object} params.data - Request body
|
|
914
932
|
* @throws {RevenexxException}
|
|
915
|
-
* @returns {Promise<Models.
|
|
933
|
+
* @returns {Promise<Models.PriceListMakeDefaultResponse>}
|
|
916
934
|
*/
|
|
917
935
|
pricesListsMakeDefault(params: {
|
|
918
936
|
listId: string;
|
|
919
937
|
data: object;
|
|
920
|
-
}): Promise<Models.
|
|
938
|
+
}): Promise<Models.PriceListMakeDefaultResponse>;
|
|
921
939
|
/**
|
|
922
940
|
* Promotes this list AND demotes whoever held the flag, in one call. The flag is a single answer, not a per-row opinion: resolution uses it as the last tie-break, so two defaults leave the winner to row order and none leaves a tie unsettled. Promote-then-demote as two PATCHes from a client produces exactly those two states whenever the second call does not land.
|
|
923
941
|
*
|
|
@@ -926,10 +944,10 @@ declare class Prices {
|
|
|
926
944
|
* @param {string} listId - The price list the entries belong to. An id no list in this tenant has answers 404 rather than an empty page.
|
|
927
945
|
* @param {object} data - Request body
|
|
928
946
|
* @throws {RevenexxException}
|
|
929
|
-
* @returns {Promise<Models.
|
|
947
|
+
* @returns {Promise<Models.PriceListMakeDefaultResponse>}
|
|
930
948
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
931
949
|
*/
|
|
932
|
-
pricesListsMakeDefault(listId: string, data: object): Promise<Models.
|
|
950
|
+
pricesListsMakeDefault(listId: string, data: object): Promise<Models.PriceListMakeDefaultResponse>;
|
|
933
951
|
/**
|
|
934
952
|
* The live price call. Everything else in this app configures prices; this is the one route that ANSWERS them, and a storefront reaches it on every listing, every product page and every cart. Send up to 200 items and the buyer context they are for — contact, organization, market and channel — and get back, per item, the unit price this buyer pays, the net/gross pair, the tax rate, the list that decided it and that item's full quantity ladder.
|
|
935
953
|
*
|
|
@@ -959,7 +977,7 @@ declare class Prices {
|
|
|
959
977
|
* @param {string} params.marketId - Buyer context: the market, as a uuid pin for older callers. Prefer the `X-Revenexx-Market` header, which carries a market CODE and is what scopes the visible price lists. The market decides the tax rates AND which per-market settings (rounding, tie-break, anonymous access) apply — with several markets and no signal at all the answer says `tax.resolved: false`, `reason: market_required` rather than quoting another market’s VAT.
|
|
960
978
|
* @param {string} params.organizationId - Buyer context: the organization the buyer belongs to. Second most specific scope; also counts as authenticated.
|
|
961
979
|
* @throws {RevenexxException}
|
|
962
|
-
* @returns {Promise<Models.
|
|
980
|
+
* @returns {Promise<Models.PriceResolveResponse>}
|
|
963
981
|
*/
|
|
964
982
|
pricesResolve(params: {
|
|
965
983
|
items: Models.PriceResolveItem[];
|
|
@@ -969,7 +987,7 @@ declare class Prices {
|
|
|
969
987
|
currency?: string;
|
|
970
988
|
marketId?: string;
|
|
971
989
|
organizationId?: string;
|
|
972
|
-
}): Promise<Models.
|
|
990
|
+
}): Promise<Models.PriceResolveResponse>;
|
|
973
991
|
/**
|
|
974
992
|
* The live price call. Everything else in this app configures prices; this is the one route that ANSWERS them, and a storefront reaches it on every listing, every product page and every cart. Send up to 200 items and the buyer context they are for — contact, organization, market and channel — and get back, per item, the unit price this buyer pays, the net/gross pair, the tax rate, the list that decided it and that item's full quantity ladder.
|
|
975
993
|
*
|
|
@@ -999,10 +1017,10 @@ declare class Prices {
|
|
|
999
1017
|
* @param {string} marketId - Buyer context: the market, as a uuid pin for older callers. Prefer the `X-Revenexx-Market` header, which carries a market CODE and is what scopes the visible price lists. The market decides the tax rates AND which per-market settings (rounding, tie-break, anonymous access) apply — with several markets and no signal at all the answer says `tax.resolved: false`, `reason: market_required` rather than quoting another market’s VAT.
|
|
1000
1018
|
* @param {string} organizationId - Buyer context: the organization the buyer belongs to. Second most specific scope; also counts as authenticated.
|
|
1001
1019
|
* @throws {RevenexxException}
|
|
1002
|
-
* @returns {Promise<Models.
|
|
1020
|
+
* @returns {Promise<Models.PriceResolveResponse>}
|
|
1003
1021
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1004
1022
|
*/
|
|
1005
|
-
pricesResolve(items: Models.PriceResolveItem[], at?: string, channelId?: string, contactId?: string, currency?: string, marketId?: string, organizationId?: string): Promise<Models.
|
|
1023
|
+
pricesResolve(items: Models.PriceResolveItem[], at?: string, channelId?: string, contactId?: string, currency?: string, marketId?: string, organizationId?: string): Promise<Models.PriceResolveResponse>;
|
|
1006
1024
|
/**
|
|
1007
1025
|
* Discovery for the vocabulary routes: the enums this app enforces, each with its name, its title and its description — and deliberately WITHOUT its values, so a UI can cache this one small answer and then fetch only the value sets it actually renders. Names: list-statuses, price-types, tax-bases. Fetch one with GET /prices/vocabularies/{name}; a client holding the qualified pair 'prices.<name>' builds that URL from the pair alone.
|
|
1008
1026
|
*
|
|
@@ -1015,20 +1033,20 @@ declare class Prices {
|
|
|
1015
1033
|
*
|
|
1016
1034
|
* @param {PricesVocabulariesGetName} params.name - The vocabulary name — the part after the dot in the qualified id.
|
|
1017
1035
|
* @throws {RevenexxException}
|
|
1018
|
-
* @returns {Promise<Models.
|
|
1036
|
+
* @returns {Promise<Models.PriceVocabulary>}
|
|
1019
1037
|
*/
|
|
1020
1038
|
pricesVocabulariesGet(params: {
|
|
1021
1039
|
name: PricesVocabulariesGetName;
|
|
1022
|
-
}): Promise<Models.
|
|
1040
|
+
}): Promise<Models.PriceVocabulary>;
|
|
1023
1041
|
/**
|
|
1024
1042
|
* One vocabulary in full: every permitted value, each with the title and description a human reads for it and the badge tone a UI colours it with — enough to render a select or a status chip without keeping a private copy of an enum this app enforces. The values are read out of the column's CHECK constraint, so the served set IS the enforced set and the two cannot drift — a value added to the constraint appears here even before anyone labels it, titled from its own key. Values come back in constraint order, which is the order a select should offer. 'closed' says the set is exhaustive, so a value outside it is stale data rather than a missing label. Answers 404 for an unknown name. Names: list-statuses, price-types, tax-bases.
|
|
1025
1043
|
*
|
|
1026
1044
|
* @param {PricesVocabulariesGetName} name - The vocabulary name — the part after the dot in the qualified id.
|
|
1027
1045
|
* @throws {RevenexxException}
|
|
1028
|
-
* @returns {Promise<Models.
|
|
1046
|
+
* @returns {Promise<Models.PriceVocabulary>}
|
|
1029
1047
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1030
1048
|
*/
|
|
1031
|
-
pricesVocabulariesGet(name: PricesVocabulariesGetName): Promise<Models.
|
|
1049
|
+
pricesVocabulariesGet(name: PricesVocabulariesGetName): Promise<Models.PriceVocabulary>;
|
|
1032
1050
|
}
|
|
1033
1051
|
|
|
1034
1052
|
export { Prices };
|