@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
package/dist/services/pages.d.ts
CHANGED
|
@@ -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';
|
|
@@ -118,6 +127,8 @@ import '../enums/payment-term-tone.js';
|
|
|
118
127
|
import '../enums/payment-term-create-request-tone.js';
|
|
119
128
|
import '../enums/payment-term-update-request-tone.js';
|
|
120
129
|
import '../enums/payment-vocabulary-tone.js';
|
|
130
|
+
import '../enums/pending-approval-approver-type.js';
|
|
131
|
+
import '../enums/pending-approval-status.js';
|
|
121
132
|
import '../enums/price-ending-rule.js';
|
|
122
133
|
import '../enums/price-entries-adjust-response-rounding.js';
|
|
123
134
|
import '../enums/price-entries-adjust-response-rounding-mode.js';
|
|
@@ -140,6 +151,11 @@ import '../enums/product-grid-column-source.js';
|
|
|
140
151
|
import '../enums/product-label-source.js';
|
|
141
152
|
import '../enums/product-label-attribute-source.js';
|
|
142
153
|
import '../enums/products-kind.js';
|
|
154
|
+
import '../enums/purchase-request-status.js';
|
|
155
|
+
import '../enums/purchase-request-event-name.js';
|
|
156
|
+
import '../enums/purchase-request-item-type.js';
|
|
157
|
+
import '../enums/purchase-request-item-create-request-type.js';
|
|
158
|
+
import '../enums/purchase-request-item-update-request-type.js';
|
|
143
159
|
import '../enums/reorder-point-source.js';
|
|
144
160
|
import '../enums/reservation-status.js';
|
|
145
161
|
import '../enums/price-on-request-reason.js';
|
|
@@ -177,6 +193,8 @@ import '../enums/shipping-weight-unit-row-tone.js';
|
|
|
177
193
|
import '../enums/shipping-weight-unit-update-request-tone.js';
|
|
178
194
|
import '../enums/stock-movement-type.js';
|
|
179
195
|
import '../enums/store-asset-request-visibility.js';
|
|
196
|
+
import '../enums/submit-item-type.js';
|
|
197
|
+
import '../enums/submit-result-outcome.js';
|
|
180
198
|
import '../enums/validation-failed-response-status.js';
|
|
181
199
|
import '../enums/vocabulary-default-tone.js';
|
|
182
200
|
import '../enums/vocabulary-source.js';
|
|
@@ -263,39 +281,39 @@ declare class Pages {
|
|
|
263
281
|
*
|
|
264
282
|
* @param {string} params.id - The library item id.
|
|
265
283
|
* @throws {RevenexxException}
|
|
266
|
-
* @returns {Promise<
|
|
284
|
+
* @returns {Promise<{}>}
|
|
267
285
|
*/
|
|
268
286
|
pagesLibraryDelete(params: {
|
|
269
287
|
id: string;
|
|
270
|
-
}): Promise<
|
|
288
|
+
}): Promise<{}>;
|
|
271
289
|
/**
|
|
272
290
|
* Retires a reusable block. It leaves the picker and every list, but the blocks pointing at it keep their `library_item_id` — the FK's `set null` belongs to a hard delete, and this writes a tombstone. Delivery then skips the expansion for a struck item rather than failing on it, so a page that used it falls back to the block content stored in its own published revision: nothing breaks, but the pages quietly stop tracking each other. Nothing here tells you which pages those are, so establish that before striking it.
|
|
273
291
|
*
|
|
274
292
|
* @param {string} id - The library item id.
|
|
275
293
|
* @throws {RevenexxException}
|
|
276
|
-
* @returns {Promise<
|
|
294
|
+
* @returns {Promise<{}>}
|
|
277
295
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
278
296
|
*/
|
|
279
|
-
pagesLibraryDelete(id: string): Promise<
|
|
297
|
+
pagesLibraryDelete(id: string): Promise<{}>;
|
|
280
298
|
/**
|
|
281
299
|
* The stored subtree behind one reusable block, so a picker can preview what dropping it into a page would produce. Because delivery expands the reference against THIS row at read time, what comes back is also what every page already using the item is currently rendering — which makes this the call to make before editing one.
|
|
282
300
|
*
|
|
283
301
|
* @param {string} params.id - The library item id.
|
|
284
302
|
* @throws {RevenexxException}
|
|
285
|
-
* @returns {Promise<Models.
|
|
303
|
+
* @returns {Promise<Models.LibraryItem>}
|
|
286
304
|
*/
|
|
287
305
|
pagesLibraryGet(params: {
|
|
288
306
|
id: string;
|
|
289
|
-
}): Promise<Models.
|
|
307
|
+
}): Promise<Models.LibraryItem>;
|
|
290
308
|
/**
|
|
291
309
|
* The stored subtree behind one reusable block, so a picker can preview what dropping it into a page would produce. Because delivery expands the reference against THIS row at read time, what comes back is also what every page already using the item is currently rendering — which makes this the call to make before editing one.
|
|
292
310
|
*
|
|
293
311
|
* @param {string} id - The library item id.
|
|
294
312
|
* @throws {RevenexxException}
|
|
295
|
-
* @returns {Promise<Models.
|
|
313
|
+
* @returns {Promise<Models.LibraryItem>}
|
|
296
314
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
297
315
|
*/
|
|
298
|
-
pagesLibraryGet(id: string): Promise<Models.
|
|
316
|
+
pagesLibraryGet(id: string): Promise<Models.LibraryItem>;
|
|
299
317
|
/**
|
|
300
318
|
* The one write in this app whose blast radius is not a single page. Delivery expands a library reference against this row every time it serves, so replacing `tree` re-renders every page that points at the item — published ones included — without any of them being edited, republished or even touched. Nothing warns you first and no revision records it, because the pages did not change; the item did. Changing `label` or `bundle` only moves the item around the picker. Detaching one page from the item, so it keeps a copy of its own, is an editor mutation and not this route.
|
|
301
319
|
*
|
|
@@ -304,14 +322,14 @@ declare class Pages {
|
|
|
304
322
|
* @param {string} params.label - What the item is called in the picker.
|
|
305
323
|
* @param {object} params.tree - A block and its whole subtree, serialized. Produced by the editor when a selection is made reusable or saved as a template, and instantiated back into real blocks when one is inserted.
|
|
306
324
|
* @throws {RevenexxException}
|
|
307
|
-
* @returns {Promise<Models.
|
|
325
|
+
* @returns {Promise<Models.LibraryItem>}
|
|
308
326
|
*/
|
|
309
327
|
pagesLibraryUpdate(params: {
|
|
310
328
|
id: string;
|
|
311
329
|
bundle?: string;
|
|
312
330
|
label?: string;
|
|
313
331
|
tree?: object;
|
|
314
|
-
}): Promise<Models.
|
|
332
|
+
}): Promise<Models.LibraryItem>;
|
|
315
333
|
/**
|
|
316
334
|
* The one write in this app whose blast radius is not a single page. Delivery expands a library reference against this row every time it serves, so replacing `tree` re-renders every page that points at the item — published ones included — without any of them being edited, republished or even touched. Nothing warns you first and no revision records it, because the pages did not change; the item did. Changing `label` or `bundle` only moves the item around the picker. Detaching one page from the item, so it keeps a copy of its own, is an editor mutation and not this route.
|
|
317
335
|
*
|
|
@@ -320,10 +338,10 @@ declare class Pages {
|
|
|
320
338
|
* @param {string} label - What the item is called in the picker.
|
|
321
339
|
* @param {object} tree - A block and its whole subtree, serialized. Produced by the editor when a selection is made reusable or saved as a template, and instantiated back into real blocks when one is inserted.
|
|
322
340
|
* @throws {RevenexxException}
|
|
323
|
-
* @returns {Promise<Models.
|
|
341
|
+
* @returns {Promise<Models.LibraryItem>}
|
|
324
342
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
325
343
|
*/
|
|
326
|
-
pagesLibraryUpdate(id: string, bundle?: string, label?: string, tree?: object): Promise<Models.
|
|
344
|
+
pagesLibraryUpdate(id: string, bundle?: string, label?: string, tree?: object): Promise<Models.LibraryItem>;
|
|
327
345
|
/**
|
|
328
346
|
* The management view of the menus a tenant keeps — `main`, `footer`, `account` and whatever else the theme asks for, each with the key it is looked up by. This route reads no filter at all — a `?menu_key=` is ignored, which the empty `filter` echo shows — so fetch a page and pick, or address one by id.
|
|
329
347
|
*
|
|
@@ -356,13 +374,13 @@ declare class Pages {
|
|
|
356
374
|
* @param {string} params.menuKey - The stable slot the theme asks for this menu by. Idempotency is keyed on it: sending an existing key replaces that menu instead of creating a second one.
|
|
357
375
|
* @param {Models.PageMenuItem[]} params.items - The ordered navigation tree. Replaces the stored one completely.
|
|
358
376
|
* @throws {RevenexxException}
|
|
359
|
-
* @returns {Promise<Models.
|
|
377
|
+
* @returns {Promise<Models.Menu>}
|
|
360
378
|
*/
|
|
361
379
|
pagesMenusUpsert(params: {
|
|
362
380
|
label: string;
|
|
363
381
|
menuKey: string;
|
|
364
382
|
items?: Models.PageMenuItem[];
|
|
365
|
-
}): Promise<Models.
|
|
383
|
+
}): Promise<Models.Menu>;
|
|
366
384
|
/**
|
|
367
385
|
* Writes a menu by its KEY rather than by its id, which is what makes theme seeding safe to repeat: a key the tenant already has has its label and items replaced in place, a key it does not have is created. `items` is replaced wholesale and never merged, so sending an empty list empties the navigation. One caveat worth reading before you rely on the idempotence: the key's uniqueness is this route's doing and not the database's — `menu_key` carries an index but no unique constraint — so a duplicate key created any other way leaves this route updating whichever row it finds first.
|
|
368
386
|
*
|
|
@@ -370,48 +388,48 @@ declare class Pages {
|
|
|
370
388
|
* @param {string} menuKey - The stable slot the theme asks for this menu by. Idempotency is keyed on it: sending an existing key replaces that menu instead of creating a second one.
|
|
371
389
|
* @param {Models.PageMenuItem[]} items - The ordered navigation tree. Replaces the stored one completely.
|
|
372
390
|
* @throws {RevenexxException}
|
|
373
|
-
* @returns {Promise<Models.
|
|
391
|
+
* @returns {Promise<Models.Menu>}
|
|
374
392
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
375
393
|
*/
|
|
376
|
-
pagesMenusUpsert(label: string, menuKey: string, items?: Models.PageMenuItem[]): Promise<Models.
|
|
394
|
+
pagesMenusUpsert(label: string, menuKey: string, items?: Models.PageMenuItem[]): Promise<Models.Menu>;
|
|
377
395
|
/**
|
|
378
396
|
* Writes the tombstone. The menu drops out of the management list and out of `GET /pages/delivery/menus` in the same moment, so a theme that reads its key gets nothing back and renders nothing — there is no fallback and no error a storefront could act on. The key is free immediately, which means re-seeding the theme is the way back. Check what reads the key before striking it.
|
|
379
397
|
*
|
|
380
398
|
* @param {string} params.id - The menu row id.
|
|
381
399
|
* @throws {RevenexxException}
|
|
382
|
-
* @returns {Promise<
|
|
400
|
+
* @returns {Promise<{}>}
|
|
383
401
|
*/
|
|
384
402
|
pagesMenusDelete(params: {
|
|
385
403
|
id: string;
|
|
386
|
-
}): Promise<
|
|
404
|
+
}): Promise<{}>;
|
|
387
405
|
/**
|
|
388
406
|
* Writes the tombstone. The menu drops out of the management list and out of `GET /pages/delivery/menus` in the same moment, so a theme that reads its key gets nothing back and renders nothing — there is no fallback and no error a storefront could act on. The key is free immediately, which means re-seeding the theme is the way back. Check what reads the key before striking it.
|
|
389
407
|
*
|
|
390
408
|
* @param {string} id - The menu row id.
|
|
391
409
|
* @throws {RevenexxException}
|
|
392
|
-
* @returns {Promise<
|
|
410
|
+
* @returns {Promise<{}>}
|
|
393
411
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
394
412
|
*/
|
|
395
|
-
pagesMenusDelete(id: string): Promise<
|
|
413
|
+
pagesMenusDelete(id: string): Promise<{}>;
|
|
396
414
|
/**
|
|
397
415
|
* One menu and its whole item tree — the ordered links a theme renders as its header, footer or account navigation. `items` is nested, not one level, so this is the entire navigation for that key in a single read. Addressed by ROW ID here; the key a theme knows it by is `menu_key` on the body, and the route that works by key is the upsert.
|
|
398
416
|
*
|
|
399
417
|
* @param {string} params.id - The menu row id — not the menu key.
|
|
400
418
|
* @throws {RevenexxException}
|
|
401
|
-
* @returns {Promise<Models.
|
|
419
|
+
* @returns {Promise<Models.Menu>}
|
|
402
420
|
*/
|
|
403
421
|
pagesMenusGet(params: {
|
|
404
422
|
id: string;
|
|
405
|
-
}): Promise<Models.
|
|
423
|
+
}): Promise<Models.Menu>;
|
|
406
424
|
/**
|
|
407
425
|
* One menu and its whole item tree — the ordered links a theme renders as its header, footer or account navigation. `items` is nested, not one level, so this is the entire navigation for that key in a single read. Addressed by ROW ID here; the key a theme knows it by is `menu_key` on the body, and the route that works by key is the upsert.
|
|
408
426
|
*
|
|
409
427
|
* @param {string} id - The menu row id — not the menu key.
|
|
410
428
|
* @throws {RevenexxException}
|
|
411
|
-
* @returns {Promise<Models.
|
|
429
|
+
* @returns {Promise<Models.Menu>}
|
|
412
430
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
413
431
|
*/
|
|
414
|
-
pagesMenusGet(id: string): Promise<Models.
|
|
432
|
+
pagesMenusGet(id: string): Promise<Models.Menu>;
|
|
415
433
|
/**
|
|
416
434
|
* The same write as the upsert, for a caller that already holds the row id — use this when editing a menu a person picked from a list, and the upsert when reconciling a theme's defaults. `menu_key` is deliberately not editable here: the key is the handle every theme reads the menu by, so changing it would empty whatever is rendering that key without anything reporting an error.
|
|
417
435
|
*
|
|
@@ -419,13 +437,13 @@ declare class Pages {
|
|
|
419
437
|
* @param {Models.PageMenuItem[]} params.items - The ordered navigation tree. Replaces the stored one completely.
|
|
420
438
|
* @param {string} params.label - What this menu is called for the people who edit it.
|
|
421
439
|
* @throws {RevenexxException}
|
|
422
|
-
* @returns {Promise<Models.
|
|
440
|
+
* @returns {Promise<Models.Menu>}
|
|
423
441
|
*/
|
|
424
442
|
pagesMenusUpdate(params: {
|
|
425
443
|
id: string;
|
|
426
444
|
items?: Models.PageMenuItem[];
|
|
427
445
|
label?: string;
|
|
428
|
-
}): Promise<Models.
|
|
446
|
+
}): Promise<Models.Menu>;
|
|
429
447
|
/**
|
|
430
448
|
* The same write as the upsert, for a caller that already holds the row id — use this when editing a menu a person picked from a list, and the upsert when reconciling a theme's defaults. `menu_key` is deliberately not editable here: the key is the handle every theme reads the menu by, so changing it would empty whatever is rendering that key without anything reporting an error.
|
|
431
449
|
*
|
|
@@ -433,10 +451,10 @@ declare class Pages {
|
|
|
433
451
|
* @param {Models.PageMenuItem[]} items - The ordered navigation tree. Replaces the stored one completely.
|
|
434
452
|
* @param {string} label - What this menu is called for the people who edit it.
|
|
435
453
|
* @throws {RevenexxException}
|
|
436
|
-
* @returns {Promise<Models.
|
|
454
|
+
* @returns {Promise<Models.Menu>}
|
|
437
455
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
438
456
|
*/
|
|
439
|
-
pagesMenusUpdate(id: string, items?: Models.PageMenuItem[], label?: string): Promise<Models.
|
|
457
|
+
pagesMenusUpdate(id: string, items?: Models.PageMenuItem[], label?: string): Promise<Models.Menu>;
|
|
440
458
|
/**
|
|
441
459
|
* The EDITORIAL index — every live page of the tenant, whatever its status, newest change first. This is the list the Cockpit shows a person: drafts and archived pages are in it, and a row here says nothing about whether a visitor can see the page, because a published status without a published revision still delivers nothing. A storefront wants `GET /pages/delivery/pages` instead, which answers only what is actually servable. Soft-deleted pages are never returned and the predicate is this route's own, not something a caller can switch off.
|
|
442
460
|
*
|
|
@@ -481,7 +499,7 @@ declare class Pages {
|
|
|
481
499
|
* @param {string} params.slug - The path segment the storefront routes it under, without a leading slash. Unique per tenant among live pages; omit or send null for a page reached only by id. Nothing here derives one from the title.
|
|
482
500
|
* @param {string} params.sourceLanguage - The language you are authoring in, and the fallback for every later translation. Omit to take the default_source_language setting for the request market.
|
|
483
501
|
* @throws {RevenexxException}
|
|
484
|
-
* @returns {Promise<Models.
|
|
502
|
+
* @returns {Promise<Models.Page>}
|
|
485
503
|
*/
|
|
486
504
|
pagesPagesCreate(params: {
|
|
487
505
|
title: string;
|
|
@@ -490,7 +508,7 @@ declare class Pages {
|
|
|
490
508
|
meta?: object;
|
|
491
509
|
slug?: string;
|
|
492
510
|
sourceLanguage?: string;
|
|
493
|
-
}): Promise<Models.
|
|
511
|
+
}): Promise<Models.Page>;
|
|
494
512
|
/**
|
|
495
513
|
* Writes two rows, not one: the page itself and the translation row for its source language, so a page is never without the language it was authored in and `GET /pages/delivery/page?slug=` can match a localized URL from the first moment. Everything the caller leaves out comes from the tenant's settings, not from a literal in this app: `bundle` from default_page_bundle, `sourceLanguage` from default_source_language (resolved for the request's market), and the status of both the page and its source translation from default_page_status (draft | published).
|
|
496
514
|
*
|
|
@@ -501,48 +519,48 @@ declare class Pages {
|
|
|
501
519
|
* @param {string} slug - The path segment the storefront routes it under, without a leading slash. Unique per tenant among live pages; omit or send null for a page reached only by id. Nothing here derives one from the title.
|
|
502
520
|
* @param {string} sourceLanguage - The language you are authoring in, and the fallback for every later translation. Omit to take the default_source_language setting for the request market.
|
|
503
521
|
* @throws {RevenexxException}
|
|
504
|
-
* @returns {Promise<Models.
|
|
522
|
+
* @returns {Promise<Models.Page>}
|
|
505
523
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
506
524
|
*/
|
|
507
|
-
pagesPagesCreate(title: string, bundle?: string, hostOptions?: object, meta?: object, slug?: string, sourceLanguage?: string): Promise<Models.
|
|
525
|
+
pagesPagesCreate(title: string, bundle?: string, hostOptions?: object, meta?: object, slug?: string, sourceLanguage?: string): Promise<Models.Page>;
|
|
508
526
|
/**
|
|
509
527
|
* Writes a tombstone. The page leaves every list, every read and all delivery at once, and its slug is immediately free for another page — the unique index counts live rows only. Nothing is erased: the translations, blocks, edit state, revisions, comments and preview grants that hang off the page all keep their rows, because their `on delete cascade` belongs to a hard delete and this is not one. So a page can be brought back intact by clearing `deleted_at` — but not through this app, which publishes no route that does it.
|
|
510
528
|
*
|
|
511
529
|
* @param {string} params.id - The page id.
|
|
512
530
|
* @throws {RevenexxException}
|
|
513
|
-
* @returns {Promise<
|
|
531
|
+
* @returns {Promise<{}>}
|
|
514
532
|
*/
|
|
515
533
|
pagesPagesDelete(params: {
|
|
516
534
|
id: string;
|
|
517
|
-
}): Promise<
|
|
535
|
+
}): Promise<{}>;
|
|
518
536
|
/**
|
|
519
537
|
* Writes a tombstone. The page leaves every list, every read and all delivery at once, and its slug is immediately free for another page — the unique index counts live rows only. Nothing is erased: the translations, blocks, edit state, revisions, comments and preview grants that hang off the page all keep their rows, because their `on delete cascade` belongs to a hard delete and this is not one. So a page can be brought back intact by clearing `deleted_at` — but not through this app, which publishes no route that does it.
|
|
520
538
|
*
|
|
521
539
|
* @param {string} id - The page id.
|
|
522
540
|
* @throws {RevenexxException}
|
|
523
|
-
* @returns {Promise<
|
|
541
|
+
* @returns {Promise<{}>}
|
|
524
542
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
525
543
|
*/
|
|
526
|
-
pagesPagesDelete(id: string): Promise<
|
|
544
|
+
pagesPagesDelete(id: string): Promise<{}>;
|
|
527
545
|
/**
|
|
528
546
|
* One page RECORD: what it is called, where it routes, what type it is, which revision is live. Not its content — the blocks are not on this row and no expansion here returns them. The editor reads them with `GET /pages/editor/{page_id}/state`, a renderer with `GET /pages/delivery/page`. A soft-deleted page answers 404 exactly like one that never existed, so this is also the check for whether an id is still good.
|
|
529
547
|
*
|
|
530
548
|
* @param {string} params.id - The page id.
|
|
531
549
|
* @throws {RevenexxException}
|
|
532
|
-
* @returns {Promise<Models.
|
|
550
|
+
* @returns {Promise<Models.Page>}
|
|
533
551
|
*/
|
|
534
552
|
pagesPagesGet(params: {
|
|
535
553
|
id: string;
|
|
536
|
-
}): Promise<Models.
|
|
554
|
+
}): Promise<Models.Page>;
|
|
537
555
|
/**
|
|
538
556
|
* One page RECORD: what it is called, where it routes, what type it is, which revision is live. Not its content — the blocks are not on this row and no expansion here returns them. The editor reads them with `GET /pages/editor/{page_id}/state`, a renderer with `GET /pages/delivery/page`. A soft-deleted page answers 404 exactly like one that never existed, so this is also the check for whether an id is still good.
|
|
539
557
|
*
|
|
540
558
|
* @param {string} id - The page id.
|
|
541
559
|
* @throws {RevenexxException}
|
|
542
|
-
* @returns {Promise<Models.
|
|
560
|
+
* @returns {Promise<Models.Page>}
|
|
543
561
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
544
562
|
*/
|
|
545
|
-
pagesPagesGet(id: string): Promise<Models.
|
|
563
|
+
pagesPagesGet(id: string): Promise<Models.Page>;
|
|
546
564
|
/**
|
|
547
565
|
* Corrects the page RECORD — the five fields an editor changes without opening the visual editor, which are `title`, `slug`, `status`, `meta` and `bundle`, and no others. Anything else in the body is dropped rather than refused, and the block tree is unreachable from here by design: content moves only through the editor's mutation log, so a caller cannot half-edit a page behind the undo history's back. Two consequences worth knowing before you call it: a slug is unique among live pages, so claiming one that is held answers 409; and setting `status` to published does NOT put anything in front of a visitor — delivery needs a revision, which only `POST /pages/editor/{page_id}/publish` writes.
|
|
548
566
|
*
|
|
@@ -553,7 +571,7 @@ declare class Pages {
|
|
|
553
571
|
* @param {PageStatus} params.status - The lifecycle status. Setting `published` here does NOT publish content — delivery still needs a revision, which only `POST /pages/editor/{page_id}/publish` writes.
|
|
554
572
|
* @param {string} params.title - The page title in its source language.
|
|
555
573
|
* @throws {RevenexxException}
|
|
556
|
-
* @returns {Promise<Models.
|
|
574
|
+
* @returns {Promise<Models.Page>}
|
|
557
575
|
*/
|
|
558
576
|
pagesPagesUpdate(params: {
|
|
559
577
|
id: string;
|
|
@@ -562,7 +580,7 @@ declare class Pages {
|
|
|
562
580
|
slug?: string;
|
|
563
581
|
status?: PageStatus;
|
|
564
582
|
title?: string;
|
|
565
|
-
}): Promise<Models.
|
|
583
|
+
}): Promise<Models.Page>;
|
|
566
584
|
/**
|
|
567
585
|
* Corrects the page RECORD — the five fields an editor changes without opening the visual editor, which are `title`, `slug`, `status`, `meta` and `bundle`, and no others. Anything else in the body is dropped rather than refused, and the block tree is unreachable from here by design: content moves only through the editor's mutation log, so a caller cannot half-edit a page behind the undo history's back. Two consequences worth knowing before you call it: a slug is unique among live pages, so claiming one that is held answers 409; and setting `status` to published does NOT put anything in front of a visitor — delivery needs a revision, which only `POST /pages/editor/{page_id}/publish` writes.
|
|
568
586
|
*
|
|
@@ -573,10 +591,10 @@ declare class Pages {
|
|
|
573
591
|
* @param {PageStatus} status - The lifecycle status. Setting `published` here does NOT publish content — delivery still needs a revision, which only `POST /pages/editor/{page_id}/publish` writes.
|
|
574
592
|
* @param {string} title - The page title in its source language.
|
|
575
593
|
* @throws {RevenexxException}
|
|
576
|
-
* @returns {Promise<Models.
|
|
594
|
+
* @returns {Promise<Models.Page>}
|
|
577
595
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
578
596
|
*/
|
|
579
|
-
pagesPagesUpdate(id: string, bundle?: string, meta?: object, slug?: string, status?: PageStatus, title?: string): Promise<Models.
|
|
597
|
+
pagesPagesUpdate(id: string, bundle?: string, meta?: object, slug?: string, status?: PageStatus, title?: string): Promise<Models.Page>;
|
|
580
598
|
/**
|
|
581
599
|
* One entry per publication, newest first, which is the order a history is read in and the one this route sorts by unless `order` says otherwise. The `snapshot` — the whole published page, in every language — is deliberately not in the index: it is page-sized, and nothing that renders a history needs it.
|
|
582
600
|
*
|
|
@@ -589,7 +607,7 @@ declare class Pages {
|
|
|
589
607
|
* @param {string} params.createdByName - Exact display name recorded at publish time.
|
|
590
608
|
* @param {string} params.createdAt - Exact publication timestamp, RFC 3339. Equality only — this data plane has no range operator, so walk the history with `order=created_at.desc` and `limit` instead.
|
|
591
609
|
* @throws {RevenexxException}
|
|
592
|
-
* @returns {Promise<
|
|
610
|
+
* @returns {Promise<{}>}
|
|
593
611
|
*/
|
|
594
612
|
pagesPagesRevisions(params: {
|
|
595
613
|
id: string;
|
|
@@ -600,7 +618,7 @@ declare class Pages {
|
|
|
600
618
|
createdBy?: string;
|
|
601
619
|
createdByName?: string;
|
|
602
620
|
createdAt?: string;
|
|
603
|
-
}): Promise<
|
|
621
|
+
}): Promise<{}>;
|
|
604
622
|
/**
|
|
605
623
|
* One entry per publication, newest first, which is the order a history is read in and the one this route sorts by unless `order` says otherwise. The `snapshot` — the whole published page, in every language — is deliberately not in the index: it is page-sized, and nothing that renders a history needs it.
|
|
606
624
|
*
|
|
@@ -613,10 +631,10 @@ declare class Pages {
|
|
|
613
631
|
* @param {string} createdByName - Exact display name recorded at publish time.
|
|
614
632
|
* @param {string} createdAt - Exact publication timestamp, RFC 3339. Equality only — this data plane has no range operator, so walk the history with `order=created_at.desc` and `limit` instead.
|
|
615
633
|
* @throws {RevenexxException}
|
|
616
|
-
* @returns {Promise<
|
|
634
|
+
* @returns {Promise<{}>}
|
|
617
635
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
618
636
|
*/
|
|
619
|
-
pagesPagesRevisions(id: string, limit?: number, offset?: number, order?: string, label?: string, createdBy?: string, createdByName?: string, createdAt?: string): Promise<
|
|
637
|
+
pagesPagesRevisions(id: string, limit?: number, offset?: number, order?: string, label?: string, createdBy?: string, createdByName?: string, createdAt?: string): Promise<{}>;
|
|
620
638
|
/**
|
|
621
639
|
* The target of a theme activation hook: hand it the theme's default pages and menus and it creates whatever is missing. Idempotent by `slug` and by menu key — a slug or a key the tenant already holds is skipped rather than rewritten, so re-running after a theme update adds only the new ones and never overwrites what an editor has since changed. A seeded page is published on the spot, immediately servable by delivery: the default_page_status setting deliberately does not apply, because a theme that activates with invisible pages looks broken.
|
|
622
640
|
*
|
|
@@ -696,39 +714,39 @@ declare class Pages {
|
|
|
696
714
|
*
|
|
697
715
|
* @param {string} params.id - The template id.
|
|
698
716
|
* @throws {RevenexxException}
|
|
699
|
-
* @returns {Promise<
|
|
717
|
+
* @returns {Promise<{}>}
|
|
700
718
|
*/
|
|
701
719
|
pagesTemplatesDelete(params: {
|
|
702
720
|
id: string;
|
|
703
|
-
}): Promise<
|
|
721
|
+
}): Promise<{}>;
|
|
704
722
|
/**
|
|
705
723
|
* Removes the template row outright. This is the one delete in the app that is not a tombstone — `templates` carries no `deleted_at` — so it cannot be undone and the id will not come back. Nothing else breaks by it: pages built from the template hold their own copy of the blocks and never referenced the row.
|
|
706
724
|
*
|
|
707
725
|
* @param {string} id - The template id.
|
|
708
726
|
* @throws {RevenexxException}
|
|
709
|
-
* @returns {Promise<
|
|
727
|
+
* @returns {Promise<{}>}
|
|
710
728
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
711
729
|
*/
|
|
712
|
-
pagesTemplatesDelete(id: string): Promise<
|
|
730
|
+
pagesTemplatesDelete(id: string): Promise<{}>;
|
|
713
731
|
/**
|
|
714
732
|
* The blocks a page would START from if an editor picked this template — read it to preview the insert. A template is a COPY source, the opposite of a library item: nothing links back from the pages already built from it, so this tells you what future pages get and nothing about existing ones.
|
|
715
733
|
*
|
|
716
734
|
* @param {string} params.id - The template id.
|
|
717
735
|
* @throws {RevenexxException}
|
|
718
|
-
* @returns {Promise<Models.
|
|
736
|
+
* @returns {Promise<Models.Template>}
|
|
719
737
|
*/
|
|
720
738
|
pagesTemplatesGet(params: {
|
|
721
739
|
id: string;
|
|
722
|
-
}): Promise<Models.
|
|
740
|
+
}): Promise<Models.Template>;
|
|
723
741
|
/**
|
|
724
742
|
* The blocks a page would START from if an editor picked this template — read it to preview the insert. A template is a COPY source, the opposite of a library item: nothing links back from the pages already built from it, so this tells you what future pages get and nothing about existing ones.
|
|
725
743
|
*
|
|
726
744
|
* @param {string} id - The template id.
|
|
727
745
|
* @throws {RevenexxException}
|
|
728
|
-
* @returns {Promise<Models.
|
|
746
|
+
* @returns {Promise<Models.Template>}
|
|
729
747
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
730
748
|
*/
|
|
731
|
-
pagesTemplatesGet(id: string): Promise<Models.
|
|
749
|
+
pagesTemplatesGet(id: string): Promise<Models.Template>;
|
|
732
750
|
/**
|
|
733
751
|
* Edits what a future page will start from. Because templates copy rather than share, this reaches nothing that already exists — pages built from it keep the blocks they were handed, which is exactly the property that makes a template safe to edit and a library item dangerous. `is_default` is the one field with an effect past the picker: it decides what a new page of `page_bundle` starts with, and nothing here stops two templates of the same bundle from both claiming it, so which one wins is left to whoever reads the list.
|
|
734
752
|
*
|
|
@@ -740,7 +758,7 @@ declare class Pages {
|
|
|
740
758
|
* @param {string} params.pageBundle - The page type this template is offered on. Null offers it on every page type.
|
|
741
759
|
* @param {Models.PageBlockTree[]} params.tree - The blocks the template inserts, in order. Replaces the stored tree completely.
|
|
742
760
|
* @throws {RevenexxException}
|
|
743
|
-
* @returns {Promise<Models.
|
|
761
|
+
* @returns {Promise<Models.Template>}
|
|
744
762
|
*/
|
|
745
763
|
pagesTemplatesUpdate(params: {
|
|
746
764
|
id: string;
|
|
@@ -750,7 +768,7 @@ declare class Pages {
|
|
|
750
768
|
label?: string;
|
|
751
769
|
pageBundle?: string;
|
|
752
770
|
tree?: Models.PageBlockTree[];
|
|
753
|
-
}): Promise<Models.
|
|
771
|
+
}): Promise<Models.Template>;
|
|
754
772
|
/**
|
|
755
773
|
* Edits what a future page will start from. Because templates copy rather than share, this reaches nothing that already exists — pages built from it keep the blocks they were handed, which is exactly the property that makes a template safe to edit and a library item dangerous. `is_default` is the one field with an effect past the picker: it decides what a new page of `page_bundle` starts with, and nothing here stops two templates of the same bundle from both claiming it, so which one wins is left to whoever reads the list.
|
|
756
774
|
*
|
|
@@ -762,10 +780,10 @@ declare class Pages {
|
|
|
762
780
|
* @param {string} pageBundle - The page type this template is offered on. Null offers it on every page type.
|
|
763
781
|
* @param {Models.PageBlockTree[]} tree - The blocks the template inserts, in order. Replaces the stored tree completely.
|
|
764
782
|
* @throws {RevenexxException}
|
|
765
|
-
* @returns {Promise<Models.
|
|
783
|
+
* @returns {Promise<Models.Template>}
|
|
766
784
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
767
785
|
*/
|
|
768
|
-
pagesTemplatesUpdate(id: string, description?: string, fieldName?: string, isDefault?: boolean, label?: string, pageBundle?: string, tree?: Models.PageBlockTree[]): Promise<Models.
|
|
786
|
+
pagesTemplatesUpdate(id: string, description?: string, fieldName?: string, isDefault?: boolean, label?: string, pageBundle?: string, tree?: Models.PageBlockTree[]): Promise<Models.Template>;
|
|
769
787
|
/**
|
|
770
788
|
* Discovery for the vocabulary routes: the enums this app publishes, each with its name, its title and what it is for, and none of them unpacked — the permitted values are not on this route, only on the one that serves a single vocabulary. Names: edit-state-statuses, page-statuses, translation-statuses. Fetch one with GET /pages/vocabularies/{name}; a client holding the qualified pair 'pages.<name>' builds that URL from the pair alone.
|
|
771
789
|
*
|
|
@@ -778,20 +796,20 @@ declare class Pages {
|
|
|
778
796
|
*
|
|
779
797
|
* @param {PagesVocabulariesGetName} params.name - The vocabulary name — the part after the dot in the qualified id.
|
|
780
798
|
* @throws {RevenexxException}
|
|
781
|
-
* @returns {Promise<Models.
|
|
799
|
+
* @returns {Promise<Models.PagesVocabulary>}
|
|
782
800
|
*/
|
|
783
801
|
pagesVocabulariesGet(params: {
|
|
784
802
|
name: PagesVocabulariesGetName;
|
|
785
|
-
}): Promise<Models.
|
|
803
|
+
}): Promise<Models.PagesVocabulary>;
|
|
786
804
|
/**
|
|
787
805
|
* One vocabulary unpacked: every value the column permits, each with the title to show for it, the sentence explaining it and the badge tone to render it in — everything a select or a status pill needs, so nothing downstream keeps its own copy of the labels. The values are read out of the column's CHECK constraint, so the served set IS the enforced set and the two cannot drift — a value added to the constraint appears here even before anyone labels it, titled from its own key. Values come back in constraint order, which is the order a select should offer. 'closed' says the set is exhaustive, so a value outside it is stale data rather than a missing label. Names: edit-state-statuses, page-statuses, translation-statuses.
|
|
788
806
|
*
|
|
789
807
|
* @param {PagesVocabulariesGetName} name - The vocabulary name — the part after the dot in the qualified id.
|
|
790
808
|
* @throws {RevenexxException}
|
|
791
|
-
* @returns {Promise<Models.
|
|
809
|
+
* @returns {Promise<Models.PagesVocabulary>}
|
|
792
810
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
793
811
|
*/
|
|
794
|
-
pagesVocabulariesGet(name: PagesVocabulariesGetName): Promise<Models.
|
|
812
|
+
pagesVocabulariesGet(name: PagesVocabulariesGetName): Promise<Models.PagesVocabulary>;
|
|
795
813
|
}
|
|
796
814
|
|
|
797
815
|
export { Pages };
|