@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';
|
|
@@ -120,6 +129,8 @@ import '../enums/payment-term-tone.js';
|
|
|
120
129
|
import '../enums/payment-term-create-request-tone.js';
|
|
121
130
|
import '../enums/payment-term-update-request-tone.js';
|
|
122
131
|
import '../enums/payment-vocabulary-tone.js';
|
|
132
|
+
import '../enums/pending-approval-approver-type.js';
|
|
133
|
+
import '../enums/pending-approval-status.js';
|
|
123
134
|
import '../enums/price-ending-rule.js';
|
|
124
135
|
import '../enums/price-entries-adjust-response-rounding.js';
|
|
125
136
|
import '../enums/price-entries-adjust-response-rounding-mode.js';
|
|
@@ -142,6 +153,11 @@ import '../enums/product-grid-column-source.js';
|
|
|
142
153
|
import '../enums/product-label-source.js';
|
|
143
154
|
import '../enums/product-label-attribute-source.js';
|
|
144
155
|
import '../enums/products-kind.js';
|
|
156
|
+
import '../enums/purchase-request-status.js';
|
|
157
|
+
import '../enums/purchase-request-event-name.js';
|
|
158
|
+
import '../enums/purchase-request-item-type.js';
|
|
159
|
+
import '../enums/purchase-request-item-create-request-type.js';
|
|
160
|
+
import '../enums/purchase-request-item-update-request-type.js';
|
|
145
161
|
import '../enums/reorder-point-source.js';
|
|
146
162
|
import '../enums/reservation-status.js';
|
|
147
163
|
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';
|
|
@@ -240,7 +258,7 @@ declare class ShippingMethods {
|
|
|
240
258
|
* @param {string} params.carrier - Exact-match filter on `carrier`. The other half of that question: the methods still resolving their carrier through the legacy free-text CODE rather than a reference. Together with `?carrier_id=` this is how a merchant finds what a carrier is still holding before retiring it.
|
|
241
259
|
* @param {string} params.taxClass - Exact-match filter on `tax_class`. The methods naming one tax class — the same question GET /shipping/tax-classes/{code}/usage counts, when the caller wants the rows rather than the count. Only a method's OWN class; a method falling back to the tenant setting does not match.
|
|
242
260
|
* @throws {RevenexxException}
|
|
243
|
-
* @returns {Promise<
|
|
261
|
+
* @returns {Promise<{}>}
|
|
244
262
|
*/
|
|
245
263
|
shippingMethodsList(params?: {
|
|
246
264
|
limit?: number;
|
|
@@ -252,7 +270,7 @@ declare class ShippingMethods {
|
|
|
252
270
|
carrierId?: string;
|
|
253
271
|
carrier?: string;
|
|
254
272
|
taxClass?: string;
|
|
255
|
-
}): Promise<
|
|
273
|
+
}): Promise<{}>;
|
|
256
274
|
/**
|
|
257
275
|
* Filterable by exact column value — `?code=`, `?enabled=`, `?pricing_type=`, `?carrier_id=`, `?carrier=` and `?tax_class=` are applied as equalities and echoed back in `filter`. `?carrier_id=` and `?carrier=` are the two halves of one question: the first finds the methods holding a reference, the second the ones still resolving through the legacy code text. A query key that names no column of this entity is SILENTLY IGNORED — `?status=` on this route is the trap, since carriers have a status and methods do not: the page comes back unfiltered, 200, with an empty `filter`.
|
|
258
276
|
*
|
|
@@ -266,10 +284,10 @@ declare class ShippingMethods {
|
|
|
266
284
|
* @param {string} carrier - Exact-match filter on `carrier`. The other half of that question: the methods still resolving their carrier through the legacy free-text CODE rather than a reference. Together with `?carrier_id=` this is how a merchant finds what a carrier is still holding before retiring it.
|
|
267
285
|
* @param {string} taxClass - Exact-match filter on `tax_class`. The methods naming one tax class — the same question GET /shipping/tax-classes/{code}/usage counts, when the caller wants the rows rather than the count. Only a method's OWN class; a method falling back to the tenant setting does not match.
|
|
268
286
|
* @throws {RevenexxException}
|
|
269
|
-
* @returns {Promise<
|
|
287
|
+
* @returns {Promise<{}>}
|
|
270
288
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
271
289
|
*/
|
|
272
|
-
shippingMethodsList(limit?: number, offset?: number, order?: string, code?: string, enabled?: boolean, pricingType?: PricingType, carrierId?: string, carrier?: string, taxClass?: string): Promise<
|
|
290
|
+
shippingMethodsList(limit?: number, offset?: number, order?: string, code?: string, enabled?: boolean, pricingType?: PricingType, carrierId?: string, carrier?: string, taxClass?: string): Promise<{}>;
|
|
273
291
|
/**
|
|
274
292
|
* A shipping method is the line a buyer picks in the checkout: a pricing model ('fixed', 'free' or 'matrix'), the countries it may be offered into, a free-above threshold, and the carrier it ships with. The method owns the PRICE; the delivery promise — tracking template, cut-off, handling and transit days — is inherited from the carrier wherever the method states none of its own. A create cannot omit `code` and `name`; every other column is optional or defaulted by the database. Two rows of this tenant may not share `code` — that is the 409. The new method is quoted by nobody until two further things are true: `enabled` defaults to FALSE, and a 'matrix' method has no tiers yet — until POST or PUT …/tiers gives it some it appears in `excluded` with 'matrix has no rate tiers configured' rather than in the rates. `carrier_id` and the legacy `carrier` code are both accepted and neither is verified against the carrier table here: an unmatched code is a plain carrier name on the rate, not an error.
|
|
275
293
|
*
|
|
@@ -294,7 +312,7 @@ declare class ShippingMethods {
|
|
|
294
312
|
* @param {number} params.quoteAbove - Above this MATRIX MEASURE the method carries no automatic price: it is still offered, flagged `quote_required` with a reason, and the storefront shows 'shipping on request'. For bulky or overweight freight priced by hand. Null = every measure is priced automatically.
|
|
295
313
|
* @param {string} params.taxClass - This method's own tax class, as a CODE into the buyer market's tax classes (markets.tax_classes) — never a rate. First step of the tax chain: unset falls back to the tenant's shipping_tax_class setting, then the market default. Not a foreign key and it could not be (ADR-0055); GET /shipping/tax-classes/{code}/usage is the integrity question markets asks in its place.
|
|
296
314
|
* @throws {RevenexxException}
|
|
297
|
-
* @returns {Promise<Models.
|
|
315
|
+
* @returns {Promise<Models.ShippingMethod>}
|
|
298
316
|
*/
|
|
299
317
|
shippingMethodsCreate(params: {
|
|
300
318
|
code: string;
|
|
@@ -317,7 +335,7 @@ declare class ShippingMethods {
|
|
|
317
335
|
pricingType?: ShippingMethodPricingType;
|
|
318
336
|
quoteAbove?: number;
|
|
319
337
|
taxClass?: string;
|
|
320
|
-
}): Promise<Models.
|
|
338
|
+
}): Promise<Models.ShippingMethod>;
|
|
321
339
|
/**
|
|
322
340
|
* A shipping method is the line a buyer picks in the checkout: a pricing model ('fixed', 'free' or 'matrix'), the countries it may be offered into, a free-above threshold, and the carrier it ships with. The method owns the PRICE; the delivery promise — tracking template, cut-off, handling and transit days — is inherited from the carrier wherever the method states none of its own. A create cannot omit `code` and `name`; every other column is optional or defaulted by the database. Two rows of this tenant may not share `code` — that is the 409. The new method is quoted by nobody until two further things are true: `enabled` defaults to FALSE, and a 'matrix' method has no tiers yet — until POST or PUT …/tiers gives it some it appears in `excluded` with 'matrix has no rate tiers configured' rather than in the rates. `carrier_id` and the legacy `carrier` code are both accepted and neither is verified against the carrier table here: an unmatched code is a plain carrier name on the rate, not an error.
|
|
323
341
|
*
|
|
@@ -342,10 +360,10 @@ declare class ShippingMethods {
|
|
|
342
360
|
* @param {number} quoteAbove - Above this MATRIX MEASURE the method carries no automatic price: it is still offered, flagged `quote_required` with a reason, and the storefront shows 'shipping on request'. For bulky or overweight freight priced by hand. Null = every measure is priced automatically.
|
|
343
361
|
* @param {string} taxClass - This method's own tax class, as a CODE into the buyer market's tax classes (markets.tax_classes) — never a rate. First step of the tax chain: unset falls back to the tenant's shipping_tax_class setting, then the market default. Not a foreign key and it could not be (ADR-0055); GET /shipping/tax-classes/{code}/usage is the integrity question markets asks in its place.
|
|
344
362
|
* @throws {RevenexxException}
|
|
345
|
-
* @returns {Promise<Models.
|
|
363
|
+
* @returns {Promise<Models.ShippingMethod>}
|
|
346
364
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
347
365
|
*/
|
|
348
|
-
shippingMethodsCreate(code: string, name: string, carrier?: string, carrierId?: string, countries?: string[], currency?: string, description?: string, enabled?: boolean, etaDaysMax?: number, etaDaysMin?: number, freeAbove?: number, labels?: object, matrixAttribute?: string, matrixBasis?: ShippingMethodMatrixBasis, metadata?: object, position?: number, price?: number, pricingType?: ShippingMethodPricingType, quoteAbove?: number, taxClass?: string): Promise<Models.
|
|
366
|
+
shippingMethodsCreate(code: string, name: string, carrier?: string, carrierId?: string, countries?: string[], currency?: string, description?: string, enabled?: boolean, etaDaysMax?: number, etaDaysMin?: number, freeAbove?: number, labels?: object, matrixAttribute?: string, matrixBasis?: ShippingMethodMatrixBasis, metadata?: object, position?: number, price?: number, pricingType?: ShippingMethodPricingType, quoteAbove?: number, taxClass?: string): Promise<Models.ShippingMethod>;
|
|
349
367
|
/**
|
|
350
368
|
* Runs the carrier seed first, then creates any missing method: the three lines a shop is expected to offer — standard, express and pickup. The app runs this itself on `app.installed`, so a fresh install already has them; calling it by hand afterwards is how a tenant that deleted one gets it back, and calling it twice costs nothing, because it reconciles rather than seeds. The seeded methods deliberately name no carrier: which carrier carries the standard method is a contract, not a default, and a method that says 'dhl' resolves to the seeded DHL row anyway.
|
|
351
369
|
*
|
|
@@ -358,39 +376,39 @@ declare class ShippingMethods {
|
|
|
358
376
|
*
|
|
359
377
|
* @param {string} params.id - The row id.
|
|
360
378
|
* @throws {RevenexxException}
|
|
361
|
-
* @returns {Promise<
|
|
379
|
+
* @returns {Promise<{}>}
|
|
362
380
|
*/
|
|
363
381
|
shippingMethodsDelete(params: {
|
|
364
382
|
id: string;
|
|
365
|
-
}): Promise<
|
|
383
|
+
}): Promise<{}>;
|
|
366
384
|
/**
|
|
367
385
|
* Deleting one takes every `shipping_rate_tiers` row that points at it with it — the foreign keys decide that, not this route. So the whole rate matrix goes with the method, which is also why this never answers a conflict and why there is no way to recover the table afterwards — for a method a checkout may still be holding in a session, `enabled: false` is the safer edit.
|
|
368
386
|
*
|
|
369
387
|
* @param {string} id - The row id.
|
|
370
388
|
* @throws {RevenexxException}
|
|
371
|
-
* @returns {Promise<
|
|
389
|
+
* @returns {Promise<{}>}
|
|
372
390
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
373
391
|
*/
|
|
374
|
-
shippingMethodsDelete(id: string): Promise<
|
|
392
|
+
shippingMethodsDelete(id: string): Promise<{}>;
|
|
375
393
|
/**
|
|
376
394
|
* A shipping method is the line a buyer picks in the checkout: a pricing model ('fixed', 'free' or 'matrix'), the countries it may be offered into, a free-above threshold, and the carrier it ships with. The method owns the PRICE; the delivery promise — tracking template, cut-off, handling and transit days — is inherited from the carrier wherever the method states none of its own. This is the CONFIGURATION of one, by row id — not what a buyer would be charged. A matrix method's prices are not in here at all: they are its rate tiers, GET /shipping/methods/{method_id}/tiers, and the price for a given basket is POST /shipping/rates, which is the only place free-above thresholds, country restrictions, the carrier's reach and tax are applied. A checkout that reads `price` off this row prices a matrix method at 0.
|
|
377
395
|
*
|
|
378
396
|
* @param {string} params.id - The row id.
|
|
379
397
|
* @throws {RevenexxException}
|
|
380
|
-
* @returns {Promise<Models.
|
|
398
|
+
* @returns {Promise<Models.ShippingMethod>}
|
|
381
399
|
*/
|
|
382
400
|
shippingMethodsGet(params: {
|
|
383
401
|
id: string;
|
|
384
|
-
}): Promise<Models.
|
|
402
|
+
}): Promise<Models.ShippingMethod>;
|
|
385
403
|
/**
|
|
386
404
|
* A shipping method is the line a buyer picks in the checkout: a pricing model ('fixed', 'free' or 'matrix'), the countries it may be offered into, a free-above threshold, and the carrier it ships with. The method owns the PRICE; the delivery promise — tracking template, cut-off, handling and transit days — is inherited from the carrier wherever the method states none of its own. This is the CONFIGURATION of one, by row id — not what a buyer would be charged. A matrix method's prices are not in here at all: they are its rate tiers, GET /shipping/methods/{method_id}/tiers, and the price for a given basket is POST /shipping/rates, which is the only place free-above thresholds, country restrictions, the carrier's reach and tax are applied. A checkout that reads `price` off this row prices a matrix method at 0.
|
|
387
405
|
*
|
|
388
406
|
* @param {string} id - The row id.
|
|
389
407
|
* @throws {RevenexxException}
|
|
390
|
-
* @returns {Promise<Models.
|
|
408
|
+
* @returns {Promise<Models.ShippingMethod>}
|
|
391
409
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
392
410
|
*/
|
|
393
|
-
shippingMethodsGet(id: string): Promise<Models.
|
|
411
|
+
shippingMethodsGet(id: string): Promise<Models.ShippingMethod>;
|
|
394
412
|
/**
|
|
395
413
|
* A shipping method is the line a buyer picks in the checkout: a pricing model ('fixed', 'free' or 'matrix'), the countries it may be offered into, a free-above threshold, and the carrier it ships with. The method owns the PRICE; the delivery promise — tracking template, cut-off, handling and transit days — is inherited from the carrier wherever the method states none of its own. A partial update — send only what changes, whether that is taking the method in or out of the checkout, its pricing, the countries it is restricted to or the delivery estimate it states of its own; a payload carrying no column at all is refused rather than answering a row it did not touch. Flipping `enabled` is what puts the method in front of a buyer or takes it away, and a disabled method is reported in the rate answer's `excluded` rather than hidden. Changing `pricing_type` away from 'matrix' does NOT delete the tier table — it stops being read, and changing back reinstates the old prices, so a method switched to 'fixed' and back quotes what it quoted before. Two rows of this tenant may not share `code` — that is the 409.
|
|
396
414
|
*
|
|
@@ -416,7 +434,7 @@ declare class ShippingMethods {
|
|
|
416
434
|
* @param {number} params.quoteAbove - Above this MATRIX MEASURE the method carries no automatic price: it is still offered, flagged `quote_required` with a reason, and the storefront shows 'shipping on request'. For bulky or overweight freight priced by hand. Null = every measure is priced automatically.
|
|
417
435
|
* @param {string} params.taxClass - This method's own tax class, as a CODE into the buyer market's tax classes (markets.tax_classes) — never a rate. First step of the tax chain: unset falls back to the tenant's shipping_tax_class setting, then the market default. Not a foreign key and it could not be (ADR-0055); GET /shipping/tax-classes/{code}/usage is the integrity question markets asks in its place.
|
|
418
436
|
* @throws {RevenexxException}
|
|
419
|
-
* @returns {Promise<Models.
|
|
437
|
+
* @returns {Promise<Models.ShippingMethod>}
|
|
420
438
|
*/
|
|
421
439
|
shippingMethodsUpdate(params: {
|
|
422
440
|
id: string;
|
|
@@ -440,7 +458,7 @@ declare class ShippingMethods {
|
|
|
440
458
|
pricingType?: ShippingMethodPricingType;
|
|
441
459
|
quoteAbove?: number;
|
|
442
460
|
taxClass?: string;
|
|
443
|
-
}): Promise<Models.
|
|
461
|
+
}): Promise<Models.ShippingMethod>;
|
|
444
462
|
/**
|
|
445
463
|
* A shipping method is the line a buyer picks in the checkout: a pricing model ('fixed', 'free' or 'matrix'), the countries it may be offered into, a free-above threshold, and the carrier it ships with. The method owns the PRICE; the delivery promise — tracking template, cut-off, handling and transit days — is inherited from the carrier wherever the method states none of its own. A partial update — send only what changes, whether that is taking the method in or out of the checkout, its pricing, the countries it is restricted to or the delivery estimate it states of its own; a payload carrying no column at all is refused rather than answering a row it did not touch. Flipping `enabled` is what puts the method in front of a buyer or takes it away, and a disabled method is reported in the rate answer's `excluded` rather than hidden. Changing `pricing_type` away from 'matrix' does NOT delete the tier table — it stops being read, and changing back reinstates the old prices, so a method switched to 'fixed' and back quotes what it quoted before. Two rows of this tenant may not share `code` — that is the 409.
|
|
446
464
|
*
|
|
@@ -466,10 +484,10 @@ declare class ShippingMethods {
|
|
|
466
484
|
* @param {number} quoteAbove - Above this MATRIX MEASURE the method carries no automatic price: it is still offered, flagged `quote_required` with a reason, and the storefront shows 'shipping on request'. For bulky or overweight freight priced by hand. Null = every measure is priced automatically.
|
|
467
485
|
* @param {string} taxClass - This method's own tax class, as a CODE into the buyer market's tax classes (markets.tax_classes) — never a rate. First step of the tax chain: unset falls back to the tenant's shipping_tax_class setting, then the market default. Not a foreign key and it could not be (ADR-0055); GET /shipping/tax-classes/{code}/usage is the integrity question markets asks in its place.
|
|
468
486
|
* @throws {RevenexxException}
|
|
469
|
-
* @returns {Promise<Models.
|
|
487
|
+
* @returns {Promise<Models.ShippingMethod>}
|
|
470
488
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
471
489
|
*/
|
|
472
|
-
shippingMethodsUpdate(id: string, carrier?: string, carrierId?: string, code?: string, countries?: string[], currency?: string, description?: string, enabled?: boolean, etaDaysMax?: number, etaDaysMin?: number, freeAbove?: number, labels?: object, matrixAttribute?: string, matrixBasis?: ShippingMethodMatrixBasis, metadata?: object, name?: string, position?: number, price?: number, pricingType?: ShippingMethodPricingType, quoteAbove?: number, taxClass?: string): Promise<Models.
|
|
490
|
+
shippingMethodsUpdate(id: string, carrier?: string, carrierId?: string, code?: string, countries?: string[], currency?: string, description?: string, enabled?: boolean, etaDaysMax?: number, etaDaysMin?: number, freeAbove?: number, labels?: object, matrixAttribute?: string, matrixBasis?: ShippingMethodMatrixBasis, metadata?: object, name?: string, position?: number, price?: number, pricingType?: ShippingMethodPricingType, quoteAbove?: number, taxClass?: string): Promise<Models.ShippingMethod>;
|
|
473
491
|
/**
|
|
474
492
|
* The rate matrix of one method — every `from_value` threshold with the price charged at or above it — lowest threshold first. Filterable by `?from_value=` — the unique index is (tenant_id, method_id, from_value), so that addresses one row of the matrix by the threshold it prices rather than by an id a bulk replace has already discarded. The applied filters are echoed in `filter`, which always carries the `method_id` taken from the path.
|
|
475
493
|
*
|
|
@@ -479,7 +497,7 @@ declare class ShippingMethods {
|
|
|
479
497
|
* @param {string} params.order - Sort as 'column.asc' | 'column.desc' — a bare 'column' sorts ascending. The column must be one this entity has; anything else is a 400 from the data plane.
|
|
480
498
|
* @param {number} params.fromValue - Exact-match filter on `from_value`. The tier at exactly this threshold. (tenant_id, method_id, from_value) is unique, so this addresses one row of the matrix by what it MEANS rather than by an id a bulk replace has already thrown away.
|
|
481
499
|
* @throws {RevenexxException}
|
|
482
|
-
* @returns {Promise<
|
|
500
|
+
* @returns {Promise<{}>}
|
|
483
501
|
*/
|
|
484
502
|
shippingTiersList(params: {
|
|
485
503
|
methodId: string;
|
|
@@ -487,7 +505,7 @@ declare class ShippingMethods {
|
|
|
487
505
|
offset?: number;
|
|
488
506
|
order?: string;
|
|
489
507
|
fromValue?: number;
|
|
490
|
-
}): Promise<
|
|
508
|
+
}): Promise<{}>;
|
|
491
509
|
/**
|
|
492
510
|
* The rate matrix of one method — every `from_value` threshold with the price charged at or above it — lowest threshold first. Filterable by `?from_value=` — the unique index is (tenant_id, method_id, from_value), so that addresses one row of the matrix by the threshold it prices rather than by an id a bulk replace has already discarded. The applied filters are echoed in `filter`, which always carries the `method_id` taken from the path.
|
|
493
511
|
*
|
|
@@ -497,10 +515,10 @@ declare class ShippingMethods {
|
|
|
497
515
|
* @param {string} order - Sort as 'column.asc' | 'column.desc' — a bare 'column' sorts ascending. The column must be one this entity has; anything else is a 400 from the data plane.
|
|
498
516
|
* @param {number} fromValue - Exact-match filter on `from_value`. The tier at exactly this threshold. (tenant_id, method_id, from_value) is unique, so this addresses one row of the matrix by what it MEANS rather than by an id a bulk replace has already thrown away.
|
|
499
517
|
* @throws {RevenexxException}
|
|
500
|
-
* @returns {Promise<
|
|
518
|
+
* @returns {Promise<{}>}
|
|
501
519
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
502
520
|
*/
|
|
503
|
-
shippingTiersList(methodId: string, limit?: number, offset?: number, order?: string, fromValue?: number): Promise<
|
|
521
|
+
shippingTiersList(methodId: string, limit?: number, offset?: number, order?: string, fromValue?: number): Promise<{}>;
|
|
504
522
|
/**
|
|
505
523
|
* A rate tier is one row of a matrix method's price table: a `from_value` threshold and the price charged at or above it. The bound is INCLUSIVE and the winning tier is the one with the highest `from_value` at or below the measured value, so a measure of exactly 10 is priced by the tier at 10. What the number measures is the method's `matrix_basis` — kilograms in the market's own weight unit, items, money in the method's currency, or a named attribute — and the last tier has no upper bound. This adds ONE row to the table of the method in the path, leaving the rest alone — the edit for a merchant who has added a heavier bracket. To lay a whole table down at once use PUT …/tiers (set semantics) or POST …/tiers/ladder (evenly stepped), and note that both of those DISCARD the ids of the rows they replace. Two rows of this tenant may not share the combination of `method_id` + `from_value` — that is the 409. `method_id` is taken from the path on every write, so a body naming a different method is ignored rather than obeyed.
|
|
506
524
|
*
|
|
@@ -509,14 +527,14 @@ declare class ShippingMethods {
|
|
|
509
527
|
* @param {number} params.position - Display order in the matrix editor (default 0; a bulk replace derives it from the array index). Pricing reads from_value, never this.
|
|
510
528
|
* @param {number} params.price - What this tier costs, in the method's currency. Charged in full for the whole consignment — a matrix is a lookup table, not a rate per unit. Defaults to 0.
|
|
511
529
|
* @throws {RevenexxException}
|
|
512
|
-
* @returns {Promise<Models.
|
|
530
|
+
* @returns {Promise<Models.ShippingRateTier>}
|
|
513
531
|
*/
|
|
514
532
|
shippingTiersCreate(params: {
|
|
515
533
|
methodId: string;
|
|
516
534
|
fromValue?: number;
|
|
517
535
|
position?: number;
|
|
518
536
|
price?: number;
|
|
519
|
-
}): Promise<Models.
|
|
537
|
+
}): Promise<Models.ShippingRateTier>;
|
|
520
538
|
/**
|
|
521
539
|
* A rate tier is one row of a matrix method's price table: a `from_value` threshold and the price charged at or above it. The bound is INCLUSIVE and the winning tier is the one with the highest `from_value` at or below the measured value, so a measure of exactly 10 is priced by the tier at 10. What the number measures is the method's `matrix_basis` — kilograms in the market's own weight unit, items, money in the method's currency, or a named attribute — and the last tier has no upper bound. This adds ONE row to the table of the method in the path, leaving the rest alone — the edit for a merchant who has added a heavier bracket. To lay a whole table down at once use PUT …/tiers (set semantics) or POST …/tiers/ladder (evenly stepped), and note that both of those DISCARD the ids of the rows they replace. Two rows of this tenant may not share the combination of `method_id` + `from_value` — that is the 409. `method_id` is taken from the path on every write, so a body naming a different method is ignored rather than obeyed.
|
|
522
540
|
*
|
|
@@ -525,32 +543,32 @@ declare class ShippingMethods {
|
|
|
525
543
|
* @param {number} position - Display order in the matrix editor (default 0; a bulk replace derives it from the array index). Pricing reads from_value, never this.
|
|
526
544
|
* @param {number} price - What this tier costs, in the method's currency. Charged in full for the whole consignment — a matrix is a lookup table, not a rate per unit. Defaults to 0.
|
|
527
545
|
* @throws {RevenexxException}
|
|
528
|
-
* @returns {Promise<Models.
|
|
546
|
+
* @returns {Promise<Models.ShippingRateTier>}
|
|
529
547
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
530
548
|
*/
|
|
531
|
-
shippingTiersCreate(methodId: string, fromValue?: number, position?: number, price?: number): Promise<Models.
|
|
549
|
+
shippingTiersCreate(methodId: string, fromValue?: number, position?: number, price?: number): Promise<Models.ShippingRateTier>;
|
|
532
550
|
/**
|
|
533
551
|
* The write behind a table editor: a merchant edits the whole matrix on screen and saves it in one call, rather than diffing it into a row added here and a row deleted there. Set semantics, and it replaces EVERY tier the method had: the tiers this method has afterwards are exactly the ones handed in, positions derived from the array order. An empty `tiers` array clears the table — and a matrix method with no tiers quotes nothing, with a reason.
|
|
534
552
|
*
|
|
535
553
|
* @param {string} params.methodId - The shipping method these tiers belong to. A method this tenant does not have is a 404, never an empty page.
|
|
536
554
|
* @param {Models.ShippingRateTierReplaceItem[]} params.tiers - The complete new tier set (set semantics) — positions are derived from the array order. An empty array clears the matrix, and a matrix method with no tiers quotes nothing.
|
|
537
555
|
* @throws {RevenexxException}
|
|
538
|
-
* @returns {Promise<
|
|
556
|
+
* @returns {Promise<{}>}
|
|
539
557
|
*/
|
|
540
558
|
shippingTiersReplace(params: {
|
|
541
559
|
methodId: string;
|
|
542
560
|
tiers: Models.ShippingRateTierReplaceItem[];
|
|
543
|
-
}): Promise<
|
|
561
|
+
}): Promise<{}>;
|
|
544
562
|
/**
|
|
545
563
|
* The write behind a table editor: a merchant edits the whole matrix on screen and saves it in one call, rather than diffing it into a row added here and a row deleted there. Set semantics, and it replaces EVERY tier the method had: the tiers this method has afterwards are exactly the ones handed in, positions derived from the array order. An empty `tiers` array clears the table — and a matrix method with no tiers quotes nothing, with a reason.
|
|
546
564
|
*
|
|
547
565
|
* @param {string} methodId - The shipping method these tiers belong to. A method this tenant does not have is a 404, never an empty page.
|
|
548
566
|
* @param {Models.ShippingRateTierReplaceItem[]} tiers - The complete new tier set (set semantics) — positions are derived from the array order. An empty array clears the matrix, and a matrix method with no tiers quotes nothing.
|
|
549
567
|
* @throws {RevenexxException}
|
|
550
|
-
* @returns {Promise<
|
|
568
|
+
* @returns {Promise<{}>}
|
|
551
569
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
552
570
|
*/
|
|
553
|
-
shippingTiersReplace(methodId: string, tiers: Models.ShippingRateTierReplaceItem[]): Promise<
|
|
571
|
+
shippingTiersReplace(methodId: string, tiers: Models.ShippingRateTierReplaceItem[]): Promise<{}>;
|
|
554
572
|
/**
|
|
555
573
|
* The tier table a merchant describes in words — "0 to 30 kg, every 5 kg, €4.90 plus €2 a step" — without typing every row. Replaces the method's tiers by default (set replace=false to append).
|
|
556
574
|
*
|
|
@@ -562,7 +580,7 @@ declare class ShippingMethods {
|
|
|
562
580
|
* @param {boolean} params.replace - Replace the whole table (default true) or append to it.
|
|
563
581
|
* @param {number} params.stepPrice - Added to each subsequent tier (default 0). A negative value is allowed as long as no tier ends up below 0.
|
|
564
582
|
* @throws {RevenexxException}
|
|
565
|
-
* @returns {Promise<
|
|
583
|
+
* @returns {Promise<{}>}
|
|
566
584
|
*/
|
|
567
585
|
shippingTiersLadder(params: {
|
|
568
586
|
methodId: string;
|
|
@@ -572,7 +590,7 @@ declare class ShippingMethods {
|
|
|
572
590
|
fromValue?: number;
|
|
573
591
|
replace?: boolean;
|
|
574
592
|
stepPrice?: number;
|
|
575
|
-
}): Promise<
|
|
593
|
+
}): Promise<{}>;
|
|
576
594
|
/**
|
|
577
595
|
* The tier table a merchant describes in words — "0 to 30 kg, every 5 kg, €4.90 plus €2 a step" — without typing every row. Replaces the method's tiers by default (set replace=false to append).
|
|
578
596
|
*
|
|
@@ -584,54 +602,54 @@ declare class ShippingMethods {
|
|
|
584
602
|
* @param {boolean} replace - Replace the whole table (default true) or append to it.
|
|
585
603
|
* @param {number} stepPrice - Added to each subsequent tier (default 0). A negative value is allowed as long as no tier ends up below 0.
|
|
586
604
|
* @throws {RevenexxException}
|
|
587
|
-
* @returns {Promise<
|
|
605
|
+
* @returns {Promise<{}>}
|
|
588
606
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
589
607
|
*/
|
|
590
|
-
shippingTiersLadder(methodId: string, basePrice: number, step: number, toValue: number, fromValue?: number, replace?: boolean, stepPrice?: number): Promise<
|
|
608
|
+
shippingTiersLadder(methodId: string, basePrice: number, step: number, toValue: number, fromValue?: number, replace?: boolean, stepPrice?: number): Promise<{}>;
|
|
591
609
|
/**
|
|
592
610
|
* A rate tier is one row of a matrix method's price table: a `from_value` threshold and the price charged at or above it. The bound is INCLUSIVE and the winning tier is the one with the highest `from_value` at or below the measured value, so a measure of exactly 10 is priced by the tier at 10. What the number measures is the method's `matrix_basis` — kilograms in the market's own weight unit, items, money in the method's currency, or a named attribute — and the last tier has no upper bound. Removing a tier in the MIDDLE of a table is harmless — the measures it used to cover fall to the highest remaining threshold below them. Removing the LOWEST one is not: a measure under the new lowest threshold matches no tier at all, and the method is then left out of POST /shipping/rates with 'no tier covers measure …' instead of being quoted at 0, so an entire band of baskets silently stops being offered this method. Deleting the last tier takes the method out of the checkout altogether. Rebuilding the table wholesale is PUT …/tiers or POST …/tiers/ladder; deleting the method deletes its tiers on its own.
|
|
593
611
|
*
|
|
594
612
|
* @param {string} params.methodId - The shipping method these tiers belong to. A method this tenant does not have is a 404, never an empty page.
|
|
595
613
|
* @param {string} params.id - The row id.
|
|
596
614
|
* @throws {RevenexxException}
|
|
597
|
-
* @returns {Promise<
|
|
615
|
+
* @returns {Promise<{}>}
|
|
598
616
|
*/
|
|
599
617
|
shippingTiersDelete(params: {
|
|
600
618
|
methodId: string;
|
|
601
619
|
id: string;
|
|
602
|
-
}): Promise<
|
|
620
|
+
}): Promise<{}>;
|
|
603
621
|
/**
|
|
604
622
|
* A rate tier is one row of a matrix method's price table: a `from_value` threshold and the price charged at or above it. The bound is INCLUSIVE and the winning tier is the one with the highest `from_value` at or below the measured value, so a measure of exactly 10 is priced by the tier at 10. What the number measures is the method's `matrix_basis` — kilograms in the market's own weight unit, items, money in the method's currency, or a named attribute — and the last tier has no upper bound. Removing a tier in the MIDDLE of a table is harmless — the measures it used to cover fall to the highest remaining threshold below them. Removing the LOWEST one is not: a measure under the new lowest threshold matches no tier at all, and the method is then left out of POST /shipping/rates with 'no tier covers measure …' instead of being quoted at 0, so an entire band of baskets silently stops being offered this method. Deleting the last tier takes the method out of the checkout altogether. Rebuilding the table wholesale is PUT …/tiers or POST …/tiers/ladder; deleting the method deletes its tiers on its own.
|
|
605
623
|
*
|
|
606
624
|
* @param {string} methodId - The shipping method these tiers belong to. A method this tenant does not have is a 404, never an empty page.
|
|
607
625
|
* @param {string} id - The row id.
|
|
608
626
|
* @throws {RevenexxException}
|
|
609
|
-
* @returns {Promise<
|
|
627
|
+
* @returns {Promise<{}>}
|
|
610
628
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
611
629
|
*/
|
|
612
|
-
shippingTiersDelete(methodId: string, id: string): Promise<
|
|
630
|
+
shippingTiersDelete(methodId: string, id: string): Promise<{}>;
|
|
613
631
|
/**
|
|
614
632
|
* A rate tier is one row of a matrix method's price table: a `from_value` threshold and the price charged at or above it. The bound is INCLUSIVE and the winning tier is the one with the highest `from_value` at or below the measured value, so a measure of exactly 10 is priced by the tier at 10. What the number measures is the method's `matrix_basis` — kilograms in the market's own weight unit, items, money in the method's currency, or a named attribute — and the last tier has no upper bound. This reads one row of that table by id, under the method that owns it; a tier id belonging to another method is a 404 rather than somebody else's price. A tier id is not durable: PUT …/tiers and POST …/tiers/ladder replace the table by deleting and recreating it, so an id read before either of them names nothing afterwards. Where a caller wants a stable handle, address the row by what it MEANS — GET …/tiers?from_value=… — since (method_id, from_value) is unique.
|
|
615
633
|
*
|
|
616
634
|
* @param {string} params.methodId - The shipping method these tiers belong to. A method this tenant does not have is a 404, never an empty page.
|
|
617
635
|
* @param {string} params.id - The row id.
|
|
618
636
|
* @throws {RevenexxException}
|
|
619
|
-
* @returns {Promise<Models.
|
|
637
|
+
* @returns {Promise<Models.ShippingRateTier>}
|
|
620
638
|
*/
|
|
621
639
|
shippingTiersGet(params: {
|
|
622
640
|
methodId: string;
|
|
623
641
|
id: string;
|
|
624
|
-
}): Promise<Models.
|
|
642
|
+
}): Promise<Models.ShippingRateTier>;
|
|
625
643
|
/**
|
|
626
644
|
* A rate tier is one row of a matrix method's price table: a `from_value` threshold and the price charged at or above it. The bound is INCLUSIVE and the winning tier is the one with the highest `from_value` at or below the measured value, so a measure of exactly 10 is priced by the tier at 10. What the number measures is the method's `matrix_basis` — kilograms in the market's own weight unit, items, money in the method's currency, or a named attribute — and the last tier has no upper bound. This reads one row of that table by id, under the method that owns it; a tier id belonging to another method is a 404 rather than somebody else's price. A tier id is not durable: PUT …/tiers and POST …/tiers/ladder replace the table by deleting and recreating it, so an id read before either of them names nothing afterwards. Where a caller wants a stable handle, address the row by what it MEANS — GET …/tiers?from_value=… — since (method_id, from_value) is unique.
|
|
627
645
|
*
|
|
628
646
|
* @param {string} methodId - The shipping method these tiers belong to. A method this tenant does not have is a 404, never an empty page.
|
|
629
647
|
* @param {string} id - The row id.
|
|
630
648
|
* @throws {RevenexxException}
|
|
631
|
-
* @returns {Promise<Models.
|
|
649
|
+
* @returns {Promise<Models.ShippingRateTier>}
|
|
632
650
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
633
651
|
*/
|
|
634
|
-
shippingTiersGet(methodId: string, id: string): Promise<Models.
|
|
652
|
+
shippingTiersGet(methodId: string, id: string): Promise<Models.ShippingRateTier>;
|
|
635
653
|
/**
|
|
636
654
|
* A tier id is not stable across a bulk edit: `PUT …/tiers` and `POST …/tiers/ladder` replace the table by deleting and recreating it, so an id read before either of them is gone afterwards.
|
|
637
655
|
*
|
|
@@ -641,7 +659,7 @@ declare class ShippingMethods {
|
|
|
641
659
|
* @param {number} params.position - Display order in the matrix editor (default 0; a bulk replace derives it from the array index). Pricing reads from_value, never this.
|
|
642
660
|
* @param {number} params.price - What this tier costs, in the method's currency. Charged in full for the whole consignment — a matrix is a lookup table, not a rate per unit. Defaults to 0.
|
|
643
661
|
* @throws {RevenexxException}
|
|
644
|
-
* @returns {Promise<Models.
|
|
662
|
+
* @returns {Promise<Models.ShippingRateTier>}
|
|
645
663
|
*/
|
|
646
664
|
shippingTiersUpdate(params: {
|
|
647
665
|
methodId: string;
|
|
@@ -649,7 +667,7 @@ declare class ShippingMethods {
|
|
|
649
667
|
fromValue?: number;
|
|
650
668
|
position?: number;
|
|
651
669
|
price?: number;
|
|
652
|
-
}): Promise<Models.
|
|
670
|
+
}): Promise<Models.ShippingRateTier>;
|
|
653
671
|
/**
|
|
654
672
|
* A tier id is not stable across a bulk edit: `PUT …/tiers` and `POST …/tiers/ladder` replace the table by deleting and recreating it, so an id read before either of them is gone afterwards.
|
|
655
673
|
*
|
|
@@ -659,10 +677,10 @@ declare class ShippingMethods {
|
|
|
659
677
|
* @param {number} position - Display order in the matrix editor (default 0; a bulk replace derives it from the array index). Pricing reads from_value, never this.
|
|
660
678
|
* @param {number} price - What this tier costs, in the method's currency. Charged in full for the whole consignment — a matrix is a lookup table, not a rate per unit. Defaults to 0.
|
|
661
679
|
* @throws {RevenexxException}
|
|
662
|
-
* @returns {Promise<Models.
|
|
680
|
+
* @returns {Promise<Models.ShippingRateTier>}
|
|
663
681
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
664
682
|
*/
|
|
665
|
-
shippingTiersUpdate(methodId: string, id: string, fromValue?: number, position?: number, price?: number): Promise<Models.
|
|
683
|
+
shippingTiersUpdate(methodId: string, id: string, fromValue?: number, position?: number, price?: number): Promise<Models.ShippingRateTier>;
|
|
666
684
|
/**
|
|
667
685
|
* The question a checkout asks, and the only route that answers a PRICE. Hand in the buyer context — the destination country, the order value, and whatever the matrix methods measure: a weight, a quantity or a named product attribute — and this comes back with the methods that may be offered and what each of them costs, free-above thresholds, country restrictions, the carrier's delivery promise and tax already applied. A method that does not apply is never an error: it moves to `excluded` with a reason. So is a tax rate that cannot be resolved — `tax.resolved: false` means the rates are UNKNOWN, not untaxed.
|
|
668
686
|
*
|
|
@@ -678,7 +696,7 @@ declare class ShippingMethods {
|
|
|
678
696
|
* @param {number} params.weight - Total weight — measure for weight matrices. Read in weight_unit and converted to the unit the tiers are keyed in.
|
|
679
697
|
* @param {string} params.weightUnit - The unit `weight` is expressed in, as a CODE into the tenant's own weight units (GET /shipping/weight-units). Omitted, it is the unit this market quotes in. A unit the tenant does not keep is a 400 — a mis-read weight prices the wrong bracket silently, and guessing is worse than refusing.
|
|
680
698
|
* @throws {RevenexxException}
|
|
681
|
-
* @returns {Promise<
|
|
699
|
+
* @returns {Promise<{}>}
|
|
682
700
|
*/
|
|
683
701
|
shippingRates(params?: {
|
|
684
702
|
at?: string;
|
|
@@ -692,7 +710,7 @@ declare class ShippingMethods {
|
|
|
692
710
|
quantity?: number;
|
|
693
711
|
weight?: number;
|
|
694
712
|
weightUnit?: string;
|
|
695
|
-
}): Promise<
|
|
713
|
+
}): Promise<{}>;
|
|
696
714
|
/**
|
|
697
715
|
* The question a checkout asks, and the only route that answers a PRICE. Hand in the buyer context — the destination country, the order value, and whatever the matrix methods measure: a weight, a quantity or a named product attribute — and this comes back with the methods that may be offered and what each of them costs, free-above thresholds, country restrictions, the carrier's delivery promise and tax already applied. A method that does not apply is never an error: it moves to `excluded` with a reason. So is a tax rate that cannot be resolved — `tax.resolved: false` means the rates are UNKNOWN, not untaxed.
|
|
698
716
|
*
|
|
@@ -708,10 +726,10 @@ declare class ShippingMethods {
|
|
|
708
726
|
* @param {number} weight - Total weight — measure for weight matrices. Read in weight_unit and converted to the unit the tiers are keyed in.
|
|
709
727
|
* @param {string} weightUnit - The unit `weight` is expressed in, as a CODE into the tenant's own weight units (GET /shipping/weight-units). Omitted, it is the unit this market quotes in. A unit the tenant does not keep is a 400 — a mis-read weight prices the wrong bracket silently, and guessing is worse than refusing.
|
|
710
728
|
* @throws {RevenexxException}
|
|
711
|
-
* @returns {Promise<
|
|
729
|
+
* @returns {Promise<{}>}
|
|
712
730
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
713
731
|
*/
|
|
714
|
-
shippingRates(at?: string, attributes?: object, country?: string, currency?: string, marketId?: string, orderValue?: number, orderValueGross?: number, orderValueNet?: number, quantity?: number, weight?: number, weightUnit?: string): Promise<
|
|
732
|
+
shippingRates(at?: string, attributes?: object, country?: string, currency?: string, marketId?: string, orderValue?: number, orderValueGross?: number, orderValueNet?: number, quantity?: number, weight?: number, weightUnit?: string): Promise<{}>;
|
|
715
733
|
/**
|
|
716
734
|
* markets.tax_classes is the source of record for the rate and this app points at it by CODE from two places: a method's own tax_class and the tenant's shipping_tax_class fallback. Neither is a foreign key and neither could be — a cross-app FK is what ADR-0055 forbids — so integrity is a question one app asks the other, and this is the answering half. It is asked before a destructive edit: markets calls it when an operator tries to delete a tax class, and a count above zero is what stops the delete rather than leaving these methods pointing at a code nobody serves. Matched as a CODE, not a row: a tax class is unique per market, so 'reduced' may exist in several and a method naming it does not say which one it meant. Reports at most 500 methods and names the first 20. Every code answers, used or not — a code nobody points at is `in_use: false`, never a 404.
|
|
717
735
|
*
|