@revenexx/node 0.1.0 → 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -0
- package/dist/client.d.mts +25 -0
- package/dist/client.d.ts +25 -0
- package/dist/client.js +39 -18
- package/dist/client.js.map +1 -1
- package/dist/client.mjs +35 -14
- package/dist/client.mjs.map +1 -1
- package/dist/enums/approval-rule-approver-type.d.mts +7 -0
- package/dist/enums/approval-rule-approver-type.d.ts +7 -0
- package/dist/enums/approval-rule-approver-type.js +12 -0
- package/dist/enums/approval-rule-approver-type.js.map +1 -0
- package/dist/enums/approval-rule-approver-type.mjs +11 -0
- package/dist/enums/approval-rule-approver-type.mjs.map +1 -0
- package/dist/enums/approval-rule-condition.d.mts +10 -0
- package/dist/enums/approval-rule-condition.d.ts +10 -0
- package/dist/enums/approval-rule-condition.js +15 -0
- package/dist/enums/approval-rule-condition.js.map +1 -0
- package/dist/enums/approval-rule-condition.mjs +14 -0
- package/dist/enums/approval-rule-condition.mjs.map +1 -0
- package/dist/enums/approval-rule-create-request-approver-type.d.mts +7 -0
- package/dist/enums/approval-rule-create-request-approver-type.d.ts +7 -0
- package/dist/enums/approval-rule-create-request-approver-type.js +12 -0
- package/dist/enums/approval-rule-create-request-approver-type.js.map +1 -0
- package/dist/enums/approval-rule-create-request-approver-type.mjs +11 -0
- package/dist/enums/approval-rule-create-request-approver-type.mjs.map +1 -0
- package/dist/enums/approval-rule-create-request-condition.d.mts +10 -0
- package/dist/enums/approval-rule-create-request-condition.d.ts +10 -0
- package/dist/enums/approval-rule-create-request-condition.js +15 -0
- package/dist/enums/approval-rule-create-request-condition.js.map +1 -0
- package/dist/enums/approval-rule-create-request-condition.mjs +14 -0
- package/dist/enums/approval-rule-create-request-condition.mjs.map +1 -0
- package/dist/enums/approval-rule-create-request-effect.d.mts +7 -0
- package/dist/enums/approval-rule-create-request-effect.d.ts +7 -0
- package/dist/enums/approval-rule-create-request-effect.js +12 -0
- package/dist/enums/approval-rule-create-request-effect.js.map +1 -0
- package/dist/enums/approval-rule-create-request-effect.mjs +11 -0
- package/dist/enums/approval-rule-create-request-effect.mjs.map +1 -0
- package/dist/enums/approval-rule-effect.d.mts +7 -0
- package/dist/enums/approval-rule-effect.d.ts +7 -0
- package/dist/enums/approval-rule-effect.js +12 -0
- package/dist/enums/approval-rule-effect.js.map +1 -0
- package/dist/enums/approval-rule-effect.mjs +11 -0
- package/dist/enums/approval-rule-effect.mjs.map +1 -0
- package/dist/enums/approval-rule-update-request-approver-type.d.mts +7 -0
- package/dist/enums/approval-rule-update-request-approver-type.d.ts +7 -0
- package/dist/enums/approval-rule-update-request-approver-type.js +12 -0
- package/dist/enums/approval-rule-update-request-approver-type.js.map +1 -0
- package/dist/enums/approval-rule-update-request-approver-type.mjs +11 -0
- package/dist/enums/approval-rule-update-request-approver-type.mjs.map +1 -0
- package/dist/enums/approval-rule-update-request-condition.d.mts +10 -0
- package/dist/enums/approval-rule-update-request-condition.d.ts +10 -0
- package/dist/enums/approval-rule-update-request-condition.js +15 -0
- package/dist/enums/approval-rule-update-request-condition.js.map +1 -0
- package/dist/enums/approval-rule-update-request-condition.mjs +14 -0
- package/dist/enums/approval-rule-update-request-condition.mjs.map +1 -0
- package/dist/enums/approval-rule-update-request-effect.d.mts +7 -0
- package/dist/enums/approval-rule-update-request-effect.d.ts +7 -0
- package/dist/enums/approval-rule-update-request-effect.js +12 -0
- package/dist/enums/approval-rule-update-request-effect.js.map +1 -0
- package/dist/enums/approval-rule-update-request-effect.mjs +11 -0
- package/dist/enums/approval-rule-update-request-effect.mjs.map +1 -0
- package/dist/enums/approver-type.d.mts +7 -0
- package/dist/enums/approver-type.d.ts +7 -0
- package/dist/enums/approver-type.js +12 -0
- package/dist/enums/approver-type.js.map +1 -0
- package/dist/enums/approver-type.mjs +11 -0
- package/dist/enums/approver-type.mjs.map +1 -0
- package/dist/enums/condition.d.mts +10 -0
- package/dist/enums/condition.d.ts +10 -0
- package/dist/enums/condition.js +15 -0
- package/dist/enums/condition.js.map +1 -0
- package/dist/enums/condition.mjs +14 -0
- package/dist/enums/condition.mjs.map +1 -0
- package/dist/enums/effect.d.mts +7 -0
- package/dist/enums/effect.d.ts +7 -0
- package/dist/enums/effect.js +12 -0
- package/dist/enums/effect.js.map +1 -0
- package/dist/enums/effect.mjs +11 -0
- package/dist/enums/effect.mjs.map +1 -0
- package/dist/enums/pending-approval-approver-type.d.mts +7 -0
- package/dist/enums/pending-approval-approver-type.d.ts +7 -0
- package/dist/enums/pending-approval-approver-type.js +12 -0
- package/dist/enums/pending-approval-approver-type.js.map +1 -0
- package/dist/enums/pending-approval-approver-type.mjs +11 -0
- package/dist/enums/pending-approval-approver-type.mjs.map +1 -0
- package/dist/enums/pending-approval-status.d.mts +7 -0
- package/dist/enums/pending-approval-status.d.ts +7 -0
- package/dist/enums/pending-approval-status.js +12 -0
- package/dist/enums/pending-approval-status.js.map +1 -0
- package/dist/enums/pending-approval-status.mjs +11 -0
- package/dist/enums/pending-approval-status.mjs.map +1 -0
- package/dist/enums/procurement-purchase-request-items-create-type.d.mts +7 -0
- package/dist/enums/procurement-purchase-request-items-create-type.d.ts +7 -0
- package/dist/enums/procurement-purchase-request-items-create-type.js +12 -0
- package/dist/enums/procurement-purchase-request-items-create-type.js.map +1 -0
- package/dist/enums/procurement-purchase-request-items-create-type.mjs +11 -0
- package/dist/enums/procurement-purchase-request-items-create-type.mjs.map +1 -0
- package/dist/enums/purchase-request-event-name.d.mts +12 -0
- package/dist/enums/purchase-request-event-name.d.ts +12 -0
- package/dist/enums/purchase-request-event-name.js +17 -0
- package/dist/enums/purchase-request-event-name.js.map +1 -0
- package/dist/enums/purchase-request-event-name.mjs +16 -0
- package/dist/enums/purchase-request-event-name.mjs.map +1 -0
- package/dist/enums/purchase-request-item-create-request-type.d.mts +7 -0
- package/dist/enums/purchase-request-item-create-request-type.d.ts +7 -0
- package/dist/enums/purchase-request-item-create-request-type.js +12 -0
- package/dist/enums/purchase-request-item-create-request-type.js.map +1 -0
- package/dist/enums/purchase-request-item-create-request-type.mjs +11 -0
- package/dist/enums/purchase-request-item-create-request-type.mjs.map +1 -0
- package/dist/enums/purchase-request-item-type.d.mts +7 -0
- package/dist/enums/purchase-request-item-type.d.ts +7 -0
- package/dist/enums/purchase-request-item-type.js +12 -0
- package/dist/enums/purchase-request-item-type.js.map +1 -0
- package/dist/enums/purchase-request-item-type.mjs +11 -0
- package/dist/enums/purchase-request-item-type.mjs.map +1 -0
- package/dist/enums/purchase-request-item-update-request-type.d.mts +7 -0
- package/dist/enums/purchase-request-item-update-request-type.d.ts +7 -0
- package/dist/enums/purchase-request-item-update-request-type.js +12 -0
- package/dist/enums/purchase-request-item-update-request-type.js.map +1 -0
- package/dist/enums/purchase-request-item-update-request-type.mjs +11 -0
- package/dist/enums/purchase-request-item-update-request-type.mjs.map +1 -0
- package/dist/enums/purchase-request-status.d.mts +9 -0
- package/dist/enums/purchase-request-status.d.ts +9 -0
- package/dist/enums/purchase-request-status.js +14 -0
- package/dist/enums/purchase-request-status.js.map +1 -0
- package/dist/enums/purchase-request-status.mjs +13 -0
- package/dist/enums/purchase-request-status.mjs.map +1 -0
- package/dist/enums/submit-item-type.d.mts +7 -0
- package/dist/enums/submit-item-type.d.ts +7 -0
- package/dist/enums/submit-item-type.js +12 -0
- package/dist/enums/submit-item-type.js.map +1 -0
- package/dist/enums/submit-item-type.mjs +11 -0
- package/dist/enums/submit-item-type.mjs.map +1 -0
- package/dist/enums/submit-result-outcome.d.mts +9 -0
- package/dist/enums/submit-result-outcome.d.ts +9 -0
- package/dist/enums/submit-result-outcome.js +14 -0
- package/dist/enums/submit-result-outcome.js.map +1 -0
- package/dist/enums/submit-result-outcome.mjs +13 -0
- package/dist/enums/submit-result-outcome.mjs.map +1 -0
- package/dist/index.d.mts +23 -0
- package/dist/index.d.ts +23 -0
- package/dist/index.js +115 -0
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +23 -0
- package/dist/index.mjs.map +1 -1
- package/dist/inputFile.js +1 -2
- package/dist/inputFile.js.map +1 -1
- package/dist/inputFile.mjs +0 -1
- package/dist/inputFile.mjs.map +1 -1
- package/dist/models.d.mts +1027 -36
- package/dist/models.d.ts +1027 -36
- package/dist/operator.js +243 -204
- package/dist/operator.js.map +1 -1
- package/dist/operator.mjs +242 -203
- package/dist/operator.mjs.map +1 -1
- package/dist/permission.js +58 -48
- package/dist/permission.js.map +1 -1
- package/dist/permission.mjs +58 -48
- package/dist/permission.mjs.map +1 -1
- package/dist/query.js +525 -422
- package/dist/query.js.map +1 -1
- package/dist/query.mjs +524 -421
- package/dist/query.mjs.map +1 -1
- package/dist/services/apps.d.mts +18 -0
- package/dist/services/apps.d.ts +18 -0
- package/dist/services/avatars.d.mts +18 -0
- package/dist/services/avatars.d.ts +18 -0
- package/dist/services/carts-io.d.mts +46 -28
- package/dist/services/carts-io.d.ts +46 -28
- package/dist/services/carts-io.js.map +1 -1
- package/dist/services/carts-io.mjs.map +1 -1
- package/dist/services/carts-items.d.mts +42 -24
- package/dist/services/carts-items.d.ts +42 -24
- package/dist/services/carts-items.js.map +1 -1
- package/dist/services/carts-items.mjs.map +1 -1
- package/dist/services/carts.d.mts +70 -52
- package/dist/services/carts.d.ts +70 -52
- package/dist/services/carts.js.map +1 -1
- package/dist/services/carts.mjs.map +1 -1
- package/dist/services/channels.d.mts +64 -46
- package/dist/services/channels.d.ts +64 -46
- package/dist/services/channels.js +1 -1
- package/dist/services/channels.js.map +1 -1
- package/dist/services/channels.mjs +1 -1
- package/dist/services/channels.mjs.map +1 -1
- package/dist/services/cost-centers.d.mts +18 -0
- package/dist/services/cost-centers.d.ts +18 -0
- package/dist/services/customers-contacts.d.mts +62 -44
- package/dist/services/customers-contacts.d.ts +62 -44
- package/dist/services/customers-contacts.js.map +1 -1
- package/dist/services/customers-contacts.mjs.map +1 -1
- package/dist/services/customers-organizations.d.mts +58 -40
- package/dist/services/customers-organizations.d.ts +58 -40
- package/dist/services/customers-organizations.js.map +1 -1
- package/dist/services/customers-organizations.mjs.map +1 -1
- package/dist/services/customers-roles.d.mts +26 -8
- package/dist/services/customers-roles.d.ts +26 -8
- package/dist/services/customers-roles.js.map +1 -1
- package/dist/services/customers-roles.mjs.map +1 -1
- package/dist/services/customers-segments.d.mts +62 -44
- package/dist/services/customers-segments.d.ts +62 -44
- package/dist/services/customers-segments.js.map +1 -1
- package/dist/services/customers-segments.mjs.map +1 -1
- package/dist/services/customers-value-lists.d.mts +90 -72
- package/dist/services/customers-value-lists.d.ts +90 -72
- package/dist/services/customers-value-lists.js.map +1 -1
- package/dist/services/customers-value-lists.mjs.map +1 -1
- package/dist/services/customers.d.mts +78 -60
- package/dist/services/customers.d.ts +78 -60
- package/dist/services/customers.js.map +1 -1
- package/dist/services/customers.mjs.map +1 -1
- package/dist/services/events.d.mts +18 -0
- package/dist/services/events.d.ts +18 -0
- package/dist/services/forms.d.mts +66 -48
- package/dist/services/forms.d.ts +66 -48
- package/dist/services/forms.js.map +1 -1
- package/dist/services/forms.mjs.map +1 -1
- package/dist/services/health.d.mts +18 -0
- package/dist/services/health.d.ts +18 -0
- package/dist/services/inventories-locations.d.mts +38 -20
- package/dist/services/inventories-locations.d.ts +38 -20
- package/dist/services/inventories-locations.js.map +1 -1
- package/dist/services/inventories-locations.mjs.map +1 -1
- package/dist/services/inventories-reservations.d.mts +38 -20
- package/dist/services/inventories-reservations.d.ts +38 -20
- package/dist/services/inventories-reservations.js.map +1 -1
- package/dist/services/inventories-reservations.mjs.map +1 -1
- package/dist/services/inventories-stock.d.mts +70 -52
- package/dist/services/inventories-stock.d.ts +70 -52
- package/dist/services/inventories-stock.js.map +1 -1
- package/dist/services/inventories-stock.mjs.map +1 -1
- package/dist/services/io.d.mts +66 -48
- package/dist/services/io.d.ts +66 -48
- package/dist/services/io.js +2 -2
- package/dist/services/io.js.map +1 -1
- package/dist/services/io.mjs +2 -2
- package/dist/services/io.mjs.map +1 -1
- package/dist/services/locale.d.mts +18 -0
- package/dist/services/locale.d.ts +18 -0
- package/dist/services/markets.d.mts +122 -104
- package/dist/services/markets.d.ts +122 -104
- package/dist/services/markets.js.map +1 -1
- package/dist/services/markets.mjs.map +1 -1
- package/dist/services/messaging.d.mts +194 -176
- package/dist/services/messaging.d.ts +194 -176
- package/dist/services/messaging.js +3 -3
- package/dist/services/messaging.js.map +1 -1
- package/dist/services/messaging.mjs +3 -3
- package/dist/services/messaging.mjs.map +1 -1
- package/dist/services/orderlists.d.mts +96 -78
- package/dist/services/orderlists.d.ts +96 -78
- package/dist/services/orderlists.js +1 -1
- package/dist/services/orderlists.js.map +1 -1
- package/dist/services/orderlists.mjs +1 -1
- package/dist/services/orderlists.mjs.map +1 -1
- package/dist/services/orders.d.mts +114 -96
- package/dist/services/orders.d.ts +114 -96
- package/dist/services/orders.js.map +1 -1
- package/dist/services/orders.mjs.map +1 -1
- package/dist/services/pages-collaboration.d.mts +34 -16
- package/dist/services/pages-collaboration.d.ts +34 -16
- package/dist/services/pages-collaboration.js.map +1 -1
- package/dist/services/pages-collaboration.mjs.map +1 -1
- package/dist/services/pages-delivery.d.mts +26 -8
- package/dist/services/pages-delivery.d.ts +26 -8
- package/dist/services/pages-delivery.js.map +1 -1
- package/dist/services/pages-delivery.mjs.map +1 -1
- package/dist/services/pages-editor.d.mts +34 -16
- package/dist/services/pages-editor.d.ts +34 -16
- package/dist/services/pages-editor.js.map +1 -1
- package/dist/services/pages-editor.mjs.map +1 -1
- package/dist/services/pages.d.mts +82 -64
- package/dist/services/pages.d.ts +82 -64
- package/dist/services/pages.js.map +1 -1
- package/dist/services/pages.mjs.map +1 -1
- package/dist/services/payments-ledger.d.mts +54 -36
- package/dist/services/payments-ledger.d.ts +54 -36
- package/dist/services/payments-ledger.js.map +1 -1
- package/dist/services/payments-ledger.mjs.map +1 -1
- package/dist/services/payments-methods.d.mts +34 -16
- package/dist/services/payments-methods.d.ts +34 -16
- package/dist/services/payments-methods.js.map +1 -1
- package/dist/services/payments-methods.mjs.map +1 -1
- package/dist/services/payments-providers.d.mts +38 -20
- package/dist/services/payments-providers.d.ts +38 -20
- package/dist/services/payments-providers.js.map +1 -1
- package/dist/services/payments-providers.mjs.map +1 -1
- package/dist/services/prices.d.mts +86 -68
- package/dist/services/prices.d.ts +86 -68
- package/dist/services/prices.js.map +1 -1
- package/dist/services/prices.mjs.map +1 -1
- package/dist/services/procurement.d.mts +991 -0
- package/dist/services/procurement.d.ts +991 -0
- package/dist/services/procurement.js +1185 -0
- package/dist/services/procurement.js.map +1 -0
- package/dist/services/procurement.mjs +1184 -0
- package/dist/services/procurement.mjs.map +1 -0
- package/dist/services/products-assets.d.mts +34 -16
- package/dist/services/products-assets.d.ts +34 -16
- package/dist/services/products-assets.js.map +1 -1
- package/dist/services/products-assets.mjs.map +1 -1
- package/dist/services/products-categories.d.mts +66 -48
- package/dist/services/products-categories.d.ts +66 -48
- package/dist/services/products-categories.js.map +1 -1
- package/dist/services/products-categories.mjs.map +1 -1
- package/dist/services/products-data-model.d.mts +166 -148
- package/dist/services/products-data-model.d.ts +166 -148
- package/dist/services/products-data-model.js.map +1 -1
- package/dist/services/products-data-model.mjs.map +1 -1
- package/dist/services/products-references.d.mts +50 -32
- package/dist/services/products-references.d.ts +50 -32
- package/dist/services/products-references.js.map +1 -1
- package/dist/services/products-references.mjs.map +1 -1
- package/dist/services/products.d.mts +70 -52
- package/dist/services/products.d.ts +70 -52
- package/dist/services/products.js.map +1 -1
- package/dist/services/products.mjs.map +1 -1
- package/dist/services/search.d.mts +40 -22
- package/dist/services/search.d.ts +40 -22
- package/dist/services/search.js +1 -1
- package/dist/services/search.js.map +1 -1
- package/dist/services/search.mjs +1 -1
- package/dist/services/search.mjs.map +1 -1
- package/dist/services/settings.d.mts +18 -0
- package/dist/services/settings.d.ts +18 -0
- package/dist/services/shipping-carriers.d.mts +42 -24
- package/dist/services/shipping-carriers.d.ts +42 -24
- package/dist/services/shipping-carriers.js.map +1 -1
- package/dist/services/shipping-carriers.mjs.map +1 -1
- package/dist/services/shipping-methods.d.mts +70 -52
- package/dist/services/shipping-methods.d.ts +70 -52
- package/dist/services/shipping-methods.js.map +1 -1
- package/dist/services/shipping-methods.mjs.map +1 -1
- package/dist/services/shipping-value-lists.d.mts +62 -44
- package/dist/services/shipping-value-lists.d.ts +62 -44
- package/dist/services/shipping-value-lists.js.map +1 -1
- package/dist/services/shipping-value-lists.mjs.map +1 -1
- package/dist/services/sites.d.mts +18 -0
- package/dist/services/sites.d.ts +18 -0
- package/dist/services/storage.d.mts +18 -0
- package/dist/services/storage.d.ts +18 -0
- package/package.json +6 -3
|
@@ -6,6 +6,15 @@ import '../query.js';
|
|
|
6
6
|
import '../enums/address-type-row-tone.js';
|
|
7
7
|
import '../enums/address-type-row-create-request-tone.js';
|
|
8
8
|
import '../enums/address-type-row-update-request-tone.js';
|
|
9
|
+
import '../enums/approval-rule-approver-type.js';
|
|
10
|
+
import '../enums/approval-rule-condition.js';
|
|
11
|
+
import '../enums/approval-rule-effect.js';
|
|
12
|
+
import '../enums/approval-rule-create-request-approver-type.js';
|
|
13
|
+
import '../enums/approval-rule-create-request-condition.js';
|
|
14
|
+
import '../enums/approval-rule-create-request-effect.js';
|
|
15
|
+
import '../enums/approval-rule-update-request-approver-type.js';
|
|
16
|
+
import '../enums/approval-rule-update-request-condition.js';
|
|
17
|
+
import '../enums/approval-rule-update-request-effect.js';
|
|
9
18
|
import '../enums/assets-source.js';
|
|
10
19
|
import '../enums/attribute-value-bucket.js';
|
|
11
20
|
import '../enums/auth-mail-source.js';
|
|
@@ -119,6 +128,8 @@ import '../enums/payment-term-tone.js';
|
|
|
119
128
|
import '../enums/payment-term-create-request-tone.js';
|
|
120
129
|
import '../enums/payment-term-update-request-tone.js';
|
|
121
130
|
import '../enums/payment-vocabulary-tone.js';
|
|
131
|
+
import '../enums/pending-approval-approver-type.js';
|
|
132
|
+
import '../enums/pending-approval-status.js';
|
|
122
133
|
import '../enums/price-ending-rule.js';
|
|
123
134
|
import '../enums/price-entries-adjust-response-rounding.js';
|
|
124
135
|
import '../enums/price-entries-adjust-response-rounding-mode.js';
|
|
@@ -141,6 +152,11 @@ import '../enums/product-grid-column-source.js';
|
|
|
141
152
|
import '../enums/product-label-source.js';
|
|
142
153
|
import '../enums/product-label-attribute-source.js';
|
|
143
154
|
import '../enums/products-kind.js';
|
|
155
|
+
import '../enums/purchase-request-status.js';
|
|
156
|
+
import '../enums/purchase-request-event-name.js';
|
|
157
|
+
import '../enums/purchase-request-item-type.js';
|
|
158
|
+
import '../enums/purchase-request-item-create-request-type.js';
|
|
159
|
+
import '../enums/purchase-request-item-update-request-type.js';
|
|
144
160
|
import '../enums/reorder-point-source.js';
|
|
145
161
|
import '../enums/reservation-status.js';
|
|
146
162
|
import '../enums/price-on-request-reason.js';
|
|
@@ -178,6 +194,8 @@ import '../enums/shipping-weight-unit-row-tone.js';
|
|
|
178
194
|
import '../enums/shipping-weight-unit-update-request-tone.js';
|
|
179
195
|
import '../enums/stock-movement-type.js';
|
|
180
196
|
import '../enums/store-asset-request-visibility.js';
|
|
197
|
+
import '../enums/submit-item-type.js';
|
|
198
|
+
import '../enums/submit-result-outcome.js';
|
|
181
199
|
import '../enums/validation-failed-response-status.js';
|
|
182
200
|
import '../enums/vocabulary-default-tone.js';
|
|
183
201
|
import '../enums/vocabulary-source.js';
|
|
@@ -247,7 +265,7 @@ declare class CustomersValueLists {
|
|
|
247
265
|
* @param {number} params.position - Where it sits in the set, ascending. Default 0.
|
|
248
266
|
* @param {Tone} params.tone - Semantic badge colour.
|
|
249
267
|
* @throws {RevenexxException}
|
|
250
|
-
* @returns {Promise<Models.
|
|
268
|
+
* @returns {Promise<Models.AddressTypeRow>}
|
|
251
269
|
*/
|
|
252
270
|
customersAddressTypesCreate(params: {
|
|
253
271
|
code: string;
|
|
@@ -258,7 +276,7 @@ declare class CustomersValueLists {
|
|
|
258
276
|
labels?: object;
|
|
259
277
|
position?: number;
|
|
260
278
|
tone?: Tone;
|
|
261
|
-
}): Promise<Models.
|
|
279
|
+
}): Promise<Models.AddressTypeRow>;
|
|
262
280
|
/**
|
|
263
281
|
* Extends this tenant's address types set with a value of their own — the whole reason these four stopped being CHECK constraints. What an address is used for. Billing and shipping are what a checkout needs; a works entrance or a central accounts office is the tenant's own. The code is lowercase and becomes what `addresses.type` stores; it cannot be changed afterwards, because every record carrying it would be orphaned.
|
|
264
282
|
*
|
|
@@ -271,48 +289,48 @@ declare class CustomersValueLists {
|
|
|
271
289
|
* @param {number} position - Where it sits in the set, ascending. Default 0.
|
|
272
290
|
* @param {Tone} tone - Semantic badge colour.
|
|
273
291
|
* @throws {RevenexxException}
|
|
274
|
-
* @returns {Promise<Models.
|
|
292
|
+
* @returns {Promise<Models.AddressTypeRow>}
|
|
275
293
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
276
294
|
*/
|
|
277
|
-
customersAddressTypesCreate(code: string, title: string, description?: string, descriptions?: object, isDefault?: boolean, labels?: object, position?: number, tone?: Tone): Promise<Models.
|
|
295
|
+
customersAddressTypesCreate(code: string, title: string, description?: string, descriptions?: object, isDefault?: boolean, labels?: object, position?: number, tone?: Tone): Promise<Models.AddressTypeRow>;
|
|
278
296
|
/**
|
|
279
297
|
* Takes a value out of the address types set. There is no foreign key behind `addresses.type` — one added to a table that starts empty fails the migration of every existing tenant — so this route IS the integrity: it refuses while any record still carries the code, and it refuses to empty the set. Retiring a value that is in use is therefore a two-step job: move the records onto another value first, then remove it.
|
|
280
298
|
*
|
|
281
299
|
* @param {string} params.id - The address type to remove.
|
|
282
300
|
* @throws {RevenexxException}
|
|
283
|
-
* @returns {Promise<
|
|
301
|
+
* @returns {Promise<{}>}
|
|
284
302
|
*/
|
|
285
303
|
customersAddressTypesDelete(params: {
|
|
286
304
|
id: string;
|
|
287
|
-
}): Promise<
|
|
305
|
+
}): Promise<{}>;
|
|
288
306
|
/**
|
|
289
307
|
* Takes a value out of the address types set. There is no foreign key behind `addresses.type` — one added to a table that starts empty fails the migration of every existing tenant — so this route IS the integrity: it refuses while any record still carries the code, and it refuses to empty the set. Retiring a value that is in use is therefore a two-step job: move the records onto another value first, then remove it.
|
|
290
308
|
*
|
|
291
309
|
* @param {string} id - The address type to remove.
|
|
292
310
|
* @throws {RevenexxException}
|
|
293
|
-
* @returns {Promise<
|
|
311
|
+
* @returns {Promise<{}>}
|
|
294
312
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
295
313
|
*/
|
|
296
|
-
customersAddressTypesDelete(id: string): Promise<
|
|
314
|
+
customersAddressTypesDelete(id: string): Promise<{}>;
|
|
297
315
|
/**
|
|
298
316
|
* One value of the address types set, by its id — its code, its fallback title, the per-language `labels` an operator reads and the badge `tone` a client renders it with. What an address is used for. Billing and shipping are what a checkout needs; a works entrance or a central accounts office is the tenant's own. Reading one value is the rare path: `GET /customers/address-types` answers the whole set in a single page, which is what a select needs.
|
|
299
317
|
*
|
|
300
318
|
* @param {string} params.id - The address type to read. Note that records store the CODE, not this id.
|
|
301
319
|
* @throws {RevenexxException}
|
|
302
|
-
* @returns {Promise<Models.
|
|
320
|
+
* @returns {Promise<Models.AddressTypeRow>}
|
|
303
321
|
*/
|
|
304
322
|
customersAddressTypesGet(params: {
|
|
305
323
|
id: string;
|
|
306
|
-
}): Promise<Models.
|
|
324
|
+
}): Promise<Models.AddressTypeRow>;
|
|
307
325
|
/**
|
|
308
326
|
* One value of the address types set, by its id — its code, its fallback title, the per-language `labels` an operator reads and the badge `tone` a client renders it with. What an address is used for. Billing and shipping are what a checkout needs; a works entrance or a central accounts office is the tenant's own. Reading one value is the rare path: `GET /customers/address-types` answers the whole set in a single page, which is what a select needs.
|
|
309
327
|
*
|
|
310
328
|
* @param {string} id - The address type to read. Note that records store the CODE, not this id.
|
|
311
329
|
* @throws {RevenexxException}
|
|
312
|
-
* @returns {Promise<Models.
|
|
330
|
+
* @returns {Promise<Models.AddressTypeRow>}
|
|
313
331
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
314
332
|
*/
|
|
315
|
-
customersAddressTypesGet(id: string): Promise<Models.
|
|
333
|
+
customersAddressTypesGet(id: string): Promise<Models.AddressTypeRow>;
|
|
316
334
|
/**
|
|
317
335
|
* Everything about a value except the value itself: its titles, its help text, its badge tone, its `position` in the select, and which one of the set is the default. The `code` is immutable, so no record carrying it is ever orphaned by an edit here — a merchant who retitles `shipping` to wording of their own changes what people READ and nothing about what `addresses.type` stores. Seeded values (`is_system`) are renameable like any other, and re-seeding leaves the rename alone.
|
|
318
336
|
*
|
|
@@ -325,7 +343,7 @@ declare class CustomersValueLists {
|
|
|
325
343
|
* @param {string} params.title - The fallback name shown when no locale matches.
|
|
326
344
|
* @param {Tone} params.tone - Semantic badge colour.
|
|
327
345
|
* @throws {RevenexxException}
|
|
328
|
-
* @returns {Promise<Models.
|
|
346
|
+
* @returns {Promise<Models.AddressTypeRow>}
|
|
329
347
|
*/
|
|
330
348
|
customersAddressTypesUpdate(params: {
|
|
331
349
|
id: string;
|
|
@@ -336,7 +354,7 @@ declare class CustomersValueLists {
|
|
|
336
354
|
position?: number;
|
|
337
355
|
title?: string;
|
|
338
356
|
tone?: Tone;
|
|
339
|
-
}): Promise<Models.
|
|
357
|
+
}): Promise<Models.AddressTypeRow>;
|
|
340
358
|
/**
|
|
341
359
|
* Everything about a value except the value itself: its titles, its help text, its badge tone, its `position` in the select, and which one of the set is the default. The `code` is immutable, so no record carrying it is ever orphaned by an edit here — a merchant who retitles `shipping` to wording of their own changes what people READ and nothing about what `addresses.type` stores. Seeded values (`is_system`) are renameable like any other, and re-seeding leaves the rename alone.
|
|
342
360
|
*
|
|
@@ -349,10 +367,10 @@ declare class CustomersValueLists {
|
|
|
349
367
|
* @param {string} title - The fallback name shown when no locale matches.
|
|
350
368
|
* @param {Tone} tone - Semantic badge colour.
|
|
351
369
|
* @throws {RevenexxException}
|
|
352
|
-
* @returns {Promise<Models.
|
|
370
|
+
* @returns {Promise<Models.AddressTypeRow>}
|
|
353
371
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
354
372
|
*/
|
|
355
|
-
customersAddressTypesUpdate(id: string, description?: string, descriptions?: object, isDefault?: boolean, labels?: object, position?: number, title?: string, tone?: Tone): Promise<Models.
|
|
373
|
+
customersAddressTypesUpdate(id: string, description?: string, descriptions?: object, isDefault?: boolean, labels?: object, position?: number, title?: string, tone?: Tone): Promise<Models.AddressTypeRow>;
|
|
356
374
|
/**
|
|
357
375
|
* What kind of entry lands on a customer timeline. 'system' is the app's own decision trail and a caller may not file one, whatever the set says. A fresh install is seeded with system, note, call, email, meeting, visit, task, and the set seeds on first read too, so the page is never empty and `contact_events.kind` always has a value it may carry. The whole set comes back in one page in the tenant's own order — this route takes no limit/offset/order and no column filters, so `page` describes the full set and `filter` is always empty.
|
|
358
376
|
*
|
|
@@ -372,7 +390,7 @@ declare class CustomersValueLists {
|
|
|
372
390
|
* @param {number} params.position - Where it sits in the set, ascending. Default 0.
|
|
373
391
|
* @param {Tone} params.tone - Semantic badge colour.
|
|
374
392
|
* @throws {RevenexxException}
|
|
375
|
-
* @returns {Promise<Models.
|
|
393
|
+
* @returns {Promise<Models.ContactEventKind>}
|
|
376
394
|
*/
|
|
377
395
|
customersContactEventKindsCreate(params: {
|
|
378
396
|
code: string;
|
|
@@ -383,7 +401,7 @@ declare class CustomersValueLists {
|
|
|
383
401
|
labels?: object;
|
|
384
402
|
position?: number;
|
|
385
403
|
tone?: Tone;
|
|
386
|
-
}): Promise<Models.
|
|
404
|
+
}): Promise<Models.ContactEventKind>;
|
|
387
405
|
/**
|
|
388
406
|
* Extends this tenant's activity types set with a value of their own — the whole reason these four stopped being CHECK constraints. What kind of entry lands on a customer timeline. 'system' is the app's own decision trail and a caller may not file one, whatever the set says. The code is lowercase and becomes what `contact_events.kind` stores; it cannot be changed afterwards, because every record carrying it would be orphaned.
|
|
389
407
|
*
|
|
@@ -396,48 +414,48 @@ declare class CustomersValueLists {
|
|
|
396
414
|
* @param {number} position - Where it sits in the set, ascending. Default 0.
|
|
397
415
|
* @param {Tone} tone - Semantic badge colour.
|
|
398
416
|
* @throws {RevenexxException}
|
|
399
|
-
* @returns {Promise<Models.
|
|
417
|
+
* @returns {Promise<Models.ContactEventKind>}
|
|
400
418
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
401
419
|
*/
|
|
402
|
-
customersContactEventKindsCreate(code: string, title: string, description?: string, descriptions?: object, isDefault?: boolean, labels?: object, position?: number, tone?: Tone): Promise<Models.
|
|
420
|
+
customersContactEventKindsCreate(code: string, title: string, description?: string, descriptions?: object, isDefault?: boolean, labels?: object, position?: number, tone?: Tone): Promise<Models.ContactEventKind>;
|
|
403
421
|
/**
|
|
404
422
|
* Takes a value out of the activity types set. There is no foreign key behind `contact_events.kind` — one added to a table that starts empty fails the migration of every existing tenant — so this route IS the integrity: it refuses while any record still carries the code, and it refuses to empty the set. Retiring a value that is in use is therefore a two-step job: move the records onto another value first, then remove it.
|
|
405
423
|
*
|
|
406
424
|
* @param {string} params.id - The activity type to remove.
|
|
407
425
|
* @throws {RevenexxException}
|
|
408
|
-
* @returns {Promise<
|
|
426
|
+
* @returns {Promise<{}>}
|
|
409
427
|
*/
|
|
410
428
|
customersContactEventKindsDelete(params: {
|
|
411
429
|
id: string;
|
|
412
|
-
}): Promise<
|
|
430
|
+
}): Promise<{}>;
|
|
413
431
|
/**
|
|
414
432
|
* Takes a value out of the activity types set. There is no foreign key behind `contact_events.kind` — one added to a table that starts empty fails the migration of every existing tenant — so this route IS the integrity: it refuses while any record still carries the code, and it refuses to empty the set. Retiring a value that is in use is therefore a two-step job: move the records onto another value first, then remove it.
|
|
415
433
|
*
|
|
416
434
|
* @param {string} id - The activity type to remove.
|
|
417
435
|
* @throws {RevenexxException}
|
|
418
|
-
* @returns {Promise<
|
|
436
|
+
* @returns {Promise<{}>}
|
|
419
437
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
420
438
|
*/
|
|
421
|
-
customersContactEventKindsDelete(id: string): Promise<
|
|
439
|
+
customersContactEventKindsDelete(id: string): Promise<{}>;
|
|
422
440
|
/**
|
|
423
441
|
* One value of the activity types set, by its id — its code, its fallback title, the per-language `labels` an operator reads and the badge `tone` a client renders it with. What kind of entry lands on a customer timeline. 'system' is the app's own decision trail and a caller may not file one, whatever the set says. Reading one value is the rare path: `GET /customers/contact-event-kinds` answers the whole set in a single page, which is what a select needs.
|
|
424
442
|
*
|
|
425
443
|
* @param {string} params.id - The activity type to read. Note that records store the CODE, not this id.
|
|
426
444
|
* @throws {RevenexxException}
|
|
427
|
-
* @returns {Promise<Models.
|
|
445
|
+
* @returns {Promise<Models.ContactEventKind>}
|
|
428
446
|
*/
|
|
429
447
|
customersContactEventKindsGet(params: {
|
|
430
448
|
id: string;
|
|
431
|
-
}): Promise<Models.
|
|
449
|
+
}): Promise<Models.ContactEventKind>;
|
|
432
450
|
/**
|
|
433
451
|
* One value of the activity types set, by its id — its code, its fallback title, the per-language `labels` an operator reads and the badge `tone` a client renders it with. What kind of entry lands on a customer timeline. 'system' is the app's own decision trail and a caller may not file one, whatever the set says. Reading one value is the rare path: `GET /customers/contact-event-kinds` answers the whole set in a single page, which is what a select needs.
|
|
434
452
|
*
|
|
435
453
|
* @param {string} id - The activity type to read. Note that records store the CODE, not this id.
|
|
436
454
|
* @throws {RevenexxException}
|
|
437
|
-
* @returns {Promise<Models.
|
|
455
|
+
* @returns {Promise<Models.ContactEventKind>}
|
|
438
456
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
439
457
|
*/
|
|
440
|
-
customersContactEventKindsGet(id: string): Promise<Models.
|
|
458
|
+
customersContactEventKindsGet(id: string): Promise<Models.ContactEventKind>;
|
|
441
459
|
/**
|
|
442
460
|
* Everything about a value except the value itself: its titles, its help text, its badge tone, its `position` in the select, and which one of the set is the default. The `code` is immutable, so no record carrying it is ever orphaned by an edit here — a merchant who retitles `call` to wording of their own changes what people READ and nothing about what `contact_events.kind` stores. Seeded values (`is_system`) are renameable like any other, and re-seeding leaves the rename alone.
|
|
443
461
|
*
|
|
@@ -450,7 +468,7 @@ declare class CustomersValueLists {
|
|
|
450
468
|
* @param {string} params.title - The fallback name shown when no locale matches.
|
|
451
469
|
* @param {Tone} params.tone - Semantic badge colour.
|
|
452
470
|
* @throws {RevenexxException}
|
|
453
|
-
* @returns {Promise<Models.
|
|
471
|
+
* @returns {Promise<Models.ContactEventKind>}
|
|
454
472
|
*/
|
|
455
473
|
customersContactEventKindsUpdate(params: {
|
|
456
474
|
id: string;
|
|
@@ -461,7 +479,7 @@ declare class CustomersValueLists {
|
|
|
461
479
|
position?: number;
|
|
462
480
|
title?: string;
|
|
463
481
|
tone?: Tone;
|
|
464
|
-
}): Promise<Models.
|
|
482
|
+
}): Promise<Models.ContactEventKind>;
|
|
465
483
|
/**
|
|
466
484
|
* Everything about a value except the value itself: its titles, its help text, its badge tone, its `position` in the select, and which one of the set is the default. The `code` is immutable, so no record carrying it is ever orphaned by an edit here — a merchant who retitles `call` to wording of their own changes what people READ and nothing about what `contact_events.kind` stores. Seeded values (`is_system`) are renameable like any other, and re-seeding leaves the rename alone.
|
|
467
485
|
*
|
|
@@ -474,29 +492,29 @@ declare class CustomersValueLists {
|
|
|
474
492
|
* @param {string} title - The fallback name shown when no locale matches.
|
|
475
493
|
* @param {Tone} tone - Semantic badge colour.
|
|
476
494
|
* @throws {RevenexxException}
|
|
477
|
-
* @returns {Promise<Models.
|
|
495
|
+
* @returns {Promise<Models.ContactEventKind>}
|
|
478
496
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
479
497
|
*/
|
|
480
|
-
customersContactEventKindsUpdate(id: string, description?: string, descriptions?: object, isDefault?: boolean, labels?: object, position?: number, title?: string, tone?: Tone): Promise<Models.
|
|
498
|
+
customersContactEventKindsUpdate(id: string, description?: string, descriptions?: object, isDefault?: boolean, labels?: object, position?: number, title?: string, tone?: Tone): Promise<Models.ContactEventKind>;
|
|
481
499
|
/**
|
|
482
500
|
* What the app.installed event runs. It fills all four of the value sets a tenant needs before anything else works — the payment terms, the address types, the lifecycle stages and the activity types — in one call. Idempotent by code: a set that already has its rows is left completely alone, so a re-delivered event and a merchant's renames both survive. A tenant installed before these tables existed is seeded lazily instead, by the first read that finds one empty.
|
|
483
501
|
*
|
|
484
502
|
* @param {object} params.data - Request body
|
|
485
503
|
* @throws {RevenexxException}
|
|
486
|
-
* @returns {Promise<Models.
|
|
504
|
+
* @returns {Promise<Models.CustomersDefaultsResponse>}
|
|
487
505
|
*/
|
|
488
506
|
customersDefaults(params: {
|
|
489
507
|
data: object;
|
|
490
|
-
}): Promise<Models.
|
|
508
|
+
}): Promise<Models.CustomersDefaultsResponse>;
|
|
491
509
|
/**
|
|
492
510
|
* What the app.installed event runs. It fills all four of the value sets a tenant needs before anything else works — the payment terms, the address types, the lifecycle stages and the activity types — in one call. Idempotent by code: a set that already has its rows is left completely alone, so a re-delivered event and a merchant's renames both survive. A tenant installed before these tables existed is seeded lazily instead, by the first read that finds one empty.
|
|
493
511
|
*
|
|
494
512
|
* @param {object} data - Request body
|
|
495
513
|
* @throws {RevenexxException}
|
|
496
|
-
* @returns {Promise<Models.
|
|
514
|
+
* @returns {Promise<Models.CustomersDefaultsResponse>}
|
|
497
515
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
498
516
|
*/
|
|
499
|
-
customersDefaults(data: object): Promise<Models.
|
|
517
|
+
customersDefaults(data: object): Promise<Models.CustomersDefaultsResponse>;
|
|
500
518
|
/**
|
|
501
519
|
* Where a company stands in the sales pipeline — a separate axis from status, and one whose steps are a sales team's own. A fresh install is seeded with lead, prospect, customer, churned, and the set seeds on first read too, so the page is never empty and `organizations.lifecycle_stage` always has a value it may carry. The whole set comes back in one page in the tenant's own order — this route takes no limit/offset/order and no column filters, so `page` describes the full set and `filter` is always empty.
|
|
502
520
|
*
|
|
@@ -516,7 +534,7 @@ declare class CustomersValueLists {
|
|
|
516
534
|
* @param {number} params.position - Where it sits in the set, ascending. Default 0.
|
|
517
535
|
* @param {Tone} params.tone - Semantic badge colour.
|
|
518
536
|
* @throws {RevenexxException}
|
|
519
|
-
* @returns {Promise<Models.
|
|
537
|
+
* @returns {Promise<Models.LifecycleStage>}
|
|
520
538
|
*/
|
|
521
539
|
customersLifecycleStagesCreate(params: {
|
|
522
540
|
code: string;
|
|
@@ -527,7 +545,7 @@ declare class CustomersValueLists {
|
|
|
527
545
|
labels?: object;
|
|
528
546
|
position?: number;
|
|
529
547
|
tone?: Tone;
|
|
530
|
-
}): Promise<Models.
|
|
548
|
+
}): Promise<Models.LifecycleStage>;
|
|
531
549
|
/**
|
|
532
550
|
* Extends this tenant's lifecycle stages set with a value of their own — the whole reason these four stopped being CHECK constraints. Where a company stands in the sales pipeline — a separate axis from status, and one whose steps are a sales team's own. The code is lowercase and becomes what `organizations.lifecycle_stage` stores; it cannot be changed afterwards, because every record carrying it would be orphaned.
|
|
533
551
|
*
|
|
@@ -540,48 +558,48 @@ declare class CustomersValueLists {
|
|
|
540
558
|
* @param {number} position - Where it sits in the set, ascending. Default 0.
|
|
541
559
|
* @param {Tone} tone - Semantic badge colour.
|
|
542
560
|
* @throws {RevenexxException}
|
|
543
|
-
* @returns {Promise<Models.
|
|
561
|
+
* @returns {Promise<Models.LifecycleStage>}
|
|
544
562
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
545
563
|
*/
|
|
546
|
-
customersLifecycleStagesCreate(code: string, title: string, description?: string, descriptions?: object, isDefault?: boolean, labels?: object, position?: number, tone?: Tone): Promise<Models.
|
|
564
|
+
customersLifecycleStagesCreate(code: string, title: string, description?: string, descriptions?: object, isDefault?: boolean, labels?: object, position?: number, tone?: Tone): Promise<Models.LifecycleStage>;
|
|
547
565
|
/**
|
|
548
566
|
* Takes a value out of the lifecycle stages set. There is no foreign key behind `organizations.lifecycle_stage` — one added to a table that starts empty fails the migration of every existing tenant — so this route IS the integrity: it refuses while any record still carries the code, and it refuses to empty the set. Retiring a value that is in use is therefore a two-step job: move the records onto another value first, then remove it.
|
|
549
567
|
*
|
|
550
568
|
* @param {string} params.id - The lifecycle stage to remove.
|
|
551
569
|
* @throws {RevenexxException}
|
|
552
|
-
* @returns {Promise<
|
|
570
|
+
* @returns {Promise<{}>}
|
|
553
571
|
*/
|
|
554
572
|
customersLifecycleStagesDelete(params: {
|
|
555
573
|
id: string;
|
|
556
|
-
}): Promise<
|
|
574
|
+
}): Promise<{}>;
|
|
557
575
|
/**
|
|
558
576
|
* Takes a value out of the lifecycle stages set. There is no foreign key behind `organizations.lifecycle_stage` — one added to a table that starts empty fails the migration of every existing tenant — so this route IS the integrity: it refuses while any record still carries the code, and it refuses to empty the set. Retiring a value that is in use is therefore a two-step job: move the records onto another value first, then remove it.
|
|
559
577
|
*
|
|
560
578
|
* @param {string} id - The lifecycle stage to remove.
|
|
561
579
|
* @throws {RevenexxException}
|
|
562
|
-
* @returns {Promise<
|
|
580
|
+
* @returns {Promise<{}>}
|
|
563
581
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
564
582
|
*/
|
|
565
|
-
customersLifecycleStagesDelete(id: string): Promise<
|
|
583
|
+
customersLifecycleStagesDelete(id: string): Promise<{}>;
|
|
566
584
|
/**
|
|
567
585
|
* One value of the lifecycle stages set, by its id — its code, its fallback title, the per-language `labels` an operator reads and the badge `tone` a client renders it with. Where a company stands in the sales pipeline — a separate axis from status, and one whose steps are a sales team's own. Reading one value is the rare path: `GET /customers/lifecycle-stages` answers the whole set in a single page, which is what a select needs.
|
|
568
586
|
*
|
|
569
587
|
* @param {string} params.id - The lifecycle stage to read. Note that records store the CODE, not this id.
|
|
570
588
|
* @throws {RevenexxException}
|
|
571
|
-
* @returns {Promise<Models.
|
|
589
|
+
* @returns {Promise<Models.LifecycleStage>}
|
|
572
590
|
*/
|
|
573
591
|
customersLifecycleStagesGet(params: {
|
|
574
592
|
id: string;
|
|
575
|
-
}): Promise<Models.
|
|
593
|
+
}): Promise<Models.LifecycleStage>;
|
|
576
594
|
/**
|
|
577
595
|
* One value of the lifecycle stages set, by its id — its code, its fallback title, the per-language `labels` an operator reads and the badge `tone` a client renders it with. Where a company stands in the sales pipeline — a separate axis from status, and one whose steps are a sales team's own. Reading one value is the rare path: `GET /customers/lifecycle-stages` answers the whole set in a single page, which is what a select needs.
|
|
578
596
|
*
|
|
579
597
|
* @param {string} id - The lifecycle stage to read. Note that records store the CODE, not this id.
|
|
580
598
|
* @throws {RevenexxException}
|
|
581
|
-
* @returns {Promise<Models.
|
|
599
|
+
* @returns {Promise<Models.LifecycleStage>}
|
|
582
600
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
583
601
|
*/
|
|
584
|
-
customersLifecycleStagesGet(id: string): Promise<Models.
|
|
602
|
+
customersLifecycleStagesGet(id: string): Promise<Models.LifecycleStage>;
|
|
585
603
|
/**
|
|
586
604
|
* Everything about a value except the value itself: its titles, its help text, its badge tone, its `position` in the select, and which one of the set is the default. The `code` is immutable, so no record carrying it is ever orphaned by an edit here — a merchant who retitles `customer` to wording of their own changes what people READ and nothing about what `organizations.lifecycle_stage` stores. Seeded values (`is_system`) are renameable like any other, and re-seeding leaves the rename alone.
|
|
587
605
|
*
|
|
@@ -594,7 +612,7 @@ declare class CustomersValueLists {
|
|
|
594
612
|
* @param {string} params.title - The fallback name shown when no locale matches.
|
|
595
613
|
* @param {Tone} params.tone - Semantic badge colour.
|
|
596
614
|
* @throws {RevenexxException}
|
|
597
|
-
* @returns {Promise<Models.
|
|
615
|
+
* @returns {Promise<Models.LifecycleStage>}
|
|
598
616
|
*/
|
|
599
617
|
customersLifecycleStagesUpdate(params: {
|
|
600
618
|
id: string;
|
|
@@ -605,7 +623,7 @@ declare class CustomersValueLists {
|
|
|
605
623
|
position?: number;
|
|
606
624
|
title?: string;
|
|
607
625
|
tone?: Tone;
|
|
608
|
-
}): Promise<Models.
|
|
626
|
+
}): Promise<Models.LifecycleStage>;
|
|
609
627
|
/**
|
|
610
628
|
* Everything about a value except the value itself: its titles, its help text, its badge tone, its `position` in the select, and which one of the set is the default. The `code` is immutable, so no record carrying it is ever orphaned by an edit here — a merchant who retitles `customer` to wording of their own changes what people READ and nothing about what `organizations.lifecycle_stage` stores. Seeded values (`is_system`) are renameable like any other, and re-seeding leaves the rename alone.
|
|
611
629
|
*
|
|
@@ -618,10 +636,10 @@ declare class CustomersValueLists {
|
|
|
618
636
|
* @param {string} title - The fallback name shown when no locale matches.
|
|
619
637
|
* @param {Tone} tone - Semantic badge colour.
|
|
620
638
|
* @throws {RevenexxException}
|
|
621
|
-
* @returns {Promise<Models.
|
|
639
|
+
* @returns {Promise<Models.LifecycleStage>}
|
|
622
640
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
623
641
|
*/
|
|
624
|
-
customersLifecycleStagesUpdate(id: string, description?: string, descriptions?: object, isDefault?: boolean, labels?: object, position?: number, title?: string, tone?: Tone): Promise<Models.
|
|
642
|
+
customersLifecycleStagesUpdate(id: string, description?: string, descriptions?: object, isDefault?: boolean, labels?: object, position?: number, title?: string, tone?: Tone): Promise<Models.LifecycleStage>;
|
|
625
643
|
/**
|
|
626
644
|
* When a company has to pay. A wholesaler who agrees net 45 with one customer used to need a release of this app to say so. A fresh install is seeded with prepayment, direct_debit, net_7, net_14, net_30, net_60, net_90, and the set seeds on first read too, so the page is never empty and `organizations.payment_terms` always has a value it may carry. The whole set comes back in one page in the tenant's own order — this route takes no limit/offset/order and no column filters, so `page` describes the full set and `filter` is always empty.
|
|
627
645
|
*
|
|
@@ -641,7 +659,7 @@ declare class CustomersValueLists {
|
|
|
641
659
|
* @param {number} params.position - Where it sits in the set, ascending. Default 0.
|
|
642
660
|
* @param {Tone} params.tone - Semantic badge colour.
|
|
643
661
|
* @throws {RevenexxException}
|
|
644
|
-
* @returns {Promise<Models.
|
|
662
|
+
* @returns {Promise<Models.PaymentTerm>}
|
|
645
663
|
*/
|
|
646
664
|
customersPaymentTermsCreate(params: {
|
|
647
665
|
code: string;
|
|
@@ -652,7 +670,7 @@ declare class CustomersValueLists {
|
|
|
652
670
|
labels?: object;
|
|
653
671
|
position?: number;
|
|
654
672
|
tone?: Tone;
|
|
655
|
-
}): Promise<Models.
|
|
673
|
+
}): Promise<Models.PaymentTerm>;
|
|
656
674
|
/**
|
|
657
675
|
* Extends this tenant's payment terms set with a value of their own — the whole reason these four stopped being CHECK constraints. When a company has to pay. A wholesaler who agrees net 45 with one customer used to need a release of this app to say so. The code is lowercase and becomes what `organizations.payment_terms` stores; it cannot be changed afterwards, because every record carrying it would be orphaned.
|
|
658
676
|
*
|
|
@@ -665,48 +683,48 @@ declare class CustomersValueLists {
|
|
|
665
683
|
* @param {number} position - Where it sits in the set, ascending. Default 0.
|
|
666
684
|
* @param {Tone} tone - Semantic badge colour.
|
|
667
685
|
* @throws {RevenexxException}
|
|
668
|
-
* @returns {Promise<Models.
|
|
686
|
+
* @returns {Promise<Models.PaymentTerm>}
|
|
669
687
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
670
688
|
*/
|
|
671
|
-
customersPaymentTermsCreate(code: string, title: string, description?: string, descriptions?: object, isDefault?: boolean, labels?: object, position?: number, tone?: Tone): Promise<Models.
|
|
689
|
+
customersPaymentTermsCreate(code: string, title: string, description?: string, descriptions?: object, isDefault?: boolean, labels?: object, position?: number, tone?: Tone): Promise<Models.PaymentTerm>;
|
|
672
690
|
/**
|
|
673
691
|
* Takes a value out of the payment terms set. There is no foreign key behind `organizations.payment_terms` — one added to a table that starts empty fails the migration of every existing tenant — so this route IS the integrity: it refuses while any record still carries the code, and it refuses to empty the set. Retiring a value that is in use is therefore a two-step job: move the records onto another value first, then remove it.
|
|
674
692
|
*
|
|
675
693
|
* @param {string} params.id - The payment term to remove.
|
|
676
694
|
* @throws {RevenexxException}
|
|
677
|
-
* @returns {Promise<
|
|
695
|
+
* @returns {Promise<{}>}
|
|
678
696
|
*/
|
|
679
697
|
customersPaymentTermsDelete(params: {
|
|
680
698
|
id: string;
|
|
681
|
-
}): Promise<
|
|
699
|
+
}): Promise<{}>;
|
|
682
700
|
/**
|
|
683
701
|
* Takes a value out of the payment terms set. There is no foreign key behind `organizations.payment_terms` — one added to a table that starts empty fails the migration of every existing tenant — so this route IS the integrity: it refuses while any record still carries the code, and it refuses to empty the set. Retiring a value that is in use is therefore a two-step job: move the records onto another value first, then remove it.
|
|
684
702
|
*
|
|
685
703
|
* @param {string} id - The payment term to remove.
|
|
686
704
|
* @throws {RevenexxException}
|
|
687
|
-
* @returns {Promise<
|
|
705
|
+
* @returns {Promise<{}>}
|
|
688
706
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
689
707
|
*/
|
|
690
|
-
customersPaymentTermsDelete(id: string): Promise<
|
|
708
|
+
customersPaymentTermsDelete(id: string): Promise<{}>;
|
|
691
709
|
/**
|
|
692
710
|
* One value of the payment terms set, by its id — its code, its fallback title, the per-language `labels` an operator reads and the badge `tone` a client renders it with. When a company has to pay. A wholesaler who agrees net 45 with one customer used to need a release of this app to say so. Reading one value is the rare path: `GET /customers/payment-terms` answers the whole set in a single page, which is what a select needs.
|
|
693
711
|
*
|
|
694
712
|
* @param {string} params.id - The payment term to read. Note that records store the CODE, not this id.
|
|
695
713
|
* @throws {RevenexxException}
|
|
696
|
-
* @returns {Promise<Models.
|
|
714
|
+
* @returns {Promise<Models.PaymentTerm>}
|
|
697
715
|
*/
|
|
698
716
|
customersPaymentTermsGet(params: {
|
|
699
717
|
id: string;
|
|
700
|
-
}): Promise<Models.
|
|
718
|
+
}): Promise<Models.PaymentTerm>;
|
|
701
719
|
/**
|
|
702
720
|
* One value of the payment terms set, by its id — its code, its fallback title, the per-language `labels` an operator reads and the badge `tone` a client renders it with. When a company has to pay. A wholesaler who agrees net 45 with one customer used to need a release of this app to say so. Reading one value is the rare path: `GET /customers/payment-terms` answers the whole set in a single page, which is what a select needs.
|
|
703
721
|
*
|
|
704
722
|
* @param {string} id - The payment term to read. Note that records store the CODE, not this id.
|
|
705
723
|
* @throws {RevenexxException}
|
|
706
|
-
* @returns {Promise<Models.
|
|
724
|
+
* @returns {Promise<Models.PaymentTerm>}
|
|
707
725
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
708
726
|
*/
|
|
709
|
-
customersPaymentTermsGet(id: string): Promise<Models.
|
|
727
|
+
customersPaymentTermsGet(id: string): Promise<Models.PaymentTerm>;
|
|
710
728
|
/**
|
|
711
729
|
* Everything about a value except the value itself: its titles, its help text, its badge tone, its `position` in the select, and which one of the set is the default. The `code` is immutable, so no record carrying it is ever orphaned by an edit here — a merchant who retitles `net_30` to wording of their own changes what people READ and nothing about what `organizations.payment_terms` stores. Seeded values (`is_system`) are renameable like any other, and re-seeding leaves the rename alone.
|
|
712
730
|
*
|
|
@@ -719,7 +737,7 @@ declare class CustomersValueLists {
|
|
|
719
737
|
* @param {string} params.title - The fallback name shown when no locale matches.
|
|
720
738
|
* @param {Tone} params.tone - Semantic badge colour.
|
|
721
739
|
* @throws {RevenexxException}
|
|
722
|
-
* @returns {Promise<Models.
|
|
740
|
+
* @returns {Promise<Models.PaymentTerm>}
|
|
723
741
|
*/
|
|
724
742
|
customersPaymentTermsUpdate(params: {
|
|
725
743
|
id: string;
|
|
@@ -730,7 +748,7 @@ declare class CustomersValueLists {
|
|
|
730
748
|
position?: number;
|
|
731
749
|
title?: string;
|
|
732
750
|
tone?: Tone;
|
|
733
|
-
}): Promise<Models.
|
|
751
|
+
}): Promise<Models.PaymentTerm>;
|
|
734
752
|
/**
|
|
735
753
|
* Everything about a value except the value itself: its titles, its help text, its badge tone, its `position` in the select, and which one of the set is the default. The `code` is immutable, so no record carrying it is ever orphaned by an edit here — a merchant who retitles `net_30` to wording of their own changes what people READ and nothing about what `organizations.payment_terms` stores. Seeded values (`is_system`) are renameable like any other, and re-seeding leaves the rename alone.
|
|
736
754
|
*
|
|
@@ -743,10 +761,10 @@ declare class CustomersValueLists {
|
|
|
743
761
|
* @param {string} title - The fallback name shown when no locale matches.
|
|
744
762
|
* @param {Tone} tone - Semantic badge colour.
|
|
745
763
|
* @throws {RevenexxException}
|
|
746
|
-
* @returns {Promise<Models.
|
|
764
|
+
* @returns {Promise<Models.PaymentTerm>}
|
|
747
765
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
748
766
|
*/
|
|
749
|
-
customersPaymentTermsUpdate(id: string, description?: string, descriptions?: object, isDefault?: boolean, labels?: object, position?: number, title?: string, tone?: Tone): Promise<Models.
|
|
767
|
+
customersPaymentTermsUpdate(id: string, description?: string, descriptions?: object, isDefault?: boolean, labels?: object, position?: number, title?: string, tone?: Tone): Promise<Models.PaymentTerm>;
|
|
750
768
|
/**
|
|
751
769
|
* Discovery for the vocabulary routes: every enum this app publishes, each as a name, a title and a description. The VALUES are deliberately left out — this is the call that says which vocabularies exist, and the detail route is the one that answers what is in them. Names: address-types, contact-event-kinds, contact-statuses, lifecycle-stages, locales, organization-statuses, payment-terms, registration-statuses, roles, rule-matches, segment-sources. Fetch one with GET /customers/vocabularies/{name}; a client holding the qualified pair 'customers.<name>' builds that URL from the pair alone.
|
|
752
770
|
*
|
|
@@ -759,20 +777,20 @@ declare class CustomersValueLists {
|
|
|
759
777
|
*
|
|
760
778
|
* @param {CustomersVocabulariesGetName} params.name - The vocabulary name — the part after the dot in the qualified id.
|
|
761
779
|
* @throws {RevenexxException}
|
|
762
|
-
* @returns {Promise<Models.
|
|
780
|
+
* @returns {Promise<Models.Vocabulary>}
|
|
763
781
|
*/
|
|
764
782
|
customersVocabulariesGet(params: {
|
|
765
783
|
name: CustomersVocabulariesGetName;
|
|
766
|
-
}): Promise<Models.
|
|
784
|
+
}): Promise<Models.Vocabulary>;
|
|
767
785
|
/**
|
|
768
786
|
* One vocabulary in full: every permitted value, each with its title, its description and the badge tone a client renders it with — enough to build a select without a second call. Two kinds of set, and 'source' says which one answered. 'schema' — the values are read out of the column's CHECK constraint, so the served set IS the enforced set and the two cannot drift; a value added to the constraint appears here even before anyone labels it, titled from its own key. 'table' — the values are the TENANT's own rows (payment terms, address types, lifecycle stages, activity types, roles), so they carry labels/descriptions per locale, is_system and is_default, and a merchant may add to them without a release of this app. 'tenant'/'defaults' are the two answers for a set the merchant configures but may not extend. Either way 'closed' is true: the set is exhaustive at this moment, so a value outside it is stale data rather than a missing label. Values come back in the order a select should offer them — lifecycle order for a status, the merchant's own position for a table. Names: address-types, contact-event-kinds, contact-statuses, lifecycle-stages, locales, organization-statuses, payment-terms, registration-statuses, roles, rule-matches, segment-sources.
|
|
769
787
|
*
|
|
770
788
|
* @param {CustomersVocabulariesGetName} name - The vocabulary name — the part after the dot in the qualified id.
|
|
771
789
|
* @throws {RevenexxException}
|
|
772
|
-
* @returns {Promise<Models.
|
|
790
|
+
* @returns {Promise<Models.Vocabulary>}
|
|
773
791
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
774
792
|
*/
|
|
775
|
-
customersVocabulariesGet(name: CustomersVocabulariesGetName): Promise<Models.
|
|
793
|
+
customersVocabulariesGet(name: CustomersVocabulariesGetName): Promise<Models.Vocabulary>;
|
|
776
794
|
}
|
|
777
795
|
|
|
778
796
|
export { CustomersValueLists };
|