@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
|
@@ -7,6 +7,15 @@ import '../query.js';
|
|
|
7
7
|
import '../enums/address-type-row-tone.js';
|
|
8
8
|
import '../enums/address-type-row-create-request-tone.js';
|
|
9
9
|
import '../enums/address-type-row-update-request-tone.js';
|
|
10
|
+
import '../enums/approval-rule-approver-type.js';
|
|
11
|
+
import '../enums/approval-rule-condition.js';
|
|
12
|
+
import '../enums/approval-rule-effect.js';
|
|
13
|
+
import '../enums/approval-rule-create-request-approver-type.js';
|
|
14
|
+
import '../enums/approval-rule-create-request-condition.js';
|
|
15
|
+
import '../enums/approval-rule-create-request-effect.js';
|
|
16
|
+
import '../enums/approval-rule-update-request-approver-type.js';
|
|
17
|
+
import '../enums/approval-rule-update-request-condition.js';
|
|
18
|
+
import '../enums/approval-rule-update-request-effect.js';
|
|
10
19
|
import '../enums/assets-source.js';
|
|
11
20
|
import '../enums/attribute-value-bucket.js';
|
|
12
21
|
import '../enums/auth-mail-source.js';
|
|
@@ -118,6 +127,8 @@ import '../enums/payment-term-tone.js';
|
|
|
118
127
|
import '../enums/payment-term-create-request-tone.js';
|
|
119
128
|
import '../enums/payment-term-update-request-tone.js';
|
|
120
129
|
import '../enums/payment-vocabulary-tone.js';
|
|
130
|
+
import '../enums/pending-approval-approver-type.js';
|
|
131
|
+
import '../enums/pending-approval-status.js';
|
|
121
132
|
import '../enums/price-ending-rule.js';
|
|
122
133
|
import '../enums/price-entries-adjust-response-rounding.js';
|
|
123
134
|
import '../enums/price-entries-adjust-response-rounding-mode.js';
|
|
@@ -140,6 +151,11 @@ import '../enums/product-grid-column-source.js';
|
|
|
140
151
|
import '../enums/product-label-source.js';
|
|
141
152
|
import '../enums/product-label-attribute-source.js';
|
|
142
153
|
import '../enums/products-kind.js';
|
|
154
|
+
import '../enums/purchase-request-status.js';
|
|
155
|
+
import '../enums/purchase-request-event-name.js';
|
|
156
|
+
import '../enums/purchase-request-item-type.js';
|
|
157
|
+
import '../enums/purchase-request-item-create-request-type.js';
|
|
158
|
+
import '../enums/purchase-request-item-update-request-type.js';
|
|
143
159
|
import '../enums/reorder-point-source.js';
|
|
144
160
|
import '../enums/reservation-status.js';
|
|
145
161
|
import '../enums/price-on-request-reason.js';
|
|
@@ -177,6 +193,8 @@ import '../enums/shipping-weight-unit-row-tone.js';
|
|
|
177
193
|
import '../enums/shipping-weight-unit-update-request-tone.js';
|
|
178
194
|
import '../enums/stock-movement-type.js';
|
|
179
195
|
import '../enums/store-asset-request-visibility.js';
|
|
196
|
+
import '../enums/submit-item-type.js';
|
|
197
|
+
import '../enums/submit-result-outcome.js';
|
|
180
198
|
import '../enums/validation-failed-response-status.js';
|
|
181
199
|
import '../enums/vocabulary-default-tone.js';
|
|
182
200
|
import '../enums/vocabulary-source.js';
|
|
@@ -244,7 +262,7 @@ declare class Markets {
|
|
|
244
262
|
* @param {number} params.offset - Row offset for pagination (default 0). A negative offset is clamped to 0 rather than refused.
|
|
245
263
|
* @param {string} params.order - Sort as 'column' | 'column.asc' | 'column.desc'. The direction is lower case, and the column has to exist: id, code, name, labels, currency, status, is_default, position, created_at, updated_at.
|
|
246
264
|
* @throws {RevenexxException}
|
|
247
|
-
* @returns {Promise<Models.
|
|
265
|
+
* @returns {Promise<Models.MarketList>}
|
|
248
266
|
*/
|
|
249
267
|
marketsList(params?: {
|
|
250
268
|
id?: string;
|
|
@@ -260,7 +278,7 @@ declare class Markets {
|
|
|
260
278
|
limit?: number;
|
|
261
279
|
offset?: number;
|
|
262
280
|
order?: string;
|
|
263
|
-
}): Promise<Models.
|
|
281
|
+
}): Promise<Models.MarketList>;
|
|
264
282
|
/**
|
|
265
283
|
* Every column is an exact-match filter and they combine with AND (?code=northwind); each one is declared as a query parameter above. A `?column=value` this entity does not have is DROPPED rather than refused — the call answers 200 with the unfiltered list — and `filter` echoes what was actually applied, which is the only way to tell that apart from a filter that matched nothing.
|
|
266
284
|
*
|
|
@@ -278,10 +296,10 @@ declare class Markets {
|
|
|
278
296
|
* @param {number} offset - Row offset for pagination (default 0). A negative offset is clamped to 0 rather than refused.
|
|
279
297
|
* @param {string} order - Sort as 'column' | 'column.asc' | 'column.desc'. The direction is lower case, and the column has to exist: id, code, name, labels, currency, status, is_default, position, created_at, updated_at.
|
|
280
298
|
* @throws {RevenexxException}
|
|
281
|
-
* @returns {Promise<Models.
|
|
299
|
+
* @returns {Promise<Models.MarketList>}
|
|
282
300
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
283
301
|
*/
|
|
284
|
-
marketsList(id?: string, code?: string, name?: string, labels?: string, currency?: string, status?: MarketsListStatus, isDefault?: boolean, position?: number, createdAt?: string, updatedAt?: string, limit?: number, offset?: number, order?: string): Promise<Models.
|
|
302
|
+
marketsList(id?: string, code?: string, name?: string, labels?: string, currency?: string, status?: MarketsListStatus, isDefault?: boolean, position?: number, createdAt?: string, updatedAt?: string, limit?: number, offset?: number, order?: string): Promise<Models.MarketList>;
|
|
285
303
|
/**
|
|
286
304
|
* A market needs a 'code' and a 'name' — currency defaults to EUR, status to active. To get a market that can actually trade, clone an existing one instead: POST /markets/{id}/clone.
|
|
287
305
|
*
|
|
@@ -293,7 +311,7 @@ declare class Markets {
|
|
|
293
311
|
* @param {number} params.position - Sort position among the tenant's markets, ascending, default 0. Presentation only — it decides the order the Cockpit and a market picker list them in, and nothing resolves a market by it.
|
|
294
312
|
* @param {MarketStatus} params.status - Default 'active'. Only an active market serves a storefront; 'inactive' keeps the market and all its configuration but takes it out of service. Readiness reports an active market that cannot trade as `serving: true, ready: false` — live and broken.
|
|
295
313
|
* @throws {RevenexxException}
|
|
296
|
-
* @returns {Promise<Models.
|
|
314
|
+
* @returns {Promise<Models.Market>}
|
|
297
315
|
*/
|
|
298
316
|
marketsCreate(params: {
|
|
299
317
|
code: string;
|
|
@@ -303,7 +321,7 @@ declare class Markets {
|
|
|
303
321
|
labels?: object;
|
|
304
322
|
position?: number;
|
|
305
323
|
status?: MarketStatus;
|
|
306
|
-
}): Promise<Models.
|
|
324
|
+
}): Promise<Models.Market>;
|
|
307
325
|
/**
|
|
308
326
|
* A market needs a 'code' and a 'name' — currency defaults to EUR, status to active. To get a market that can actually trade, clone an existing one instead: POST /markets/{id}/clone.
|
|
309
327
|
*
|
|
@@ -315,10 +333,10 @@ declare class Markets {
|
|
|
315
333
|
* @param {number} position - Sort position among the tenant's markets, ascending, default 0. Presentation only — it decides the order the Cockpit and a market picker list them in, and nothing resolves a market by it.
|
|
316
334
|
* @param {MarketStatus} status - Default 'active'. Only an active market serves a storefront; 'inactive' keeps the market and all its configuration but takes it out of service. Readiness reports an active market that cannot trade as `serving: true, ready: false` — live and broken.
|
|
317
335
|
* @throws {RevenexxException}
|
|
318
|
-
* @returns {Promise<Models.
|
|
336
|
+
* @returns {Promise<Models.Market>}
|
|
319
337
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
320
338
|
*/
|
|
321
|
-
marketsCreate(code: string, name: string, currency?: string, isDefault?: boolean, labels?: object, position?: number, status?: MarketStatus): Promise<Models.
|
|
339
|
+
marketsCreate(code: string, name: string, currency?: string, isDefault?: boolean, labels?: object, position?: number, status?: MarketStatus): Promise<Models.Market>;
|
|
322
340
|
/**
|
|
323
341
|
* How this tenant keys its translations, resolved for a surface that stands in no market at all. The Cockpit edits a tenant BASELINE when no market is selected, and a baseline value has to be readable by every market — so the locale set answered here is the UNION of every market's locales, each one already resolved to the key it is written under, not one market's list and not a pair of setting names to re-implement. Each entry names the markets that asked for that locale: an editor listing six inputs without saying who needs them invites translations nobody will ever read. Write/read keys follow the same two settings as the per-market answer, so a baseline and a market value can never be keyed differently.
|
|
324
342
|
*
|
|
@@ -338,58 +356,58 @@ declare class Markets {
|
|
|
338
356
|
*
|
|
339
357
|
* @param {MarketsVocabularyName} params.name - Which vocabulary to read. The enum is exhaustive — these are every value set this app owns, and anything else is a 404.
|
|
340
358
|
* @throws {RevenexxException}
|
|
341
|
-
* @returns {Promise<Models.
|
|
359
|
+
* @returns {Promise<Models.MarketsVocabulary>}
|
|
342
360
|
*/
|
|
343
361
|
marketsVocabulary(params: {
|
|
344
362
|
name: MarketsVocabularyName;
|
|
345
|
-
}): Promise<Models.
|
|
363
|
+
}): Promise<Models.MarketsVocabulary>;
|
|
346
364
|
/**
|
|
347
365
|
* One value set in full: every value the column may hold, in the order it may hold them, with the copy and the badge tone a client renders each one as. The values are not kept in a list beside the database, they are parsed out of the CHECK constraint in this app's own schema.json — so the set served here IS the set enforced on a write, and a select box built from it cannot offer a value the write would then refuse. A name outside the declared enum is a 404 rather than an empty list — an empty vocabulary and an unknown one mean different things to a select box.
|
|
348
366
|
*
|
|
349
367
|
* @param {MarketsVocabularyName} name - Which vocabulary to read. The enum is exhaustive — these are every value set this app owns, and anything else is a 404.
|
|
350
368
|
* @throws {RevenexxException}
|
|
351
|
-
* @returns {Promise<Models.
|
|
369
|
+
* @returns {Promise<Models.MarketsVocabulary>}
|
|
352
370
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
353
371
|
*/
|
|
354
|
-
marketsVocabulary(name: MarketsVocabularyName): Promise<Models.
|
|
372
|
+
marketsVocabulary(name: MarketsVocabularyName): Promise<Models.MarketsVocabulary>;
|
|
355
373
|
/**
|
|
356
374
|
* Deleting a market takes its locales, currencies and tax classes with it: all three carry an ON DELETE CASCADE onto markets.id, so this is never refused for having children.
|
|
357
375
|
*
|
|
358
376
|
* @param {string} params.id - The market, by its primary key. A uuid — this route does not resolve a market code, so a segment that will not cast is a 400 before any row is read.
|
|
359
377
|
* @throws {RevenexxException}
|
|
360
|
-
* @returns {Promise<Models.
|
|
378
|
+
* @returns {Promise<Models.MarketDeleted>}
|
|
361
379
|
*/
|
|
362
380
|
marketsDelete(params: {
|
|
363
381
|
id: string;
|
|
364
|
-
}): Promise<Models.
|
|
382
|
+
}): Promise<Models.MarketDeleted>;
|
|
365
383
|
/**
|
|
366
384
|
* Deleting a market takes its locales, currencies and tax classes with it: all three carry an ON DELETE CASCADE onto markets.id, so this is never refused for having children.
|
|
367
385
|
*
|
|
368
386
|
* @param {string} id - The market, by its primary key. A uuid — this route does not resolve a market code, so a segment that will not cast is a 400 before any row is read.
|
|
369
387
|
* @throws {RevenexxException}
|
|
370
|
-
* @returns {Promise<Models.
|
|
388
|
+
* @returns {Promise<Models.MarketDeleted>}
|
|
371
389
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
372
390
|
*/
|
|
373
|
-
marketsDelete(id: string): Promise<Models.
|
|
391
|
+
marketsDelete(id: string): Promise<Models.MarketDeleted>;
|
|
374
392
|
/**
|
|
375
393
|
* Resolved by uuid only — unlike /readiness, /clone, /backfill and /make-default, a market CODE here is a 400 rather than a lookup.
|
|
376
394
|
*
|
|
377
395
|
* @param {string} params.id - The market, by its primary key. A uuid — this route does not resolve a market code, so a segment that will not cast is a 400 before any row is read.
|
|
378
396
|
* @throws {RevenexxException}
|
|
379
|
-
* @returns {Promise<Models.
|
|
397
|
+
* @returns {Promise<Models.Market>}
|
|
380
398
|
*/
|
|
381
399
|
marketsGet(params: {
|
|
382
400
|
id: string;
|
|
383
|
-
}): Promise<Models.
|
|
401
|
+
}): Promise<Models.Market>;
|
|
384
402
|
/**
|
|
385
403
|
* Resolved by uuid only — unlike /readiness, /clone, /backfill and /make-default, a market CODE here is a 400 rather than a lookup.
|
|
386
404
|
*
|
|
387
405
|
* @param {string} id - The market, by its primary key. A uuid — this route does not resolve a market code, so a segment that will not cast is a 400 before any row is read.
|
|
388
406
|
* @throws {RevenexxException}
|
|
389
|
-
* @returns {Promise<Models.
|
|
407
|
+
* @returns {Promise<Models.Market>}
|
|
390
408
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
391
409
|
*/
|
|
392
|
-
marketsGet(id: string): Promise<Models.
|
|
410
|
+
marketsGet(id: string): Promise<Models.Market>;
|
|
393
411
|
/**
|
|
394
412
|
* Partial: omitted fields keep their value.
|
|
395
413
|
*
|
|
@@ -402,7 +420,7 @@ declare class Markets {
|
|
|
402
420
|
* @param {number} params.position - Sort position among the tenant's markets, ascending, default 0. Presentation only — it decides the order the Cockpit and a market picker list them in, and nothing resolves a market by it.
|
|
403
421
|
* @param {MarketStatus} params.status - Default 'active'. Only an active market serves a storefront; 'inactive' keeps the market and all its configuration but takes it out of service. Readiness reports an active market that cannot trade as `serving: true, ready: false` — live and broken.
|
|
404
422
|
* @throws {RevenexxException}
|
|
405
|
-
* @returns {Promise<Models.
|
|
423
|
+
* @returns {Promise<Models.Market>}
|
|
406
424
|
*/
|
|
407
425
|
marketsUpdate(params: {
|
|
408
426
|
id: string;
|
|
@@ -413,7 +431,7 @@ declare class Markets {
|
|
|
413
431
|
name?: string;
|
|
414
432
|
position?: number;
|
|
415
433
|
status?: MarketStatus;
|
|
416
|
-
}): Promise<Models.
|
|
434
|
+
}): Promise<Models.Market>;
|
|
417
435
|
/**
|
|
418
436
|
* Partial: omitted fields keep their value.
|
|
419
437
|
*
|
|
@@ -426,10 +444,10 @@ declare class Markets {
|
|
|
426
444
|
* @param {number} position - Sort position among the tenant's markets, ascending, default 0. Presentation only — it decides the order the Cockpit and a market picker list them in, and nothing resolves a market by it.
|
|
427
445
|
* @param {MarketStatus} status - Default 'active'. Only an active market serves a storefront; 'inactive' keeps the market and all its configuration but takes it out of service. Readiness reports an active market that cannot trade as `serving: true, ready: false` — live and broken.
|
|
428
446
|
* @throws {RevenexxException}
|
|
429
|
-
* @returns {Promise<Models.
|
|
447
|
+
* @returns {Promise<Models.Market>}
|
|
430
448
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
431
449
|
*/
|
|
432
|
-
marketsUpdate(id: string, code?: string, currency?: string, isDefault?: boolean, labels?: object, name?: string, position?: number, status?: MarketStatus): Promise<Models.
|
|
450
|
+
marketsUpdate(id: string, code?: string, currency?: string, isDefault?: boolean, labels?: object, name?: string, position?: number, status?: MarketStatus): Promise<Models.Market>;
|
|
433
451
|
/**
|
|
434
452
|
* Repairs the market in the path out of a source market that is already right. The two are compared by CODE, collection by collection, and only the codes this market does not already carry are added — so a locale, a currency or a tax class it already holds is left exactly as the merchant left it, rate included, and is never overwritten. Both the path id and `source` are resolved by uuid OR by market code. Idempotent: running it twice adds nothing the second time.
|
|
435
453
|
*
|
|
@@ -439,7 +457,7 @@ declare class Markets {
|
|
|
439
457
|
* @param {boolean} params.locales - Take the source's locales for codes this market does not already carry. Default true.
|
|
440
458
|
* @param {boolean} params.taxClasses - Take the source's tax classes for codes this market does not already carry. An existing code keeps ITS rate — a backfill never re-rates a class the merchant already set. Default true.
|
|
441
459
|
* @throws {RevenexxException}
|
|
442
|
-
* @returns {Promise<Models.
|
|
460
|
+
* @returns {Promise<Models.MarketBackfillResult>}
|
|
443
461
|
*/
|
|
444
462
|
marketsBackfill(params: {
|
|
445
463
|
id: string;
|
|
@@ -447,7 +465,7 @@ declare class Markets {
|
|
|
447
465
|
currencies?: boolean;
|
|
448
466
|
locales?: boolean;
|
|
449
467
|
taxClasses?: boolean;
|
|
450
|
-
}): Promise<Models.
|
|
468
|
+
}): Promise<Models.MarketBackfillResult>;
|
|
451
469
|
/**
|
|
452
470
|
* Repairs the market in the path out of a source market that is already right. The two are compared by CODE, collection by collection, and only the codes this market does not already carry are added — so a locale, a currency or a tax class it already holds is left exactly as the merchant left it, rate included, and is never overwritten. Both the path id and `source` are resolved by uuid OR by market code. Idempotent: running it twice adds nothing the second time.
|
|
453
471
|
*
|
|
@@ -457,10 +475,10 @@ declare class Markets {
|
|
|
457
475
|
* @param {boolean} locales - Take the source's locales for codes this market does not already carry. Default true.
|
|
458
476
|
* @param {boolean} taxClasses - Take the source's tax classes for codes this market does not already carry. An existing code keeps ITS rate — a backfill never re-rates a class the merchant already set. Default true.
|
|
459
477
|
* @throws {RevenexxException}
|
|
460
|
-
* @returns {Promise<Models.
|
|
478
|
+
* @returns {Promise<Models.MarketBackfillResult>}
|
|
461
479
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
462
480
|
*/
|
|
463
|
-
marketsBackfill(id: string, source: string, currencies?: boolean, locales?: boolean, taxClasses?: boolean): Promise<Models.
|
|
481
|
+
marketsBackfill(id: string, source: string, currencies?: boolean, locales?: boolean, taxClasses?: boolean): Promise<Models.MarketBackfillResult>;
|
|
464
482
|
/**
|
|
465
483
|
* Creates a NEW market out of an existing one, taking its locales, its traded currencies and its tax classes with it in a single call. That is the difference between this and POST /markets: a plain create leaves a row that cannot serve anybody, while what comes back here is a market with a language to render in, a currency to price in and a rate to tax with. The path id is the SOURCE market, resolved by uuid OR by market code.
|
|
466
484
|
*
|
|
@@ -473,7 +491,7 @@ declare class Markets {
|
|
|
473
491
|
* @param {string} params.name - Display name of the new market. Defaults to its code.
|
|
474
492
|
* @param {MarketStatus} params.status - Status of the new market. Defaults to 'active'; clone it 'inactive' to build it out before it serves anyone.
|
|
475
493
|
* @throws {RevenexxException}
|
|
476
|
-
* @returns {Promise<Models.
|
|
494
|
+
* @returns {Promise<Models.MarketCloneResult>}
|
|
477
495
|
*/
|
|
478
496
|
marketsClone(params: {
|
|
479
497
|
id: string;
|
|
@@ -484,7 +502,7 @@ declare class Markets {
|
|
|
484
502
|
currency?: string;
|
|
485
503
|
name?: string;
|
|
486
504
|
status?: MarketStatus;
|
|
487
|
-
}): Promise<Models.
|
|
505
|
+
}): Promise<Models.MarketCloneResult>;
|
|
488
506
|
/**
|
|
489
507
|
* Creates a NEW market out of an existing one, taking its locales, its traded currencies and its tax classes with it in a single call. That is the difference between this and POST /markets: a plain create leaves a row that cannot serve anybody, while what comes back here is a market with a language to render in, a currency to price in and a rate to tax with. The path id is the SOURCE market, resolved by uuid OR by market code.
|
|
490
508
|
*
|
|
@@ -497,70 +515,70 @@ declare class Markets {
|
|
|
497
515
|
* @param {string} name - Display name of the new market. Defaults to its code.
|
|
498
516
|
* @param {MarketStatus} status - Status of the new market. Defaults to 'active'; clone it 'inactive' to build it out before it serves anyone.
|
|
499
517
|
* @throws {RevenexxException}
|
|
500
|
-
* @returns {Promise<Models.
|
|
518
|
+
* @returns {Promise<Models.MarketCloneResult>}
|
|
501
519
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
502
520
|
*/
|
|
503
|
-
marketsClone(id: string, code: string, copyCurrencies?: boolean, copyLocales?: boolean, copyTaxClasses?: boolean, currency?: string, name?: string, status?: MarketStatus): Promise<Models.
|
|
521
|
+
marketsClone(id: string, code: string, copyCurrencies?: boolean, copyLocales?: boolean, copyTaxClasses?: boolean, currency?: string, name?: string, status?: MarketStatus): Promise<Models.MarketCloneResult>;
|
|
504
522
|
/**
|
|
505
523
|
* The storefront bootstrap: everything a frontend needs to render one market, resolved server-side so no client re-derives it — the market row, its locales, the currencies it trades in and its tax classes; WHICH locale to actually render in and where that answer came from; which key to read and write a translation under; whether the prices it will be handed are gross or net; and whether any of it is trustworthy. One call rather than five, and — more to the point — one place the resolution rules live, instead of a slightly different copy of them in every storefront. This one resolves the market by id only: unlike /readiness, /clone and /backfill, a market CODE here is a 400, not a lookup.
|
|
506
524
|
*
|
|
507
525
|
* @param {string} params.id - The market. A uuid — this route does not accept a market code.
|
|
508
526
|
* @throws {RevenexxException}
|
|
509
|
-
* @returns {Promise<Models.
|
|
527
|
+
* @returns {Promise<Models.MarketContext>}
|
|
510
528
|
*/
|
|
511
529
|
marketsContext(params: {
|
|
512
530
|
id: string;
|
|
513
|
-
}): Promise<Models.
|
|
531
|
+
}): Promise<Models.MarketContext>;
|
|
514
532
|
/**
|
|
515
533
|
* The storefront bootstrap: everything a frontend needs to render one market, resolved server-side so no client re-derives it — the market row, its locales, the currencies it trades in and its tax classes; WHICH locale to actually render in and where that answer came from; which key to read and write a translation under; whether the prices it will be handed are gross or net; and whether any of it is trustworthy. One call rather than five, and — more to the point — one place the resolution rules live, instead of a slightly different copy of them in every storefront. This one resolves the market by id only: unlike /readiness, /clone and /backfill, a market CODE here is a 400, not a lookup.
|
|
516
534
|
*
|
|
517
535
|
* @param {string} id - The market. A uuid — this route does not accept a market code.
|
|
518
536
|
* @throws {RevenexxException}
|
|
519
|
-
* @returns {Promise<Models.
|
|
537
|
+
* @returns {Promise<Models.MarketContext>}
|
|
520
538
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
521
539
|
*/
|
|
522
|
-
marketsContext(id: string): Promise<Models.
|
|
540
|
+
marketsContext(id: string): Promise<Models.MarketContext>;
|
|
523
541
|
/**
|
|
524
542
|
* A tenant has ONE default market: it is what every call naming none falls back to. Moving the flag from a client was promote-then-demote, two PATCHes that leave two defaults when the second does not land and none when the first does. This is the one call instead — it promotes the market in the path and demotes whoever held the flag in the same operation, writing once per row that was actually wrong and not touching the rest. Accepts an id or a market CODE. Answers the market plus the codes it demoted; repeating the call writes nothing.
|
|
525
543
|
*
|
|
526
544
|
* @param {string} params.id - The market to promote — a uuid or a market code.
|
|
527
545
|
* @param {object} params.data - Request body
|
|
528
546
|
* @throws {RevenexxException}
|
|
529
|
-
* @returns {Promise<Models.
|
|
547
|
+
* @returns {Promise<Models.MarketMakeDefaultResponse>}
|
|
530
548
|
*/
|
|
531
549
|
marketsMakeDefault(params: {
|
|
532
550
|
id: string;
|
|
533
551
|
data: object;
|
|
534
|
-
}): Promise<Models.
|
|
552
|
+
}): Promise<Models.MarketMakeDefaultResponse>;
|
|
535
553
|
/**
|
|
536
554
|
* A tenant has ONE default market: it is what every call naming none falls back to. Moving the flag from a client was promote-then-demote, two PATCHes that leave two defaults when the second does not land and none when the first does. This is the one call instead — it promotes the market in the path and demotes whoever held the flag in the same operation, writing once per row that was actually wrong and not touching the rest. Accepts an id or a market CODE. Answers the market plus the codes it demoted; repeating the call writes nothing.
|
|
537
555
|
*
|
|
538
556
|
* @param {string} id - The market to promote — a uuid or a market code.
|
|
539
557
|
* @param {object} data - Request body
|
|
540
558
|
* @throws {RevenexxException}
|
|
541
|
-
* @returns {Promise<Models.
|
|
559
|
+
* @returns {Promise<Models.MarketMakeDefaultResponse>}
|
|
542
560
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
543
561
|
*/
|
|
544
|
-
marketsMakeDefault(id: string, data: object): Promise<Models.
|
|
562
|
+
marketsMakeDefault(id: string, data: object): Promise<Models.MarketMakeDefaultResponse>;
|
|
545
563
|
/**
|
|
546
564
|
* Whether this market can actually trade, and if not, what is missing. Every check runs on every call and comes back with its own severity, so the answer is a diagnosis rather than a yes or a no: a market with no currency registered has nothing to price in and a market with no tax class has nothing to tax with, and both of those fail BLOCKING, which is what turns `ready` false. A check that is merely degraded — no locale of its own, while the tenant declares a fallback_locale that covers for it — fails as a warning and leaves the market serviceable. Resolves the market by uuid OR by market code.
|
|
547
565
|
*
|
|
548
566
|
* @param {string} params.id - The market — a uuid or a market code.
|
|
549
567
|
* @throws {RevenexxException}
|
|
550
|
-
* @returns {Promise<Models.
|
|
568
|
+
* @returns {Promise<Models.MarketReadinessReport>}
|
|
551
569
|
*/
|
|
552
570
|
marketsReadiness(params: {
|
|
553
571
|
id: string;
|
|
554
|
-
}): Promise<Models.
|
|
572
|
+
}): Promise<Models.MarketReadinessReport>;
|
|
555
573
|
/**
|
|
556
574
|
* Whether this market can actually trade, and if not, what is missing. Every check runs on every call and comes back with its own severity, so the answer is a diagnosis rather than a yes or a no: a market with no currency registered has nothing to price in and a market with no tax class has nothing to tax with, and both of those fail BLOCKING, which is what turns `ready` false. A check that is merely degraded — no locale of its own, while the tenant declares a fallback_locale that covers for it — fails as a warning and leaves the market serviceable. Resolves the market by uuid OR by market code.
|
|
557
575
|
*
|
|
558
576
|
* @param {string} id - The market — a uuid or a market code.
|
|
559
577
|
* @throws {RevenexxException}
|
|
560
|
-
* @returns {Promise<Models.
|
|
578
|
+
* @returns {Promise<Models.MarketReadinessReport>}
|
|
561
579
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
562
580
|
*/
|
|
563
|
-
marketsReadiness(id: string): Promise<Models.
|
|
581
|
+
marketsReadiness(id: string): Promise<Models.MarketReadinessReport>;
|
|
564
582
|
/**
|
|
565
583
|
* Every column is an exact-match filter and they combine with AND (?code=EUR); each one is declared as a query parameter above. A `?column=value` this entity does not have is DROPPED rather than refused — the call answers 200 with the unfiltered list — and `filter` echoes what was actually applied, which is the only way to tell that apart from a filter that matched nothing. `market_id` is not among them: the owning market comes from the path and overwrites anything the query says. An unknown but well-formed market lists empty rather than 404 — the parent is filtered on, not verified.
|
|
566
584
|
*
|
|
@@ -574,7 +592,7 @@ declare class Markets {
|
|
|
574
592
|
* @param {number} params.offset - Row offset for pagination (default 0). A negative offset is clamped to 0 rather than refused.
|
|
575
593
|
* @param {string} params.order - Sort as 'column' | 'column.asc' | 'column.desc'. The direction is lower case, and the column has to exist: id, market_id, code, is_default, position, created_at.
|
|
576
594
|
* @throws {RevenexxException}
|
|
577
|
-
* @returns {Promise<Models.
|
|
595
|
+
* @returns {Promise<Models.MarketCurrencyList>}
|
|
578
596
|
*/
|
|
579
597
|
marketsCurrenciesList(params: {
|
|
580
598
|
marketId: string;
|
|
@@ -586,7 +604,7 @@ declare class Markets {
|
|
|
586
604
|
limit?: number;
|
|
587
605
|
offset?: number;
|
|
588
606
|
order?: string;
|
|
589
|
-
}): Promise<Models.
|
|
607
|
+
}): Promise<Models.MarketCurrencyList>;
|
|
590
608
|
/**
|
|
591
609
|
* Every column is an exact-match filter and they combine with AND (?code=EUR); each one is declared as a query parameter above. A `?column=value` this entity does not have is DROPPED rather than refused — the call answers 200 with the unfiltered list — and `filter` echoes what was actually applied, which is the only way to tell that apart from a filter that matched nothing. `market_id` is not among them: the owning market comes from the path and overwrites anything the query says. An unknown but well-formed market lists empty rather than 404 — the parent is filtered on, not verified.
|
|
592
610
|
*
|
|
@@ -600,10 +618,10 @@ declare class Markets {
|
|
|
600
618
|
* @param {number} offset - Row offset for pagination (default 0). A negative offset is clamped to 0 rather than refused.
|
|
601
619
|
* @param {string} order - Sort as 'column' | 'column.asc' | 'column.desc'. The direction is lower case, and the column has to exist: id, market_id, code, is_default, position, created_at.
|
|
602
620
|
* @throws {RevenexxException}
|
|
603
|
-
* @returns {Promise<Models.
|
|
621
|
+
* @returns {Promise<Models.MarketCurrencyList>}
|
|
604
622
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
605
623
|
*/
|
|
606
|
-
marketsCurrenciesList(marketId: string, id?: string, code?: string, isDefault?: boolean, position?: number, createdAt?: string, limit?: number, offset?: number, order?: string): Promise<Models.
|
|
624
|
+
marketsCurrenciesList(marketId: string, id?: string, code?: string, isDefault?: boolean, position?: number, createdAt?: string, limit?: number, offset?: number, order?: string): Promise<Models.MarketCurrencyList>;
|
|
607
625
|
/**
|
|
608
626
|
* The owning market comes from the path and overrides anything in the body.
|
|
609
627
|
*
|
|
@@ -612,14 +630,14 @@ declare class Markets {
|
|
|
612
630
|
* @param {boolean} params.isDefault - The currency offered first to a buyer who states no preference. At most one per market, and it should be the market's base currency — readiness reports it as a warning when it is not.
|
|
613
631
|
* @param {number} params.position - Sort position among this market's currencies, ascending, default 0 — the order a currency switcher lists them in.
|
|
614
632
|
* @throws {RevenexxException}
|
|
615
|
-
* @returns {Promise<Models.
|
|
633
|
+
* @returns {Promise<Models.MarketCurrency>}
|
|
616
634
|
*/
|
|
617
635
|
marketsCurrenciesCreate(params: {
|
|
618
636
|
marketId: string;
|
|
619
637
|
code: string;
|
|
620
638
|
isDefault?: boolean;
|
|
621
639
|
position?: number;
|
|
622
|
-
}): Promise<Models.
|
|
640
|
+
}): Promise<Models.MarketCurrency>;
|
|
623
641
|
/**
|
|
624
642
|
* The owning market comes from the path and overrides anything in the body.
|
|
625
643
|
*
|
|
@@ -628,54 +646,54 @@ declare class Markets {
|
|
|
628
646
|
* @param {boolean} isDefault - The currency offered first to a buyer who states no preference. At most one per market, and it should be the market's base currency — readiness reports it as a warning when it is not.
|
|
629
647
|
* @param {number} position - Sort position among this market's currencies, ascending, default 0 — the order a currency switcher lists them in.
|
|
630
648
|
* @throws {RevenexxException}
|
|
631
|
-
* @returns {Promise<Models.
|
|
649
|
+
* @returns {Promise<Models.MarketCurrency>}
|
|
632
650
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
633
651
|
*/
|
|
634
|
-
marketsCurrenciesCreate(marketId: string, code: string, isDefault?: boolean, position?: number): Promise<Models.
|
|
652
|
+
marketsCurrenciesCreate(marketId: string, code: string, isDefault?: boolean, position?: number): Promise<Models.MarketCurrency>;
|
|
635
653
|
/**
|
|
636
654
|
* Scoped to the market in the path — a row belonging to another market is a 404 here, and is never deleted.
|
|
637
655
|
*
|
|
638
656
|
* @param {string} params.marketId - The owning market. A uuid — this route does not accept a market code. An unknown market lists empty rather than 404.
|
|
639
657
|
* @param {string} params.id - The currency of a market, by its primary key. A uuid — this route does not resolve a code, so a segment that will not cast is a 400 before any row is read.
|
|
640
658
|
* @throws {RevenexxException}
|
|
641
|
-
* @returns {Promise<Models.
|
|
659
|
+
* @returns {Promise<Models.MarketCurrencyDeleted>}
|
|
642
660
|
*/
|
|
643
661
|
marketsCurrenciesDelete(params: {
|
|
644
662
|
marketId: string;
|
|
645
663
|
id: string;
|
|
646
|
-
}): Promise<Models.
|
|
664
|
+
}): Promise<Models.MarketCurrencyDeleted>;
|
|
647
665
|
/**
|
|
648
666
|
* Scoped to the market in the path — a row belonging to another market is a 404 here, and is never deleted.
|
|
649
667
|
*
|
|
650
668
|
* @param {string} marketId - The owning market. A uuid — this route does not accept a market code. An unknown market lists empty rather than 404.
|
|
651
669
|
* @param {string} id - The currency of a market, by its primary key. A uuid — this route does not resolve a code, so a segment that will not cast is a 400 before any row is read.
|
|
652
670
|
* @throws {RevenexxException}
|
|
653
|
-
* @returns {Promise<Models.
|
|
671
|
+
* @returns {Promise<Models.MarketCurrencyDeleted>}
|
|
654
672
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
655
673
|
*/
|
|
656
|
-
marketsCurrenciesDelete(marketId: string, id: string): Promise<Models.
|
|
674
|
+
marketsCurrenciesDelete(marketId: string, id: string): Promise<Models.MarketCurrencyDeleted>;
|
|
657
675
|
/**
|
|
658
676
|
* Scoped strictly to the market in the path: a row belonging to another market is a 404 here, never a 200.
|
|
659
677
|
*
|
|
660
678
|
* @param {string} params.marketId - The owning market. A uuid — this route does not accept a market code. An unknown market lists empty rather than 404.
|
|
661
679
|
* @param {string} params.id - The currency of a market, by its primary key. A uuid — this route does not resolve a code, so a segment that will not cast is a 400 before any row is read.
|
|
662
680
|
* @throws {RevenexxException}
|
|
663
|
-
* @returns {Promise<Models.
|
|
681
|
+
* @returns {Promise<Models.MarketCurrency>}
|
|
664
682
|
*/
|
|
665
683
|
marketsCurrenciesGet(params: {
|
|
666
684
|
marketId: string;
|
|
667
685
|
id: string;
|
|
668
|
-
}): Promise<Models.
|
|
686
|
+
}): Promise<Models.MarketCurrency>;
|
|
669
687
|
/**
|
|
670
688
|
* Scoped strictly to the market in the path: a row belonging to another market is a 404 here, never a 200.
|
|
671
689
|
*
|
|
672
690
|
* @param {string} marketId - The owning market. A uuid — this route does not accept a market code. An unknown market lists empty rather than 404.
|
|
673
691
|
* @param {string} id - The currency of a market, by its primary key. A uuid — this route does not resolve a code, so a segment that will not cast is a 400 before any row is read.
|
|
674
692
|
* @throws {RevenexxException}
|
|
675
|
-
* @returns {Promise<Models.
|
|
693
|
+
* @returns {Promise<Models.MarketCurrency>}
|
|
676
694
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
677
695
|
*/
|
|
678
|
-
marketsCurrenciesGet(marketId: string, id: string): Promise<Models.
|
|
696
|
+
marketsCurrenciesGet(marketId: string, id: string): Promise<Models.MarketCurrency>;
|
|
679
697
|
/**
|
|
680
698
|
* Partial: omitted fields keep their value.
|
|
681
699
|
*
|
|
@@ -685,7 +703,7 @@ declare class Markets {
|
|
|
685
703
|
* @param {boolean} params.isDefault - The currency offered first to a buyer who states no preference. At most one per market, and it should be the market's base currency — readiness reports it as a warning when it is not.
|
|
686
704
|
* @param {number} params.position - Sort position among this market's currencies, ascending, default 0 — the order a currency switcher lists them in.
|
|
687
705
|
* @throws {RevenexxException}
|
|
688
|
-
* @returns {Promise<Models.
|
|
706
|
+
* @returns {Promise<Models.MarketCurrency>}
|
|
689
707
|
*/
|
|
690
708
|
marketsCurrenciesUpdate(params: {
|
|
691
709
|
marketId: string;
|
|
@@ -693,7 +711,7 @@ declare class Markets {
|
|
|
693
711
|
code?: string;
|
|
694
712
|
isDefault?: boolean;
|
|
695
713
|
position?: number;
|
|
696
|
-
}): Promise<Models.
|
|
714
|
+
}): Promise<Models.MarketCurrency>;
|
|
697
715
|
/**
|
|
698
716
|
* Partial: omitted fields keep their value.
|
|
699
717
|
*
|
|
@@ -703,10 +721,10 @@ declare class Markets {
|
|
|
703
721
|
* @param {boolean} isDefault - The currency offered first to a buyer who states no preference. At most one per market, and it should be the market's base currency — readiness reports it as a warning when it is not.
|
|
704
722
|
* @param {number} position - Sort position among this market's currencies, ascending, default 0 — the order a currency switcher lists them in.
|
|
705
723
|
* @throws {RevenexxException}
|
|
706
|
-
* @returns {Promise<Models.
|
|
724
|
+
* @returns {Promise<Models.MarketCurrency>}
|
|
707
725
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
708
726
|
*/
|
|
709
|
-
marketsCurrenciesUpdate(marketId: string, id: string, code?: string, isDefault?: boolean, position?: number): Promise<Models.
|
|
727
|
+
marketsCurrenciesUpdate(marketId: string, id: string, code?: string, isDefault?: boolean, position?: number): Promise<Models.MarketCurrency>;
|
|
710
728
|
/**
|
|
711
729
|
* Every column is an exact-match filter and they combine with AND (?code=de-DE); each one is declared as a query parameter above. A `?column=value` this entity does not have is DROPPED rather than refused — the call answers 200 with the unfiltered list — and `filter` echoes what was actually applied, which is the only way to tell that apart from a filter that matched nothing. `market_id` is not among them: the owning market comes from the path and overwrites anything the query says. An unknown but well-formed market lists empty rather than 404 — the parent is filtered on, not verified.
|
|
712
730
|
*
|
|
@@ -722,7 +740,7 @@ declare class Markets {
|
|
|
722
740
|
* @param {number} params.offset - Row offset for pagination (default 0). A negative offset is clamped to 0 rather than refused.
|
|
723
741
|
* @param {string} params.order - Sort as 'column' | 'column.asc' | 'column.desc'. The direction is lower case, and the column has to exist: id, market_id, code, language, country, is_default, position, created_at.
|
|
724
742
|
* @throws {RevenexxException}
|
|
725
|
-
* @returns {Promise<Models.
|
|
743
|
+
* @returns {Promise<Models.MarketLocaleList>}
|
|
726
744
|
*/
|
|
727
745
|
marketsLocalesList(params: {
|
|
728
746
|
marketId: string;
|
|
@@ -736,7 +754,7 @@ declare class Markets {
|
|
|
736
754
|
limit?: number;
|
|
737
755
|
offset?: number;
|
|
738
756
|
order?: string;
|
|
739
|
-
}): Promise<Models.
|
|
757
|
+
}): Promise<Models.MarketLocaleList>;
|
|
740
758
|
/**
|
|
741
759
|
* Every column is an exact-match filter and they combine with AND (?code=de-DE); each one is declared as a query parameter above. A `?column=value` this entity does not have is DROPPED rather than refused — the call answers 200 with the unfiltered list — and `filter` echoes what was actually applied, which is the only way to tell that apart from a filter that matched nothing. `market_id` is not among them: the owning market comes from the path and overwrites anything the query says. An unknown but well-formed market lists empty rather than 404 — the parent is filtered on, not verified.
|
|
742
760
|
*
|
|
@@ -752,10 +770,10 @@ declare class Markets {
|
|
|
752
770
|
* @param {number} offset - Row offset for pagination (default 0). A negative offset is clamped to 0 rather than refused.
|
|
753
771
|
* @param {string} order - Sort as 'column' | 'column.asc' | 'column.desc'. The direction is lower case, and the column has to exist: id, market_id, code, language, country, is_default, position, created_at.
|
|
754
772
|
* @throws {RevenexxException}
|
|
755
|
-
* @returns {Promise<Models.
|
|
773
|
+
* @returns {Promise<Models.MarketLocaleList>}
|
|
756
774
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
757
775
|
*/
|
|
758
|
-
marketsLocalesList(marketId: string, id?: string, code?: string, language?: string, country?: string, isDefault?: boolean, position?: number, createdAt?: string, limit?: number, offset?: number, order?: string): Promise<Models.
|
|
776
|
+
marketsLocalesList(marketId: string, id?: string, code?: string, language?: string, country?: string, isDefault?: boolean, position?: number, createdAt?: string, limit?: number, offset?: number, order?: string): Promise<Models.MarketLocaleList>;
|
|
759
777
|
/**
|
|
760
778
|
* The owning market comes from the path and overrides anything in the body.
|
|
761
779
|
*
|
|
@@ -766,7 +784,7 @@ declare class Markets {
|
|
|
766
784
|
* @param {boolean} params.isDefault - The locale a storefront renders this market in when the request asks for none. At most one per market; where none carries the flag the first by position is used, and `default_locale.source` on the context says which of the two happened.
|
|
767
785
|
* @param {number} params.position - Sort position among this market's locales, ascending, default 0 — and the tie-break that picks a default when no locale is flagged.
|
|
768
786
|
* @throws {RevenexxException}
|
|
769
|
-
* @returns {Promise<Models.
|
|
787
|
+
* @returns {Promise<Models.MarketLocale>}
|
|
770
788
|
*/
|
|
771
789
|
marketsLocalesCreate(params: {
|
|
772
790
|
marketId: string;
|
|
@@ -775,7 +793,7 @@ declare class Markets {
|
|
|
775
793
|
language: string;
|
|
776
794
|
isDefault?: boolean;
|
|
777
795
|
position?: number;
|
|
778
|
-
}): Promise<Models.
|
|
796
|
+
}): Promise<Models.MarketLocale>;
|
|
779
797
|
/**
|
|
780
798
|
* The owning market comes from the path and overrides anything in the body.
|
|
781
799
|
*
|
|
@@ -786,54 +804,54 @@ declare class Markets {
|
|
|
786
804
|
* @param {boolean} isDefault - The locale a storefront renders this market in when the request asks for none. At most one per market; where none carries the flag the first by position is used, and `default_locale.source` on the context says which of the two happened.
|
|
787
805
|
* @param {number} position - Sort position among this market's locales, ascending, default 0 — and the tie-break that picks a default when no locale is flagged.
|
|
788
806
|
* @throws {RevenexxException}
|
|
789
|
-
* @returns {Promise<Models.
|
|
807
|
+
* @returns {Promise<Models.MarketLocale>}
|
|
790
808
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
791
809
|
*/
|
|
792
|
-
marketsLocalesCreate(marketId: string, code: string, country: string, language: string, isDefault?: boolean, position?: number): Promise<Models.
|
|
810
|
+
marketsLocalesCreate(marketId: string, code: string, country: string, language: string, isDefault?: boolean, position?: number): Promise<Models.MarketLocale>;
|
|
793
811
|
/**
|
|
794
812
|
* Scoped to the market in the path — a row belonging to another market is a 404 here, and is never deleted.
|
|
795
813
|
*
|
|
796
814
|
* @param {string} params.marketId - The owning market. A uuid — this route does not accept a market code. An unknown market lists empty rather than 404.
|
|
797
815
|
* @param {string} params.id - The locale of a market, by its primary key. A uuid — this route does not resolve a code, so a segment that will not cast is a 400 before any row is read.
|
|
798
816
|
* @throws {RevenexxException}
|
|
799
|
-
* @returns {Promise<Models.
|
|
817
|
+
* @returns {Promise<Models.MarketLocaleDeleted>}
|
|
800
818
|
*/
|
|
801
819
|
marketsLocalesDelete(params: {
|
|
802
820
|
marketId: string;
|
|
803
821
|
id: string;
|
|
804
|
-
}): Promise<Models.
|
|
822
|
+
}): Promise<Models.MarketLocaleDeleted>;
|
|
805
823
|
/**
|
|
806
824
|
* Scoped to the market in the path — a row belonging to another market is a 404 here, and is never deleted.
|
|
807
825
|
*
|
|
808
826
|
* @param {string} marketId - The owning market. A uuid — this route does not accept a market code. An unknown market lists empty rather than 404.
|
|
809
827
|
* @param {string} id - The locale of a market, by its primary key. A uuid — this route does not resolve a code, so a segment that will not cast is a 400 before any row is read.
|
|
810
828
|
* @throws {RevenexxException}
|
|
811
|
-
* @returns {Promise<Models.
|
|
829
|
+
* @returns {Promise<Models.MarketLocaleDeleted>}
|
|
812
830
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
813
831
|
*/
|
|
814
|
-
marketsLocalesDelete(marketId: string, id: string): Promise<Models.
|
|
832
|
+
marketsLocalesDelete(marketId: string, id: string): Promise<Models.MarketLocaleDeleted>;
|
|
815
833
|
/**
|
|
816
834
|
* Scoped strictly to the market in the path: a row belonging to another market is a 404 here, never a 200.
|
|
817
835
|
*
|
|
818
836
|
* @param {string} params.marketId - The owning market. A uuid — this route does not accept a market code. An unknown market lists empty rather than 404.
|
|
819
837
|
* @param {string} params.id - The locale of a market, by its primary key. A uuid — this route does not resolve a code, so a segment that will not cast is a 400 before any row is read.
|
|
820
838
|
* @throws {RevenexxException}
|
|
821
|
-
* @returns {Promise<Models.
|
|
839
|
+
* @returns {Promise<Models.MarketLocale>}
|
|
822
840
|
*/
|
|
823
841
|
marketsLocalesGet(params: {
|
|
824
842
|
marketId: string;
|
|
825
843
|
id: string;
|
|
826
|
-
}): Promise<Models.
|
|
844
|
+
}): Promise<Models.MarketLocale>;
|
|
827
845
|
/**
|
|
828
846
|
* Scoped strictly to the market in the path: a row belonging to another market is a 404 here, never a 200.
|
|
829
847
|
*
|
|
830
848
|
* @param {string} marketId - The owning market. A uuid — this route does not accept a market code. An unknown market lists empty rather than 404.
|
|
831
849
|
* @param {string} id - The locale of a market, by its primary key. A uuid — this route does not resolve a code, so a segment that will not cast is a 400 before any row is read.
|
|
832
850
|
* @throws {RevenexxException}
|
|
833
|
-
* @returns {Promise<Models.
|
|
851
|
+
* @returns {Promise<Models.MarketLocale>}
|
|
834
852
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
835
853
|
*/
|
|
836
|
-
marketsLocalesGet(marketId: string, id: string): Promise<Models.
|
|
854
|
+
marketsLocalesGet(marketId: string, id: string): Promise<Models.MarketLocale>;
|
|
837
855
|
/**
|
|
838
856
|
* Partial: omitted fields keep their value.
|
|
839
857
|
*
|
|
@@ -845,7 +863,7 @@ declare class Markets {
|
|
|
845
863
|
* @param {string} params.language - ISO 639-1 language code — the language half of `code`, stored separately so a client can group markets by language without parsing.
|
|
846
864
|
* @param {number} params.position - Sort position among this market's locales, ascending, default 0 — and the tie-break that picks a default when no locale is flagged.
|
|
847
865
|
* @throws {RevenexxException}
|
|
848
|
-
* @returns {Promise<Models.
|
|
866
|
+
* @returns {Promise<Models.MarketLocale>}
|
|
849
867
|
*/
|
|
850
868
|
marketsLocalesUpdate(params: {
|
|
851
869
|
marketId: string;
|
|
@@ -855,7 +873,7 @@ declare class Markets {
|
|
|
855
873
|
isDefault?: boolean;
|
|
856
874
|
language?: string;
|
|
857
875
|
position?: number;
|
|
858
|
-
}): Promise<Models.
|
|
876
|
+
}): Promise<Models.MarketLocale>;
|
|
859
877
|
/**
|
|
860
878
|
* Partial: omitted fields keep their value.
|
|
861
879
|
*
|
|
@@ -867,10 +885,10 @@ declare class Markets {
|
|
|
867
885
|
* @param {string} language - ISO 639-1 language code — the language half of `code`, stored separately so a client can group markets by language without parsing.
|
|
868
886
|
* @param {number} position - Sort position among this market's locales, ascending, default 0 — and the tie-break that picks a default when no locale is flagged.
|
|
869
887
|
* @throws {RevenexxException}
|
|
870
|
-
* @returns {Promise<Models.
|
|
888
|
+
* @returns {Promise<Models.MarketLocale>}
|
|
871
889
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
872
890
|
*/
|
|
873
|
-
marketsLocalesUpdate(marketId: string, id: string, code?: string, country?: string, isDefault?: boolean, language?: string, position?: number): Promise<Models.
|
|
891
|
+
marketsLocalesUpdate(marketId: string, id: string, code?: string, country?: string, isDefault?: boolean, language?: string, position?: number): Promise<Models.MarketLocale>;
|
|
874
892
|
/**
|
|
875
893
|
* Every column is an exact-match filter and they combine with AND (?code=standard); each one is declared as a query parameter above. A `?column=value` this entity does not have is DROPPED rather than refused — the call answers 200 with the unfiltered list — and `filter` echoes what was actually applied, which is the only way to tell that apart from a filter that matched nothing. `market_id` is not among them: the owning market comes from the path and overwrites anything the query says. An unknown but well-formed market lists empty rather than 404 — the parent is filtered on, not verified.
|
|
876
894
|
*
|
|
@@ -888,7 +906,7 @@ declare class Markets {
|
|
|
888
906
|
* @param {number} params.offset - Row offset for pagination (default 0). A negative offset is clamped to 0 rather than refused.
|
|
889
907
|
* @param {string} params.order - Sort as 'column' | 'column.asc' | 'column.desc'. The direction is lower case, and the column has to exist: id, market_id, code, name, labels, rate, is_default, position, created_at, updated_at.
|
|
890
908
|
* @throws {RevenexxException}
|
|
891
|
-
* @returns {Promise<Models.
|
|
909
|
+
* @returns {Promise<Models.MarketTaxClassList>}
|
|
892
910
|
*/
|
|
893
911
|
marketsTaxClassesList(params: {
|
|
894
912
|
marketId: string;
|
|
@@ -904,7 +922,7 @@ declare class Markets {
|
|
|
904
922
|
limit?: number;
|
|
905
923
|
offset?: number;
|
|
906
924
|
order?: string;
|
|
907
|
-
}): Promise<Models.
|
|
925
|
+
}): Promise<Models.MarketTaxClassList>;
|
|
908
926
|
/**
|
|
909
927
|
* Every column is an exact-match filter and they combine with AND (?code=standard); each one is declared as a query parameter above. A `?column=value` this entity does not have is DROPPED rather than refused — the call answers 200 with the unfiltered list — and `filter` echoes what was actually applied, which is the only way to tell that apart from a filter that matched nothing. `market_id` is not among them: the owning market comes from the path and overwrites anything the query says. An unknown but well-formed market lists empty rather than 404 — the parent is filtered on, not verified.
|
|
910
928
|
*
|
|
@@ -922,10 +940,10 @@ declare class Markets {
|
|
|
922
940
|
* @param {number} offset - Row offset for pagination (default 0). A negative offset is clamped to 0 rather than refused.
|
|
923
941
|
* @param {string} order - Sort as 'column' | 'column.asc' | 'column.desc'. The direction is lower case, and the column has to exist: id, market_id, code, name, labels, rate, is_default, position, created_at, updated_at.
|
|
924
942
|
* @throws {RevenexxException}
|
|
925
|
-
* @returns {Promise<Models.
|
|
943
|
+
* @returns {Promise<Models.MarketTaxClassList>}
|
|
926
944
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
927
945
|
*/
|
|
928
|
-
marketsTaxClassesList(marketId: string, id?: string, code?: string, name?: string, labels?: string, rate?: number, isDefault?: boolean, position?: number, createdAt?: string, updatedAt?: string, limit?: number, offset?: number, order?: string): Promise<Models.
|
|
946
|
+
marketsTaxClassesList(marketId: string, id?: string, code?: string, name?: string, labels?: string, rate?: number, isDefault?: boolean, position?: number, createdAt?: string, updatedAt?: string, limit?: number, offset?: number, order?: string): Promise<Models.MarketTaxClassList>;
|
|
929
947
|
/**
|
|
930
948
|
* The owning market comes from the path and overrides anything in the body.
|
|
931
949
|
*
|
|
@@ -937,7 +955,7 @@ declare class Markets {
|
|
|
937
955
|
* @param {number} params.position - Sort position among this market's tax classes, ascending, default 0 — and the tie-break that picks a class when none is flagged default.
|
|
938
956
|
* @param {number} params.rate - Tax rate in PERCENT, 0–100 (default 0) — 20 means 20 %, not 0.2. Whether a stored price already contains it is a separate question, answered per market by `pricing.tax_basis` on the context.
|
|
939
957
|
* @throws {RevenexxException}
|
|
940
|
-
* @returns {Promise<Models.
|
|
958
|
+
* @returns {Promise<Models.MarketTaxClass>}
|
|
941
959
|
*/
|
|
942
960
|
marketsTaxClassesCreate(params: {
|
|
943
961
|
marketId: string;
|
|
@@ -947,7 +965,7 @@ declare class Markets {
|
|
|
947
965
|
labels?: object;
|
|
948
966
|
position?: number;
|
|
949
967
|
rate?: number;
|
|
950
|
-
}): Promise<Models.
|
|
968
|
+
}): Promise<Models.MarketTaxClass>;
|
|
951
969
|
/**
|
|
952
970
|
* The owning market comes from the path and overrides anything in the body.
|
|
953
971
|
*
|
|
@@ -959,54 +977,54 @@ declare class Markets {
|
|
|
959
977
|
* @param {number} position - Sort position among this market's tax classes, ascending, default 0 — and the tie-break that picks a class when none is flagged default.
|
|
960
978
|
* @param {number} rate - Tax rate in PERCENT, 0–100 (default 0) — 20 means 20 %, not 0.2. Whether a stored price already contains it is a separate question, answered per market by `pricing.tax_basis` on the context.
|
|
961
979
|
* @throws {RevenexxException}
|
|
962
|
-
* @returns {Promise<Models.
|
|
980
|
+
* @returns {Promise<Models.MarketTaxClass>}
|
|
963
981
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
964
982
|
*/
|
|
965
|
-
marketsTaxClassesCreate(marketId: string, code: string, name: string, isDefault?: boolean, labels?: object, position?: number, rate?: number): Promise<Models.
|
|
983
|
+
marketsTaxClassesCreate(marketId: string, code: string, name: string, isDefault?: boolean, labels?: object, position?: number, rate?: number): Promise<Models.MarketTaxClass>;
|
|
966
984
|
/**
|
|
967
985
|
* Refused with a 409 for as long as another app still points at this tax class by its code. A tax class is the source of record for a rate, and other apps name it by CODE with no foreign key behind it — a cross-app FK is what ADR-0055 forbids. So this asks the shipping app what still uses the code (shipping.tax-classes.usage) and answers 409 with the count and the first few names rather than leaving methods quoting a rate nobody defines. The check FAILS OPEN: a tenant without the shipping app, or an unreachable one, deletes as before, and the answer says which happened in 'usage_checked'. Matched on the code, which is shared across markets — the refusal message says so.
|
|
968
986
|
*
|
|
969
987
|
* @param {string} params.marketId - The owning market. A uuid — this route does not accept a market code. An unknown market lists empty rather than 404.
|
|
970
988
|
* @param {string} params.id - The tax class of a market, by its primary key. A uuid — this route does not resolve a code, so a segment that will not cast is a 400 before any row is read.
|
|
971
989
|
* @throws {RevenexxException}
|
|
972
|
-
* @returns {Promise<Models.
|
|
990
|
+
* @returns {Promise<Models.MarketTaxClassDeleted>}
|
|
973
991
|
*/
|
|
974
992
|
marketsTaxClassesDelete(params: {
|
|
975
993
|
marketId: string;
|
|
976
994
|
id: string;
|
|
977
|
-
}): Promise<Models.
|
|
995
|
+
}): Promise<Models.MarketTaxClassDeleted>;
|
|
978
996
|
/**
|
|
979
997
|
* Refused with a 409 for as long as another app still points at this tax class by its code. A tax class is the source of record for a rate, and other apps name it by CODE with no foreign key behind it — a cross-app FK is what ADR-0055 forbids. So this asks the shipping app what still uses the code (shipping.tax-classes.usage) and answers 409 with the count and the first few names rather than leaving methods quoting a rate nobody defines. The check FAILS OPEN: a tenant without the shipping app, or an unreachable one, deletes as before, and the answer says which happened in 'usage_checked'. Matched on the code, which is shared across markets — the refusal message says so.
|
|
980
998
|
*
|
|
981
999
|
* @param {string} marketId - The owning market. A uuid — this route does not accept a market code. An unknown market lists empty rather than 404.
|
|
982
1000
|
* @param {string} id - The tax class of a market, by its primary key. A uuid — this route does not resolve a code, so a segment that will not cast is a 400 before any row is read.
|
|
983
1001
|
* @throws {RevenexxException}
|
|
984
|
-
* @returns {Promise<Models.
|
|
1002
|
+
* @returns {Promise<Models.MarketTaxClassDeleted>}
|
|
985
1003
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
986
1004
|
*/
|
|
987
|
-
marketsTaxClassesDelete(marketId: string, id: string): Promise<Models.
|
|
1005
|
+
marketsTaxClassesDelete(marketId: string, id: string): Promise<Models.MarketTaxClassDeleted>;
|
|
988
1006
|
/**
|
|
989
1007
|
* Scoped strictly to the market in the path: a row belonging to another market is a 404 here, never a 200.
|
|
990
1008
|
*
|
|
991
1009
|
* @param {string} params.marketId - The owning market. A uuid — this route does not accept a market code. An unknown market lists empty rather than 404.
|
|
992
1010
|
* @param {string} params.id - The tax class of a market, by its primary key. A uuid — this route does not resolve a code, so a segment that will not cast is a 400 before any row is read.
|
|
993
1011
|
* @throws {RevenexxException}
|
|
994
|
-
* @returns {Promise<Models.
|
|
1012
|
+
* @returns {Promise<Models.MarketTaxClass>}
|
|
995
1013
|
*/
|
|
996
1014
|
marketsTaxClassesGet(params: {
|
|
997
1015
|
marketId: string;
|
|
998
1016
|
id: string;
|
|
999
|
-
}): Promise<Models.
|
|
1017
|
+
}): Promise<Models.MarketTaxClass>;
|
|
1000
1018
|
/**
|
|
1001
1019
|
* Scoped strictly to the market in the path: a row belonging to another market is a 404 here, never a 200.
|
|
1002
1020
|
*
|
|
1003
1021
|
* @param {string} marketId - The owning market. A uuid — this route does not accept a market code. An unknown market lists empty rather than 404.
|
|
1004
1022
|
* @param {string} id - The tax class of a market, by its primary key. A uuid — this route does not resolve a code, so a segment that will not cast is a 400 before any row is read.
|
|
1005
1023
|
* @throws {RevenexxException}
|
|
1006
|
-
* @returns {Promise<Models.
|
|
1024
|
+
* @returns {Promise<Models.MarketTaxClass>}
|
|
1007
1025
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1008
1026
|
*/
|
|
1009
|
-
marketsTaxClassesGet(marketId: string, id: string): Promise<Models.
|
|
1027
|
+
marketsTaxClassesGet(marketId: string, id: string): Promise<Models.MarketTaxClass>;
|
|
1010
1028
|
/**
|
|
1011
1029
|
* Partial: omitted fields keep their value.
|
|
1012
1030
|
*
|
|
@@ -1019,7 +1037,7 @@ declare class Markets {
|
|
|
1019
1037
|
* @param {number} params.position - Sort position among this market's tax classes, ascending, default 0 — and the tie-break that picks a class when none is flagged default.
|
|
1020
1038
|
* @param {number} params.rate - Tax rate in PERCENT, 0–100 (default 0) — 20 means 20 %, not 0.2. Whether a stored price already contains it is a separate question, answered per market by `pricing.tax_basis` on the context.
|
|
1021
1039
|
* @throws {RevenexxException}
|
|
1022
|
-
* @returns {Promise<Models.
|
|
1040
|
+
* @returns {Promise<Models.MarketTaxClass>}
|
|
1023
1041
|
*/
|
|
1024
1042
|
marketsTaxClassesUpdate(params: {
|
|
1025
1043
|
marketId: string;
|
|
@@ -1030,7 +1048,7 @@ declare class Markets {
|
|
|
1030
1048
|
name?: string;
|
|
1031
1049
|
position?: number;
|
|
1032
1050
|
rate?: number;
|
|
1033
|
-
}): Promise<Models.
|
|
1051
|
+
}): Promise<Models.MarketTaxClass>;
|
|
1034
1052
|
/**
|
|
1035
1053
|
* Partial: omitted fields keep their value.
|
|
1036
1054
|
*
|
|
@@ -1043,10 +1061,10 @@ declare class Markets {
|
|
|
1043
1061
|
* @param {number} position - Sort position among this market's tax classes, ascending, default 0 — and the tie-break that picks a class when none is flagged default.
|
|
1044
1062
|
* @param {number} rate - Tax rate in PERCENT, 0–100 (default 0) — 20 means 20 %, not 0.2. Whether a stored price already contains it is a separate question, answered per market by `pricing.tax_basis` on the context.
|
|
1045
1063
|
* @throws {RevenexxException}
|
|
1046
|
-
* @returns {Promise<Models.
|
|
1064
|
+
* @returns {Promise<Models.MarketTaxClass>}
|
|
1047
1065
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1048
1066
|
*/
|
|
1049
|
-
marketsTaxClassesUpdate(marketId: string, id: string, code?: string, isDefault?: boolean, labels?: object, name?: string, position?: number, rate?: number): Promise<Models.
|
|
1067
|
+
marketsTaxClassesUpdate(marketId: string, id: string, code?: string, isDefault?: boolean, labels?: object, name?: string, position?: number, rate?: number): Promise<Models.MarketTaxClass>;
|
|
1050
1068
|
}
|
|
1051
1069
|
|
|
1052
1070
|
export { Markets };
|