@revenexx/node 0.0.2 → 0.1.0
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 +9 -5
- package/dist/client.d.mts +175 -12
- package/dist/client.d.ts +175 -12
- package/dist/client.js +39 -46
- package/dist/client.js.map +1 -1
- package/dist/client.mjs +36 -43
- package/dist/client.mjs.map +1 -1
- package/dist/enums/address-type-row-create-request-tone.d.mts +9 -0
- package/dist/enums/address-type-row-create-request-tone.d.ts +9 -0
- package/dist/enums/address-type-row-create-request-tone.js +14 -0
- package/dist/enums/address-type-row-create-request-tone.js.map +1 -0
- package/dist/enums/address-type-row-create-request-tone.mjs +13 -0
- package/dist/enums/address-type-row-create-request-tone.mjs.map +1 -0
- package/dist/enums/address-type-row-tone.d.mts +9 -0
- package/dist/enums/address-type-row-tone.d.ts +9 -0
- package/dist/enums/address-type-row-tone.js +14 -0
- package/dist/enums/address-type-row-tone.js.map +1 -0
- package/dist/enums/address-type-row-tone.mjs +13 -0
- package/dist/enums/address-type-row-tone.mjs.map +1 -0
- package/dist/enums/address-type-row-update-request-tone.d.mts +9 -0
- package/dist/enums/address-type-row-update-request-tone.d.ts +9 -0
- package/dist/enums/address-type-row-update-request-tone.js +14 -0
- package/dist/enums/address-type-row-update-request-tone.js.map +1 -0
- package/dist/enums/address-type-row-update-request-tone.mjs +13 -0
- package/dist/enums/address-type-row-update-request-tone.mjs.map +1 -0
- package/dist/enums/apply-mode.d.mts +7 -0
- package/dist/enums/apply-mode.d.ts +7 -0
- package/dist/enums/apply-mode.js +12 -0
- package/dist/enums/apply-mode.js.map +1 -0
- package/dist/enums/apply-mode.mjs +11 -0
- package/dist/enums/apply-mode.mjs.map +1 -0
- package/dist/enums/apps-create-vcs-deployment-type.d.mts +6 -0
- package/dist/enums/apps-create-vcs-deployment-type.d.ts +6 -0
- package/dist/enums/apps-create-vcs-deployment-type.js +11 -0
- package/dist/enums/apps-create-vcs-deployment-type.js.map +1 -0
- package/dist/enums/apps-create-vcs-deployment-type.mjs +10 -0
- package/dist/enums/apps-create-vcs-deployment-type.mjs.map +1 -0
- package/dist/enums/apps-get-deployment-download-type.d.mts +6 -0
- package/dist/enums/apps-get-deployment-download-type.d.ts +6 -0
- package/dist/enums/apps-get-deployment-download-type.js +11 -0
- package/dist/enums/apps-get-deployment-download-type.js.map +1 -0
- package/dist/enums/apps-get-deployment-download-type.mjs +10 -0
- package/dist/enums/apps-get-deployment-download-type.mjs.map +1 -0
- package/dist/enums/assets-source.d.mts +6 -0
- package/dist/enums/assets-source.d.ts +6 -0
- package/dist/enums/assets-source.js +11 -0
- package/dist/enums/assets-source.js.map +1 -0
- package/dist/enums/assets-source.mjs +10 -0
- package/dist/enums/assets-source.mjs.map +1 -0
- package/dist/enums/attribute-value-bucket.d.mts +8 -0
- package/dist/enums/attribute-value-bucket.d.ts +8 -0
- package/dist/enums/attribute-value-bucket.js +13 -0
- package/dist/enums/attribute-value-bucket.js.map +1 -0
- package/dist/enums/attribute-value-bucket.mjs +12 -0
- package/dist/enums/attribute-value-bucket.mjs.map +1 -0
- package/dist/enums/auth-mail-source.d.mts +6 -0
- package/dist/enums/auth-mail-source.d.ts +6 -0
- package/dist/enums/auth-mail-source.js +11 -0
- package/dist/enums/auth-mail-source.js.map +1 -0
- package/dist/enums/auth-mail-source.mjs +10 -0
- package/dist/enums/auth-mail-source.mjs.map +1 -0
- package/dist/enums/avatars-get-credit-card-code.d.mts +21 -0
- package/dist/enums/avatars-get-credit-card-code.d.ts +21 -0
- package/dist/enums/avatars-get-credit-card-code.js +26 -0
- package/dist/enums/avatars-get-credit-card-code.js.map +1 -0
- package/dist/enums/avatars-get-credit-card-code.mjs +25 -0
- package/dist/enums/avatars-get-credit-card-code.mjs.map +1 -0
- package/dist/enums/avatars-get-flag-code.d.mts +199 -0
- package/dist/enums/avatars-get-flag-code.d.ts +199 -0
- package/dist/enums/avatars-get-flag-code.js +204 -0
- package/dist/enums/avatars-get-flag-code.js.map +1 -0
- package/dist/enums/avatars-get-flag-code.mjs +203 -0
- package/dist/enums/avatars-get-flag-code.mjs.map +1 -0
- package/dist/enums/budget-change-reason.d.mts +11 -0
- package/dist/enums/budget-change-reason.d.ts +11 -0
- package/dist/enums/budget-change-reason.js +16 -0
- package/dist/enums/budget-change-reason.js.map +1 -0
- package/dist/enums/budget-change-reason.mjs +15 -0
- package/dist/enums/budget-change-reason.mjs.map +1 -0
- package/dist/enums/budget-movement-result-status.d.mts +8 -0
- package/dist/enums/budget-movement-result-status.d.ts +8 -0
- package/dist/enums/budget-movement-result-status.js +13 -0
- package/dist/enums/budget-movement-result-status.js.map +1 -0
- package/dist/enums/budget-movement-result-status.mjs +12 -0
- package/dist/enums/budget-movement-result-status.mjs.map +1 -0
- package/dist/enums/cart-merge-strategy.d.mts +6 -0
- package/dist/enums/cart-merge-strategy.d.ts +6 -0
- package/dist/enums/cart-merge-strategy.js +11 -0
- package/dist/enums/cart-merge-strategy.js.map +1 -0
- package/dist/enums/cart-merge-strategy.mjs +10 -0
- package/dist/enums/cart-merge-strategy.mjs.map +1 -0
- package/dist/enums/cart-price-snapshot-mode.d.mts +6 -0
- package/dist/enums/cart-price-snapshot-mode.d.ts +6 -0
- package/dist/enums/cart-price-snapshot-mode.js +11 -0
- package/dist/enums/cart-price-snapshot-mode.js.map +1 -0
- package/dist/enums/cart-price-snapshot-mode.mjs +10 -0
- package/dist/enums/cart-price-snapshot-mode.mjs.map +1 -0
- package/dist/enums/cart-status.d.mts +8 -0
- package/dist/enums/cart-status.d.ts +8 -0
- package/dist/enums/cart-status.js +13 -0
- package/dist/enums/cart-status.js.map +1 -0
- package/dist/enums/cart-status.mjs +12 -0
- package/dist/enums/cart-status.mjs.map +1 -0
- package/dist/enums/cart-vocabulary-name.d.mts +10 -0
- package/dist/enums/cart-vocabulary-name.d.ts +10 -0
- package/dist/enums/cart-vocabulary-name.js +15 -0
- package/dist/enums/cart-vocabulary-name.js.map +1 -0
- package/dist/enums/cart-vocabulary-name.mjs +14 -0
- package/dist/enums/cart-vocabulary-name.mjs.map +1 -0
- package/dist/enums/cart-vocabulary-ref-name.d.mts +10 -0
- package/dist/enums/cart-vocabulary-ref-name.d.ts +10 -0
- package/dist/enums/cart-vocabulary-ref-name.js +15 -0
- package/dist/enums/cart-vocabulary-ref-name.js.map +1 -0
- package/dist/enums/cart-vocabulary-ref-name.mjs +14 -0
- package/dist/enums/cart-vocabulary-ref-name.mjs.map +1 -0
- package/dist/enums/cart-vocabulary-source.d.mts +5 -0
- package/dist/enums/cart-vocabulary-source.d.ts +5 -0
- package/dist/enums/cart-vocabulary-source.js +10 -0
- package/dist/enums/cart-vocabulary-source.js.map +1 -0
- package/dist/enums/cart-vocabulary-source.mjs +9 -0
- package/dist/enums/cart-vocabulary-source.mjs.map +1 -0
- package/dist/enums/cart-vocabulary-tone.d.mts +9 -0
- package/dist/enums/cart-vocabulary-tone.d.ts +9 -0
- package/dist/enums/cart-vocabulary-tone.js +14 -0
- package/dist/enums/cart-vocabulary-tone.js.map +1 -0
- package/dist/enums/cart-vocabulary-tone.mjs +13 -0
- package/dist/enums/cart-vocabulary-tone.mjs.map +1 -0
- package/dist/enums/categories-rule-match.d.mts +6 -0
- package/dist/enums/categories-rule-match.d.ts +6 -0
- package/dist/enums/categories-rule-match.js +11 -0
- package/dist/enums/categories-rule-match.js.map +1 -0
- package/dist/enums/categories-rule-match.mjs +10 -0
- package/dist/enums/categories-rule-match.mjs.map +1 -0
- package/dist/enums/category-rule-match.d.mts +6 -0
- package/dist/enums/category-rule-match.d.ts +6 -0
- package/dist/enums/category-rule-match.js +11 -0
- package/dist/enums/category-rule-match.js.map +1 -0
- package/dist/enums/category-rule-match.mjs +10 -0
- package/dist/enums/category-rule-match.mjs.map +1 -0
- package/dist/enums/category-rule-operator.d.mts +16 -0
- package/dist/enums/category-rule-operator.d.ts +16 -0
- package/dist/enums/category-rule-operator.js +21 -0
- package/dist/enums/category-rule-operator.js.map +1 -0
- package/dist/enums/category-rule-operator.mjs +20 -0
- package/dist/enums/category-rule-operator.mjs.map +1 -0
- package/dist/enums/channel-context-source.d.mts +9 -0
- package/dist/enums/channel-context-source.d.ts +9 -0
- package/dist/enums/channel-context-source.js +14 -0
- package/dist/enums/channel-context-source.js.map +1 -0
- package/dist/enums/channel-context-source.mjs +13 -0
- package/dist/enums/channel-context-source.mjs.map +1 -0
- package/dist/enums/channel-inactive-behavior.d.mts +6 -0
- package/dist/enums/channel-inactive-behavior.d.ts +6 -0
- package/dist/enums/channel-inactive-behavior.js +11 -0
- package/dist/enums/channel-inactive-behavior.js.map +1 -0
- package/dist/enums/channel-inactive-behavior.mjs +10 -0
- package/dist/enums/channel-inactive-behavior.mjs.map +1 -0
- package/dist/enums/channel-policy-source.d.mts +6 -0
- package/dist/enums/channel-policy-source.d.ts +6 -0
- package/dist/enums/channel-policy-source.js +11 -0
- package/dist/enums/channel-policy-source.js.map +1 -0
- package/dist/enums/channel-policy-source.mjs +10 -0
- package/dist/enums/channel-policy-source.mjs.map +1 -0
- package/dist/enums/channel-policy-tenant-default.d.mts +6 -0
- package/dist/enums/channel-policy-tenant-default.d.ts +6 -0
- package/dist/enums/channel-policy-tenant-default.js +11 -0
- package/dist/enums/channel-policy-tenant-default.js.map +1 -0
- package/dist/enums/channel-policy-tenant-default.mjs +10 -0
- package/dist/enums/channel-policy-tenant-default.mjs.map +1 -0
- package/dist/enums/channel-type-tone.d.mts +9 -0
- package/dist/enums/channel-type-tone.d.ts +9 -0
- package/dist/enums/channel-type-tone.js +14 -0
- package/dist/enums/channel-type-tone.js.map +1 -0
- package/dist/enums/channel-type-tone.mjs +13 -0
- package/dist/enums/channel-type-tone.mjs.map +1 -0
- package/dist/enums/channel-unassigned-policy.d.mts +6 -0
- package/dist/enums/channel-unassigned-policy.d.ts +6 -0
- package/dist/enums/channel-unassigned-policy.js +11 -0
- package/dist/enums/channel-unassigned-policy.js.map +1 -0
- package/dist/enums/channel-unassigned-policy.mjs +10 -0
- package/dist/enums/channel-unassigned-policy.mjs.map +1 -0
- package/dist/enums/channel-unassigned-visibility.d.mts +7 -0
- package/dist/enums/channel-unassigned-visibility.d.ts +7 -0
- package/dist/enums/channel-unassigned-visibility.js +12 -0
- package/dist/enums/channel-unassigned-visibility.js.map +1 -0
- package/dist/enums/channel-unassigned-visibility.mjs +11 -0
- package/dist/enums/channel-unassigned-visibility.mjs.map +1 -0
- package/dist/enums/channel-unresolved-reason.d.mts +8 -0
- package/dist/enums/channel-unresolved-reason.d.ts +8 -0
- package/dist/enums/channel-unresolved-reason.js +13 -0
- package/dist/enums/channel-unresolved-reason.js.map +1 -0
- package/dist/enums/channel-unresolved-reason.mjs +12 -0
- package/dist/enums/channel-unresolved-reason.mjs.map +1 -0
- package/dist/enums/channel-visibility-reason.d.mts +9 -0
- package/dist/enums/channel-visibility-reason.d.ts +9 -0
- package/dist/enums/channel-visibility-reason.js +14 -0
- package/dist/enums/channel-visibility-reason.js.map +1 -0
- package/dist/enums/channel-visibility-reason.mjs +13 -0
- package/dist/enums/channel-visibility-reason.mjs.map +1 -0
- package/dist/enums/channel-vocabulary-name.d.mts +7 -0
- package/dist/enums/channel-vocabulary-name.d.ts +7 -0
- package/dist/enums/channel-vocabulary-name.js +12 -0
- package/dist/enums/channel-vocabulary-name.js.map +1 -0
- package/dist/enums/channel-vocabulary-name.mjs +11 -0
- package/dist/enums/channel-vocabulary-name.mjs.map +1 -0
- package/dist/enums/channel-vocabulary-ref-name.d.mts +7 -0
- package/dist/enums/channel-vocabulary-ref-name.d.ts +7 -0
- package/dist/enums/channel-vocabulary-ref-name.js +12 -0
- package/dist/enums/channel-vocabulary-ref-name.js.map +1 -0
- package/dist/enums/channel-vocabulary-ref-name.mjs +11 -0
- package/dist/enums/channel-vocabulary-ref-name.mjs.map +1 -0
- package/dist/enums/channel-vocabulary-source.d.mts +6 -0
- package/dist/enums/channel-vocabulary-source.d.ts +6 -0
- package/dist/enums/channel-vocabulary-source.js +11 -0
- package/dist/enums/channel-vocabulary-source.js.map +1 -0
- package/dist/enums/channel-vocabulary-source.mjs +10 -0
- package/dist/enums/channel-vocabulary-source.mjs.map +1 -0
- package/dist/enums/channel-vocabulary-tone.d.mts +9 -0
- package/dist/enums/channel-vocabulary-tone.d.ts +9 -0
- package/dist/enums/channel-vocabulary-tone.js +14 -0
- package/dist/enums/channel-vocabulary-tone.js.map +1 -0
- package/dist/enums/channel-vocabulary-tone.mjs +13 -0
- package/dist/enums/channel-vocabulary-tone.mjs.map +1 -0
- package/dist/enums/channels-vocabularies-get-name.d.mts +7 -0
- package/dist/enums/channels-vocabularies-get-name.d.ts +7 -0
- package/dist/enums/channels-vocabularies-get-name.js +12 -0
- package/dist/enums/channels-vocabularies-get-name.js.map +1 -0
- package/dist/enums/channels-vocabularies-get-name.mjs +11 -0
- package/dist/enums/channels-vocabularies-get-name.mjs.map +1 -0
- package/dist/enums/collection.d.mts +0 -1
- package/dist/enums/collection.d.ts +0 -1
- package/dist/enums/collection.js +0 -1
- package/dist/enums/collection.js.map +1 -1
- package/dist/enums/collection.mjs +0 -1
- package/dist/enums/collection.mjs.map +1 -1
- package/dist/enums/conditions.d.mts +6 -0
- package/dist/enums/conditions.d.ts +6 -0
- package/dist/enums/conditions.js +11 -0
- package/dist/enums/conditions.js.map +1 -0
- package/dist/enums/conditions.mjs +10 -0
- package/dist/enums/conditions.mjs.map +1 -0
- package/dist/enums/contact-activity-kind.d.mts +10 -0
- package/dist/enums/contact-activity-kind.d.ts +10 -0
- package/dist/enums/contact-activity-kind.js +15 -0
- package/dist/enums/contact-activity-kind.js.map +1 -0
- package/dist/enums/contact-activity-kind.mjs +14 -0
- package/dist/enums/contact-activity-kind.mjs.map +1 -0
- package/dist/enums/contact-create-request-registration-status.d.mts +6 -0
- package/dist/enums/contact-create-request-registration-status.d.ts +6 -0
- package/dist/enums/contact-create-request-registration-status.js +11 -0
- package/dist/enums/contact-create-request-registration-status.js.map +1 -0
- package/dist/enums/contact-create-request-registration-status.mjs +10 -0
- package/dist/enums/contact-create-request-registration-status.mjs.map +1 -0
- package/dist/enums/contact-event-kind-create-request-tone.d.mts +9 -0
- package/dist/enums/contact-event-kind-create-request-tone.d.ts +9 -0
- package/dist/enums/contact-event-kind-create-request-tone.js +14 -0
- package/dist/enums/contact-event-kind-create-request-tone.js.map +1 -0
- package/dist/enums/contact-event-kind-create-request-tone.mjs +13 -0
- package/dist/enums/contact-event-kind-create-request-tone.mjs.map +1 -0
- package/dist/enums/contact-event-kind-tone.d.mts +9 -0
- package/dist/enums/contact-event-kind-tone.d.ts +9 -0
- package/dist/enums/contact-event-kind-tone.js +14 -0
- package/dist/enums/contact-event-kind-tone.js.map +1 -0
- package/dist/enums/contact-event-kind-tone.mjs +13 -0
- package/dist/enums/contact-event-kind-tone.mjs.map +1 -0
- package/dist/enums/contact-event-kind-update-request-tone.d.mts +9 -0
- package/dist/enums/contact-event-kind-update-request-tone.d.ts +9 -0
- package/dist/enums/contact-event-kind-update-request-tone.js +14 -0
- package/dist/enums/contact-event-kind-update-request-tone.js.map +1 -0
- package/dist/enums/contact-event-kind-update-request-tone.mjs +13 -0
- package/dist/enums/contact-event-kind-update-request-tone.mjs.map +1 -0
- package/dist/enums/contact-permissions-permissions.d.mts +14 -0
- package/dist/enums/contact-permissions-permissions.d.ts +14 -0
- package/dist/enums/contact-permissions-permissions.js +19 -0
- package/dist/enums/contact-permissions-permissions.js.map +1 -0
- package/dist/enums/contact-permissions-permissions.mjs +18 -0
- package/dist/enums/contact-permissions-permissions.mjs.map +1 -0
- package/dist/enums/contact-registration-status.d.mts +7 -0
- package/dist/enums/contact-registration-status.d.ts +7 -0
- package/dist/enums/contact-registration-status.js +12 -0
- package/dist/enums/contact-registration-status.js.map +1 -0
- package/dist/enums/contact-registration-status.mjs +11 -0
- package/dist/enums/contact-registration-status.mjs.map +1 -0
- package/dist/enums/contact-update-request-registration-status.d.mts +6 -0
- package/dist/enums/contact-update-request-registration-status.d.ts +6 -0
- package/dist/enums/contact-update-request-registration-status.js +11 -0
- package/dist/enums/contact-update-request-registration-status.js.map +1 -0
- package/dist/enums/contact-update-request-registration-status.mjs +10 -0
- package/dist/enums/contact-update-request-registration-status.mjs.map +1 -0
- package/dist/enums/cost-center-budget-type.d.mts +5 -0
- package/dist/enums/cost-center-budget-type.d.ts +5 -0
- package/dist/enums/cost-center-budget-type.js +10 -0
- package/dist/enums/cost-center-budget-type.js.map +1 -0
- package/dist/enums/cost-center-budget-type.mjs +9 -0
- package/dist/enums/cost-center-budget-type.mjs.map +1 -0
- package/dist/enums/cost-center-restriction-create-request-type.d.mts +9 -0
- package/dist/enums/cost-center-restriction-create-request-type.d.ts +9 -0
- package/dist/enums/cost-center-restriction-create-request-type.js +14 -0
- package/dist/enums/cost-center-restriction-create-request-type.js.map +1 -0
- package/dist/enums/cost-center-restriction-create-request-type.mjs +13 -0
- package/dist/enums/cost-center-restriction-create-request-type.mjs.map +1 -0
- package/dist/enums/cost-center-restriction-type.d.mts +9 -0
- package/dist/enums/cost-center-restriction-type.d.ts +9 -0
- package/dist/enums/cost-center-restriction-type.js +14 -0
- package/dist/enums/cost-center-restriction-type.js.map +1 -0
- package/dist/enums/cost-center-restriction-type.mjs +13 -0
- package/dist/enums/cost-center-restriction-type.mjs.map +1 -0
- package/dist/enums/cost-center-restriction-update-request-type.d.mts +9 -0
- package/dist/enums/cost-center-restriction-update-request-type.d.ts +9 -0
- package/dist/enums/cost-center-restriction-update-request-type.js +14 -0
- package/dist/enums/cost-center-restriction-update-request-type.js.map +1 -0
- package/dist/enums/cost-center-restriction-update-request-type.mjs +13 -0
- package/dist/enums/cost-center-restriction-update-request-type.mjs.map +1 -0
- package/dist/enums/cost-centers-restrictions-create-type.d.mts +9 -0
- package/dist/enums/cost-centers-restrictions-create-type.d.ts +9 -0
- package/dist/enums/cost-centers-restrictions-create-type.js +14 -0
- package/dist/enums/cost-centers-restrictions-create-type.js.map +1 -0
- package/dist/enums/cost-centers-restrictions-create-type.mjs +13 -0
- package/dist/enums/cost-centers-restrictions-create-type.mjs.map +1 -0
- package/dist/enums/create-import-target.d.mts +6 -0
- package/dist/enums/create-import-target.d.ts +6 -0
- package/dist/enums/create-import-target.js +11 -0
- package/dist/enums/create-import-target.js.map +1 -0
- package/dist/enums/create-import-target.mjs +10 -0
- package/dist/enums/create-import-target.mjs.map +1 -0
- package/dist/enums/customers-contacts-create-registration-status.d.mts +6 -0
- package/dist/enums/customers-contacts-create-registration-status.d.ts +6 -0
- package/dist/enums/customers-contacts-create-registration-status.js +11 -0
- package/dist/enums/customers-contacts-create-registration-status.js.map +1 -0
- package/dist/enums/customers-contacts-create-registration-status.mjs +10 -0
- package/dist/enums/customers-contacts-create-registration-status.mjs.map +1 -0
- package/dist/enums/customers-organizations-list-status.d.mts +6 -0
- package/dist/enums/customers-organizations-list-status.d.ts +6 -0
- package/dist/enums/customers-organizations-list-status.js +11 -0
- package/dist/enums/customers-organizations-list-status.js.map +1 -0
- package/dist/enums/customers-organizations-list-status.mjs +10 -0
- package/dist/enums/customers-organizations-list-status.mjs.map +1 -0
- package/dist/enums/customers-vocabularies-get-name.d.mts +15 -0
- package/dist/enums/customers-vocabularies-get-name.d.ts +15 -0
- package/dist/enums/customers-vocabularies-get-name.js +20 -0
- package/dist/enums/customers-vocabularies-get-name.js.map +1 -0
- package/dist/enums/customers-vocabularies-get-name.mjs +19 -0
- package/dist/enums/customers-vocabularies-get-name.mjs.map +1 -0
- package/dist/enums/direction.d.mts +6 -0
- package/dist/enums/direction.d.ts +6 -0
- package/dist/enums/direction.js +11 -0
- package/dist/enums/direction.js.map +1 -0
- package/dist/enums/direction.mjs +10 -0
- package/dist/enums/direction.mjs.map +1 -0
- package/dist/enums/entity-type.d.mts +8 -0
- package/dist/enums/entity-type.d.ts +8 -0
- package/dist/enums/entity-type.js +13 -0
- package/dist/enums/entity-type.js.map +1 -0
- package/dist/enums/entity-type.mjs +12 -0
- package/dist/enums/entity-type.mjs.map +1 -0
- package/dist/enums/evaluate-request-conditions.d.mts +6 -0
- package/dist/enums/evaluate-request-conditions.d.ts +6 -0
- package/dist/enums/evaluate-request-conditions.js +11 -0
- package/dist/enums/evaluate-request-conditions.js.map +1 -0
- package/dist/enums/evaluate-request-conditions.mjs +10 -0
- package/dist/enums/evaluate-request-conditions.mjs.map +1 -0
- package/dist/enums/form-notify-source.d.mts +6 -0
- package/dist/enums/form-notify-source.d.ts +6 -0
- package/dist/enums/form-notify-source.js +11 -0
- package/dist/enums/form-notify-source.js.map +1 -0
- package/dist/enums/form-notify-source.mjs +10 -0
- package/dist/enums/form-notify-source.mjs.map +1 -0
- package/dist/enums/form-status.d.mts +7 -0
- package/dist/enums/form-status.d.ts +7 -0
- package/dist/enums/form-status.js +12 -0
- package/dist/enums/form-status.js.map +1 -0
- package/dist/enums/form-status.mjs +11 -0
- package/dist/enums/form-status.mjs.map +1 -0
- package/dist/enums/form-submission-prune-request-status.d.mts +8 -0
- package/dist/enums/form-submission-prune-request-status.d.ts +8 -0
- package/dist/enums/form-submission-prune-request-status.js +13 -0
- package/dist/enums/form-submission-prune-request-status.js.map +1 -0
- package/dist/enums/form-submission-prune-request-status.mjs +12 -0
- package/dist/enums/form-submission-prune-request-status.mjs.map +1 -0
- package/dist/enums/form-submission-status.d.mts +8 -0
- package/dist/enums/form-submission-status.d.ts +8 -0
- package/dist/enums/form-submission-status.js +13 -0
- package/dist/enums/form-submission-status.js.map +1 -0
- package/dist/enums/form-submission-status.mjs +12 -0
- package/dist/enums/form-submission-status.mjs.map +1 -0
- package/dist/enums/format.d.mts +8 -0
- package/dist/enums/format.d.ts +8 -0
- package/dist/enums/format.js +13 -0
- package/dist/enums/format.js.map +1 -0
- package/dist/enums/format.mjs +12 -0
- package/dist/enums/format.mjs.map +1 -0
- package/dist/enums/forms-submissions-prune-status.d.mts +8 -0
- package/dist/enums/forms-submissions-prune-status.d.ts +8 -0
- package/dist/enums/forms-submissions-prune-status.js +13 -0
- package/dist/enums/forms-submissions-prune-status.js.map +1 -0
- package/dist/enums/forms-submissions-prune-status.mjs +12 -0
- package/dist/enums/forms-submissions-prune-status.mjs.map +1 -0
- package/dist/enums/forms-vocabularies-get-name.d.mts +6 -0
- package/dist/enums/forms-vocabularies-get-name.d.ts +6 -0
- package/dist/enums/forms-vocabularies-get-name.js +11 -0
- package/dist/enums/forms-vocabularies-get-name.js.map +1 -0
- package/dist/enums/forms-vocabularies-get-name.mjs +10 -0
- package/dist/enums/forms-vocabularies-get-name.mjs.map +1 -0
- package/dist/enums/forms-vocabulary-name.d.mts +6 -0
- package/dist/enums/forms-vocabulary-name.d.ts +6 -0
- package/dist/enums/forms-vocabulary-name.js +11 -0
- package/dist/enums/forms-vocabulary-name.js.map +1 -0
- package/dist/enums/forms-vocabulary-name.mjs +10 -0
- package/dist/enums/forms-vocabulary-name.mjs.map +1 -0
- package/dist/enums/forms-vocabulary-summary-name.d.mts +6 -0
- package/dist/enums/forms-vocabulary-summary-name.d.ts +6 -0
- package/dist/enums/forms-vocabulary-summary-name.js +11 -0
- package/dist/enums/forms-vocabulary-summary-name.js.map +1 -0
- package/dist/enums/forms-vocabulary-summary-name.mjs +10 -0
- package/dist/enums/forms-vocabulary-summary-name.mjs.map +1 -0
- package/dist/enums/forms-vocabulary-tone.d.mts +9 -0
- package/dist/enums/forms-vocabulary-tone.d.ts +9 -0
- package/dist/enums/forms-vocabulary-tone.js +14 -0
- package/dist/enums/forms-vocabulary-tone.js.map +1 -0
- package/dist/enums/forms-vocabulary-tone.mjs +13 -0
- package/dist/enums/forms-vocabulary-tone.mjs.map +1 -0
- package/dist/enums/inventories-locations-list-type.d.mts +8 -0
- package/dist/enums/inventories-locations-list-type.d.ts +8 -0
- package/dist/enums/inventories-locations-list-type.js +13 -0
- package/dist/enums/inventories-locations-list-type.js.map +1 -0
- package/dist/enums/inventories-locations-list-type.mjs +12 -0
- package/dist/enums/inventories-locations-list-type.mjs.map +1 -0
- package/dist/enums/inventories-movements-list-type.d.mts +10 -0
- package/dist/enums/inventories-movements-list-type.d.ts +10 -0
- package/dist/enums/inventories-movements-list-type.js +15 -0
- package/dist/enums/inventories-movements-list-type.js.map +1 -0
- package/dist/enums/inventories-movements-list-type.mjs +14 -0
- package/dist/enums/inventories-movements-list-type.mjs.map +1 -0
- package/dist/enums/inventories-reservations-list-status.d.mts +7 -0
- package/dist/enums/inventories-reservations-list-status.d.ts +7 -0
- package/dist/enums/inventories-reservations-list-status.js +12 -0
- package/dist/enums/inventories-reservations-list-status.js.map +1 -0
- package/dist/enums/inventories-reservations-list-status.mjs +11 -0
- package/dist/enums/inventories-reservations-list-status.mjs.map +1 -0
- package/dist/enums/inventories-vocabularies-get-name.d.mts +7 -0
- package/dist/enums/inventories-vocabularies-get-name.d.ts +7 -0
- package/dist/enums/inventories-vocabularies-get-name.js +12 -0
- package/dist/enums/inventories-vocabularies-get-name.js.map +1 -0
- package/dist/enums/inventories-vocabularies-get-name.mjs +11 -0
- package/dist/enums/inventories-vocabularies-get-name.mjs.map +1 -0
- package/dist/enums/inventory-vocabulary-default-tone.d.mts +9 -0
- package/dist/enums/inventory-vocabulary-default-tone.d.ts +9 -0
- package/dist/enums/inventory-vocabulary-default-tone.js +14 -0
- package/dist/enums/inventory-vocabulary-default-tone.js.map +1 -0
- package/dist/enums/inventory-vocabulary-default-tone.mjs +13 -0
- package/dist/enums/inventory-vocabulary-default-tone.mjs.map +1 -0
- package/dist/enums/inventory-vocabulary-source.d.mts +5 -0
- package/dist/enums/inventory-vocabulary-source.d.ts +5 -0
- package/dist/enums/inventory-vocabulary-source.js +10 -0
- package/dist/enums/inventory-vocabulary-source.js.map +1 -0
- package/dist/enums/inventory-vocabulary-source.mjs +9 -0
- package/dist/enums/inventory-vocabulary-source.mjs.map +1 -0
- package/dist/enums/io-profile-resource-apply-mode.d.mts +7 -0
- package/dist/enums/io-profile-resource-apply-mode.d.ts +7 -0
- package/dist/enums/io-profile-resource-apply-mode.js +12 -0
- package/dist/enums/io-profile-resource-apply-mode.js.map +1 -0
- package/dist/enums/io-profile-resource-apply-mode.mjs +11 -0
- package/dist/enums/io-profile-resource-apply-mode.mjs.map +1 -0
- package/dist/enums/io-profile-resource-direction.d.mts +6 -0
- package/dist/enums/io-profile-resource-direction.d.ts +6 -0
- package/dist/enums/io-profile-resource-direction.js +11 -0
- package/dist/enums/io-profile-resource-direction.js.map +1 -0
- package/dist/enums/io-profile-resource-direction.mjs +10 -0
- package/dist/enums/io-profile-resource-direction.mjs.map +1 -0
- package/dist/enums/kind.d.mts +7 -0
- package/dist/enums/kind.d.ts +7 -0
- package/dist/enums/kind.js +12 -0
- package/dist/enums/kind.js.map +1 -0
- package/dist/enums/kind.mjs +11 -0
- package/dist/enums/kind.mjs.map +1 -0
- package/dist/enums/lifecycle-stage-create-request-tone.d.mts +9 -0
- package/dist/enums/lifecycle-stage-create-request-tone.d.ts +9 -0
- package/dist/enums/lifecycle-stage-create-request-tone.js +14 -0
- package/dist/enums/lifecycle-stage-create-request-tone.js.map +1 -0
- package/dist/enums/lifecycle-stage-create-request-tone.mjs +13 -0
- package/dist/enums/lifecycle-stage-create-request-tone.mjs.map +1 -0
- package/dist/enums/lifecycle-stage-tone.d.mts +9 -0
- package/dist/enums/lifecycle-stage-tone.d.ts +9 -0
- package/dist/enums/lifecycle-stage-tone.js +14 -0
- package/dist/enums/lifecycle-stage-tone.js.map +1 -0
- package/dist/enums/lifecycle-stage-tone.mjs +13 -0
- package/dist/enums/lifecycle-stage-tone.mjs.map +1 -0
- package/dist/enums/lifecycle-stage-update-request-tone.d.mts +9 -0
- package/dist/enums/lifecycle-stage-update-request-tone.d.ts +9 -0
- package/dist/enums/lifecycle-stage-update-request-tone.js +14 -0
- package/dist/enums/lifecycle-stage-update-request-tone.js.map +1 -0
- package/dist/enums/lifecycle-stage-update-request-tone.mjs +13 -0
- package/dist/enums/lifecycle-stage-update-request-tone.mjs.map +1 -0
- package/dist/enums/market-default-locale-source.d.mts +7 -0
- package/dist/enums/market-default-locale-source.d.ts +7 -0
- package/dist/enums/market-default-locale-source.js +12 -0
- package/dist/enums/market-default-locale-source.js.map +1 -0
- package/dist/enums/market-default-locale-source.mjs +11 -0
- package/dist/enums/market-default-locale-source.mjs.map +1 -0
- package/dist/enums/market-locale-fallback.d.mts +7 -0
- package/dist/enums/market-locale-fallback.d.ts +7 -0
- package/dist/enums/market-locale-fallback.js +12 -0
- package/dist/enums/market-locale-fallback.js.map +1 -0
- package/dist/enums/market-locale-fallback.mjs +11 -0
- package/dist/enums/market-locale-fallback.mjs.map +1 -0
- package/dist/enums/market-locale-granularity.d.mts +6 -0
- package/dist/enums/market-locale-granularity.d.ts +6 -0
- package/dist/enums/market-locale-granularity.js +11 -0
- package/dist/enums/market-locale-granularity.js.map +1 -0
- package/dist/enums/market-locale-granularity.mjs +10 -0
- package/dist/enums/market-locale-granularity.mjs.map +1 -0
- package/dist/enums/market-pricing-source.d.mts +7 -0
- package/dist/enums/market-pricing-source.d.ts +7 -0
- package/dist/enums/market-pricing-source.js +12 -0
- package/dist/enums/market-pricing-source.js.map +1 -0
- package/dist/enums/market-pricing-source.mjs +11 -0
- package/dist/enums/market-pricing-source.mjs.map +1 -0
- package/dist/enums/market-readiness-blocking.d.mts +8 -0
- package/dist/enums/market-readiness-blocking.d.ts +8 -0
- package/dist/enums/market-readiness-blocking.js +13 -0
- package/dist/enums/market-readiness-blocking.js.map +1 -0
- package/dist/enums/market-readiness-blocking.mjs +12 -0
- package/dist/enums/market-readiness-blocking.mjs.map +1 -0
- package/dist/enums/market-readiness-check-id.d.mts +8 -0
- package/dist/enums/market-readiness-check-id.d.ts +8 -0
- package/dist/enums/market-readiness-check-id.js +13 -0
- package/dist/enums/market-readiness-check-id.js.map +1 -0
- package/dist/enums/market-readiness-check-id.mjs +12 -0
- package/dist/enums/market-readiness-check-id.mjs.map +1 -0
- package/dist/enums/market-readiness-report-blocking.d.mts +8 -0
- package/dist/enums/market-readiness-report-blocking.d.ts +8 -0
- package/dist/enums/market-readiness-report-blocking.js +13 -0
- package/dist/enums/market-readiness-report-blocking.js.map +1 -0
- package/dist/enums/market-readiness-report-blocking.mjs +12 -0
- package/dist/enums/market-readiness-report-blocking.mjs.map +1 -0
- package/dist/enums/market-readiness-report-warnings.d.mts +8 -0
- package/dist/enums/market-readiness-report-warnings.d.ts +8 -0
- package/dist/enums/market-readiness-report-warnings.js +13 -0
- package/dist/enums/market-readiness-report-warnings.js.map +1 -0
- package/dist/enums/market-readiness-report-warnings.mjs +12 -0
- package/dist/enums/market-readiness-report-warnings.mjs.map +1 -0
- package/dist/enums/market-readiness-severity.d.mts +7 -0
- package/dist/enums/market-readiness-severity.d.ts +7 -0
- package/dist/enums/market-readiness-severity.js +12 -0
- package/dist/enums/market-readiness-severity.js.map +1 -0
- package/dist/enums/market-readiness-severity.mjs +11 -0
- package/dist/enums/market-readiness-severity.mjs.map +1 -0
- package/dist/enums/market-readiness-warnings.d.mts +8 -0
- package/dist/enums/market-readiness-warnings.d.ts +8 -0
- package/dist/enums/market-readiness-warnings.js +13 -0
- package/dist/enums/market-readiness-warnings.js.map +1 -0
- package/dist/enums/market-readiness-warnings.mjs +12 -0
- package/dist/enums/market-readiness-warnings.mjs.map +1 -0
- package/dist/enums/market-tax-basis.d.mts +6 -0
- package/dist/enums/market-tax-basis.d.ts +6 -0
- package/dist/enums/market-tax-basis.js +11 -0
- package/dist/enums/market-tax-basis.js.map +1 -0
- package/dist/enums/market-tax-basis.mjs +10 -0
- package/dist/enums/market-tax-basis.mjs.map +1 -0
- package/dist/enums/markets-list-status.d.mts +6 -0
- package/dist/enums/markets-list-status.d.ts +6 -0
- package/dist/enums/markets-list-status.js +11 -0
- package/dist/enums/markets-list-status.js.map +1 -0
- package/dist/enums/markets-list-status.mjs +10 -0
- package/dist/enums/markets-list-status.mjs.map +1 -0
- package/dist/enums/markets-vocabulary-name.d.mts +5 -0
- package/dist/enums/markets-vocabulary-name.d.ts +5 -0
- package/dist/enums/markets-vocabulary-name.js +10 -0
- package/dist/enums/markets-vocabulary-name.js.map +1 -0
- package/dist/enums/markets-vocabulary-name.mjs +9 -0
- package/dist/enums/markets-vocabulary-name.mjs.map +1 -0
- package/dist/enums/markets-vocabulary-source.d.mts +5 -0
- package/dist/enums/markets-vocabulary-source.d.ts +5 -0
- package/dist/enums/markets-vocabulary-source.js +10 -0
- package/dist/enums/markets-vocabulary-source.js.map +1 -0
- package/dist/enums/markets-vocabulary-source.mjs +9 -0
- package/dist/enums/markets-vocabulary-source.mjs.map +1 -0
- package/dist/enums/markets-vocabulary-summary-name.d.mts +5 -0
- package/dist/enums/markets-vocabulary-summary-name.d.ts +5 -0
- package/dist/enums/markets-vocabulary-summary-name.js +10 -0
- package/dist/enums/markets-vocabulary-summary-name.js.map +1 -0
- package/dist/enums/markets-vocabulary-summary-name.mjs +9 -0
- package/dist/enums/markets-vocabulary-summary-name.mjs.map +1 -0
- package/dist/enums/markets-vocabulary-tone.d.mts +9 -0
- package/dist/enums/markets-vocabulary-tone.d.ts +9 -0
- package/dist/enums/markets-vocabulary-tone.js +14 -0
- package/dist/enums/markets-vocabulary-tone.js.map +1 -0
- package/dist/enums/markets-vocabulary-tone.mjs +13 -0
- package/dist/enums/markets-vocabulary-tone.mjs.map +1 -0
- package/dist/enums/{message-status.d.mts → message-2-status.d.mts} +2 -2
- package/dist/enums/{message-status.d.ts → message-2-status.d.ts} +2 -2
- package/dist/enums/message-2-status.js +14 -0
- package/dist/enums/message-2-status.js.map +1 -0
- package/dist/enums/message-2-status.mjs +13 -0
- package/dist/enums/message-2-status.mjs.map +1 -0
- package/dist/enums/message-class.d.mts +6 -0
- package/dist/enums/message-class.d.ts +6 -0
- package/dist/enums/message-class.js +11 -0
- package/dist/enums/message-class.js.map +1 -0
- package/dist/enums/message-class.mjs +10 -0
- package/dist/enums/message-class.mjs.map +1 -0
- package/dist/enums/mode.d.mts +7 -0
- package/dist/enums/mode.d.ts +7 -0
- package/dist/enums/mode.js +12 -0
- package/dist/enums/mode.js.map +1 -0
- package/dist/enums/mode.mjs +11 -0
- package/dist/enums/mode.mjs.map +1 -0
- package/dist/enums/name.d.mts +10 -0
- package/dist/enums/name.d.ts +10 -0
- package/dist/enums/name.js +15 -0
- package/dist/enums/name.js.map +1 -0
- package/dist/enums/name.mjs +14 -0
- package/dist/enums/name.mjs.map +1 -0
- package/dist/enums/order-cancellation-scope.d.mts +6 -0
- package/dist/enums/order-cancellation-scope.d.ts +6 -0
- package/dist/enums/order-cancellation-scope.js +11 -0
- package/dist/enums/order-cancellation-scope.js.map +1 -0
- package/dist/enums/order-cancellation-scope.mjs +10 -0
- package/dist/enums/order-cancellation-scope.mjs.map +1 -0
- package/dist/enums/order-customer-rollup-request-statuses.d.mts +9 -0
- package/dist/enums/order-customer-rollup-request-statuses.d.ts +9 -0
- package/dist/enums/order-customer-rollup-request-statuses.js +14 -0
- package/dist/enums/order-customer-rollup-request-statuses.js.map +1 -0
- package/dist/enums/order-customer-rollup-request-statuses.mjs +13 -0
- package/dist/enums/order-customer-rollup-request-statuses.mjs.map +1 -0
- package/dist/enums/order-customer-rollup-response-statuses.d.mts +9 -0
- package/dist/enums/order-customer-rollup-response-statuses.d.ts +9 -0
- package/dist/enums/order-customer-rollup-response-statuses.js +14 -0
- package/dist/enums/order-customer-rollup-response-statuses.js.map +1 -0
- package/dist/enums/order-customer-rollup-response-statuses.mjs +13 -0
- package/dist/enums/order-customer-rollup-response-statuses.mjs.map +1 -0
- package/dist/enums/{fulfillment-status.d.mts → order-fulfillment-status.d.mts} +2 -2
- package/dist/enums/{fulfillment-status.d.ts → order-fulfillment-status.d.ts} +2 -2
- package/dist/enums/order-fulfillment-status.js +12 -0
- package/dist/enums/order-fulfillment-status.js.map +1 -0
- package/dist/enums/order-fulfillment-status.mjs +11 -0
- package/dist/enums/order-fulfillment-status.mjs.map +1 -0
- package/dist/enums/order-list-cart-mode.d.mts +6 -0
- package/dist/enums/order-list-cart-mode.d.ts +6 -0
- package/dist/enums/order-list-cart-mode.js +11 -0
- package/dist/enums/order-list-cart-mode.js.map +1 -0
- package/dist/enums/order-list-cart-mode.mjs +10 -0
- package/dist/enums/order-list-cart-mode.mjs.map +1 -0
- package/dist/enums/order-list-kind-row-tone.d.mts +9 -0
- package/dist/enums/order-list-kind-row-tone.d.ts +9 -0
- package/dist/enums/order-list-kind-row-tone.js +14 -0
- package/dist/enums/order-list-kind-row-tone.js.map +1 -0
- package/dist/enums/order-list-kind-row-tone.mjs +13 -0
- package/dist/enums/order-list-kind-row-tone.mjs.map +1 -0
- package/dist/enums/order-list-kind-tone.d.mts +9 -0
- package/dist/enums/order-list-kind-tone.d.ts +9 -0
- package/dist/enums/order-list-kind-tone.js +14 -0
- package/dist/enums/order-list-kind-tone.js.map +1 -0
- package/dist/enums/order-list-kind-tone.mjs +13 -0
- package/dist/enums/order-list-kind-tone.mjs.map +1 -0
- package/dist/enums/order-list-vocabulary-default-tone.d.mts +9 -0
- package/dist/enums/order-list-vocabulary-default-tone.d.ts +9 -0
- package/dist/enums/order-list-vocabulary-default-tone.js +14 -0
- package/dist/enums/order-list-vocabulary-default-tone.js.map +1 -0
- package/dist/enums/order-list-vocabulary-default-tone.mjs +13 -0
- package/dist/enums/order-list-vocabulary-default-tone.mjs.map +1 -0
- package/dist/enums/order-list-vocabulary-name.d.mts +5 -0
- package/dist/enums/order-list-vocabulary-name.d.ts +5 -0
- package/dist/enums/order-list-vocabulary-name.js +10 -0
- package/dist/enums/order-list-vocabulary-name.js.map +1 -0
- package/dist/enums/order-list-vocabulary-name.mjs +9 -0
- package/dist/enums/order-list-vocabulary-name.mjs.map +1 -0
- package/dist/enums/order-list-vocabulary-source.d.mts +6 -0
- package/dist/enums/order-list-vocabulary-source.d.ts +6 -0
- package/dist/enums/order-list-vocabulary-source.js +11 -0
- package/dist/enums/order-list-vocabulary-source.js.map +1 -0
- package/dist/enums/order-list-vocabulary-source.mjs +10 -0
- package/dist/enums/order-list-vocabulary-source.mjs.map +1 -0
- package/dist/enums/order-list-vocabulary-tone.d.mts +9 -0
- package/dist/enums/order-list-vocabulary-tone.d.ts +9 -0
- package/dist/enums/order-list-vocabulary-tone.js +14 -0
- package/dist/enums/order-list-vocabulary-tone.js.map +1 -0
- package/dist/enums/order-list-vocabulary-tone.mjs +13 -0
- package/dist/enums/order-list-vocabulary-tone.mjs.map +1 -0
- package/dist/enums/order-resolution-stage.d.mts +6 -0
- package/dist/enums/order-resolution-stage.d.ts +6 -0
- package/dist/enums/order-resolution-stage.js +11 -0
- package/dist/enums/order-resolution-stage.js.map +1 -0
- package/dist/enums/order-resolution-stage.mjs +10 -0
- package/dist/enums/order-resolution-stage.mjs.map +1 -0
- package/dist/enums/order-return-refusal.d.mts +6 -0
- package/dist/enums/order-return-refusal.d.ts +6 -0
- package/dist/enums/order-return-refusal.js +11 -0
- package/dist/enums/order-return-refusal.js.map +1 -0
- package/dist/enums/order-return-refusal.mjs +10 -0
- package/dist/enums/order-return-refusal.mjs.map +1 -0
- package/dist/enums/order-return-settlement.d.mts +9 -0
- package/dist/enums/order-return-settlement.d.ts +9 -0
- package/dist/enums/order-return-settlement.js +14 -0
- package/dist/enums/order-return-settlement.js.map +1 -0
- package/dist/enums/order-return-settlement.mjs +13 -0
- package/dist/enums/order-return-settlement.mjs.map +1 -0
- package/dist/enums/order-return-status.d.mts +8 -0
- package/dist/enums/order-return-status.d.ts +8 -0
- package/dist/enums/order-return-status.js +13 -0
- package/dist/enums/order-return-status.js.map +1 -0
- package/dist/enums/order-return-status.mjs +12 -0
- package/dist/enums/order-return-status.mjs.map +1 -0
- package/dist/enums/order-status.d.mts +9 -0
- package/dist/enums/order-status.d.ts +9 -0
- package/dist/enums/order-status.js +14 -0
- package/dist/enums/order-status.js.map +1 -0
- package/dist/enums/order-status.mjs +13 -0
- package/dist/enums/order-status.mjs.map +1 -0
- package/dist/enums/order-vocabulary-name.d.mts +12 -0
- package/dist/enums/order-vocabulary-name.d.ts +12 -0
- package/dist/enums/order-vocabulary-name.js +17 -0
- package/dist/enums/order-vocabulary-name.js.map +1 -0
- package/dist/enums/order-vocabulary-name.mjs +16 -0
- package/dist/enums/order-vocabulary-name.mjs.map +1 -0
- package/dist/enums/order-vocabulary-source.d.mts +6 -0
- package/dist/enums/order-vocabulary-source.d.ts +6 -0
- package/dist/enums/order-vocabulary-source.js +11 -0
- package/dist/enums/order-vocabulary-source.js.map +1 -0
- package/dist/enums/order-vocabulary-source.mjs +10 -0
- package/dist/enums/order-vocabulary-source.mjs.map +1 -0
- package/dist/enums/order-vocabulary-summary-name.d.mts +12 -0
- package/dist/enums/order-vocabulary-summary-name.d.ts +12 -0
- package/dist/enums/order-vocabulary-summary-name.js +17 -0
- package/dist/enums/order-vocabulary-summary-name.js.map +1 -0
- package/dist/enums/order-vocabulary-summary-name.mjs +16 -0
- package/dist/enums/order-vocabulary-summary-name.mjs.map +1 -0
- package/dist/enums/order-vocabulary-tone.d.mts +9 -0
- package/dist/enums/order-vocabulary-tone.d.ts +9 -0
- package/dist/enums/order-vocabulary-tone.js +14 -0
- package/dist/enums/order-vocabulary-tone.js.map +1 -0
- package/dist/enums/order-vocabulary-tone.mjs +13 -0
- package/dist/enums/order-vocabulary-tone.mjs.map +1 -0
- package/dist/enums/orderlists-vocabularies-get-name.d.mts +5 -0
- package/dist/enums/orderlists-vocabularies-get-name.d.ts +5 -0
- package/dist/enums/orderlists-vocabularies-get-name.js +10 -0
- package/dist/enums/orderlists-vocabularies-get-name.js.map +1 -0
- package/dist/enums/orderlists-vocabularies-get-name.mjs +9 -0
- package/dist/enums/orderlists-vocabularies-get-name.mjs.map +1 -0
- package/dist/enums/orders-vocabularies-get-name.d.mts +12 -0
- package/dist/enums/orders-vocabularies-get-name.d.ts +12 -0
- package/dist/enums/orders-vocabularies-get-name.js +17 -0
- package/dist/enums/orders-vocabularies-get-name.js.map +1 -0
- package/dist/enums/orders-vocabularies-get-name.mjs +16 -0
- package/dist/enums/orders-vocabularies-get-name.mjs.map +1 -0
- package/dist/enums/page-edit-state-status.d.mts +8 -0
- package/dist/enums/page-edit-state-status.d.ts +8 -0
- package/dist/enums/page-edit-state-status.js +13 -0
- package/dist/enums/page-edit-state-status.js.map +1 -0
- package/dist/enums/page-edit-state-status.mjs +12 -0
- package/dist/enums/page-edit-state-status.mjs.map +1 -0
- package/dist/enums/pages-vocabularies-get-name.d.mts +7 -0
- package/dist/enums/pages-vocabularies-get-name.d.ts +7 -0
- package/dist/enums/pages-vocabularies-get-name.js +12 -0
- package/dist/enums/pages-vocabularies-get-name.js.map +1 -0
- package/dist/enums/pages-vocabularies-get-name.mjs +11 -0
- package/dist/enums/pages-vocabularies-get-name.mjs.map +1 -0
- package/dist/enums/pages-vocabulary-app.d.mts +5 -0
- package/dist/enums/pages-vocabulary-app.d.ts +5 -0
- package/dist/enums/pages-vocabulary-app.js +10 -0
- package/dist/enums/pages-vocabulary-app.js.map +1 -0
- package/dist/enums/pages-vocabulary-app.mjs +9 -0
- package/dist/enums/pages-vocabulary-app.mjs.map +1 -0
- package/dist/enums/pages-vocabulary-index-app.d.mts +5 -0
- package/dist/enums/pages-vocabulary-index-app.d.ts +5 -0
- package/dist/enums/pages-vocabulary-index-app.js +10 -0
- package/dist/enums/pages-vocabulary-index-app.js.map +1 -0
- package/dist/enums/pages-vocabulary-index-app.mjs +9 -0
- package/dist/enums/pages-vocabulary-index-app.mjs.map +1 -0
- package/dist/enums/pages-vocabulary-name.d.mts +7 -0
- package/dist/enums/pages-vocabulary-name.d.ts +7 -0
- package/dist/enums/pages-vocabulary-name.js +12 -0
- package/dist/enums/pages-vocabulary-name.js.map +1 -0
- package/dist/enums/pages-vocabulary-name.mjs +11 -0
- package/dist/enums/pages-vocabulary-name.mjs.map +1 -0
- package/dist/enums/pages-vocabulary-source.d.mts +5 -0
- package/dist/enums/pages-vocabulary-source.d.ts +5 -0
- package/dist/enums/pages-vocabulary-source.js +10 -0
- package/dist/enums/pages-vocabulary-source.js.map +1 -0
- package/dist/enums/pages-vocabulary-source.mjs +9 -0
- package/dist/enums/pages-vocabulary-source.mjs.map +1 -0
- package/dist/enums/pages-vocabulary-tone.d.mts +9 -0
- package/dist/enums/pages-vocabulary-tone.d.ts +9 -0
- package/dist/enums/pages-vocabulary-tone.js +14 -0
- package/dist/enums/pages-vocabulary-tone.js.map +1 -0
- package/dist/enums/pages-vocabulary-tone.mjs +13 -0
- package/dist/enums/pages-vocabulary-tone.mjs.map +1 -0
- package/dist/enums/payment-dunning-stage.d.mts +7 -0
- package/dist/enums/payment-dunning-stage.d.ts +7 -0
- package/dist/enums/payment-dunning-stage.js +12 -0
- package/dist/enums/payment-dunning-stage.js.map +1 -0
- package/dist/enums/payment-dunning-stage.mjs +11 -0
- package/dist/enums/payment-dunning-stage.mjs.map +1 -0
- package/dist/enums/payment-failure-code.d.mts +9 -0
- package/dist/enums/payment-failure-code.d.ts +9 -0
- package/dist/enums/payment-failure-code.js +14 -0
- package/dist/enums/payment-failure-code.js.map +1 -0
- package/dist/enums/payment-failure-code.mjs +13 -0
- package/dist/enums/payment-failure-code.mjs.map +1 -0
- package/dist/enums/payment-status.d.mts +6 -6
- package/dist/enums/payment-status.d.ts +6 -6
- package/dist/enums/payment-status.js +5 -5
- package/dist/enums/payment-status.js.map +1 -1
- package/dist/enums/payment-status.mjs +5 -5
- package/dist/enums/payment-status.mjs.map +1 -1
- package/dist/enums/payment-term-create-request-tone.d.mts +9 -0
- package/dist/enums/payment-term-create-request-tone.d.ts +9 -0
- package/dist/enums/payment-term-create-request-tone.js +14 -0
- package/dist/enums/payment-term-create-request-tone.js.map +1 -0
- package/dist/enums/payment-term-create-request-tone.mjs +13 -0
- package/dist/enums/payment-term-create-request-tone.mjs.map +1 -0
- package/dist/enums/payment-term-tone.d.mts +9 -0
- package/dist/enums/payment-term-tone.d.ts +9 -0
- package/dist/enums/payment-term-tone.js +14 -0
- package/dist/enums/payment-term-tone.js.map +1 -0
- package/dist/enums/payment-term-tone.mjs +13 -0
- package/dist/enums/payment-term-tone.mjs.map +1 -0
- package/dist/enums/payment-term-update-request-tone.d.mts +9 -0
- package/dist/enums/payment-term-update-request-tone.d.ts +9 -0
- package/dist/enums/payment-term-update-request-tone.js +14 -0
- package/dist/enums/payment-term-update-request-tone.js.map +1 -0
- package/dist/enums/payment-term-update-request-tone.mjs +13 -0
- package/dist/enums/payment-term-update-request-tone.mjs.map +1 -0
- package/dist/enums/payment-vocabulary-tone.d.mts +9 -0
- package/dist/enums/payment-vocabulary-tone.d.ts +9 -0
- package/dist/enums/payment-vocabulary-tone.js +14 -0
- package/dist/enums/payment-vocabulary-tone.js.map +1 -0
- package/dist/enums/payment-vocabulary-tone.mjs +13 -0
- package/dist/enums/payment-vocabulary-tone.mjs.map +1 -0
- package/dist/enums/payments-vocabularies-get-name.d.mts +8 -0
- package/dist/enums/payments-vocabularies-get-name.d.ts +8 -0
- package/dist/enums/payments-vocabularies-get-name.js +13 -0
- package/dist/enums/payments-vocabularies-get-name.js.map +1 -0
- package/dist/enums/payments-vocabularies-get-name.mjs +12 -0
- package/dist/enums/payments-vocabularies-get-name.mjs.map +1 -0
- package/dist/enums/price-currency-source.d.mts +8 -0
- package/dist/enums/price-currency-source.d.ts +8 -0
- package/dist/enums/price-currency-source.js +13 -0
- package/dist/enums/price-currency-source.js.map +1 -0
- package/dist/enums/price-currency-source.mjs +12 -0
- package/dist/enums/price-currency-source.mjs.map +1 -0
- package/dist/enums/price-ending-rule.d.mts +9 -0
- package/dist/enums/price-ending-rule.d.ts +9 -0
- package/dist/enums/price-ending-rule.js +14 -0
- package/dist/enums/price-ending-rule.js.map +1 -0
- package/dist/enums/price-ending-rule.mjs +13 -0
- package/dist/enums/price-ending-rule.mjs.map +1 -0
- package/dist/enums/price-entries-adjust-response-rounding-mode.d.mts +8 -0
- package/dist/enums/price-entries-adjust-response-rounding-mode.d.ts +8 -0
- package/dist/enums/price-entries-adjust-response-rounding-mode.js +13 -0
- package/dist/enums/price-entries-adjust-response-rounding-mode.js.map +1 -0
- package/dist/enums/price-entries-adjust-response-rounding-mode.mjs +12 -0
- package/dist/enums/price-entries-adjust-response-rounding-mode.mjs.map +1 -0
- package/dist/enums/price-entries-adjust-response-rounding.d.mts +9 -0
- package/dist/enums/price-entries-adjust-response-rounding.d.ts +9 -0
- package/dist/enums/price-entries-adjust-response-rounding.js +14 -0
- package/dist/enums/price-entries-adjust-response-rounding.js.map +1 -0
- package/dist/enums/price-entries-adjust-response-rounding.mjs +13 -0
- package/dist/enums/price-entries-adjust-response-rounding.mjs.map +1 -0
- package/dist/enums/price-entries-bulk-mode.d.mts +6 -0
- package/dist/enums/price-entries-bulk-mode.d.ts +6 -0
- package/dist/enums/price-entries-bulk-mode.js +11 -0
- package/dist/enums/price-entries-bulk-mode.js.map +1 -0
- package/dist/enums/price-entries-bulk-mode.mjs +10 -0
- package/dist/enums/price-entries-bulk-mode.mjs.map +1 -0
- package/dist/enums/price-list-tax-basis.d.mts +6 -0
- package/dist/enums/price-list-tax-basis.d.ts +6 -0
- package/dist/enums/price-list-tax-basis.js +11 -0
- package/dist/enums/price-list-tax-basis.js.map +1 -0
- package/dist/enums/price-list-tax-basis.mjs +10 -0
- package/dist/enums/price-list-tax-basis.mjs.map +1 -0
- package/dist/enums/price-list-tiebreak.d.mts +8 -0
- package/dist/enums/price-list-tiebreak.d.ts +8 -0
- package/dist/enums/price-list-tiebreak.js +13 -0
- package/dist/enums/price-list-tiebreak.js.map +1 -0
- package/dist/enums/price-list-tiebreak.mjs +12 -0
- package/dist/enums/price-list-tiebreak.mjs.map +1 -0
- package/dist/enums/price-on-request-reason.d.mts +8 -0
- package/dist/enums/price-on-request-reason.d.ts +8 -0
- package/dist/enums/price-on-request-reason.js +13 -0
- package/dist/enums/price-on-request-reason.js.map +1 -0
- package/dist/enums/price-on-request-reason.mjs +12 -0
- package/dist/enums/price-on-request-reason.mjs.map +1 -0
- package/dist/enums/price-rounding-mode.d.mts +8 -0
- package/dist/enums/price-rounding-mode.d.ts +8 -0
- package/dist/enums/price-rounding-mode.js +13 -0
- package/dist/enums/price-rounding-mode.js.map +1 -0
- package/dist/enums/price-rounding-mode.mjs +12 -0
- package/dist/enums/price-rounding-mode.mjs.map +1 -0
- package/dist/enums/price-tax-basis-source.d.mts +7 -0
- package/dist/enums/price-tax-basis-source.d.ts +7 -0
- package/dist/enums/price-tax-basis-source.js +12 -0
- package/dist/enums/price-tax-basis-source.js.map +1 -0
- package/dist/enums/price-tax-basis-source.mjs +11 -0
- package/dist/enums/price-tax-basis-source.mjs.map +1 -0
- package/dist/enums/price-tax-basis.d.mts +6 -0
- package/dist/enums/price-tax-basis.d.ts +6 -0
- package/dist/enums/price-tax-basis.js +11 -0
- package/dist/enums/price-tax-basis.js.map +1 -0
- package/dist/enums/price-tax-basis.mjs +10 -0
- package/dist/enums/price-tax-basis.mjs.map +1 -0
- package/dist/enums/price-tax-inclusive-default.d.mts +6 -0
- package/dist/enums/price-tax-inclusive-default.d.ts +6 -0
- package/dist/enums/price-tax-inclusive-default.js +11 -0
- package/dist/enums/price-tax-inclusive-default.js.map +1 -0
- package/dist/enums/price-tax-inclusive-default.mjs +10 -0
- package/dist/enums/price-tax-inclusive-default.mjs.map +1 -0
- package/dist/enums/price-tax-market-source.d.mts +7 -0
- package/dist/enums/price-tax-market-source.d.ts +7 -0
- package/dist/enums/price-tax-market-source.js +12 -0
- package/dist/enums/price-tax-market-source.js.map +1 -0
- package/dist/enums/price-tax-market-source.mjs +11 -0
- package/dist/enums/price-tax-market-source.mjs.map +1 -0
- package/dist/enums/price-tax-unresolved-reason.d.mts +8 -0
- package/dist/enums/price-tax-unresolved-reason.d.ts +8 -0
- package/dist/enums/price-tax-unresolved-reason.js +13 -0
- package/dist/enums/price-tax-unresolved-reason.js.map +1 -0
- package/dist/enums/price-tax-unresolved-reason.mjs +12 -0
- package/dist/enums/price-tax-unresolved-reason.mjs.map +1 -0
- package/dist/enums/price-vocabulary-name.d.mts +7 -0
- package/dist/enums/price-vocabulary-name.d.ts +7 -0
- package/dist/enums/price-vocabulary-name.js +12 -0
- package/dist/enums/price-vocabulary-name.js.map +1 -0
- package/dist/enums/price-vocabulary-name.mjs +11 -0
- package/dist/enums/price-vocabulary-name.mjs.map +1 -0
- package/dist/enums/price-vocabulary-ref-name.d.mts +7 -0
- package/dist/enums/price-vocabulary-ref-name.d.ts +7 -0
- package/dist/enums/price-vocabulary-ref-name.js +12 -0
- package/dist/enums/price-vocabulary-ref-name.js.map +1 -0
- package/dist/enums/price-vocabulary-ref-name.mjs +11 -0
- package/dist/enums/price-vocabulary-ref-name.mjs.map +1 -0
- package/dist/enums/price-vocabulary-source.d.mts +5 -0
- package/dist/enums/price-vocabulary-source.d.ts +5 -0
- package/dist/enums/price-vocabulary-source.js +10 -0
- package/dist/enums/price-vocabulary-source.js.map +1 -0
- package/dist/enums/price-vocabulary-source.mjs +9 -0
- package/dist/enums/price-vocabulary-source.mjs.map +1 -0
- package/dist/enums/price-vocabulary-tone.d.mts +9 -0
- package/dist/enums/price-vocabulary-tone.d.ts +9 -0
- package/dist/enums/price-vocabulary-tone.js +14 -0
- package/dist/enums/price-vocabulary-tone.js.map +1 -0
- package/dist/enums/price-vocabulary-tone.mjs +13 -0
- package/dist/enums/price-vocabulary-tone.mjs.map +1 -0
- package/dist/enums/prices-vocabularies-get-name.d.mts +7 -0
- package/dist/enums/prices-vocabularies-get-name.d.ts +7 -0
- package/dist/enums/prices-vocabularies-get-name.js +12 -0
- package/dist/enums/prices-vocabularies-get-name.js.map +1 -0
- package/dist/enums/prices-vocabularies-get-name.mjs +11 -0
- package/dist/enums/prices-vocabularies-get-name.mjs.map +1 -0
- package/dist/enums/pricing-type.d.mts +7 -0
- package/dist/enums/pricing-type.d.ts +7 -0
- package/dist/enums/pricing-type.js +12 -0
- package/dist/enums/pricing-type.js.map +1 -0
- package/dist/enums/pricing-type.mjs +11 -0
- package/dist/enums/pricing-type.mjs.map +1 -0
- package/dist/enums/product-categories-source.d.mts +6 -0
- package/dist/enums/product-categories-source.d.ts +6 -0
- package/dist/enums/product-categories-source.js +11 -0
- package/dist/enums/product-categories-source.js.map +1 -0
- package/dist/enums/product-categories-source.mjs +10 -0
- package/dist/enums/product-categories-source.mjs.map +1 -0
- package/dist/enums/product-grid-column-source.d.mts +7 -0
- package/dist/enums/product-grid-column-source.d.ts +7 -0
- package/dist/enums/product-grid-column-source.js +12 -0
- package/dist/enums/product-grid-column-source.js.map +1 -0
- package/dist/enums/product-grid-column-source.mjs +11 -0
- package/dist/enums/product-grid-column-source.mjs.map +1 -0
- package/dist/enums/product-label-attribute-source.d.mts +7 -0
- package/dist/enums/product-label-attribute-source.d.ts +7 -0
- package/dist/enums/product-label-attribute-source.js +12 -0
- package/dist/enums/product-label-attribute-source.js.map +1 -0
- package/dist/enums/product-label-attribute-source.mjs +11 -0
- package/dist/enums/product-label-attribute-source.mjs.map +1 -0
- package/dist/enums/product-label-source.d.mts +9 -0
- package/dist/enums/product-label-source.d.ts +9 -0
- package/dist/enums/product-label-source.js +14 -0
- package/dist/enums/product-label-source.js.map +1 -0
- package/dist/enums/product-label-source.mjs +13 -0
- package/dist/enums/product-label-source.mjs.map +1 -0
- package/dist/enums/products-assets-list-source.d.mts +6 -0
- package/dist/enums/products-assets-list-source.d.ts +6 -0
- package/dist/enums/products-assets-list-source.js +11 -0
- package/dist/enums/products-assets-list-source.js.map +1 -0
- package/dist/enums/products-assets-list-source.mjs +10 -0
- package/dist/enums/products-assets-list-source.mjs.map +1 -0
- package/dist/enums/products-kind.d.mts +7 -0
- package/dist/enums/products-kind.d.ts +7 -0
- package/dist/enums/products-kind.js +12 -0
- package/dist/enums/products-kind.js.map +1 -0
- package/dist/enums/products-kind.mjs +11 -0
- package/dist/enums/products-kind.mjs.map +1 -0
- package/dist/enums/reason.d.mts +8 -0
- package/dist/enums/reason.d.ts +8 -0
- package/dist/enums/reason.js +13 -0
- package/dist/enums/reason.js.map +1 -0
- package/dist/enums/reason.mjs +12 -0
- package/dist/enums/reason.mjs.map +1 -0
- package/dist/enums/recovery-mail-source.d.mts +6 -0
- package/dist/enums/recovery-mail-source.d.ts +6 -0
- package/dist/enums/recovery-mail-source.js +11 -0
- package/dist/enums/recovery-mail-source.js.map +1 -0
- package/dist/enums/recovery-mail-source.mjs +10 -0
- package/dist/enums/recovery-mail-source.mjs.map +1 -0
- package/dist/enums/registration-status.d.mts +7 -0
- package/dist/enums/registration-status.d.ts +7 -0
- package/dist/enums/registration-status.js +12 -0
- package/dist/enums/registration-status.js.map +1 -0
- package/dist/enums/registration-status.mjs +11 -0
- package/dist/enums/registration-status.mjs.map +1 -0
- package/dist/enums/reorder-point-source.d.mts +6 -0
- package/dist/enums/reorder-point-source.d.ts +6 -0
- package/dist/enums/reorder-point-source.js +11 -0
- package/dist/enums/reorder-point-source.js.map +1 -0
- package/dist/enums/reorder-point-source.mjs +10 -0
- package/dist/enums/reorder-point-source.mjs.map +1 -0
- package/dist/enums/reservation-status.d.mts +7 -0
- package/dist/enums/reservation-status.d.ts +7 -0
- package/dist/enums/reservation-status.js +12 -0
- package/dist/enums/reservation-status.js.map +1 -0
- package/dist/enums/reservation-status.mjs +11 -0
- package/dist/enums/reservation-status.mjs.map +1 -0
- package/dist/enums/resource-type.d.mts +7 -0
- package/dist/enums/resource-type.d.ts +7 -0
- package/dist/enums/resource-type.js +12 -0
- package/dist/enums/resource-type.js.map +1 -0
- package/dist/enums/resource-type.mjs +11 -0
- package/dist/enums/resource-type.mjs.map +1 -0
- package/dist/enums/role-catalog-response-source.d.mts +6 -0
- package/dist/enums/role-catalog-response-source.d.ts +6 -0
- package/dist/enums/role-catalog-response-source.js +11 -0
- package/dist/enums/role-catalog-response-source.js.map +1 -0
- package/dist/enums/role-catalog-response-source.mjs +10 -0
- package/dist/enums/role-catalog-response-source.mjs.map +1 -0
- package/dist/enums/rule-match.d.mts +6 -0
- package/dist/enums/rule-match.d.ts +6 -0
- package/dist/enums/rule-match.js +11 -0
- package/dist/enums/rule-match.js.map +1 -0
- package/dist/enums/rule-match.mjs +10 -0
- package/dist/enums/rule-match.mjs.map +1 -0
- package/dist/enums/scope.d.mts +6 -0
- package/dist/enums/scope.d.ts +6 -0
- package/dist/enums/scope.js +11 -0
- package/dist/enums/scope.js.map +1 -0
- package/dist/enums/scope.mjs +10 -0
- package/dist/enums/scope.mjs.map +1 -0
- package/dist/enums/segment-member-source.d.mts +6 -0
- package/dist/enums/segment-member-source.d.ts +6 -0
- package/dist/enums/segment-member-source.js +11 -0
- package/dist/enums/segment-member-source.js.map +1 -0
- package/dist/enums/segment-member-source.mjs +10 -0
- package/dist/enums/segment-member-source.mjs.map +1 -0
- package/dist/enums/segment-rule-match.d.mts +6 -0
- package/dist/enums/segment-rule-match.d.ts +6 -0
- package/dist/enums/segment-rule-match.js +11 -0
- package/dist/enums/segment-rule-match.js.map +1 -0
- package/dist/enums/segment-rule-match.mjs +10 -0
- package/dist/enums/segment-rule-match.mjs.map +1 -0
- package/dist/enums/segment-rule-operator.d.mts +16 -0
- package/dist/enums/segment-rule-operator.d.ts +16 -0
- package/dist/enums/segment-rule-operator.js +21 -0
- package/dist/enums/segment-rule-operator.js.map +1 -0
- package/dist/enums/segment-rule-operator.mjs +20 -0
- package/dist/enums/segment-rule-operator.mjs.map +1 -0
- package/dist/enums/segment-rule-preview-request-rule-match.d.mts +6 -0
- package/dist/enums/segment-rule-preview-request-rule-match.d.ts +6 -0
- package/dist/enums/segment-rule-preview-request-rule-match.js +11 -0
- package/dist/enums/segment-rule-preview-request-rule-match.js.map +1 -0
- package/dist/enums/segment-rule-preview-request-rule-match.mjs +10 -0
- package/dist/enums/segment-rule-preview-request-rule-match.mjs.map +1 -0
- package/dist/enums/segment-rule-preview-request-target.d.mts +5 -0
- package/dist/enums/segment-rule-preview-request-target.d.ts +5 -0
- package/dist/enums/segment-rule-preview-request-target.js +10 -0
- package/dist/enums/segment-rule-preview-request-target.js.map +1 -0
- package/dist/enums/segment-rule-preview-request-target.mjs +9 -0
- package/dist/enums/segment-rule-preview-request-target.mjs.map +1 -0
- package/dist/enums/segment-rule-preview-response-rule-match.d.mts +6 -0
- package/dist/enums/segment-rule-preview-response-rule-match.d.ts +6 -0
- package/dist/enums/segment-rule-preview-response-rule-match.js +11 -0
- package/dist/enums/segment-rule-preview-response-rule-match.js.map +1 -0
- package/dist/enums/segment-rule-preview-response-rule-match.mjs +10 -0
- package/dist/enums/segment-rule-preview-response-rule-match.mjs.map +1 -0
- package/dist/enums/segment-rule-preview-response-target.d.mts +5 -0
- package/dist/enums/segment-rule-preview-response-target.d.ts +5 -0
- package/dist/enums/segment-rule-preview-response-target.js +10 -0
- package/dist/enums/segment-rule-preview-response-target.js.map +1 -0
- package/dist/enums/segment-rule-preview-response-target.mjs +9 -0
- package/dist/enums/segment-rule-preview-response-target.mjs.map +1 -0
- package/dist/enums/segment-rules-target.d.mts +5 -0
- package/dist/enums/segment-rules-target.d.ts +5 -0
- package/dist/enums/segment-rules-target.js +10 -0
- package/dist/enums/segment-rules-target.js.map +1 -0
- package/dist/enums/segment-rules-target.mjs +9 -0
- package/dist/enums/segment-rules-target.mjs.map +1 -0
- package/dist/enums/shipping-carrier-source.d.mts +9 -0
- package/dist/enums/shipping-carrier-source.d.ts +9 -0
- package/dist/enums/shipping-carrier-source.js +14 -0
- package/dist/enums/shipping-carrier-source.js.map +1 -0
- package/dist/enums/shipping-carrier-source.mjs +13 -0
- package/dist/enums/shipping-carrier-source.mjs.map +1 -0
- package/dist/enums/shipping-carrier-status.d.mts +7 -0
- package/dist/enums/shipping-carrier-status.d.ts +7 -0
- package/dist/enums/shipping-carrier-status.js +12 -0
- package/dist/enums/shipping-carrier-status.js.map +1 -0
- package/dist/enums/shipping-carrier-status.mjs +11 -0
- package/dist/enums/shipping-carrier-status.mjs.map +1 -0
- package/dist/enums/shipping-carriers-list-status.d.mts +7 -0
- package/dist/enums/shipping-carriers-list-status.d.ts +7 -0
- package/dist/enums/shipping-carriers-list-status.js +12 -0
- package/dist/enums/shipping-carriers-list-status.js.map +1 -0
- package/dist/enums/shipping-carriers-list-status.mjs +11 -0
- package/dist/enums/shipping-carriers-list-status.mjs.map +1 -0
- package/dist/enums/shipping-free-above-basis.d.mts +6 -0
- package/dist/enums/shipping-free-above-basis.d.ts +6 -0
- package/dist/enums/shipping-free-above-basis.js +11 -0
- package/dist/enums/shipping-free-above-basis.js.map +1 -0
- package/dist/enums/shipping-free-above-basis.mjs +10 -0
- package/dist/enums/shipping-free-above-basis.mjs.map +1 -0
- package/dist/enums/shipping-rate-pricing-type.d.mts +7 -0
- package/dist/enums/shipping-rate-pricing-type.d.ts +7 -0
- package/dist/enums/shipping-rate-pricing-type.js +12 -0
- package/dist/enums/shipping-rate-pricing-type.js.map +1 -0
- package/dist/enums/shipping-rate-pricing-type.mjs +11 -0
- package/dist/enums/shipping-rate-pricing-type.mjs.map +1 -0
- package/dist/enums/shipping-rates-basis-matrix-basis-default.d.mts +7 -0
- package/dist/enums/shipping-rates-basis-matrix-basis-default.d.ts +7 -0
- package/dist/enums/shipping-rates-basis-matrix-basis-default.js +12 -0
- package/dist/enums/shipping-rates-basis-matrix-basis-default.js.map +1 -0
- package/dist/enums/shipping-rates-basis-matrix-basis-default.mjs +11 -0
- package/dist/enums/shipping-rates-basis-matrix-basis-default.mjs.map +1 -0
- package/dist/enums/shipping-service-level-create-request-tone.d.mts +9 -0
- package/dist/enums/shipping-service-level-create-request-tone.d.ts +9 -0
- package/dist/enums/shipping-service-level-create-request-tone.js +14 -0
- package/dist/enums/shipping-service-level-create-request-tone.js.map +1 -0
- package/dist/enums/shipping-service-level-create-request-tone.mjs +13 -0
- package/dist/enums/shipping-service-level-create-request-tone.mjs.map +1 -0
- package/dist/enums/shipping-service-level-row-tone.d.mts +9 -0
- package/dist/enums/shipping-service-level-row-tone.d.ts +9 -0
- package/dist/enums/shipping-service-level-row-tone.js +14 -0
- package/dist/enums/shipping-service-level-row-tone.js.map +1 -0
- package/dist/enums/shipping-service-level-row-tone.mjs +13 -0
- package/dist/enums/shipping-service-level-row-tone.mjs.map +1 -0
- package/dist/enums/shipping-service-level-update-request-tone.d.mts +9 -0
- package/dist/enums/shipping-service-level-update-request-tone.d.ts +9 -0
- package/dist/enums/shipping-service-level-update-request-tone.js +14 -0
- package/dist/enums/shipping-service-level-update-request-tone.js.map +1 -0
- package/dist/enums/shipping-service-level-update-request-tone.mjs +13 -0
- package/dist/enums/shipping-service-level-update-request-tone.mjs.map +1 -0
- package/dist/enums/shipping-tax-context-via.d.mts +5 -0
- package/dist/enums/shipping-tax-context-via.d.ts +5 -0
- package/dist/enums/shipping-tax-context-via.js +10 -0
- package/dist/enums/shipping-tax-context-via.js.map +1 -0
- package/dist/enums/shipping-tax-context-via.mjs +9 -0
- package/dist/enums/shipping-tax-context-via.mjs.map +1 -0
- package/dist/enums/shipping-tax-market-source.d.mts +8 -0
- package/dist/enums/shipping-tax-market-source.d.ts +8 -0
- package/dist/enums/shipping-tax-market-source.js +13 -0
- package/dist/enums/shipping-tax-market-source.js.map +1 -0
- package/dist/enums/shipping-tax-market-source.mjs +12 -0
- package/dist/enums/shipping-tax-market-source.mjs.map +1 -0
- package/dist/enums/shipping-tax-source.d.mts +8 -0
- package/dist/enums/shipping-tax-source.d.ts +8 -0
- package/dist/enums/shipping-tax-source.js +13 -0
- package/dist/enums/shipping-tax-source.js.map +1 -0
- package/dist/enums/shipping-tax-source.mjs +12 -0
- package/dist/enums/shipping-tax-source.mjs.map +1 -0
- package/dist/enums/shipping-tax-unresolved-reason.d.mts +8 -0
- package/dist/enums/shipping-tax-unresolved-reason.d.ts +8 -0
- package/dist/enums/shipping-tax-unresolved-reason.js +13 -0
- package/dist/enums/shipping-tax-unresolved-reason.js.map +1 -0
- package/dist/enums/shipping-tax-unresolved-reason.mjs +12 -0
- package/dist/enums/shipping-tax-unresolved-reason.mjs.map +1 -0
- package/dist/enums/shipping-tracking-carrier-status.d.mts +7 -0
- package/dist/enums/shipping-tracking-carrier-status.d.ts +7 -0
- package/dist/enums/shipping-tracking-carrier-status.js +12 -0
- package/dist/enums/shipping-tracking-carrier-status.js.map +1 -0
- package/dist/enums/shipping-tracking-carrier-status.mjs +11 -0
- package/dist/enums/shipping-tracking-carrier-status.mjs.map +1 -0
- package/dist/enums/shipping-vocabularies-get-name.d.mts +9 -0
- package/dist/enums/shipping-vocabularies-get-name.d.ts +9 -0
- package/dist/enums/shipping-vocabularies-get-name.js +14 -0
- package/dist/enums/shipping-vocabularies-get-name.js.map +1 -0
- package/dist/enums/shipping-vocabularies-get-name.mjs +13 -0
- package/dist/enums/shipping-vocabularies-get-name.mjs.map +1 -0
- package/dist/enums/shipping-vocabulary-default-tone.d.mts +9 -0
- package/dist/enums/shipping-vocabulary-default-tone.d.ts +9 -0
- package/dist/enums/shipping-vocabulary-default-tone.js +14 -0
- package/dist/enums/shipping-vocabulary-default-tone.js.map +1 -0
- package/dist/enums/shipping-vocabulary-default-tone.mjs +13 -0
- package/dist/enums/shipping-vocabulary-default-tone.mjs.map +1 -0
- package/dist/enums/shipping-vocabulary-source.d.mts +6 -0
- package/dist/enums/shipping-vocabulary-source.d.ts +6 -0
- package/dist/enums/shipping-vocabulary-source.js +11 -0
- package/dist/enums/shipping-vocabulary-source.js.map +1 -0
- package/dist/enums/shipping-vocabulary-source.mjs +10 -0
- package/dist/enums/shipping-vocabulary-source.mjs.map +1 -0
- package/dist/enums/shipping-vocabulary-tone.d.mts +9 -0
- package/dist/enums/shipping-vocabulary-tone.d.ts +9 -0
- package/dist/enums/shipping-vocabulary-tone.js +14 -0
- package/dist/enums/shipping-vocabulary-tone.js.map +1 -0
- package/dist/enums/shipping-vocabulary-tone.mjs +13 -0
- package/dist/enums/shipping-vocabulary-tone.mjs.map +1 -0
- package/dist/enums/shipping-weight-unit-create-request-tone.d.mts +9 -0
- package/dist/enums/shipping-weight-unit-create-request-tone.d.ts +9 -0
- package/dist/enums/shipping-weight-unit-create-request-tone.js +14 -0
- package/dist/enums/shipping-weight-unit-create-request-tone.js.map +1 -0
- package/dist/enums/shipping-weight-unit-create-request-tone.mjs +13 -0
- package/dist/enums/shipping-weight-unit-create-request-tone.mjs.map +1 -0
- package/dist/enums/shipping-weight-unit-row-tone.d.mts +9 -0
- package/dist/enums/shipping-weight-unit-row-tone.d.ts +9 -0
- package/dist/enums/shipping-weight-unit-row-tone.js +14 -0
- package/dist/enums/shipping-weight-unit-row-tone.js.map +1 -0
- package/dist/enums/shipping-weight-unit-row-tone.mjs +13 -0
- package/dist/enums/shipping-weight-unit-row-tone.mjs.map +1 -0
- package/dist/enums/shipping-weight-unit-update-request-tone.d.mts +9 -0
- package/dist/enums/shipping-weight-unit-update-request-tone.d.ts +9 -0
- package/dist/enums/shipping-weight-unit-update-request-tone.js +14 -0
- package/dist/enums/shipping-weight-unit-update-request-tone.js.map +1 -0
- package/dist/enums/shipping-weight-unit-update-request-tone.mjs +13 -0
- package/dist/enums/shipping-weight-unit-update-request-tone.mjs.map +1 -0
- package/dist/enums/sites-create-template-deployment-type.d.mts +7 -0
- package/dist/enums/sites-create-template-deployment-type.d.ts +7 -0
- package/dist/enums/sites-create-template-deployment-type.js +12 -0
- package/dist/enums/sites-create-template-deployment-type.js.map +1 -0
- package/dist/enums/sites-create-template-deployment-type.mjs +11 -0
- package/dist/enums/sites-create-template-deployment-type.mjs.map +1 -0
- package/dist/enums/source.d.mts +6 -0
- package/dist/enums/source.d.ts +6 -0
- package/dist/enums/source.js +11 -0
- package/dist/enums/source.js.map +1 -0
- package/dist/enums/source.mjs +10 -0
- package/dist/enums/source.mjs.map +1 -0
- package/dist/enums/status.d.mts +3 -5
- package/dist/enums/status.d.ts +3 -5
- package/dist/enums/status.js +3 -5
- package/dist/enums/status.js.map +1 -1
- package/dist/enums/status.mjs +3 -5
- package/dist/enums/status.mjs.map +1 -1
- package/dist/enums/stock-movement-type.d.mts +10 -0
- package/dist/enums/stock-movement-type.d.ts +10 -0
- package/dist/enums/stock-movement-type.js +15 -0
- package/dist/enums/stock-movement-type.js.map +1 -0
- package/dist/enums/stock-movement-type.mjs +14 -0
- package/dist/enums/stock-movement-type.mjs.map +1 -0
- package/dist/enums/target.d.mts +5 -0
- package/dist/enums/target.d.ts +5 -0
- package/dist/enums/target.js +10 -0
- package/dist/enums/target.js.map +1 -0
- package/dist/enums/target.mjs +9 -0
- package/dist/enums/target.mjs.map +1 -0
- package/dist/enums/timezone.d.mts +393 -419
- package/dist/enums/timezone.d.ts +393 -419
- package/dist/enums/timezone.js +393 -419
- package/dist/enums/timezone.js.map +1 -1
- package/dist/enums/timezone.mjs +393 -419
- package/dist/enums/timezone.mjs.map +1 -1
- package/dist/enums/tone.d.mts +9 -0
- package/dist/enums/tone.d.ts +9 -0
- package/dist/enums/tone.js +14 -0
- package/dist/enums/tone.js.map +1 -0
- package/dist/enums/tone.mjs +13 -0
- package/dist/enums/tone.mjs.map +1 -0
- package/dist/enums/validation-failed-response-status.d.mts +5 -0
- package/dist/enums/validation-failed-response-status.d.ts +5 -0
- package/dist/enums/validation-failed-response-status.js +10 -0
- package/dist/enums/validation-failed-response-status.js.map +1 -0
- package/dist/enums/validation-failed-response-status.mjs +9 -0
- package/dist/enums/validation-failed-response-status.mjs.map +1 -0
- package/dist/enums/vocabulary-default-tone.d.mts +9 -0
- package/dist/enums/vocabulary-default-tone.d.ts +9 -0
- package/dist/enums/vocabulary-default-tone.js +14 -0
- package/dist/enums/vocabulary-default-tone.js.map +1 -0
- package/dist/enums/vocabulary-default-tone.mjs +13 -0
- package/dist/enums/vocabulary-default-tone.mjs.map +1 -0
- package/dist/enums/vocabulary-source.d.mts +8 -0
- package/dist/enums/vocabulary-source.d.ts +8 -0
- package/dist/enums/vocabulary-source.js +13 -0
- package/dist/enums/vocabulary-source.js.map +1 -0
- package/dist/enums/vocabulary-source.mjs +12 -0
- package/dist/enums/vocabulary-source.mjs.map +1 -0
- package/dist/enums/vocabulary-tone.d.mts +9 -0
- package/dist/enums/vocabulary-tone.d.ts +9 -0
- package/dist/enums/vocabulary-tone.js +14 -0
- package/dist/enums/vocabulary-tone.js.map +1 -0
- package/dist/enums/vocabulary-tone.mjs +13 -0
- package/dist/enums/vocabulary-tone.mjs.map +1 -0
- package/dist/enums/whatsapp-category.d.mts +8 -0
- package/dist/enums/whatsapp-category.d.ts +8 -0
- package/dist/enums/whatsapp-category.js +13 -0
- package/dist/enums/whatsapp-category.js.map +1 -0
- package/dist/enums/whatsapp-category.mjs +12 -0
- package/dist/enums/whatsapp-category.mjs.map +1 -0
- package/dist/index.d.mts +247 -20
- package/dist/index.d.ts +247 -20
- package/dist/index.js +1198 -63
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +247 -20
- package/dist/index.mjs.map +1 -1
- package/dist/models.d.mts +14792 -3532
- package/dist/models.d.ts +14792 -3532
- package/dist/services/apps.d.mts +258 -103
- package/dist/services/apps.d.ts +258 -103
- package/dist/services/apps.js +59 -59
- package/dist/services/apps.js.map +1 -1
- package/dist/services/apps.mjs +60 -60
- package/dist/services/apps.mjs.map +1 -1
- package/dist/services/avatars.d.mts +190 -58
- package/dist/services/avatars.d.ts +190 -58
- package/dist/services/avatars.js +6 -33
- package/dist/services/avatars.js.map +1 -1
- package/dist/services/avatars.mjs +7 -34
- package/dist/services/avatars.mjs.map +1 -1
- package/dist/services/carts-io.d.mts +473 -0
- package/dist/services/carts-io.d.ts +473 -0
- package/dist/services/carts-io.js +383 -0
- package/dist/services/carts-io.js.map +1 -0
- package/dist/services/carts-io.mjs +382 -0
- package/dist/services/carts-io.mjs.map +1 -0
- package/dist/services/carts-items.d.mts +486 -0
- package/dist/services/carts-items.d.ts +486 -0
- package/dist/services/carts-items.js +401 -0
- package/dist/services/carts-items.js.map +1 -0
- package/dist/services/carts-items.mjs +400 -0
- package/dist/services/carts-items.mjs.map +1 -0
- package/dist/services/carts.d.mts +400 -496
- package/dist/services/carts.d.ts +400 -496
- package/dist/services/carts.js +125 -573
- package/dist/services/carts.js.map +1 -1
- package/dist/services/carts.mjs +126 -574
- package/dist/services/carts.mjs.map +1 -1
- package/dist/services/channels.d.mts +497 -66
- package/dist/services/channels.d.ts +497 -66
- package/dist/services/channels.js +408 -15
- package/dist/services/channels.js.map +1 -1
- package/dist/services/channels.mjs +409 -16
- package/dist/services/channels.mjs.map +1 -1
- package/dist/services/cost-centers.d.mts +1033 -0
- package/dist/services/cost-centers.d.ts +1033 -0
- package/dist/services/cost-centers.js +1308 -0
- package/dist/services/cost-centers.js.map +1 -0
- package/dist/services/cost-centers.mjs +1307 -0
- package/dist/services/cost-centers.mjs.map +1 -0
- package/dist/services/customers-contacts.d.mts +693 -0
- package/dist/services/customers-contacts.d.ts +693 -0
- package/dist/services/customers-contacts.js +712 -0
- package/dist/services/customers-contacts.js.map +1 -0
- package/dist/services/customers-contacts.mjs +711 -0
- package/dist/services/customers-contacts.mjs.map +1 -0
- package/dist/services/customers-organizations.d.mts +798 -0
- package/dist/services/customers-organizations.d.ts +798 -0
- package/dist/services/customers-organizations.js +888 -0
- package/dist/services/customers-organizations.js.map +1 -0
- package/dist/services/customers-organizations.mjs +887 -0
- package/dist/services/customers-organizations.mjs.map +1 -0
- package/dist/services/customers-roles.d.mts +279 -0
- package/dist/services/customers-roles.d.ts +279 -0
- package/dist/services/customers-roles.js +94 -0
- package/dist/services/customers-roles.js.map +1 -0
- package/dist/services/customers-roles.mjs +93 -0
- package/dist/services/customers-roles.mjs.map +1 -0
- package/dist/services/customers-segments.d.mts +583 -0
- package/dist/services/customers-segments.d.ts +583 -0
- package/dist/services/customers-segments.js +524 -0
- package/dist/services/customers-segments.js.map +1 -0
- package/dist/services/customers-segments.mjs +523 -0
- package/dist/services/customers-segments.mjs.map +1 -0
- package/dist/services/customers-value-lists.d.mts +778 -0
- package/dist/services/customers-value-lists.d.ts +778 -0
- package/dist/services/customers-value-lists.js +860 -0
- package/dist/services/customers-value-lists.js.map +1 -0
- package/dist/services/customers-value-lists.mjs +859 -0
- package/dist/services/customers-value-lists.mjs.map +1 -0
- package/dist/services/customers.d.mts +406 -455
- package/dist/services/customers.d.ts +406 -455
- package/dist/services/customers.js +221 -557
- package/dist/services/customers.js.map +1 -1
- package/dist/services/customers.mjs +222 -558
- package/dist/services/customers.mjs.map +1 -1
- package/dist/services/events.d.mts +250 -0
- package/dist/services/events.d.ts +250 -0
- package/dist/services/events.js +35 -0
- package/dist/services/events.js.map +1 -0
- package/dist/services/events.mjs +34 -0
- package/dist/services/events.mjs.map +1 -0
- package/dist/services/forms.d.mts +777 -0
- package/dist/services/forms.d.ts +777 -0
- package/dist/services/forms.js +577 -0
- package/dist/services/forms.js.map +1 -0
- package/dist/services/forms.mjs +576 -0
- package/dist/services/forms.mjs.map +1 -0
- package/dist/services/health.d.mts +245 -0
- package/dist/services/health.d.ts +245 -0
- package/dist/services/health.js +47 -0
- package/dist/services/health.js.map +1 -0
- package/dist/services/health.mjs +46 -0
- package/dist/services/health.mjs.map +1 -0
- package/dist/services/inventories-locations.d.mts +418 -0
- package/dist/services/inventories-locations.d.ts +418 -0
- package/dist/services/inventories-locations.js +301 -0
- package/dist/services/inventories-locations.js.map +1 -0
- package/dist/services/inventories-locations.mjs +300 -0
- package/dist/services/inventories-locations.mjs.map +1 -0
- package/dist/services/inventories-reservations.d.mts +406 -0
- package/dist/services/inventories-reservations.d.ts +406 -0
- package/dist/services/inventories-reservations.js +277 -0
- package/dist/services/inventories-reservations.js.map +1 -0
- package/dist/services/inventories-reservations.mjs +276 -0
- package/dist/services/inventories-reservations.mjs.map +1 -0
- package/dist/services/inventories-stock.d.mts +681 -0
- package/dist/services/inventories-stock.d.ts +681 -0
- package/dist/services/{inventories.js → inventories-stock.js} +303 -367
- package/dist/services/inventories-stock.js.map +1 -0
- package/dist/services/{inventories.mjs → inventories-stock.mjs} +305 -369
- package/dist/services/inventories-stock.mjs.map +1 -0
- package/dist/services/io.d.mts +713 -0
- package/dist/services/io.d.ts +713 -0
- package/dist/services/io.js +592 -0
- package/dist/services/io.js.map +1 -0
- package/dist/services/io.mjs +591 -0
- package/dist/services/io.mjs.map +1 -0
- package/dist/services/locale.d.mts +170 -17
- package/dist/services/locale.d.ts +170 -17
- package/dist/services/locale.js +8 -8
- package/dist/services/locale.js.map +1 -1
- package/dist/services/locale.mjs +8 -8
- package/dist/services/locale.mjs.map +1 -1
- package/dist/services/markets.d.mts +743 -309
- package/dist/services/markets.d.ts +743 -309
- package/dist/services/markets.js +434 -48
- package/dist/services/markets.js.map +1 -1
- package/dist/services/markets.mjs +435 -49
- package/dist/services/markets.mjs.map +1 -1
- package/dist/services/messaging.d.mts +2222 -1156
- package/dist/services/messaging.d.ts +2222 -1156
- package/dist/services/messaging.js +1026 -1225
- package/dist/services/messaging.js.map +1 -1
- package/dist/services/messaging.mjs +1027 -1226
- package/dist/services/messaging.mjs.map +1 -1
- package/dist/services/orderlists.d.mts +691 -210
- package/dist/services/orderlists.d.ts +691 -210
- package/dist/services/orderlists.js +485 -21
- package/dist/services/orderlists.js.map +1 -1
- package/dist/services/orderlists.mjs +486 -22
- package/dist/services/orderlists.mjs.map +1 -1
- package/dist/services/orders.d.mts +800 -361
- package/dist/services/orders.d.ts +800 -361
- package/dist/services/orders.js +456 -88
- package/dist/services/orders.js.map +1 -1
- package/dist/services/orders.mjs +457 -89
- package/dist/services/orders.mjs.map +1 -1
- package/dist/services/pages-collaboration.d.mts +437 -0
- package/dist/services/pages-collaboration.d.ts +437 -0
- package/dist/services/pages-collaboration.js +329 -0
- package/dist/services/pages-collaboration.js.map +1 -0
- package/dist/services/pages-collaboration.mjs +328 -0
- package/dist/services/pages-collaboration.mjs.map +1 -0
- package/dist/services/pages-delivery.d.mts +331 -0
- package/dist/services/pages-delivery.d.ts +331 -0
- package/dist/services/pages-delivery.js +149 -0
- package/dist/services/pages-delivery.js.map +1 -0
- package/dist/services/pages-delivery.mjs +148 -0
- package/dist/services/pages-delivery.mjs.map +1 -0
- package/dist/services/pages-editor.d.mts +590 -0
- package/dist/services/pages-editor.d.ts +590 -0
- package/dist/services/pages-editor.js +540 -0
- package/dist/services/pages-editor.js.map +1 -0
- package/dist/services/pages-editor.mjs +539 -0
- package/dist/services/pages-editor.mjs.map +1 -0
- package/dist/services/pages.d.mts +542 -703
- package/dist/services/pages.d.ts +542 -703
- package/dist/services/pages.js +247 -907
- package/dist/services/pages.js.map +1 -1
- package/dist/services/pages.mjs +248 -908
- package/dist/services/pages.mjs.map +1 -1
- package/dist/services/payments-ledger.d.mts +533 -0
- package/dist/services/payments-ledger.d.ts +533 -0
- package/dist/services/payments-ledger.js +459 -0
- package/dist/services/payments-ledger.js.map +1 -0
- package/dist/services/payments-ledger.mjs +458 -0
- package/dist/services/payments-ledger.mjs.map +1 -0
- package/dist/services/payments-methods.d.mts +469 -0
- package/dist/services/payments-methods.d.ts +469 -0
- package/dist/services/payments-methods.js +382 -0
- package/dist/services/payments-methods.js.map +1 -0
- package/dist/services/payments-methods.mjs +381 -0
- package/dist/services/payments-methods.mjs.map +1 -0
- package/dist/services/payments-providers.d.mts +406 -0
- package/dist/services/payments-providers.d.ts +406 -0
- package/dist/services/payments-providers.js +272 -0
- package/dist/services/payments-providers.js.map +1 -0
- package/dist/services/payments-providers.mjs +271 -0
- package/dist/services/payments-providers.mjs.map +1 -0
- package/dist/services/prices.d.mts +803 -243
- package/dist/services/prices.d.ts +803 -243
- package/dist/services/prices.js +445 -52
- package/dist/services/prices.js.map +1 -1
- package/dist/services/prices.mjs +446 -53
- package/dist/services/prices.mjs.map +1 -1
- package/dist/services/products-assets.d.mts +522 -0
- package/dist/services/products-assets.d.ts +522 -0
- package/dist/services/products-assets.js +268 -0
- package/dist/services/products-assets.js.map +1 -0
- package/dist/services/products-assets.mjs +267 -0
- package/dist/services/products-assets.mjs.map +1 -0
- package/dist/services/products-categories.d.mts +744 -0
- package/dist/services/products-categories.d.ts +744 -0
- package/dist/services/products-categories.js +638 -0
- package/dist/services/products-categories.js.map +1 -0
- package/dist/services/products-categories.mjs +637 -0
- package/dist/services/products-categories.mjs.map +1 -0
- package/dist/services/products-data-model.d.mts +2034 -0
- package/dist/services/products-data-model.d.ts +2034 -0
- package/dist/services/products-data-model.js +2080 -0
- package/dist/services/products-data-model.js.map +1 -0
- package/dist/services/products-data-model.mjs +2079 -0
- package/dist/services/products-data-model.mjs.map +1 -0
- package/dist/services/products-references.d.mts +672 -0
- package/dist/services/products-references.d.ts +672 -0
- package/dist/services/products-references.js +415 -0
- package/dist/services/products-references.js.map +1 -0
- package/dist/services/products-references.mjs +414 -0
- package/dist/services/products-references.mjs.map +1 -0
- package/dist/services/products.d.mts +670 -1746
- package/dist/services/products.d.ts +670 -1746
- package/dist/services/products.js +373 -2596
- package/dist/services/products.js.map +1 -1
- package/dist/services/products.mjs +374 -2597
- package/dist/services/products.mjs.map +1 -1
- package/dist/services/search.d.mts +359 -80
- package/dist/services/search.d.ts +359 -80
- package/dist/services/search.js +149 -19
- package/dist/services/search.js.map +1 -1
- package/dist/services/search.mjs +150 -20
- package/dist/services/search.mjs.map +1 -1
- package/dist/services/settings.d.mts +253 -0
- package/dist/services/settings.d.ts +253 -0
- package/dist/services/settings.js +42 -0
- package/dist/services/settings.js.map +1 -0
- package/dist/services/settings.mjs +41 -0
- package/dist/services/settings.mjs.map +1 -0
- package/dist/services/shipping-carriers.d.mts +459 -0
- package/dist/services/shipping-carriers.d.ts +459 -0
- package/dist/services/shipping-carriers.js +373 -0
- package/dist/services/shipping-carriers.js.map +1 -0
- package/dist/services/shipping-carriers.mjs +372 -0
- package/dist/services/shipping-carriers.mjs.map +1 -0
- package/dist/services/shipping-methods.d.mts +736 -0
- package/dist/services/shipping-methods.d.ts +736 -0
- package/dist/services/{shipping.js → shipping-methods.js} +272 -65
- package/dist/services/shipping-methods.js.map +1 -0
- package/dist/services/{shipping.mjs → shipping-methods.mjs} +274 -67
- package/dist/services/shipping-methods.mjs.map +1 -0
- package/dist/services/shipping-value-lists.d.mts +589 -0
- package/dist/services/shipping-value-lists.d.ts +589 -0
- package/dist/services/shipping-value-lists.js +546 -0
- package/dist/services/shipping-value-lists.js.map +1 -0
- package/dist/services/shipping-value-lists.mjs +545 -0
- package/dist/services/shipping-value-lists.mjs.map +1 -0
- package/dist/services/sites.d.mts +240 -86
- package/dist/services/sites.d.ts +240 -86
- package/dist/services/sites.js +53 -53
- package/dist/services/sites.js.map +1 -1
- package/dist/services/sites.mjs +54 -54
- package/dist/services/sites.mjs.map +1 -1
- package/dist/services/storage.d.mts +705 -68
- package/dist/services/storage.d.ts +705 -68
- package/dist/services/storage.js +138 -36
- package/dist/services/storage.js.map +1 -1
- package/dist/services/storage.mjs +139 -37
- package/dist/services/storage.mjs.map +1 -1
- package/package.json +1 -1
- package/dist/enums/address-type.d.mts +0 -6
- package/dist/enums/address-type.d.ts +0 -6
- package/dist/enums/address-type.js +0 -11
- package/dist/enums/address-type.js.map +0 -1
- package/dist/enums/address-type.mjs +0 -10
- package/dist/enums/address-type.mjs.map +0 -1
- package/dist/enums/channel-type.d.mts +0 -9
- package/dist/enums/channel-type.d.ts +0 -9
- package/dist/enums/channel-type.js +0 -14
- package/dist/enums/channel-type.js.map +0 -1
- package/dist/enums/channel-type.mjs +0 -13
- package/dist/enums/channel-type.mjs.map +0 -1
- package/dist/enums/contact-role.d.mts +0 -8
- package/dist/enums/contact-role.d.ts +0 -8
- package/dist/enums/contact-role.js +0 -13
- package/dist/enums/contact-role.js.map +0 -1
- package/dist/enums/contact-role.mjs +0 -12
- package/dist/enums/contact-role.mjs.map +0 -1
- package/dist/enums/fulfillment-status.js +0 -12
- package/dist/enums/fulfillment-status.js.map +0 -1
- package/dist/enums/fulfillment-status.mjs +0 -11
- package/dist/enums/fulfillment-status.mjs.map +0 -1
- package/dist/enums/message-status.js +0 -14
- package/dist/enums/message-status.js.map +0 -1
- package/dist/enums/message-status.mjs +0 -13
- package/dist/enums/message-status.mjs.map +0 -1
- package/dist/enums/order-list-kind.d.mts +0 -6
- package/dist/enums/order-list-kind.d.ts +0 -6
- package/dist/enums/order-list-kind.js +0 -11
- package/dist/enums/order-list-kind.js.map +0 -1
- package/dist/enums/order-list-kind.mjs +0 -10
- package/dist/enums/order-list-kind.mjs.map +0 -1
- package/dist/enums/priority.d.mts +0 -6
- package/dist/enums/priority.d.ts +0 -6
- package/dist/enums/priority.js +0 -11
- package/dist/enums/priority.js.map +0 -1
- package/dist/enums/priority.mjs +0 -10
- package/dist/enums/priority.mjs.map +0 -1
- package/dist/services/greetings.d.mts +0 -173
- package/dist/services/greetings.d.ts +0 -173
- package/dist/services/greetings.js +0 -175
- package/dist/services/greetings.js.map +0 -1
- package/dist/services/greetings.mjs +0 -174
- package/dist/services/greetings.mjs.map +0 -1
- package/dist/services/inventories.d.mts +0 -511
- package/dist/services/inventories.d.ts +0 -511
- package/dist/services/inventories.js.map +0 -1
- package/dist/services/inventories.mjs.map +0 -1
- package/dist/services/payments.d.mts +0 -550
- package/dist/services/payments.d.ts +0 -550
- package/dist/services/payments.js +0 -794
- package/dist/services/payments.js.map +0 -1
- package/dist/services/payments.mjs +0 -793
- package/dist/services/payments.mjs.map +0 -1
- package/dist/services/shipping.d.mts +0 -424
- package/dist/services/shipping.d.ts +0 -424
- package/dist/services/shipping.js.map +0 -1
- package/dist/services/shipping.mjs.map +0 -1
- package/dist/services/tokens.d.mts +0 -191
- package/dist/services/tokens.d.ts +0 -191
- package/dist/services/tokens.js +0 -167
- package/dist/services/tokens.js.map +0 -1
- package/dist/services/tokens.mjs +0 -166
- package/dist/services/tokens.mjs.map +0 -1
|
@@ -1,33 +1,190 @@
|
|
|
1
1
|
import { Client } from '../client.mjs';
|
|
2
2
|
import { Models } from '../models.mjs';
|
|
3
|
-
import {
|
|
3
|
+
import { ResourceType } from '../enums/resource-type.mjs';
|
|
4
|
+
import { Scope } from '../enums/scope.mjs';
|
|
5
|
+
import { Reason } from '../enums/reason.mjs';
|
|
6
|
+
import { MessageClass } from '../enums/message-class.mjs';
|
|
7
|
+
import { WhatsappCategory } from '../enums/whatsapp-category.mjs';
|
|
4
8
|
import '../query.mjs';
|
|
5
|
-
import '../enums/address-type.mjs';
|
|
9
|
+
import '../enums/address-type-row-tone.mjs';
|
|
10
|
+
import '../enums/address-type-row-create-request-tone.mjs';
|
|
11
|
+
import '../enums/address-type-row-update-request-tone.mjs';
|
|
12
|
+
import '../enums/assets-source.mjs';
|
|
13
|
+
import '../enums/attribute-value-bucket.mjs';
|
|
14
|
+
import '../enums/auth-mail-source.mjs';
|
|
15
|
+
import '../enums/recovery-mail-source.mjs';
|
|
16
|
+
import '../enums/registration-status.mjs';
|
|
17
|
+
import '../enums/budget-change-reason.mjs';
|
|
18
|
+
import '../enums/budget-movement-result-status.mjs';
|
|
19
|
+
import '../enums/cart-status.mjs';
|
|
20
|
+
import '../enums/cart-merge-strategy.mjs';
|
|
21
|
+
import '../enums/cart-price-snapshot-mode.mjs';
|
|
22
|
+
import '../enums/cart-io-format.mjs';
|
|
6
23
|
import '../enums/cart-export-format.mjs';
|
|
7
24
|
import '../enums/cart-item-type.mjs';
|
|
25
|
+
import '../enums/cart-vocabulary-tone.mjs';
|
|
26
|
+
import '../enums/cart-vocabulary-name.mjs';
|
|
27
|
+
import '../enums/cart-vocabulary-source.mjs';
|
|
28
|
+
import '../enums/cart-vocabulary-ref-name.mjs';
|
|
29
|
+
import '../enums/categories-rule-match.mjs';
|
|
30
|
+
import '../enums/category-rule-operator.mjs';
|
|
31
|
+
import '../enums/category-rule-match.mjs';
|
|
8
32
|
import '../enums/channel-status.mjs';
|
|
9
|
-
import '../enums/channel-
|
|
10
|
-
import '../enums/
|
|
33
|
+
import '../enums/channel-unassigned-visibility.mjs';
|
|
34
|
+
import '../enums/channel-unresolved-reason.mjs';
|
|
35
|
+
import '../enums/channel-context-source.mjs';
|
|
36
|
+
import '../enums/channel-inactive-behavior.mjs';
|
|
37
|
+
import '../enums/channel-policy-source.mjs';
|
|
38
|
+
import '../enums/channel-policy-tenant-default.mjs';
|
|
39
|
+
import '../enums/channel-unassigned-policy.mjs';
|
|
40
|
+
import '../enums/channel-type-tone.mjs';
|
|
41
|
+
import '../enums/channel-visibility-reason.mjs';
|
|
42
|
+
import '../enums/channel-vocabulary-tone.mjs';
|
|
43
|
+
import '../enums/channel-vocabulary-name.mjs';
|
|
44
|
+
import '../enums/channel-vocabulary-source.mjs';
|
|
45
|
+
import '../enums/channel-vocabulary-ref-name.mjs';
|
|
46
|
+
import '../enums/contact-registration-status.mjs';
|
|
11
47
|
import '../enums/contact-status.mjs';
|
|
48
|
+
import '../enums/contact-activity-kind.mjs';
|
|
49
|
+
import '../enums/contact-create-request-registration-status.mjs';
|
|
50
|
+
import '../enums/contact-event-kind-tone.mjs';
|
|
51
|
+
import '../enums/contact-event-kind-create-request-tone.mjs';
|
|
52
|
+
import '../enums/contact-event-kind-update-request-tone.mjs';
|
|
53
|
+
import '../enums/contact-update-request-registration-status.mjs';
|
|
54
|
+
import '../enums/cost-center-budget-type.mjs';
|
|
55
|
+
import '../enums/cost-center-restriction-type.mjs';
|
|
56
|
+
import '../enums/cost-center-restriction-create-request-type.mjs';
|
|
57
|
+
import '../enums/cost-center-restriction-update-request-type.mjs';
|
|
58
|
+
import '../enums/payment-fee-type.mjs';
|
|
59
|
+
import '../enums/payment-method-kind.mjs';
|
|
60
|
+
import '../enums/form-status.mjs';
|
|
61
|
+
import '../enums/form-submission-status.mjs';
|
|
62
|
+
import '../enums/form-notify-source.mjs';
|
|
63
|
+
import '../enums/form-submission-prune-request-status.mjs';
|
|
64
|
+
import '../enums/forms-vocabulary-tone.mjs';
|
|
65
|
+
import '../enums/forms-vocabulary-name.mjs';
|
|
66
|
+
import '../enums/forms-vocabulary-summary-name.mjs';
|
|
67
|
+
import '../enums/inventory-vocabulary-default-tone.mjs';
|
|
68
|
+
import '../enums/inventory-vocabulary-source.mjs';
|
|
12
69
|
import '../enums/cart-io-apply-mode.mjs';
|
|
13
70
|
import '../enums/cart-io-direction.mjs';
|
|
14
71
|
import '../enums/cart-io-entity.mjs';
|
|
15
|
-
import '../enums/
|
|
72
|
+
import '../enums/io-profile-resource-apply-mode.mjs';
|
|
73
|
+
import '../enums/io-profile-resource-direction.mjs';
|
|
74
|
+
import '../enums/lifecycle-stage-tone.mjs';
|
|
75
|
+
import '../enums/lifecycle-stage-create-request-tone.mjs';
|
|
76
|
+
import '../enums/lifecycle-stage-update-request-tone.mjs';
|
|
16
77
|
import '../enums/location-type.mjs';
|
|
17
78
|
import '../enums/market-status.mjs';
|
|
79
|
+
import '../enums/market-default-locale-source.mjs';
|
|
80
|
+
import '../enums/market-locale-fallback.mjs';
|
|
81
|
+
import '../enums/market-locale-granularity.mjs';
|
|
82
|
+
import '../enums/market-pricing-source.mjs';
|
|
83
|
+
import '../enums/market-tax-basis.mjs';
|
|
84
|
+
import '../enums/market-readiness-check-id.mjs';
|
|
85
|
+
import '../enums/market-readiness-severity.mjs';
|
|
86
|
+
import '../enums/markets-vocabulary-tone.mjs';
|
|
87
|
+
import '../enums/markets-vocabulary-name.mjs';
|
|
88
|
+
import '../enums/markets-vocabulary-source.mjs';
|
|
89
|
+
import '../enums/markets-vocabulary-summary-name.mjs';
|
|
90
|
+
import '../enums/order-fulfillment-status.mjs';
|
|
91
|
+
import '../enums/order-payment-status.mjs';
|
|
92
|
+
import '../enums/order-status.mjs';
|
|
93
|
+
import '../enums/order-cancellation-scope.mjs';
|
|
18
94
|
import '../enums/order-comment-visibility.mjs';
|
|
19
95
|
import '../enums/order-item-type.mjs';
|
|
20
|
-
import '../enums/order-list-kind.mjs';
|
|
21
|
-
import '../enums/order-
|
|
96
|
+
import '../enums/order-list-kind-tone.mjs';
|
|
97
|
+
import '../enums/order-list-kind-row-tone.mjs';
|
|
98
|
+
import '../enums/order-list-cart-mode.mjs';
|
|
99
|
+
import '../enums/order-list-vocabulary-default-tone.mjs';
|
|
100
|
+
import '../enums/order-list-vocabulary-name.mjs';
|
|
101
|
+
import '../enums/order-list-vocabulary-source.mjs';
|
|
102
|
+
import '../enums/order-list-vocabulary-tone.mjs';
|
|
103
|
+
import '../enums/order-return-status.mjs';
|
|
104
|
+
import '../enums/order-return-settlement.mjs';
|
|
105
|
+
import '../enums/order-return-refusal.mjs';
|
|
106
|
+
import '../enums/order-vocabulary-tone.mjs';
|
|
107
|
+
import '../enums/order-vocabulary-name.mjs';
|
|
108
|
+
import '../enums/order-vocabulary-source.mjs';
|
|
109
|
+
import '../enums/order-vocabulary-summary-name.mjs';
|
|
110
|
+
import '../enums/order-resolution-stage.mjs';
|
|
22
111
|
import '../enums/organization-status.mjs';
|
|
23
112
|
import '../enums/page-status.mjs';
|
|
24
|
-
import '../enums/
|
|
25
|
-
import '../enums/
|
|
113
|
+
import '../enums/pages-vocabulary-app.mjs';
|
|
114
|
+
import '../enums/pages-vocabulary-tone.mjs';
|
|
115
|
+
import '../enums/pages-vocabulary-name.mjs';
|
|
116
|
+
import '../enums/pages-vocabulary-source.mjs';
|
|
117
|
+
import '../enums/pages-vocabulary-index-app.mjs';
|
|
118
|
+
import '../enums/payment-dunning-stage.mjs';
|
|
119
|
+
import '../enums/payment-failure-code.mjs';
|
|
120
|
+
import '../enums/payment-status.mjs';
|
|
121
|
+
import '../enums/payment-term-tone.mjs';
|
|
122
|
+
import '../enums/payment-term-create-request-tone.mjs';
|
|
123
|
+
import '../enums/payment-term-update-request-tone.mjs';
|
|
124
|
+
import '../enums/payment-vocabulary-tone.mjs';
|
|
125
|
+
import '../enums/price-ending-rule.mjs';
|
|
126
|
+
import '../enums/price-entries-adjust-response-rounding.mjs';
|
|
127
|
+
import '../enums/price-entries-adjust-response-rounding-mode.mjs';
|
|
128
|
+
import '../enums/price-entries-bulk-mode.mjs';
|
|
129
|
+
import '../enums/price-rounding-mode.mjs';
|
|
26
130
|
import '../enums/price-entry-type.mjs';
|
|
27
131
|
import '../enums/price-list-status.mjs';
|
|
132
|
+
import '../enums/price-list-tax-basis.mjs';
|
|
133
|
+
import '../enums/price-currency-source.mjs';
|
|
134
|
+
import '../enums/price-list-tiebreak.mjs';
|
|
135
|
+
import '../enums/price-tax-inclusive-default.mjs';
|
|
136
|
+
import '../enums/price-tax-unresolved-reason.mjs';
|
|
137
|
+
import '../enums/price-tax-market-source.mjs';
|
|
138
|
+
import '../enums/price-vocabulary-tone.mjs';
|
|
139
|
+
import '../enums/price-vocabulary-name.mjs';
|
|
140
|
+
import '../enums/price-vocabulary-source.mjs';
|
|
141
|
+
import '../enums/price-vocabulary-ref-name.mjs';
|
|
142
|
+
import '../enums/product-categories-source.mjs';
|
|
143
|
+
import '../enums/product-grid-column-source.mjs';
|
|
144
|
+
import '../enums/product-label-source.mjs';
|
|
145
|
+
import '../enums/product-label-attribute-source.mjs';
|
|
146
|
+
import '../enums/products-kind.mjs';
|
|
147
|
+
import '../enums/reorder-point-source.mjs';
|
|
148
|
+
import '../enums/reservation-status.mjs';
|
|
149
|
+
import '../enums/price-on-request-reason.mjs';
|
|
150
|
+
import '../enums/price-tax-basis.mjs';
|
|
151
|
+
import '../enums/price-tax-basis-source.mjs';
|
|
152
|
+
import '../enums/role-catalog-response-source.mjs';
|
|
153
|
+
import '../enums/segment-rule-match.mjs';
|
|
154
|
+
import '../enums/segment-member-source.mjs';
|
|
155
|
+
import '../enums/segment-rule-operator.mjs';
|
|
156
|
+
import '../enums/segment-rule-preview-request-rule-match.mjs';
|
|
157
|
+
import '../enums/segment-rule-preview-request-target.mjs';
|
|
158
|
+
import '../enums/segment-rule-preview-response-rule-match.mjs';
|
|
159
|
+
import '../enums/segment-rule-preview-response-target.mjs';
|
|
160
|
+
import '../enums/segment-rules-target.mjs';
|
|
161
|
+
import '../enums/shipping-carrier-status.mjs';
|
|
28
162
|
import '../enums/shipping-method-matrix-basis.mjs';
|
|
29
163
|
import '../enums/shipping-method-pricing-type.mjs';
|
|
164
|
+
import '../enums/shipping-carrier-source.mjs';
|
|
165
|
+
import '../enums/shipping-rate-pricing-type.mjs';
|
|
166
|
+
import '../enums/shipping-tax-source.mjs';
|
|
167
|
+
import '../enums/shipping-free-above-basis.mjs';
|
|
168
|
+
import '../enums/shipping-rates-basis-matrix-basis-default.mjs';
|
|
169
|
+
import '../enums/shipping-service-level-create-request-tone.mjs';
|
|
170
|
+
import '../enums/shipping-service-level-row-tone.mjs';
|
|
171
|
+
import '../enums/shipping-service-level-update-request-tone.mjs';
|
|
172
|
+
import '../enums/shipping-tax-unresolved-reason.mjs';
|
|
173
|
+
import '../enums/shipping-tax-market-source.mjs';
|
|
174
|
+
import '../enums/shipping-tax-context-via.mjs';
|
|
175
|
+
import '../enums/shipping-tracking-carrier-status.mjs';
|
|
176
|
+
import '../enums/shipping-vocabulary-default-tone.mjs';
|
|
177
|
+
import '../enums/shipping-vocabulary-source.mjs';
|
|
178
|
+
import '../enums/shipping-vocabulary-tone.mjs';
|
|
179
|
+
import '../enums/shipping-weight-unit-create-request-tone.mjs';
|
|
180
|
+
import '../enums/shipping-weight-unit-row-tone.mjs';
|
|
181
|
+
import '../enums/shipping-weight-unit-update-request-tone.mjs';
|
|
182
|
+
import '../enums/stock-movement-type.mjs';
|
|
30
183
|
import '../enums/store-asset-request-visibility.mjs';
|
|
184
|
+
import '../enums/validation-failed-response-status.mjs';
|
|
185
|
+
import '../enums/vocabulary-default-tone.mjs';
|
|
186
|
+
import '../enums/vocabulary-source.mjs';
|
|
187
|
+
import '../enums/vocabulary-tone.mjs';
|
|
31
188
|
import '../enums/attribute-boolean-status.mjs';
|
|
32
189
|
import '../enums/attribute-datetime-status.mjs';
|
|
33
190
|
import '../enums/attribute-email-status.mjs';
|
|
@@ -69,1328 +226,2237 @@ import '../enums/execution-trigger.mjs';
|
|
|
69
226
|
import '../enums/health-antivirus-status.mjs';
|
|
70
227
|
import '../enums/health-status-status.mjs';
|
|
71
228
|
import '../enums/index-status.mjs';
|
|
72
|
-
import '../enums/message-status.mjs';
|
|
229
|
+
import '../enums/message-2-status.mjs';
|
|
73
230
|
|
|
74
231
|
declare class Messaging {
|
|
75
232
|
client: Client;
|
|
76
233
|
constructor(client: Client);
|
|
77
234
|
/**
|
|
78
|
-
*
|
|
235
|
+
* Filterable by `resource_type`, `resource_id` and `subject` — the last one
|
|
236
|
+
* being the human-readable name a row was recorded under (a template's key,
|
|
237
|
+
* a layout's name), which is what an operator has to hand six weeks later
|
|
238
|
+
* when the id means nothing to them.
|
|
79
239
|
*
|
|
80
|
-
*
|
|
81
|
-
*
|
|
82
|
-
* @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
83
|
-
* @throws {RevenexxAPIRevenexxException}
|
|
84
|
-
* @returns {Promise<Models.MessageList>}
|
|
85
|
-
*/
|
|
86
|
-
messagingListMessages(params?: {
|
|
87
|
-
queries?: string[];
|
|
88
|
-
search?: string;
|
|
89
|
-
total?: boolean;
|
|
90
|
-
}): Promise<Models.MessageList>;
|
|
91
|
-
/**
|
|
92
|
-
* Get a list of all messages from the current Revenexx project.
|
|
240
|
+
* There is no write route and no delete route: an append-only log with an
|
|
241
|
+
* editor is a log that says whatever the last editor wanted.
|
|
93
242
|
*
|
|
94
|
-
* @param {
|
|
95
|
-
* @param {string}
|
|
96
|
-
* @param {
|
|
97
|
-
* @
|
|
98
|
-
* @
|
|
99
|
-
* @
|
|
243
|
+
* @param {ResourceType} params.resourceType -
|
|
244
|
+
* @param {string} params.resourceId -
|
|
245
|
+
* @param {string} params.subject -
|
|
246
|
+
* @param {number} params.limit -
|
|
247
|
+
* @throws {RevenexxException}
|
|
248
|
+
* @returns {Promise<Models.Error>}
|
|
100
249
|
*/
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
*
|
|
105
|
-
* @param {string} params.content - Email Content.
|
|
106
|
-
* @param {string} params.messageId - Message ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
|
|
107
|
-
* @param {string} params.subject - Email Subject.
|
|
108
|
-
* @param {string[]} params.attachments - Array of compound ID strings of bucket IDs and file IDs to be attached to the email. They should be formatted as <BUCKET_ID>:<FILE_ID>.
|
|
109
|
-
* @param {string[]} params.bcc - Array of target IDs to be added as BCC.
|
|
110
|
-
* @param {string[]} params.cc - Array of target IDs to be added as CC.
|
|
111
|
-
* @param {boolean} params.draft - Is message a draft
|
|
112
|
-
* @param {boolean} params.html - Is content of type HTML
|
|
113
|
-
* @param {string} params.scheduledAt - Scheduled delivery time for message in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. DateTime value must be in future.
|
|
114
|
-
* @param {string[]} params.targets - List of Targets IDs.
|
|
115
|
-
* @param {string[]} params.topics - List of Topic IDs.
|
|
116
|
-
* @param {string[]} params.users - List of User IDs.
|
|
117
|
-
* @throws {RevenexxAPIRevenexxException}
|
|
118
|
-
* @returns {Promise<Models.Message>}
|
|
119
|
-
*/
|
|
120
|
-
messagingCreateEmail(params: {
|
|
121
|
-
content: string;
|
|
122
|
-
messageId: string;
|
|
123
|
-
subject: string;
|
|
124
|
-
attachments?: string[];
|
|
125
|
-
bcc?: string[];
|
|
126
|
-
cc?: string[];
|
|
127
|
-
draft?: boolean;
|
|
128
|
-
html?: boolean;
|
|
129
|
-
scheduledAt?: string;
|
|
130
|
-
targets?: string[];
|
|
131
|
-
topics?: string[];
|
|
132
|
-
users?: string[];
|
|
133
|
-
}): Promise<Models.Message>;
|
|
134
|
-
/**
|
|
135
|
-
* Create a new email message.
|
|
136
|
-
*
|
|
137
|
-
* @param {string} content - Email Content.
|
|
138
|
-
* @param {string} messageId - Message ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
|
|
139
|
-
* @param {string} subject - Email Subject.
|
|
140
|
-
* @param {string[]} attachments - Array of compound ID strings of bucket IDs and file IDs to be attached to the email. They should be formatted as <BUCKET_ID>:<FILE_ID>.
|
|
141
|
-
* @param {string[]} bcc - Array of target IDs to be added as BCC.
|
|
142
|
-
* @param {string[]} cc - Array of target IDs to be added as CC.
|
|
143
|
-
* @param {boolean} draft - Is message a draft
|
|
144
|
-
* @param {boolean} html - Is content of type HTML
|
|
145
|
-
* @param {string} scheduledAt - Scheduled delivery time for message in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. DateTime value must be in future.
|
|
146
|
-
* @param {string[]} targets - List of Targets IDs.
|
|
147
|
-
* @param {string[]} topics - List of Topic IDs.
|
|
148
|
-
* @param {string[]} users - List of User IDs.
|
|
149
|
-
* @throws {RevenexxAPIRevenexxException}
|
|
150
|
-
* @returns {Promise<Models.Message>}
|
|
151
|
-
* @deprecated Use the object parameter style method for a better developer experience.
|
|
152
|
-
*/
|
|
153
|
-
messagingCreateEmail(content: string, messageId: string, subject: string, attachments?: string[], bcc?: string[], cc?: string[], draft?: boolean, html?: boolean, scheduledAt?: string, targets?: string[], topics?: string[], users?: string[]): Promise<Models.Message>;
|
|
154
|
-
/**
|
|
155
|
-
* Update an email message by its unique ID. This endpoint only works on messages that are in draft status. Messages that are already processing, sent, or failed cannot be updated.
|
|
156
|
-
*
|
|
157
|
-
*
|
|
158
|
-
* @param {string} params.messageId - Message ID.
|
|
159
|
-
* @param {string[]} params.attachments - Array of compound ID strings of bucket IDs and file IDs to be attached to the email. They should be formatted as <BUCKET_ID>:<FILE_ID>.
|
|
160
|
-
* @param {string[]} params.bcc - Array of target IDs to be added as BCC.
|
|
161
|
-
* @param {string[]} params.cc - Array of target IDs to be added as CC.
|
|
162
|
-
* @param {string} params.content - Email Content.
|
|
163
|
-
* @param {boolean} params.draft - Is message a draft
|
|
164
|
-
* @param {boolean} params.html - Is content of type HTML
|
|
165
|
-
* @param {string} params.scheduledAt - Scheduled delivery time for message in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. DateTime value must be in future.
|
|
166
|
-
* @param {string} params.subject - Email Subject.
|
|
167
|
-
* @param {string[]} params.targets - List of Targets IDs.
|
|
168
|
-
* @param {string[]} params.topics - List of Topic IDs.
|
|
169
|
-
* @param {string[]} params.users - List of User IDs.
|
|
170
|
-
* @throws {RevenexxAPIRevenexxException}
|
|
171
|
-
* @returns {Promise<Models.Message>}
|
|
172
|
-
*/
|
|
173
|
-
messagingUpdateEmail(params: {
|
|
174
|
-
messageId: string;
|
|
175
|
-
attachments?: string[];
|
|
176
|
-
bcc?: string[];
|
|
177
|
-
cc?: string[];
|
|
178
|
-
content?: string;
|
|
179
|
-
draft?: boolean;
|
|
180
|
-
html?: boolean;
|
|
181
|
-
scheduledAt?: string;
|
|
250
|
+
auditIndex(params?: {
|
|
251
|
+
resourceType?: ResourceType;
|
|
252
|
+
resourceId?: string;
|
|
182
253
|
subject?: string;
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
*
|
|
189
|
-
*
|
|
190
|
-
*
|
|
191
|
-
*
|
|
192
|
-
*
|
|
193
|
-
*
|
|
194
|
-
* @param {
|
|
195
|
-
* @param {string}
|
|
196
|
-
* @param {
|
|
197
|
-
* @param {
|
|
198
|
-
* @
|
|
199
|
-
* @
|
|
200
|
-
* @param {string[]} targets - List of Targets IDs.
|
|
201
|
-
* @param {string[]} topics - List of Topic IDs.
|
|
202
|
-
* @param {string[]} users - List of User IDs.
|
|
203
|
-
* @throws {RevenexxAPIRevenexxException}
|
|
204
|
-
* @returns {Promise<Models.Message>}
|
|
205
|
-
* @deprecated Use the object parameter style method for a better developer experience.
|
|
206
|
-
*/
|
|
207
|
-
messagingUpdateEmail(messageId: string, attachments?: string[], bcc?: string[], cc?: string[], content?: string, draft?: boolean, html?: boolean, scheduledAt?: string, subject?: string, targets?: string[], topics?: string[], users?: string[]): Promise<Models.Message>;
|
|
208
|
-
/**
|
|
209
|
-
* Create a new push notification.
|
|
210
|
-
*
|
|
211
|
-
* @param {string} params.messageId - Message ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
|
|
212
|
-
* @param {string} params.action - Action for push notification.
|
|
213
|
-
* @param {number} params.badge - Badge for push notification. Available only for iOS Platform.
|
|
214
|
-
* @param {string} params.body - Body for push notification.
|
|
215
|
-
* @param {string} params.color - Color for push notification. Available only for Android Platform.
|
|
216
|
-
* @param {boolean} params.contentAvailable - If set to true, the notification will be delivered in the background. Available only for iOS Platform.
|
|
217
|
-
* @param {boolean} params.critical - If set to true, the notification will be marked as critical. This requires the app to have the critical notification entitlement. Available only for iOS Platform.
|
|
218
|
-
* @param {object} params.data - Additional key-value pair data for push notification.
|
|
219
|
-
* @param {boolean} params.draft - Is message a draft
|
|
220
|
-
* @param {string} params.icon - Icon for push notification. Available only for Android and Web Platform.
|
|
221
|
-
* @param {string} params.image - Image for push notification. Must be a compound bucket ID to file ID of a jpeg, png, or bmp image in Appwrite Storage. It should be formatted as <BUCKET_ID>:<FILE_ID>.
|
|
222
|
-
* @param {Priority} params.priority - Set the notification priority. "normal" will consider device state and may not deliver notifications immediately. "high" will always attempt to immediately deliver the notification.
|
|
223
|
-
* @param {string} params.scheduledAt - Scheduled delivery time for message in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. DateTime value must be in future.
|
|
224
|
-
* @param {string} params.sound - Sound for push notification. Available only for Android and iOS Platform.
|
|
225
|
-
* @param {string} params.tag - Tag for push notification. Available only for Android Platform.
|
|
226
|
-
* @param {string[]} params.targets - List of Targets IDs.
|
|
227
|
-
* @param {string} params.title - Title for push notification.
|
|
228
|
-
* @param {string[]} params.topics - List of Topic IDs.
|
|
229
|
-
* @param {string[]} params.users - List of User IDs.
|
|
230
|
-
* @throws {RevenexxAPIRevenexxException}
|
|
231
|
-
* @returns {Promise<Models.Message>}
|
|
232
|
-
*/
|
|
233
|
-
messagingCreatePush(params: {
|
|
234
|
-
messageId: string;
|
|
235
|
-
action?: string;
|
|
236
|
-
badge?: number;
|
|
237
|
-
body?: string;
|
|
238
|
-
color?: string;
|
|
239
|
-
contentAvailable?: boolean;
|
|
240
|
-
critical?: boolean;
|
|
241
|
-
data?: object;
|
|
242
|
-
draft?: boolean;
|
|
243
|
-
icon?: string;
|
|
244
|
-
image?: string;
|
|
245
|
-
priority?: Priority;
|
|
246
|
-
scheduledAt?: string;
|
|
247
|
-
sound?: string;
|
|
248
|
-
tag?: string;
|
|
249
|
-
targets?: string[];
|
|
250
|
-
title?: string;
|
|
251
|
-
topics?: string[];
|
|
252
|
-
users?: string[];
|
|
253
|
-
}): Promise<Models.Message>;
|
|
254
|
-
/**
|
|
255
|
-
* Create a new push notification.
|
|
256
|
-
*
|
|
257
|
-
* @param {string} messageId - Message ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
|
|
258
|
-
* @param {string} action - Action for push notification.
|
|
259
|
-
* @param {number} badge - Badge for push notification. Available only for iOS Platform.
|
|
260
|
-
* @param {string} body - Body for push notification.
|
|
261
|
-
* @param {string} color - Color for push notification. Available only for Android Platform.
|
|
262
|
-
* @param {boolean} contentAvailable - If set to true, the notification will be delivered in the background. Available only for iOS Platform.
|
|
263
|
-
* @param {boolean} critical - If set to true, the notification will be marked as critical. This requires the app to have the critical notification entitlement. Available only for iOS Platform.
|
|
264
|
-
* @param {object} data - Additional key-value pair data for push notification.
|
|
265
|
-
* @param {boolean} draft - Is message a draft
|
|
266
|
-
* @param {string} icon - Icon for push notification. Available only for Android and Web Platform.
|
|
267
|
-
* @param {string} image - Image for push notification. Must be a compound bucket ID to file ID of a jpeg, png, or bmp image in Appwrite Storage. It should be formatted as <BUCKET_ID>:<FILE_ID>.
|
|
268
|
-
* @param {Priority} priority - Set the notification priority. "normal" will consider device state and may not deliver notifications immediately. "high" will always attempt to immediately deliver the notification.
|
|
269
|
-
* @param {string} scheduledAt - Scheduled delivery time for message in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. DateTime value must be in future.
|
|
270
|
-
* @param {string} sound - Sound for push notification. Available only for Android and iOS Platform.
|
|
271
|
-
* @param {string} tag - Tag for push notification. Available only for Android Platform.
|
|
272
|
-
* @param {string[]} targets - List of Targets IDs.
|
|
273
|
-
* @param {string} title - Title for push notification.
|
|
274
|
-
* @param {string[]} topics - List of Topic IDs.
|
|
275
|
-
* @param {string[]} users - List of User IDs.
|
|
276
|
-
* @throws {RevenexxAPIRevenexxException}
|
|
277
|
-
* @returns {Promise<Models.Message>}
|
|
254
|
+
limit?: number;
|
|
255
|
+
}): Promise<Models.Error>;
|
|
256
|
+
/**
|
|
257
|
+
* Filterable by `resource_type`, `resource_id` and `subject` — the last one
|
|
258
|
+
* being the human-readable name a row was recorded under (a template's key,
|
|
259
|
+
* a layout's name), which is what an operator has to hand six weeks later
|
|
260
|
+
* when the id means nothing to them.
|
|
261
|
+
*
|
|
262
|
+
* There is no write route and no delete route: an append-only log with an
|
|
263
|
+
* editor is a log that says whatever the last editor wanted.
|
|
264
|
+
*
|
|
265
|
+
* @param {ResourceType} resourceType -
|
|
266
|
+
* @param {string} resourceId -
|
|
267
|
+
* @param {string} subject -
|
|
268
|
+
* @param {number} limit -
|
|
269
|
+
* @throws {RevenexxException}
|
|
270
|
+
* @returns {Promise<Models.Error>}
|
|
278
271
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
279
272
|
*/
|
|
280
|
-
|
|
281
|
-
/**
|
|
282
|
-
* Update a push notification by its unique ID. This endpoint only works on messages that are in draft status. Messages that are already processing, sent, or failed cannot be updated.
|
|
283
|
-
*
|
|
284
|
-
*
|
|
285
|
-
* @param {string} params.messageId - Message ID.
|
|
286
|
-
* @param {string} params.action - Action for push notification.
|
|
287
|
-
* @param {number} params.badge - Badge for push notification. Available only for iOS platforms.
|
|
288
|
-
* @param {string} params.body - Body for push notification.
|
|
289
|
-
* @param {string} params.color - Color for push notification. Available only for Android platforms.
|
|
290
|
-
* @param {boolean} params.contentAvailable - If set to true, the notification will be delivered in the background. Available only for iOS Platform.
|
|
291
|
-
* @param {boolean} params.critical - If set to true, the notification will be marked as critical. This requires the app to have the critical notification entitlement. Available only for iOS Platform.
|
|
292
|
-
* @param {object} params.data - Additional Data for push notification.
|
|
293
|
-
* @param {boolean} params.draft - Is message a draft
|
|
294
|
-
* @param {string} params.icon - Icon for push notification. Available only for Android and Web platforms.
|
|
295
|
-
* @param {string} params.image - Image for push notification. Must be a compound bucket ID to file ID of a jpeg, png, or bmp image in Appwrite Storage. It should be formatted as <BUCKET_ID>:<FILE_ID>.
|
|
296
|
-
* @param {Priority} params.priority - Set the notification priority. "normal" will consider device battery state and may send notifications later. "high" will always attempt to immediately deliver the notification.
|
|
297
|
-
* @param {string} params.scheduledAt - Scheduled delivery time for message in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. DateTime value must be in future.
|
|
298
|
-
* @param {string} params.sound - Sound for push notification. Available only for Android and iOS platforms.
|
|
299
|
-
* @param {string} params.tag - Tag for push notification. Available only for Android platforms.
|
|
300
|
-
* @param {string[]} params.targets - List of Targets IDs.
|
|
301
|
-
* @param {string} params.title - Title for push notification.
|
|
302
|
-
* @param {string[]} params.topics - List of Topic IDs.
|
|
303
|
-
* @param {string[]} params.users - List of User IDs.
|
|
304
|
-
* @throws {RevenexxAPIRevenexxException}
|
|
305
|
-
* @returns {Promise<Models.Message>}
|
|
306
|
-
*/
|
|
307
|
-
messagingUpdatePush(params: {
|
|
308
|
-
messageId: string;
|
|
309
|
-
action?: string;
|
|
310
|
-
badge?: number;
|
|
311
|
-
body?: string;
|
|
312
|
-
color?: string;
|
|
313
|
-
contentAvailable?: boolean;
|
|
314
|
-
critical?: boolean;
|
|
315
|
-
data?: object;
|
|
316
|
-
draft?: boolean;
|
|
317
|
-
icon?: string;
|
|
318
|
-
image?: string;
|
|
319
|
-
priority?: Priority;
|
|
320
|
-
scheduledAt?: string;
|
|
321
|
-
sound?: string;
|
|
322
|
-
tag?: string;
|
|
323
|
-
targets?: string[];
|
|
324
|
-
title?: string;
|
|
325
|
-
topics?: string[];
|
|
326
|
-
users?: string[];
|
|
327
|
-
}): Promise<Models.Message>;
|
|
328
|
-
/**
|
|
329
|
-
* Update a push notification by its unique ID. This endpoint only works on messages that are in draft status. Messages that are already processing, sent, or failed cannot be updated.
|
|
330
|
-
*
|
|
331
|
-
*
|
|
332
|
-
* @param {string} messageId - Message ID.
|
|
333
|
-
* @param {string} action - Action for push notification.
|
|
334
|
-
* @param {number} badge - Badge for push notification. Available only for iOS platforms.
|
|
335
|
-
* @param {string} body - Body for push notification.
|
|
336
|
-
* @param {string} color - Color for push notification. Available only for Android platforms.
|
|
337
|
-
* @param {boolean} contentAvailable - If set to true, the notification will be delivered in the background. Available only for iOS Platform.
|
|
338
|
-
* @param {boolean} critical - If set to true, the notification will be marked as critical. This requires the app to have the critical notification entitlement. Available only for iOS Platform.
|
|
339
|
-
* @param {object} data - Additional Data for push notification.
|
|
340
|
-
* @param {boolean} draft - Is message a draft
|
|
341
|
-
* @param {string} icon - Icon for push notification. Available only for Android and Web platforms.
|
|
342
|
-
* @param {string} image - Image for push notification. Must be a compound bucket ID to file ID of a jpeg, png, or bmp image in Appwrite Storage. It should be formatted as <BUCKET_ID>:<FILE_ID>.
|
|
343
|
-
* @param {Priority} priority - Set the notification priority. "normal" will consider device battery state and may send notifications later. "high" will always attempt to immediately deliver the notification.
|
|
344
|
-
* @param {string} scheduledAt - Scheduled delivery time for message in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. DateTime value must be in future.
|
|
345
|
-
* @param {string} sound - Sound for push notification. Available only for Android and iOS platforms.
|
|
346
|
-
* @param {string} tag - Tag for push notification. Available only for Android platforms.
|
|
347
|
-
* @param {string[]} targets - List of Targets IDs.
|
|
348
|
-
* @param {string} title - Title for push notification.
|
|
349
|
-
* @param {string[]} topics - List of Topic IDs.
|
|
350
|
-
* @param {string[]} users - List of User IDs.
|
|
351
|
-
* @throws {RevenexxAPIRevenexxException}
|
|
352
|
-
* @returns {Promise<Models.Message>}
|
|
353
|
-
* @deprecated Use the object parameter style method for a better developer experience.
|
|
354
|
-
*/
|
|
355
|
-
messagingUpdatePush(messageId: string, action?: string, badge?: number, body?: string, color?: string, contentAvailable?: boolean, critical?: boolean, data?: object, draft?: boolean, icon?: string, image?: string, priority?: Priority, scheduledAt?: string, sound?: string, tag?: string, targets?: string[], title?: string, topics?: string[], users?: string[]): Promise<Models.Message>;
|
|
356
|
-
/**
|
|
357
|
-
* Delete a message. If the message is not a draft or scheduled, but has been sent, this will not recall the message.
|
|
358
|
-
*
|
|
359
|
-
* @param {string} params.messageId - Message ID.
|
|
360
|
-
* @throws {RevenexxAPIRevenexxException}
|
|
361
|
-
* @returns {Promise<{}>}
|
|
362
|
-
*/
|
|
363
|
-
messagingDelete(params: {
|
|
364
|
-
messageId: string;
|
|
365
|
-
}): Promise<{}>;
|
|
366
|
-
/**
|
|
367
|
-
* Delete a message. If the message is not a draft or scheduled, but has been sent, this will not recall the message.
|
|
368
|
-
*
|
|
369
|
-
* @param {string} messageId - Message ID.
|
|
370
|
-
* @throws {RevenexxAPIRevenexxException}
|
|
371
|
-
* @returns {Promise<{}>}
|
|
372
|
-
* @deprecated Use the object parameter style method for a better developer experience.
|
|
373
|
-
*/
|
|
374
|
-
messagingDelete(messageId: string): Promise<{}>;
|
|
273
|
+
auditIndex(resourceType?: ResourceType, resourceId?: string, subject?: string, limit?: number): Promise<Models.Error>;
|
|
375
274
|
/**
|
|
376
|
-
*
|
|
377
|
-
*
|
|
275
|
+
* `?event_topic=` narrows to one topic, which is the question worth asking
|
|
276
|
+
* of this list: "what does this event actually do".
|
|
378
277
|
*
|
|
379
|
-
* @param {string} params.
|
|
380
|
-
* @throws {
|
|
381
|
-
* @returns {Promise<Models.
|
|
278
|
+
* @param {string} params.eventTopic -
|
|
279
|
+
* @throws {RevenexxException}
|
|
280
|
+
* @returns {Promise<Models.Error>}
|
|
382
281
|
*/
|
|
383
|
-
|
|
384
|
-
|
|
385
|
-
}): Promise<Models.
|
|
282
|
+
bindingIndex(params?: {
|
|
283
|
+
eventTopic?: string;
|
|
284
|
+
}): Promise<Models.Error>;
|
|
386
285
|
/**
|
|
387
|
-
*
|
|
388
|
-
*
|
|
286
|
+
* `?event_topic=` narrows to one topic, which is the question worth asking
|
|
287
|
+
* of this list: "what does this event actually do".
|
|
389
288
|
*
|
|
390
|
-
* @param {string}
|
|
391
|
-
* @throws {
|
|
392
|
-
* @returns {Promise<Models.
|
|
289
|
+
* @param {string} eventTopic -
|
|
290
|
+
* @throws {RevenexxException}
|
|
291
|
+
* @returns {Promise<Models.Error>}
|
|
393
292
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
394
293
|
*/
|
|
395
|
-
|
|
396
|
-
/**
|
|
397
|
-
*
|
|
398
|
-
*
|
|
399
|
-
*
|
|
400
|
-
*
|
|
401
|
-
*
|
|
402
|
-
*
|
|
403
|
-
*
|
|
404
|
-
|
|
405
|
-
|
|
406
|
-
|
|
407
|
-
|
|
408
|
-
|
|
409
|
-
|
|
410
|
-
|
|
411
|
-
*
|
|
412
|
-
*
|
|
413
|
-
|
|
414
|
-
|
|
415
|
-
|
|
416
|
-
* @throws {
|
|
417
|
-
* @returns {Promise<Models.
|
|
294
|
+
bindingIndex(eventTopic?: string): Promise<Models.Error>;
|
|
295
|
+
/**
|
|
296
|
+
* `recipient` is a template, not an address: `{{ customer.email }}` is
|
|
297
|
+
* rendered against the event payload when the event arrives, which is the
|
|
298
|
+
* only way one binding can serve every customer. An event that renders it
|
|
299
|
+
* empty is skipped and logged rather than sent to nobody.
|
|
300
|
+
*
|
|
301
|
+
* `locale` is what the OPERATOR said this route speaks, and it outranks the
|
|
302
|
+
* tenant's default. Leave it null when nobody has made that decision, so
|
|
303
|
+
* that the recipient's own language is still allowed to decide.
|
|
304
|
+
*
|
|
305
|
+
* @param {string} params.channel -
|
|
306
|
+
* @param {string} params.eventTopic -
|
|
307
|
+
* @param {string} params.recipient -
|
|
308
|
+
* @param {string} params.templateKey -
|
|
309
|
+
* @param {boolean} params.enabled -
|
|
310
|
+
* @param {number} params.fallbackOrder -
|
|
311
|
+
* @param {string} params.locale - Nullable: a binding's locale is what the OPERATOR said this
|
|
312
|
+
route speaks, and it outranks the tenant's own default
|
|
313
|
+
(LocaleResolver). "No opinion" has to be expressible, or a route
|
|
314
|
+
nobody made a language decision about silently makes one.
|
|
315
|
+
* @throws {RevenexxException}
|
|
316
|
+
* @returns {Promise<Models.Error>}
|
|
317
|
+
*/
|
|
318
|
+
bindingStore(params: {
|
|
319
|
+
channel: string;
|
|
320
|
+
eventTopic: string;
|
|
321
|
+
recipient: string;
|
|
322
|
+
templateKey: string;
|
|
323
|
+
enabled?: boolean;
|
|
324
|
+
fallbackOrder?: number;
|
|
325
|
+
locale?: string;
|
|
326
|
+
}): Promise<Models.Error>;
|
|
327
|
+
/**
|
|
328
|
+
* `recipient` is a template, not an address: `{{ customer.email }}` is
|
|
329
|
+
* rendered against the event payload when the event arrives, which is the
|
|
330
|
+
* only way one binding can serve every customer. An event that renders it
|
|
331
|
+
* empty is skipped and logged rather than sent to nobody.
|
|
332
|
+
*
|
|
333
|
+
* `locale` is what the OPERATOR said this route speaks, and it outranks the
|
|
334
|
+
* tenant's default. Leave it null when nobody has made that decision, so
|
|
335
|
+
* that the recipient's own language is still allowed to decide.
|
|
336
|
+
*
|
|
337
|
+
* @param {string} channel -
|
|
338
|
+
* @param {string} eventTopic -
|
|
339
|
+
* @param {string} recipient -
|
|
340
|
+
* @param {string} templateKey -
|
|
341
|
+
* @param {boolean} enabled -
|
|
342
|
+
* @param {number} fallbackOrder -
|
|
343
|
+
* @param {string} locale - Nullable: a binding's locale is what the OPERATOR said this
|
|
344
|
+
route speaks, and it outranks the tenant's own default
|
|
345
|
+
(LocaleResolver). "No opinion" has to be expressible, or a route
|
|
346
|
+
nobody made a language decision about silently makes one.
|
|
347
|
+
* @throws {RevenexxException}
|
|
348
|
+
* @returns {Promise<Models.Error>}
|
|
418
349
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
419
350
|
*/
|
|
420
|
-
|
|
351
|
+
bindingStore(channel: string, eventTopic: string, recipient: string, templateKey: string, enabled?: boolean, fallbackOrder?: number, locale?: string): Promise<Models.Error>;
|
|
421
352
|
/**
|
|
422
|
-
*
|
|
353
|
+
* The event it answered goes back to doing nothing. Prefer `enabled: false`
|
|
354
|
+
* when the intent is to pause rather than to forget.
|
|
423
355
|
*
|
|
424
|
-
* @param {string} params.
|
|
425
|
-
* @
|
|
426
|
-
* @
|
|
427
|
-
* @throws {RevenexxAPIRevenexxException}
|
|
428
|
-
* @returns {Promise<Models.TargetList>}
|
|
356
|
+
* @param {string} params.id -
|
|
357
|
+
* @throws {RevenexxException}
|
|
358
|
+
* @returns {Promise<Models.Error>}
|
|
429
359
|
*/
|
|
430
|
-
|
|
431
|
-
|
|
432
|
-
|
|
433
|
-
total?: boolean;
|
|
434
|
-
}): Promise<Models.TargetList>;
|
|
360
|
+
bindingDestroy(params: {
|
|
361
|
+
id: string;
|
|
362
|
+
}): Promise<Models.Error>;
|
|
435
363
|
/**
|
|
436
|
-
*
|
|
364
|
+
* The event it answered goes back to doing nothing. Prefer `enabled: false`
|
|
365
|
+
* when the intent is to pause rather than to forget.
|
|
437
366
|
*
|
|
438
|
-
* @param {string}
|
|
439
|
-
* @
|
|
440
|
-
* @
|
|
441
|
-
* @throws {RevenexxAPIRevenexxException}
|
|
442
|
-
* @returns {Promise<Models.TargetList>}
|
|
367
|
+
* @param {string} id -
|
|
368
|
+
* @throws {RevenexxException}
|
|
369
|
+
* @returns {Promise<Models.Error>}
|
|
443
370
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
444
371
|
*/
|
|
445
|
-
|
|
372
|
+
bindingDestroy(id: string): Promise<Models.Error>;
|
|
446
373
|
/**
|
|
447
|
-
*
|
|
374
|
+
* 404 for a binding belonging to another tenant, not 403 — an id that
|
|
375
|
+
* answered differently would say whether it exists.
|
|
448
376
|
*
|
|
449
|
-
* @param {string
|
|
450
|
-
* @
|
|
451
|
-
* @
|
|
452
|
-
* @throws {RevenexxAPIRevenexxException}
|
|
453
|
-
* @returns {Promise<Models.ProviderList>}
|
|
377
|
+
* @param {string} params.id -
|
|
378
|
+
* @throws {RevenexxException}
|
|
379
|
+
* @returns {Promise<Models.Error>}
|
|
454
380
|
*/
|
|
455
|
-
|
|
456
|
-
|
|
457
|
-
|
|
458
|
-
total?: boolean;
|
|
459
|
-
}): Promise<Models.ProviderList>;
|
|
381
|
+
bindingShow(params: {
|
|
382
|
+
id: string;
|
|
383
|
+
}): Promise<Models.Error>;
|
|
460
384
|
/**
|
|
461
|
-
*
|
|
385
|
+
* 404 for a binding belonging to another tenant, not 403 — an id that
|
|
386
|
+
* answered differently would say whether it exists.
|
|
462
387
|
*
|
|
463
|
-
* @param {string
|
|
464
|
-
* @
|
|
465
|
-
* @
|
|
466
|
-
* @throws {RevenexxAPIRevenexxException}
|
|
467
|
-
* @returns {Promise<Models.ProviderList>}
|
|
388
|
+
* @param {string} id -
|
|
389
|
+
* @throws {RevenexxException}
|
|
390
|
+
* @returns {Promise<Models.Error>}
|
|
468
391
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
469
392
|
*/
|
|
470
|
-
|
|
471
|
-
/**
|
|
472
|
-
*
|
|
473
|
-
*
|
|
474
|
-
*
|
|
475
|
-
*
|
|
476
|
-
*
|
|
477
|
-
*
|
|
478
|
-
*
|
|
479
|
-
* @param {string} params.
|
|
480
|
-
* @param {string} params.
|
|
481
|
-
* @param {boolean} params.
|
|
482
|
-
* @param {string} params.
|
|
483
|
-
* @param {
|
|
484
|
-
* @
|
|
485
|
-
|
|
486
|
-
|
|
487
|
-
|
|
488
|
-
|
|
489
|
-
|
|
490
|
-
|
|
491
|
-
|
|
393
|
+
bindingShow(id: string): Promise<Models.Error>;
|
|
394
|
+
/**
|
|
395
|
+
* Every field is optional; only what is sent is written. `enabled: false`
|
|
396
|
+
* is how a binding is taken out of service without losing what it said —
|
|
397
|
+
* the alternative is deleting it and typing the payload path back in
|
|
398
|
+
* correctly from memory later.
|
|
399
|
+
*
|
|
400
|
+
* This path answers on `PUT` and `PATCH`, both routed to the same action.
|
|
401
|
+
*
|
|
402
|
+
* @param {string} params.id -
|
|
403
|
+
* @param {string} params.channel -
|
|
404
|
+
* @param {boolean} params.enabled -
|
|
405
|
+
* @param {string} params.eventTopic -
|
|
406
|
+
* @param {number} params.fallbackOrder -
|
|
407
|
+
* @param {string} params.locale - Nullable: a binding's locale is what the OPERATOR said this
|
|
408
|
+
route speaks, and it outranks the tenant's own default
|
|
409
|
+
(LocaleResolver). "No opinion" has to be expressible, or a route
|
|
410
|
+
nobody made a language decision about silently makes one.
|
|
411
|
+
* @param {string} params.recipient -
|
|
412
|
+
* @param {string} params.templateKey -
|
|
413
|
+
* @throws {RevenexxException}
|
|
414
|
+
* @returns {Promise<Models.Error>}
|
|
415
|
+
*/
|
|
416
|
+
bindingUpdatePatch(params: {
|
|
417
|
+
id: string;
|
|
418
|
+
channel?: string;
|
|
492
419
|
enabled?: boolean;
|
|
493
|
-
|
|
494
|
-
|
|
495
|
-
|
|
496
|
-
|
|
497
|
-
|
|
498
|
-
}): Promise<Models.
|
|
499
|
-
/**
|
|
500
|
-
*
|
|
501
|
-
*
|
|
502
|
-
*
|
|
503
|
-
*
|
|
504
|
-
*
|
|
505
|
-
*
|
|
506
|
-
*
|
|
507
|
-
* @param {string}
|
|
508
|
-
* @param {string}
|
|
509
|
-
* @param {boolean}
|
|
510
|
-
* @param {string}
|
|
511
|
-
* @param {
|
|
512
|
-
* @
|
|
513
|
-
|
|
420
|
+
eventTopic?: string;
|
|
421
|
+
fallbackOrder?: number;
|
|
422
|
+
locale?: string;
|
|
423
|
+
recipient?: string;
|
|
424
|
+
templateKey?: string;
|
|
425
|
+
}): Promise<Models.Error>;
|
|
426
|
+
/**
|
|
427
|
+
* Every field is optional; only what is sent is written. `enabled: false`
|
|
428
|
+
* is how a binding is taken out of service without losing what it said —
|
|
429
|
+
* the alternative is deleting it and typing the payload path back in
|
|
430
|
+
* correctly from memory later.
|
|
431
|
+
*
|
|
432
|
+
* This path answers on `PUT` and `PATCH`, both routed to the same action.
|
|
433
|
+
*
|
|
434
|
+
* @param {string} id -
|
|
435
|
+
* @param {string} channel -
|
|
436
|
+
* @param {boolean} enabled -
|
|
437
|
+
* @param {string} eventTopic -
|
|
438
|
+
* @param {number} fallbackOrder -
|
|
439
|
+
* @param {string} locale - Nullable: a binding's locale is what the OPERATOR said this
|
|
440
|
+
route speaks, and it outranks the tenant's own default
|
|
441
|
+
(LocaleResolver). "No opinion" has to be expressible, or a route
|
|
442
|
+
nobody made a language decision about silently makes one.
|
|
443
|
+
* @param {string} recipient -
|
|
444
|
+
* @param {string} templateKey -
|
|
445
|
+
* @throws {RevenexxException}
|
|
446
|
+
* @returns {Promise<Models.Error>}
|
|
514
447
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
515
448
|
*/
|
|
516
|
-
|
|
517
|
-
/**
|
|
518
|
-
*
|
|
519
|
-
*
|
|
520
|
-
*
|
|
521
|
-
*
|
|
522
|
-
*
|
|
523
|
-
*
|
|
524
|
-
*
|
|
525
|
-
* @param {string} params.
|
|
526
|
-
* @param {
|
|
527
|
-
* @param {
|
|
528
|
-
* @param {string} params.
|
|
529
|
-
* @param {
|
|
530
|
-
* @
|
|
531
|
-
|
|
532
|
-
|
|
533
|
-
|
|
534
|
-
|
|
535
|
-
|
|
536
|
-
|
|
449
|
+
bindingUpdatePatch(id: string, channel?: string, enabled?: boolean, eventTopic?: string, fallbackOrder?: number, locale?: string, recipient?: string, templateKey?: string): Promise<Models.Error>;
|
|
450
|
+
/**
|
|
451
|
+
* Every field is optional; only what is sent is written. `enabled: false`
|
|
452
|
+
* is how a binding is taken out of service without losing what it said —
|
|
453
|
+
* the alternative is deleting it and typing the payload path back in
|
|
454
|
+
* correctly from memory later.
|
|
455
|
+
*
|
|
456
|
+
* This path answers on `PUT` and `PATCH`, both routed to the same action.
|
|
457
|
+
*
|
|
458
|
+
* @param {string} params.id -
|
|
459
|
+
* @param {string} params.channel -
|
|
460
|
+
* @param {boolean} params.enabled -
|
|
461
|
+
* @param {string} params.eventTopic -
|
|
462
|
+
* @param {number} params.fallbackOrder -
|
|
463
|
+
* @param {string} params.locale - Nullable: a binding's locale is what the OPERATOR said this
|
|
464
|
+
route speaks, and it outranks the tenant's own default
|
|
465
|
+
(LocaleResolver). "No opinion" has to be expressible, or a route
|
|
466
|
+
nobody made a language decision about silently makes one.
|
|
467
|
+
* @param {string} params.recipient -
|
|
468
|
+
* @param {string} params.templateKey -
|
|
469
|
+
* @throws {RevenexxException}
|
|
470
|
+
* @returns {Promise<Models.Error>}
|
|
471
|
+
*/
|
|
472
|
+
bindingUpdate(params: {
|
|
473
|
+
id: string;
|
|
474
|
+
channel?: string;
|
|
537
475
|
enabled?: boolean;
|
|
538
|
-
|
|
539
|
-
|
|
540
|
-
|
|
541
|
-
|
|
542
|
-
|
|
543
|
-
|
|
544
|
-
|
|
545
|
-
|
|
546
|
-
*
|
|
547
|
-
*
|
|
548
|
-
*
|
|
549
|
-
*
|
|
550
|
-
*
|
|
551
|
-
*
|
|
552
|
-
* @param {string}
|
|
553
|
-
* @param {string}
|
|
554
|
-
* @param {boolean}
|
|
555
|
-
* @param {string}
|
|
556
|
-
* @param {
|
|
557
|
-
* @param {string}
|
|
558
|
-
|
|
559
|
-
|
|
476
|
+
eventTopic?: string;
|
|
477
|
+
fallbackOrder?: number;
|
|
478
|
+
locale?: string;
|
|
479
|
+
recipient?: string;
|
|
480
|
+
templateKey?: string;
|
|
481
|
+
}): Promise<Models.Error>;
|
|
482
|
+
/**
|
|
483
|
+
* Every field is optional; only what is sent is written. `enabled: false`
|
|
484
|
+
* is how a binding is taken out of service without losing what it said —
|
|
485
|
+
* the alternative is deleting it and typing the payload path back in
|
|
486
|
+
* correctly from memory later.
|
|
487
|
+
*
|
|
488
|
+
* This path answers on `PUT` and `PATCH`, both routed to the same action.
|
|
489
|
+
*
|
|
490
|
+
* @param {string} id -
|
|
491
|
+
* @param {string} channel -
|
|
492
|
+
* @param {boolean} enabled -
|
|
493
|
+
* @param {string} eventTopic -
|
|
494
|
+
* @param {number} fallbackOrder -
|
|
495
|
+
* @param {string} locale - Nullable: a binding's locale is what the OPERATOR said this
|
|
496
|
+
route speaks, and it outranks the tenant's own default
|
|
497
|
+
(LocaleResolver). "No opinion" has to be expressible, or a route
|
|
498
|
+
nobody made a language decision about silently makes one.
|
|
499
|
+
* @param {string} recipient -
|
|
500
|
+
* @param {string} templateKey -
|
|
501
|
+
* @throws {RevenexxException}
|
|
502
|
+
* @returns {Promise<Models.Error>}
|
|
560
503
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
561
504
|
*/
|
|
562
|
-
|
|
505
|
+
bindingUpdate(id: string, channel?: string, enabled?: boolean, eventTopic?: string, fallbackOrder?: number, locale?: string, recipient?: string, templateKey?: string): Promise<Models.Error>;
|
|
563
506
|
/**
|
|
564
|
-
*
|
|
507
|
+
* Answers per channel with: which fields the chosen provider wants and
|
|
508
|
+
* which of them are SET (never their values — secrets go in and do not come
|
|
509
|
+
* back), which markets hold an override, which providers this build offers,
|
|
510
|
+
* whether the deployment has the channel switched on at all, the URL to
|
|
511
|
+
* paste into the provider's own console so bounces and opens come back, and
|
|
512
|
+
* whether callbacks are actually arriving.
|
|
565
513
|
*
|
|
566
|
-
*
|
|
567
|
-
*
|
|
568
|
-
*
|
|
569
|
-
*
|
|
570
|
-
*
|
|
571
|
-
* @param {string} params.
|
|
572
|
-
|
|
573
|
-
|
|
574
|
-
|
|
575
|
-
|
|
576
|
-
|
|
577
|
-
|
|
578
|
-
|
|
579
|
-
|
|
580
|
-
|
|
581
|
-
|
|
582
|
-
|
|
583
|
-
|
|
584
|
-
|
|
585
|
-
|
|
586
|
-
|
|
587
|
-
|
|
588
|
-
|
|
589
|
-
|
|
590
|
-
|
|
591
|
-
|
|
592
|
-
|
|
593
|
-
* @
|
|
514
|
+
* Admin tier on the read as well as the write: the identifiers alone —
|
|
515
|
+
* which Twilio account, which sender number — are more than a read-only
|
|
516
|
+
* operator has reason to see, and the webhook URL served here contains the
|
|
517
|
+
* tenant's callback token.
|
|
518
|
+
*
|
|
519
|
+
* @param {string} params.market - Which market's credentials this call is about. Absent means the GLOBAL bag — what every
|
|
520
|
+
send used before markets reached this path, and what a market with no override of its own
|
|
521
|
+
still uses.
|
|
522
|
+
|
|
523
|
+
Lowercase, opening with a letter, 63 characters at most (Baseline's market slug rule,
|
|
524
|
+
mirrored exactly). A code that does not match is refused with 422 rather than read as
|
|
525
|
+
"no market": on the write paths, silently falling back to global would have an operator
|
|
526
|
+
point every market's traffic at one market's provider while looking at a screen that said
|
|
527
|
+
they had not.
|
|
528
|
+
* @param {string} params.markets - Set to `all` to get every market's credentials in one answer: each channel gains an
|
|
529
|
+
`overrides` object keyed by market code, holding that market's own resolved view of the
|
|
530
|
+
channel — its provider, which of that provider's fields are set, its callback URL, and
|
|
531
|
+
whether callbacks are arriving. Only markets with credentials of their OWN appear; a market
|
|
532
|
+
that inherits has nothing to add.
|
|
533
|
+
|
|
534
|
+
The channel's top-level entry is the GLOBAL one whenever this is set, and `?market=` is
|
|
535
|
+
ignored: `all` is not a market to resolve against, and honouring both would leave the
|
|
536
|
+
base entry meaning something different depending on a header.
|
|
537
|
+
|
|
538
|
+
The override entries carry no `providers` catalogue, `enabled` flag or `markets` list.
|
|
539
|
+
Those are properties of the channel, identical in every market, and repeating
|
|
540
|
+
twenty-six providers' field specifications per market would be most of the response.
|
|
541
|
+
* @throws {RevenexxException}
|
|
542
|
+
* @returns {Promise<Models.Error>}
|
|
543
|
+
*/
|
|
544
|
+
channelCredentialIndex(params?: {
|
|
545
|
+
market?: string;
|
|
546
|
+
markets?: string;
|
|
547
|
+
}): Promise<Models.Error>;
|
|
548
|
+
/**
|
|
549
|
+
* Answers per channel with: which fields the chosen provider wants and
|
|
550
|
+
* which of them are SET (never their values — secrets go in and do not come
|
|
551
|
+
* back), which markets hold an override, which providers this build offers,
|
|
552
|
+
* whether the deployment has the channel switched on at all, the URL to
|
|
553
|
+
* paste into the provider's own console so bounces and opens come back, and
|
|
554
|
+
* whether callbacks are actually arriving.
|
|
555
|
+
*
|
|
556
|
+
* Admin tier on the read as well as the write: the identifiers alone —
|
|
557
|
+
* which Twilio account, which sender number — are more than a read-only
|
|
558
|
+
* operator has reason to see, and the webhook URL served here contains the
|
|
559
|
+
* tenant's callback token.
|
|
560
|
+
*
|
|
561
|
+
* @param {string} market - Which market's credentials this call is about. Absent means the GLOBAL bag — what every
|
|
562
|
+
send used before markets reached this path, and what a market with no override of its own
|
|
563
|
+
still uses.
|
|
564
|
+
|
|
565
|
+
Lowercase, opening with a letter, 63 characters at most (Baseline's market slug rule,
|
|
566
|
+
mirrored exactly). A code that does not match is refused with 422 rather than read as
|
|
567
|
+
"no market": on the write paths, silently falling back to global would have an operator
|
|
568
|
+
point every market's traffic at one market's provider while looking at a screen that said
|
|
569
|
+
they had not.
|
|
570
|
+
* @param {string} markets - Set to `all` to get every market's credentials in one answer: each channel gains an
|
|
571
|
+
`overrides` object keyed by market code, holding that market's own resolved view of the
|
|
572
|
+
channel — its provider, which of that provider's fields are set, its callback URL, and
|
|
573
|
+
whether callbacks are arriving. Only markets with credentials of their OWN appear; a market
|
|
574
|
+
that inherits has nothing to add.
|
|
575
|
+
|
|
576
|
+
The channel's top-level entry is the GLOBAL one whenever this is set, and `?market=` is
|
|
577
|
+
ignored: `all` is not a market to resolve against, and honouring both would leave the
|
|
578
|
+
base entry meaning something different depending on a header.
|
|
579
|
+
|
|
580
|
+
The override entries carry no `providers` catalogue, `enabled` flag or `markets` list.
|
|
581
|
+
Those are properties of the channel, identical in every market, and repeating
|
|
582
|
+
twenty-six providers' field specifications per market would be most of the response.
|
|
583
|
+
* @throws {RevenexxException}
|
|
584
|
+
* @returns {Promise<Models.Error>}
|
|
594
585
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
595
586
|
*/
|
|
596
|
-
|
|
587
|
+
channelCredentialIndex(market?: string, markets?: string): Promise<Models.Error>;
|
|
597
588
|
/**
|
|
598
|
-
*
|
|
589
|
+
* With `?market=`, only that market's override goes and the global
|
|
590
|
+
* credentials stand — the market then sends over the global provider again,
|
|
591
|
+
* which is what it did before anybody configured it. Without a market the
|
|
592
|
+
* channel goes entirely, overrides and all: a caller asking for a channel
|
|
593
|
+
* to hold no credentials means all of them.
|
|
599
594
|
*
|
|
600
|
-
*
|
|
601
|
-
*
|
|
602
|
-
*
|
|
603
|
-
* @param {string} params.
|
|
604
|
-
* @param {string} params.
|
|
605
|
-
|
|
606
|
-
|
|
607
|
-
|
|
608
|
-
|
|
609
|
-
|
|
610
|
-
|
|
611
|
-
|
|
612
|
-
|
|
613
|
-
|
|
614
|
-
|
|
615
|
-
|
|
616
|
-
|
|
617
|
-
|
|
618
|
-
|
|
619
|
-
|
|
620
|
-
|
|
621
|
-
*
|
|
622
|
-
*
|
|
623
|
-
*
|
|
624
|
-
*
|
|
625
|
-
*
|
|
626
|
-
*
|
|
627
|
-
*
|
|
595
|
+
* 204 whether or not anything was there. The caller wants this channel to
|
|
596
|
+
* hold no credentials, and it does.
|
|
597
|
+
*
|
|
598
|
+
* @param {string} params.channel -
|
|
599
|
+
* @param {string} params.market - Which market's credentials this call is about. Absent means the GLOBAL bag — what every
|
|
600
|
+
send used before markets reached this path, and what a market with no override of its own
|
|
601
|
+
still uses.
|
|
602
|
+
|
|
603
|
+
Lowercase, opening with a letter, 63 characters at most (Baseline's market slug rule,
|
|
604
|
+
mirrored exactly). A code that does not match is refused with 422 rather than read as
|
|
605
|
+
"no market": on the write paths, silently falling back to global would have an operator
|
|
606
|
+
point every market's traffic at one market's provider while looking at a screen that said
|
|
607
|
+
they had not.
|
|
608
|
+
* @throws {RevenexxException}
|
|
609
|
+
* @returns {Promise<Models.Error>}
|
|
610
|
+
*/
|
|
611
|
+
channelCredentialDestroy(params: {
|
|
612
|
+
channel: string;
|
|
613
|
+
market?: string;
|
|
614
|
+
}): Promise<Models.Error>;
|
|
615
|
+
/**
|
|
616
|
+
* With `?market=`, only that market's override goes and the global
|
|
617
|
+
* credentials stand — the market then sends over the global provider again,
|
|
618
|
+
* which is what it did before anybody configured it. Without a market the
|
|
619
|
+
* channel goes entirely, overrides and all: a caller asking for a channel
|
|
620
|
+
* to hold no credentials means all of them.
|
|
621
|
+
*
|
|
622
|
+
* 204 whether or not anything was there. The caller wants this channel to
|
|
623
|
+
* hold no credentials, and it does.
|
|
624
|
+
*
|
|
625
|
+
* @param {string} channel -
|
|
626
|
+
* @param {string} market - Which market's credentials this call is about. Absent means the GLOBAL bag — what every
|
|
627
|
+
send used before markets reached this path, and what a market with no override of its own
|
|
628
|
+
still uses.
|
|
629
|
+
|
|
630
|
+
Lowercase, opening with a letter, 63 characters at most (Baseline's market slug rule,
|
|
631
|
+
mirrored exactly). A code that does not match is refused with 422 rather than read as
|
|
632
|
+
"no market": on the write paths, silently falling back to global would have an operator
|
|
633
|
+
point every market's traffic at one market's provider while looking at a screen that said
|
|
634
|
+
they had not.
|
|
635
|
+
* @throws {RevenexxException}
|
|
636
|
+
* @returns {Promise<Models.Error>}
|
|
628
637
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
629
638
|
*/
|
|
630
|
-
|
|
631
|
-
/**
|
|
632
|
-
*
|
|
633
|
-
*
|
|
634
|
-
*
|
|
635
|
-
*
|
|
636
|
-
*
|
|
637
|
-
*
|
|
638
|
-
*
|
|
639
|
-
*
|
|
640
|
-
*
|
|
641
|
-
*
|
|
642
|
-
*
|
|
643
|
-
*
|
|
644
|
-
|
|
645
|
-
|
|
646
|
-
|
|
647
|
-
|
|
648
|
-
|
|
649
|
-
|
|
650
|
-
|
|
651
|
-
|
|
652
|
-
|
|
653
|
-
|
|
654
|
-
|
|
655
|
-
|
|
656
|
-
|
|
657
|
-
|
|
658
|
-
|
|
659
|
-
|
|
660
|
-
|
|
661
|
-
|
|
662
|
-
|
|
663
|
-
|
|
664
|
-
* @param {string}
|
|
665
|
-
* @
|
|
666
|
-
* @
|
|
667
|
-
|
|
639
|
+
channelCredentialDestroy(channel: string, market?: string): Promise<Models.Error>;
|
|
640
|
+
/**
|
|
641
|
+
* A PATCH in spirit whichever verb is used: only the fields present in the
|
|
642
|
+
* body are written, and the answer says which of them actually CHANGED, so
|
|
643
|
+
* a form that resent everything it had on screen does not report a change
|
|
644
|
+
* that did not happen.
|
|
645
|
+
*
|
|
646
|
+
* Three refusals, all 422 and all deliberate rather than ignored. A field
|
|
647
|
+
* the channel's provider does not have (`unknown_credential_field`) — a
|
|
648
|
+
* typo sitting in the bag looking like configuration fails later with a
|
|
649
|
+
* message about a MISSING field the operator can see they filled in. A
|
|
650
|
+
* field the platform issues (`managed_credential`) — ignoring it would have
|
|
651
|
+
* the caller believe they set something. A channel with nothing to
|
|
652
|
+
* configure (`channel_not_configurable`), which is push: its VAPID keypair
|
|
653
|
+
* is generated at provisioning, and pasting a new one would orphan every
|
|
654
|
+
* browser registration the tenant has collected.
|
|
655
|
+
*
|
|
656
|
+
* Switching provider is `driver`, and the fields in the same request are
|
|
657
|
+
* validated against the provider being switched TO — validating Postmark's
|
|
658
|
+
* key against Mailgun's field list is how a switch loses everything the
|
|
659
|
+
* operator just typed.
|
|
660
|
+
*
|
|
661
|
+
* This path answers on `PUT` and `PATCH`, both routed to the same action.
|
|
662
|
+
*
|
|
663
|
+
* @param {string} params.channel -
|
|
664
|
+
* @param {string} params.market - Which market's credentials this call is about. Absent means the GLOBAL bag — what every
|
|
665
|
+
send used before markets reached this path, and what a market with no override of its own
|
|
666
|
+
still uses.
|
|
667
|
+
|
|
668
|
+
Lowercase, opening with a letter, 63 characters at most (Baseline's market slug rule,
|
|
669
|
+
mirrored exactly). A code that does not match is refused with 422 rather than read as
|
|
670
|
+
"no market": on the write paths, silently falling back to global would have an operator
|
|
671
|
+
point every market's traffic at one market's provider while looking at a screen that said
|
|
672
|
+
they had not.
|
|
673
|
+
* @param {string} params.driver -
|
|
674
|
+
* @throws {RevenexxException}
|
|
675
|
+
* @returns {Promise<Models.Error>}
|
|
676
|
+
*/
|
|
677
|
+
channelCredentialUpdatePatch(params: {
|
|
678
|
+
channel: string;
|
|
679
|
+
market?: string;
|
|
680
|
+
driver?: string;
|
|
681
|
+
}): Promise<Models.Error>;
|
|
682
|
+
/**
|
|
683
|
+
* A PATCH in spirit whichever verb is used: only the fields present in the
|
|
684
|
+
* body are written, and the answer says which of them actually CHANGED, so
|
|
685
|
+
* a form that resent everything it had on screen does not report a change
|
|
686
|
+
* that did not happen.
|
|
687
|
+
*
|
|
688
|
+
* Three refusals, all 422 and all deliberate rather than ignored. A field
|
|
689
|
+
* the channel's provider does not have (`unknown_credential_field`) — a
|
|
690
|
+
* typo sitting in the bag looking like configuration fails later with a
|
|
691
|
+
* message about a MISSING field the operator can see they filled in. A
|
|
692
|
+
* field the platform issues (`managed_credential`) — ignoring it would have
|
|
693
|
+
* the caller believe they set something. A channel with nothing to
|
|
694
|
+
* configure (`channel_not_configurable`), which is push: its VAPID keypair
|
|
695
|
+
* is generated at provisioning, and pasting a new one would orphan every
|
|
696
|
+
* browser registration the tenant has collected.
|
|
697
|
+
*
|
|
698
|
+
* Switching provider is `driver`, and the fields in the same request are
|
|
699
|
+
* validated against the provider being switched TO — validating Postmark's
|
|
700
|
+
* key against Mailgun's field list is how a switch loses everything the
|
|
701
|
+
* operator just typed.
|
|
702
|
+
*
|
|
703
|
+
* This path answers on `PUT` and `PATCH`, both routed to the same action.
|
|
704
|
+
*
|
|
705
|
+
* @param {string} channel -
|
|
706
|
+
* @param {string} market - Which market's credentials this call is about. Absent means the GLOBAL bag — what every
|
|
707
|
+
send used before markets reached this path, and what a market with no override of its own
|
|
708
|
+
still uses.
|
|
709
|
+
|
|
710
|
+
Lowercase, opening with a letter, 63 characters at most (Baseline's market slug rule,
|
|
711
|
+
mirrored exactly). A code that does not match is refused with 422 rather than read as
|
|
712
|
+
"no market": on the write paths, silently falling back to global would have an operator
|
|
713
|
+
point every market's traffic at one market's provider while looking at a screen that said
|
|
714
|
+
they had not.
|
|
715
|
+
* @param {string} driver -
|
|
716
|
+
* @throws {RevenexxException}
|
|
717
|
+
* @returns {Promise<Models.Error>}
|
|
668
718
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
669
719
|
*/
|
|
670
|
-
|
|
671
|
-
/**
|
|
672
|
-
*
|
|
673
|
-
*
|
|
674
|
-
*
|
|
675
|
-
*
|
|
676
|
-
*
|
|
677
|
-
*
|
|
678
|
-
*
|
|
679
|
-
*
|
|
680
|
-
*
|
|
681
|
-
*
|
|
682
|
-
*
|
|
683
|
-
*
|
|
684
|
-
|
|
685
|
-
|
|
686
|
-
|
|
687
|
-
|
|
688
|
-
|
|
689
|
-
|
|
690
|
-
|
|
691
|
-
|
|
692
|
-
|
|
693
|
-
|
|
694
|
-
|
|
695
|
-
|
|
696
|
-
|
|
697
|
-
|
|
698
|
-
|
|
699
|
-
|
|
700
|
-
|
|
701
|
-
|
|
702
|
-
|
|
703
|
-
|
|
704
|
-
* @param {string}
|
|
705
|
-
* @
|
|
706
|
-
* @
|
|
707
|
-
|
|
720
|
+
channelCredentialUpdatePatch(channel: string, market?: string, driver?: string): Promise<Models.Error>;
|
|
721
|
+
/**
|
|
722
|
+
* A PATCH in spirit whichever verb is used: only the fields present in the
|
|
723
|
+
* body are written, and the answer says which of them actually CHANGED, so
|
|
724
|
+
* a form that resent everything it had on screen does not report a change
|
|
725
|
+
* that did not happen.
|
|
726
|
+
*
|
|
727
|
+
* Three refusals, all 422 and all deliberate rather than ignored. A field
|
|
728
|
+
* the channel's provider does not have (`unknown_credential_field`) — a
|
|
729
|
+
* typo sitting in the bag looking like configuration fails later with a
|
|
730
|
+
* message about a MISSING field the operator can see they filled in. A
|
|
731
|
+
* field the platform issues (`managed_credential`) — ignoring it would have
|
|
732
|
+
* the caller believe they set something. A channel with nothing to
|
|
733
|
+
* configure (`channel_not_configurable`), which is push: its VAPID keypair
|
|
734
|
+
* is generated at provisioning, and pasting a new one would orphan every
|
|
735
|
+
* browser registration the tenant has collected.
|
|
736
|
+
*
|
|
737
|
+
* Switching provider is `driver`, and the fields in the same request are
|
|
738
|
+
* validated against the provider being switched TO — validating Postmark's
|
|
739
|
+
* key against Mailgun's field list is how a switch loses everything the
|
|
740
|
+
* operator just typed.
|
|
741
|
+
*
|
|
742
|
+
* This path answers on `PUT` and `PATCH`, both routed to the same action.
|
|
743
|
+
*
|
|
744
|
+
* @param {string} params.channel -
|
|
745
|
+
* @param {string} params.market - Which market's credentials this call is about. Absent means the GLOBAL bag — what every
|
|
746
|
+
send used before markets reached this path, and what a market with no override of its own
|
|
747
|
+
still uses.
|
|
748
|
+
|
|
749
|
+
Lowercase, opening with a letter, 63 characters at most (Baseline's market slug rule,
|
|
750
|
+
mirrored exactly). A code that does not match is refused with 422 rather than read as
|
|
751
|
+
"no market": on the write paths, silently falling back to global would have an operator
|
|
752
|
+
point every market's traffic at one market's provider while looking at a screen that said
|
|
753
|
+
they had not.
|
|
754
|
+
* @param {string} params.driver -
|
|
755
|
+
* @throws {RevenexxException}
|
|
756
|
+
* @returns {Promise<Models.Error>}
|
|
757
|
+
*/
|
|
758
|
+
channelCredentialUpdate(params: {
|
|
759
|
+
channel: string;
|
|
760
|
+
market?: string;
|
|
761
|
+
driver?: string;
|
|
762
|
+
}): Promise<Models.Error>;
|
|
763
|
+
/**
|
|
764
|
+
* A PATCH in spirit whichever verb is used: only the fields present in the
|
|
765
|
+
* body are written, and the answer says which of them actually CHANGED, so
|
|
766
|
+
* a form that resent everything it had on screen does not report a change
|
|
767
|
+
* that did not happen.
|
|
768
|
+
*
|
|
769
|
+
* Three refusals, all 422 and all deliberate rather than ignored. A field
|
|
770
|
+
* the channel's provider does not have (`unknown_credential_field`) — a
|
|
771
|
+
* typo sitting in the bag looking like configuration fails later with a
|
|
772
|
+
* message about a MISSING field the operator can see they filled in. A
|
|
773
|
+
* field the platform issues (`managed_credential`) — ignoring it would have
|
|
774
|
+
* the caller believe they set something. A channel with nothing to
|
|
775
|
+
* configure (`channel_not_configurable`), which is push: its VAPID keypair
|
|
776
|
+
* is generated at provisioning, and pasting a new one would orphan every
|
|
777
|
+
* browser registration the tenant has collected.
|
|
778
|
+
*
|
|
779
|
+
* Switching provider is `driver`, and the fields in the same request are
|
|
780
|
+
* validated against the provider being switched TO — validating Postmark's
|
|
781
|
+
* key against Mailgun's field list is how a switch loses everything the
|
|
782
|
+
* operator just typed.
|
|
783
|
+
*
|
|
784
|
+
* This path answers on `PUT` and `PATCH`, both routed to the same action.
|
|
785
|
+
*
|
|
786
|
+
* @param {string} channel -
|
|
787
|
+
* @param {string} market - Which market's credentials this call is about. Absent means the GLOBAL bag — what every
|
|
788
|
+
send used before markets reached this path, and what a market with no override of its own
|
|
789
|
+
still uses.
|
|
790
|
+
|
|
791
|
+
Lowercase, opening with a letter, 63 characters at most (Baseline's market slug rule,
|
|
792
|
+
mirrored exactly). A code that does not match is refused with 422 rather than read as
|
|
793
|
+
"no market": on the write paths, silently falling back to global would have an operator
|
|
794
|
+
point every market's traffic at one market's provider while looking at a screen that said
|
|
795
|
+
they had not.
|
|
796
|
+
* @param {string} driver -
|
|
797
|
+
* @throws {RevenexxException}
|
|
798
|
+
* @returns {Promise<Models.Error>}
|
|
708
799
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
709
800
|
*/
|
|
710
|
-
|
|
711
|
-
/**
|
|
712
|
-
*
|
|
713
|
-
*
|
|
714
|
-
*
|
|
715
|
-
*
|
|
716
|
-
*
|
|
717
|
-
*
|
|
718
|
-
*
|
|
719
|
-
*
|
|
720
|
-
*
|
|
721
|
-
*
|
|
722
|
-
*
|
|
723
|
-
*
|
|
724
|
-
|
|
725
|
-
|
|
726
|
-
|
|
727
|
-
|
|
728
|
-
|
|
729
|
-
|
|
730
|
-
|
|
731
|
-
|
|
732
|
-
|
|
733
|
-
|
|
734
|
-
|
|
735
|
-
|
|
736
|
-
*
|
|
737
|
-
|
|
738
|
-
|
|
739
|
-
|
|
740
|
-
|
|
741
|
-
|
|
742
|
-
|
|
743
|
-
*
|
|
744
|
-
*
|
|
745
|
-
*
|
|
746
|
-
*
|
|
747
|
-
*
|
|
801
|
+
channelCredentialUpdate(channel: string, market?: string, driver?: string): Promise<Models.Error>;
|
|
802
|
+
/**
|
|
803
|
+
* The one thing that turns this screen from a form into a tool. Credentials
|
|
804
|
+
* that only fail at send time cost a customer their first order
|
|
805
|
+
* confirmation, and by then nobody connects the failure to the afternoon
|
|
806
|
+
* somebody pasted a key with a trailing space.
|
|
807
|
+
*
|
|
808
|
+
* **Always 200.** The answer is `{ok, message}` in the body, including when
|
|
809
|
+
* the credentials are wrong: the REQUEST was fine, the credentials are not,
|
|
810
|
+
* and a 4xx here would have the cockpit's own error handling swallow the
|
|
811
|
+
* one sentence worth reading. A channel that asks for no credentials at all
|
|
812
|
+
* (push, in-app) answers `ok: true` — "nothing to verify" is a finished
|
|
813
|
+
* check, not a failed one, and reporting it as an error painted a channel
|
|
814
|
+
* that has worked since provisioning in the same red as a wrong token.
|
|
815
|
+
*
|
|
816
|
+
* @param {string} params.channel -
|
|
817
|
+
* @param {string} params.market - Which market's credentials this call is about. Absent means the GLOBAL bag — what every
|
|
818
|
+
send used before markets reached this path, and what a market with no override of its own
|
|
819
|
+
still uses.
|
|
820
|
+
|
|
821
|
+
Lowercase, opening with a letter, 63 characters at most (Baseline's market slug rule,
|
|
822
|
+
mirrored exactly). A code that does not match is refused with 422 rather than read as
|
|
823
|
+
"no market": on the write paths, silently falling back to global would have an operator
|
|
824
|
+
point every market's traffic at one market's provider while looking at a screen that said
|
|
825
|
+
they had not.
|
|
826
|
+
* @throws {RevenexxException}
|
|
827
|
+
* @returns {Promise<Models.Error>}
|
|
828
|
+
*/
|
|
829
|
+
channelCredentialVerify(params: {
|
|
830
|
+
channel: string;
|
|
831
|
+
market?: string;
|
|
832
|
+
}): Promise<Models.Error>;
|
|
833
|
+
/**
|
|
834
|
+
* The one thing that turns this screen from a form into a tool. Credentials
|
|
835
|
+
* that only fail at send time cost a customer their first order
|
|
836
|
+
* confirmation, and by then nobody connects the failure to the afternoon
|
|
837
|
+
* somebody pasted a key with a trailing space.
|
|
838
|
+
*
|
|
839
|
+
* **Always 200.** The answer is `{ok, message}` in the body, including when
|
|
840
|
+
* the credentials are wrong: the REQUEST was fine, the credentials are not,
|
|
841
|
+
* and a 4xx here would have the cockpit's own error handling swallow the
|
|
842
|
+
* one sentence worth reading. A channel that asks for no credentials at all
|
|
843
|
+
* (push, in-app) answers `ok: true` — "nothing to verify" is a finished
|
|
844
|
+
* check, not a failed one, and reporting it as an error painted a channel
|
|
845
|
+
* that has worked since provisioning in the same red as a wrong token.
|
|
846
|
+
*
|
|
847
|
+
* @param {string} channel -
|
|
848
|
+
* @param {string} market - Which market's credentials this call is about. Absent means the GLOBAL bag — what every
|
|
849
|
+
send used before markets reached this path, and what a market with no override of its own
|
|
850
|
+
still uses.
|
|
851
|
+
|
|
852
|
+
Lowercase, opening with a letter, 63 characters at most (Baseline's market slug rule,
|
|
853
|
+
mirrored exactly). A code that does not match is refused with 422 rather than read as
|
|
854
|
+
"no market": on the write paths, silently falling back to global would have an operator
|
|
855
|
+
point every market's traffic at one market's provider while looking at a screen that said
|
|
856
|
+
they had not.
|
|
857
|
+
* @throws {RevenexxException}
|
|
858
|
+
* @returns {Promise<Models.Error>}
|
|
748
859
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
749
860
|
*/
|
|
750
|
-
|
|
751
|
-
/**
|
|
752
|
-
*
|
|
753
|
-
*
|
|
754
|
-
*
|
|
755
|
-
*
|
|
756
|
-
*
|
|
757
|
-
*
|
|
758
|
-
* @
|
|
759
|
-
* @
|
|
760
|
-
|
|
761
|
-
|
|
762
|
-
|
|
763
|
-
*
|
|
764
|
-
|
|
765
|
-
|
|
766
|
-
|
|
767
|
-
|
|
768
|
-
|
|
769
|
-
|
|
770
|
-
|
|
771
|
-
|
|
772
|
-
|
|
773
|
-
|
|
774
|
-
|
|
775
|
-
|
|
776
|
-
|
|
777
|
-
|
|
778
|
-
*
|
|
779
|
-
*
|
|
780
|
-
*
|
|
781
|
-
*
|
|
782
|
-
*
|
|
783
|
-
*
|
|
784
|
-
*
|
|
785
|
-
*
|
|
786
|
-
*
|
|
787
|
-
*
|
|
861
|
+
channelCredentialVerify(channel: string, market?: string): Promise<Models.Error>;
|
|
862
|
+
/**
|
|
863
|
+
* Each entry says whether the channel is switched on and which provider
|
|
864
|
+
* carries it by default. A channel that is off will refuse a send, so a UI
|
|
865
|
+
* that offers a channel picker should build it from this rather than from a
|
|
866
|
+
* list of its own — a channel added to the service then appears without a
|
|
867
|
+
* release of the client.
|
|
868
|
+
*
|
|
869
|
+
* @throws {RevenexxException}
|
|
870
|
+
* @returns {Promise<Models.Error>}
|
|
871
|
+
*/
|
|
872
|
+
channelIndex(): Promise<Models.Error>;
|
|
873
|
+
/**
|
|
874
|
+
* A tenant that was never provisioned has no row and still gets an answer:
|
|
875
|
+
* an empty shape rather than a 404, so the Cockpit's panels open on
|
|
876
|
+
* editable blanks instead of an error.
|
|
877
|
+
*
|
|
878
|
+
* `meta.push_public_key` is the VAPID public key, and only the public one.
|
|
879
|
+
* A storefront cannot call `PushManager.subscribe()` without it, so it has
|
|
880
|
+
* to leave the service; the private half and every provider secret stay
|
|
881
|
+
* hidden on the model, where they are protected on every route rather than
|
|
882
|
+
* on this one.
|
|
883
|
+
*
|
|
884
|
+
* @throws {RevenexxException}
|
|
885
|
+
* @returns {Promise<Models.Error>}
|
|
886
|
+
*/
|
|
887
|
+
configShow(): Promise<Models.Error>;
|
|
888
|
+
/**
|
|
889
|
+
* Reaches every message this tenant sends, including templates saved months
|
|
890
|
+
* ago — content placeholders resolve at send time, not at save time — which
|
|
891
|
+
* is why writing is admin tier while reading is not.
|
|
892
|
+
*
|
|
893
|
+
* Two refusals worth knowing about. `defaults.brand` is 422, not ignored:
|
|
894
|
+
* the letterhead moved to /v1/layouts when a tenant gained more than one of
|
|
895
|
+
* them, and a letterhead edit that appears to save and changes nothing is
|
|
896
|
+
* the worst of the three possible behaviours. A half-written `quiet_hours`
|
|
897
|
+
* is 422 as well — a tenant that typed a start and forgot the end has an
|
|
898
|
+
* opinion about when not to message people, and silently sending through
|
|
899
|
+
* the night is the one answer that is definitely wrong.
|
|
900
|
+
*
|
|
901
|
+
* Provider credentials cannot be written here. That path is
|
|
902
|
+
* /v1/channel-credentials, so the one route that handles secrets stays the
|
|
903
|
+
* one that was built for it.
|
|
904
|
+
*
|
|
905
|
+
* This path answers on `PUT` and `PATCH`, both routed to the same action.
|
|
906
|
+
*
|
|
907
|
+
* @param {string} params.defaultLocale - The house language — step 4 of the send path's resolution order,
|
|
908
|
+
reached only when neither the caller, the event payload nor the
|
|
909
|
+
binding said anything. A column of its own and not a key in
|
|
910
|
+
`defaults` below, because everything in that bag is merged into
|
|
911
|
+
the render model: a `locale` key there would start filling
|
|
912
|
+
`{{ locale }}` inside template bodies, which is a routing
|
|
913
|
+
decision leaking into content.
|
|
914
|
+
* @param {string[]} params.defaults - The saved modules live in here. The shape is the Cockpit's
|
|
915
|
+
contract and is not pinned down further: adding a block type
|
|
916
|
+
would otherwise be a service deploy. The one key that IS pinned
|
|
917
|
+
down is `brand`, because it moved out — and it is refused with a
|
|
918
|
+
closure rather than a `defaults.brand` rule, since a nested rule
|
|
919
|
+
makes the validator drop the parent and quietly discard every
|
|
920
|
+
other key in the bag along with it.
|
|
921
|
+
* @param {string} params.product -
|
|
922
|
+
* @param {string[]} params.quietHours -
|
|
923
|
+
* @param {string} params.supportEmail -
|
|
924
|
+
* @throws {RevenexxException}
|
|
925
|
+
* @returns {Promise<Models.Error>}
|
|
926
|
+
*/
|
|
927
|
+
configUpdatePatch(params?: {
|
|
928
|
+
defaultLocale?: string;
|
|
929
|
+
defaults?: string[];
|
|
930
|
+
product?: string;
|
|
931
|
+
quietHours?: string[];
|
|
932
|
+
supportEmail?: string;
|
|
933
|
+
}): Promise<Models.Error>;
|
|
934
|
+
/**
|
|
935
|
+
* Reaches every message this tenant sends, including templates saved months
|
|
936
|
+
* ago — content placeholders resolve at send time, not at save time — which
|
|
937
|
+
* is why writing is admin tier while reading is not.
|
|
938
|
+
*
|
|
939
|
+
* Two refusals worth knowing about. `defaults.brand` is 422, not ignored:
|
|
940
|
+
* the letterhead moved to /v1/layouts when a tenant gained more than one of
|
|
941
|
+
* them, and a letterhead edit that appears to save and changes nothing is
|
|
942
|
+
* the worst of the three possible behaviours. A half-written `quiet_hours`
|
|
943
|
+
* is 422 as well — a tenant that typed a start and forgot the end has an
|
|
944
|
+
* opinion about when not to message people, and silently sending through
|
|
945
|
+
* the night is the one answer that is definitely wrong.
|
|
946
|
+
*
|
|
947
|
+
* Provider credentials cannot be written here. That path is
|
|
948
|
+
* /v1/channel-credentials, so the one route that handles secrets stays the
|
|
949
|
+
* one that was built for it.
|
|
950
|
+
*
|
|
951
|
+
* This path answers on `PUT` and `PATCH`, both routed to the same action.
|
|
952
|
+
*
|
|
953
|
+
* @param {string} defaultLocale - The house language — step 4 of the send path's resolution order,
|
|
954
|
+
reached only when neither the caller, the event payload nor the
|
|
955
|
+
binding said anything. A column of its own and not a key in
|
|
956
|
+
`defaults` below, because everything in that bag is merged into
|
|
957
|
+
the render model: a `locale` key there would start filling
|
|
958
|
+
`{{ locale }}` inside template bodies, which is a routing
|
|
959
|
+
decision leaking into content.
|
|
960
|
+
* @param {string[]} defaults - The saved modules live in here. The shape is the Cockpit's
|
|
961
|
+
contract and is not pinned down further: adding a block type
|
|
962
|
+
would otherwise be a service deploy. The one key that IS pinned
|
|
963
|
+
down is `brand`, because it moved out — and it is refused with a
|
|
964
|
+
closure rather than a `defaults.brand` rule, since a nested rule
|
|
965
|
+
makes the validator drop the parent and quietly discard every
|
|
966
|
+
other key in the bag along with it.
|
|
967
|
+
* @param {string} product -
|
|
968
|
+
* @param {string[]} quietHours -
|
|
969
|
+
* @param {string} supportEmail -
|
|
970
|
+
* @throws {RevenexxException}
|
|
971
|
+
* @returns {Promise<Models.Error>}
|
|
788
972
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
789
973
|
*/
|
|
790
|
-
|
|
791
|
-
/**
|
|
792
|
-
*
|
|
793
|
-
*
|
|
794
|
-
*
|
|
795
|
-
*
|
|
796
|
-
*
|
|
797
|
-
*
|
|
798
|
-
*
|
|
799
|
-
*
|
|
800
|
-
*
|
|
801
|
-
*
|
|
802
|
-
|
|
803
|
-
|
|
804
|
-
|
|
805
|
-
|
|
806
|
-
|
|
807
|
-
|
|
808
|
-
|
|
809
|
-
|
|
810
|
-
|
|
811
|
-
|
|
812
|
-
|
|
813
|
-
|
|
814
|
-
|
|
815
|
-
|
|
816
|
-
|
|
817
|
-
* @param {string}
|
|
818
|
-
|
|
819
|
-
|
|
820
|
-
|
|
821
|
-
|
|
974
|
+
configUpdatePatch(defaultLocale?: string, defaults?: string[], product?: string, quietHours?: string[], supportEmail?: string): Promise<Models.Error>;
|
|
975
|
+
/**
|
|
976
|
+
* Reaches every message this tenant sends, including templates saved months
|
|
977
|
+
* ago — content placeholders resolve at send time, not at save time — which
|
|
978
|
+
* is why writing is admin tier while reading is not.
|
|
979
|
+
*
|
|
980
|
+
* Two refusals worth knowing about. `defaults.brand` is 422, not ignored:
|
|
981
|
+
* the letterhead moved to /v1/layouts when a tenant gained more than one of
|
|
982
|
+
* them, and a letterhead edit that appears to save and changes nothing is
|
|
983
|
+
* the worst of the three possible behaviours. A half-written `quiet_hours`
|
|
984
|
+
* is 422 as well — a tenant that typed a start and forgot the end has an
|
|
985
|
+
* opinion about when not to message people, and silently sending through
|
|
986
|
+
* the night is the one answer that is definitely wrong.
|
|
987
|
+
*
|
|
988
|
+
* Provider credentials cannot be written here. That path is
|
|
989
|
+
* /v1/channel-credentials, so the one route that handles secrets stays the
|
|
990
|
+
* one that was built for it.
|
|
991
|
+
*
|
|
992
|
+
* This path answers on `PUT` and `PATCH`, both routed to the same action.
|
|
993
|
+
*
|
|
994
|
+
* @param {string} params.defaultLocale - The house language — step 4 of the send path's resolution order,
|
|
995
|
+
reached only when neither the caller, the event payload nor the
|
|
996
|
+
binding said anything. A column of its own and not a key in
|
|
997
|
+
`defaults` below, because everything in that bag is merged into
|
|
998
|
+
the render model: a `locale` key there would start filling
|
|
999
|
+
`{{ locale }}` inside template bodies, which is a routing
|
|
1000
|
+
decision leaking into content.
|
|
1001
|
+
* @param {string[]} params.defaults - The saved modules live in here. The shape is the Cockpit's
|
|
1002
|
+
contract and is not pinned down further: adding a block type
|
|
1003
|
+
would otherwise be a service deploy. The one key that IS pinned
|
|
1004
|
+
down is `brand`, because it moved out — and it is refused with a
|
|
1005
|
+
closure rather than a `defaults.brand` rule, since a nested rule
|
|
1006
|
+
makes the validator drop the parent and quietly discard every
|
|
1007
|
+
other key in the bag along with it.
|
|
1008
|
+
* @param {string} params.product -
|
|
1009
|
+
* @param {string[]} params.quietHours -
|
|
1010
|
+
* @param {string} params.supportEmail -
|
|
1011
|
+
* @throws {RevenexxException}
|
|
1012
|
+
* @returns {Promise<Models.Error>}
|
|
1013
|
+
*/
|
|
1014
|
+
configUpdate(params?: {
|
|
1015
|
+
defaultLocale?: string;
|
|
1016
|
+
defaults?: string[];
|
|
1017
|
+
product?: string;
|
|
1018
|
+
quietHours?: string[];
|
|
1019
|
+
supportEmail?: string;
|
|
1020
|
+
}): Promise<Models.Error>;
|
|
1021
|
+
/**
|
|
1022
|
+
* Reaches every message this tenant sends, including templates saved months
|
|
1023
|
+
* ago — content placeholders resolve at send time, not at save time — which
|
|
1024
|
+
* is why writing is admin tier while reading is not.
|
|
1025
|
+
*
|
|
1026
|
+
* Two refusals worth knowing about. `defaults.brand` is 422, not ignored:
|
|
1027
|
+
* the letterhead moved to /v1/layouts when a tenant gained more than one of
|
|
1028
|
+
* them, and a letterhead edit that appears to save and changes nothing is
|
|
1029
|
+
* the worst of the three possible behaviours. A half-written `quiet_hours`
|
|
1030
|
+
* is 422 as well — a tenant that typed a start and forgot the end has an
|
|
1031
|
+
* opinion about when not to message people, and silently sending through
|
|
1032
|
+
* the night is the one answer that is definitely wrong.
|
|
1033
|
+
*
|
|
1034
|
+
* Provider credentials cannot be written here. That path is
|
|
1035
|
+
* /v1/channel-credentials, so the one route that handles secrets stays the
|
|
1036
|
+
* one that was built for it.
|
|
1037
|
+
*
|
|
1038
|
+
* This path answers on `PUT` and `PATCH`, both routed to the same action.
|
|
1039
|
+
*
|
|
1040
|
+
* @param {string} defaultLocale - The house language — step 4 of the send path's resolution order,
|
|
1041
|
+
reached only when neither the caller, the event payload nor the
|
|
1042
|
+
binding said anything. A column of its own and not a key in
|
|
1043
|
+
`defaults` below, because everything in that bag is merged into
|
|
1044
|
+
the render model: a `locale` key there would start filling
|
|
1045
|
+
`{{ locale }}` inside template bodies, which is a routing
|
|
1046
|
+
decision leaking into content.
|
|
1047
|
+
* @param {string[]} defaults - The saved modules live in here. The shape is the Cockpit's
|
|
1048
|
+
contract and is not pinned down further: adding a block type
|
|
1049
|
+
would otherwise be a service deploy. The one key that IS pinned
|
|
1050
|
+
down is `brand`, because it moved out — and it is refused with a
|
|
1051
|
+
closure rather than a `defaults.brand` rule, since a nested rule
|
|
1052
|
+
makes the validator drop the parent and quietly discard every
|
|
1053
|
+
other key in the bag along with it.
|
|
1054
|
+
* @param {string} product -
|
|
1055
|
+
* @param {string[]} quietHours -
|
|
1056
|
+
* @param {string} supportEmail -
|
|
1057
|
+
* @throws {RevenexxException}
|
|
1058
|
+
* @returns {Promise<Models.Error>}
|
|
822
1059
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
823
1060
|
*/
|
|
824
|
-
|
|
1061
|
+
configUpdate(defaultLocale?: string, defaults?: string[], product?: string, quietHours?: string[], supportEmail?: string): Promise<Models.Error>;
|
|
825
1062
|
/**
|
|
826
|
-
*
|
|
1063
|
+
* The order is the list's purpose: it is a picker, and the entry most
|
|
1064
|
+
* templates are actually on belongs at the top of it.
|
|
827
1065
|
*
|
|
828
|
-
*
|
|
829
|
-
*
|
|
830
|
-
*
|
|
831
|
-
* @param {
|
|
832
|
-
* @
|
|
833
|
-
* @
|
|
834
|
-
* @throws {RevenexxAPIRevenexxException}
|
|
835
|
-
* @returns {Promise<Models.Provider>}
|
|
836
|
-
*/
|
|
837
|
-
messagingUpdateTelesignProvider(params: {
|
|
838
|
-
providerId: string;
|
|
839
|
-
apiKey?: string;
|
|
840
|
-
customerId?: string;
|
|
841
|
-
enabled?: boolean;
|
|
842
|
-
from?: string;
|
|
843
|
-
name?: string;
|
|
844
|
-
}): Promise<Models.Provider>;
|
|
845
|
-
/**
|
|
846
|
-
* Update a Telesign provider by its unique ID.
|
|
847
|
-
*
|
|
848
|
-
* @param {string} providerId - Provider ID.
|
|
849
|
-
* @param {string} apiKey - Telesign API key.
|
|
850
|
-
* @param {string} customerId - Telesign customer ID.
|
|
851
|
-
* @param {boolean} enabled - Set as enabled.
|
|
852
|
-
* @param {string} from - Sender number.
|
|
853
|
-
* @param {string} name - Provider name.
|
|
854
|
-
* @throws {RevenexxAPIRevenexxException}
|
|
855
|
-
* @returns {Promise<Models.Provider>}
|
|
856
|
-
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1066
|
+
* Market-scoped as a browsing filter — see the parameters. `GET /layouts/{id}`
|
|
1067
|
+
* deliberately is not: somebody holding an id may read it.
|
|
1068
|
+
*
|
|
1069
|
+
* @param {string} params.markets - Set to `all` for the unscoped read: every row whatever its markets, ignoring the `X-Revenexx-Market` header. The deliberate admin case, spelled in the query string so it is asked for rather than fallen into. No other value has any effect.
|
|
1070
|
+
* @throws {RevenexxException}
|
|
1071
|
+
* @returns {Promise<Models.Error>}
|
|
857
1072
|
*/
|
|
858
|
-
|
|
1073
|
+
layoutIndex(params?: {
|
|
1074
|
+
markets?: string;
|
|
1075
|
+
}): Promise<Models.Error>;
|
|
859
1076
|
/**
|
|
860
|
-
*
|
|
1077
|
+
* The order is the list's purpose: it is a picker, and the entry most
|
|
1078
|
+
* templates are actually on belongs at the top of it.
|
|
861
1079
|
*
|
|
862
|
-
*
|
|
863
|
-
*
|
|
864
|
-
*
|
|
865
|
-
* @param {
|
|
866
|
-
* @
|
|
867
|
-
* @
|
|
868
|
-
* @throws {RevenexxAPIRevenexxException}
|
|
869
|
-
* @returns {Promise<Models.Provider>}
|
|
870
|
-
*/
|
|
871
|
-
messagingCreateTextmagicProvider(params: {
|
|
872
|
-
name: string;
|
|
873
|
-
providerId: string;
|
|
874
|
-
apiKey?: string;
|
|
875
|
-
enabled?: boolean;
|
|
876
|
-
from?: string;
|
|
877
|
-
username?: string;
|
|
878
|
-
}): Promise<Models.Provider>;
|
|
879
|
-
/**
|
|
880
|
-
* Create a new Textmagic provider.
|
|
881
|
-
*
|
|
882
|
-
* @param {string} name - Provider name.
|
|
883
|
-
* @param {string} providerId - Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
|
|
884
|
-
* @param {string} apiKey - Textmagic apiKey.
|
|
885
|
-
* @param {boolean} enabled - Set as enabled.
|
|
886
|
-
* @param {string} from - Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.
|
|
887
|
-
* @param {string} username - Textmagic username.
|
|
888
|
-
* @throws {RevenexxAPIRevenexxException}
|
|
889
|
-
* @returns {Promise<Models.Provider>}
|
|
1080
|
+
* Market-scoped as a browsing filter — see the parameters. `GET /layouts/{id}`
|
|
1081
|
+
* deliberately is not: somebody holding an id may read it.
|
|
1082
|
+
*
|
|
1083
|
+
* @param {string} markets - Set to `all` for the unscoped read: every row whatever its markets, ignoring the `X-Revenexx-Market` header. The deliberate admin case, spelled in the query string so it is asked for rather than fallen into. No other value has any effect.
|
|
1084
|
+
* @throws {RevenexxException}
|
|
1085
|
+
* @returns {Promise<Models.Error>}
|
|
890
1086
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
891
1087
|
*/
|
|
892
|
-
|
|
1088
|
+
layoutIndex(markets?: string): Promise<Models.Error>;
|
|
893
1089
|
/**
|
|
894
|
-
*
|
|
1090
|
+
* A tenant's FIRST layout becomes the default whatever the request says: a
|
|
1091
|
+
* tenant with no default cannot compile a template that does not name one.
|
|
895
1092
|
*
|
|
896
|
-
*
|
|
897
|
-
*
|
|
898
|
-
*
|
|
899
|
-
*
|
|
900
|
-
*
|
|
901
|
-
*
|
|
902
|
-
*
|
|
903
|
-
* @
|
|
904
|
-
|
|
905
|
-
messagingUpdateTextmagicProvider(params: {
|
|
906
|
-
providerId: string;
|
|
907
|
-
apiKey?: string;
|
|
908
|
-
enabled?: boolean;
|
|
909
|
-
from?: string;
|
|
910
|
-
name?: string;
|
|
911
|
-
username?: string;
|
|
912
|
-
}): Promise<Models.Provider>;
|
|
913
|
-
/**
|
|
914
|
-
* Update a Textmagic provider by its unique ID.
|
|
915
|
-
*
|
|
916
|
-
* @param {string} providerId - Provider ID.
|
|
917
|
-
* @param {string} apiKey - Textmagic apiKey.
|
|
918
|
-
* @param {boolean} enabled - Set as enabled.
|
|
919
|
-
* @param {string} from - Sender number.
|
|
920
|
-
* @param {string} name - Provider name.
|
|
921
|
-
* @param {string} username - Textmagic username.
|
|
922
|
-
* @throws {RevenexxAPIRevenexxException}
|
|
923
|
-
* @returns {Promise<Models.Provider>}
|
|
924
|
-
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1093
|
+
* The default may hold neither a validity window nor `enabled: false`, and
|
|
1094
|
+
* asking for both in one request is refused with 422
|
|
1095
|
+
* `layout_default_always_in_force`. There is no fallback behind the default
|
|
1096
|
+
* — every template that names no layout is framed by it — so a window set
|
|
1097
|
+
* today would take a tenant's whole letterhead away on a morning months
|
|
1098
|
+
* from now, with nobody left who remembers typing the date.
|
|
1099
|
+
*
|
|
1100
|
+
* @throws {RevenexxException}
|
|
1101
|
+
* @returns {Promise<Models.Error>}
|
|
925
1102
|
*/
|
|
926
|
-
|
|
1103
|
+
layoutStore(): Promise<Models.Error>;
|
|
927
1104
|
/**
|
|
928
|
-
*
|
|
1105
|
+
* Answers 200 with a body rather than the 204 the other resources use: the
|
|
1106
|
+
* count of reassigned templates is the part an operator needs, and a
|
|
1107
|
+
* deletion that silently moved eleven templates onto another letterhead is
|
|
1108
|
+
* one they would only discover from the next mail that went out.
|
|
929
1109
|
*
|
|
930
|
-
* @param {string} params.
|
|
931
|
-
* @
|
|
932
|
-
* @
|
|
933
|
-
* @param {string} params.authToken - Twilio authentication token.
|
|
934
|
-
* @param {boolean} params.enabled - Set as enabled.
|
|
935
|
-
* @param {string} params.from - Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.
|
|
936
|
-
* @throws {RevenexxAPIRevenexxException}
|
|
937
|
-
* @returns {Promise<Models.Provider>}
|
|
938
|
-
*/
|
|
939
|
-
messagingCreateTwilioProvider(params: {
|
|
940
|
-
name: string;
|
|
941
|
-
providerId: string;
|
|
942
|
-
accountSid?: string;
|
|
943
|
-
authToken?: string;
|
|
944
|
-
enabled?: boolean;
|
|
945
|
-
from?: string;
|
|
946
|
-
}): Promise<Models.Provider>;
|
|
947
|
-
/**
|
|
948
|
-
* Create a new Twilio provider.
|
|
949
|
-
*
|
|
950
|
-
* @param {string} name - Provider name.
|
|
951
|
-
* @param {string} providerId - Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
|
|
952
|
-
* @param {string} accountSid - Twilio account secret ID.
|
|
953
|
-
* @param {string} authToken - Twilio authentication token.
|
|
954
|
-
* @param {boolean} enabled - Set as enabled.
|
|
955
|
-
* @param {string} from - Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.
|
|
956
|
-
* @throws {RevenexxAPIRevenexxException}
|
|
957
|
-
* @returns {Promise<Models.Provider>}
|
|
958
|
-
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1110
|
+
* @param {string} params.id -
|
|
1111
|
+
* @throws {RevenexxException}
|
|
1112
|
+
* @returns {Promise<Models.Error>}
|
|
959
1113
|
*/
|
|
960
|
-
|
|
1114
|
+
layoutDestroy(params: {
|
|
1115
|
+
id: string;
|
|
1116
|
+
}): Promise<Models.Error>;
|
|
961
1117
|
/**
|
|
962
|
-
*
|
|
1118
|
+
* Answers 200 with a body rather than the 204 the other resources use: the
|
|
1119
|
+
* count of reassigned templates is the part an operator needs, and a
|
|
1120
|
+
* deletion that silently moved eleven templates onto another letterhead is
|
|
1121
|
+
* one they would only discover from the next mail that went out.
|
|
963
1122
|
*
|
|
964
|
-
* @param {string}
|
|
965
|
-
* @
|
|
966
|
-
* @
|
|
967
|
-
* @param {boolean} params.enabled - Set as enabled.
|
|
968
|
-
* @param {string} params.from - Sender number.
|
|
969
|
-
* @param {string} params.name - Provider name.
|
|
970
|
-
* @throws {RevenexxAPIRevenexxException}
|
|
971
|
-
* @returns {Promise<Models.Provider>}
|
|
972
|
-
*/
|
|
973
|
-
messagingUpdateTwilioProvider(params: {
|
|
974
|
-
providerId: string;
|
|
975
|
-
accountSid?: string;
|
|
976
|
-
authToken?: string;
|
|
977
|
-
enabled?: boolean;
|
|
978
|
-
from?: string;
|
|
979
|
-
name?: string;
|
|
980
|
-
}): Promise<Models.Provider>;
|
|
981
|
-
/**
|
|
982
|
-
* Update a Twilio provider by its unique ID.
|
|
983
|
-
*
|
|
984
|
-
* @param {string} providerId - Provider ID.
|
|
985
|
-
* @param {string} accountSid - Twilio account secret ID.
|
|
986
|
-
* @param {string} authToken - Twilio authentication token.
|
|
987
|
-
* @param {boolean} enabled - Set as enabled.
|
|
988
|
-
* @param {string} from - Sender number.
|
|
989
|
-
* @param {string} name - Provider name.
|
|
990
|
-
* @throws {RevenexxAPIRevenexxException}
|
|
991
|
-
* @returns {Promise<Models.Provider>}
|
|
1123
|
+
* @param {string} id -
|
|
1124
|
+
* @throws {RevenexxException}
|
|
1125
|
+
* @returns {Promise<Models.Error>}
|
|
992
1126
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
993
1127
|
*/
|
|
994
|
-
|
|
1128
|
+
layoutDestroy(id: string): Promise<Models.Error>;
|
|
995
1129
|
/**
|
|
996
|
-
*
|
|
1130
|
+
* Not market-filtered, deliberately: market scoping is a browsing concern,
|
|
1131
|
+
* and somebody holding an id may read the row. A template pinned to a
|
|
1132
|
+
* layout keeps mailing on it whatever market the reader is looking at.
|
|
997
1133
|
*
|
|
998
|
-
* @param {string} params.
|
|
999
|
-
* @
|
|
1000
|
-
* @
|
|
1001
|
-
* @param {string} params.apiSecret - Vonage API secret.
|
|
1002
|
-
* @param {boolean} params.enabled - Set as enabled.
|
|
1003
|
-
* @param {string} params.from - Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.
|
|
1004
|
-
* @throws {RevenexxAPIRevenexxException}
|
|
1005
|
-
* @returns {Promise<Models.Provider>}
|
|
1006
|
-
*/
|
|
1007
|
-
messagingCreateVonageProvider(params: {
|
|
1008
|
-
name: string;
|
|
1009
|
-
providerId: string;
|
|
1010
|
-
apiKey?: string;
|
|
1011
|
-
apiSecret?: string;
|
|
1012
|
-
enabled?: boolean;
|
|
1013
|
-
from?: string;
|
|
1014
|
-
}): Promise<Models.Provider>;
|
|
1015
|
-
/**
|
|
1016
|
-
* Create a new Vonage provider.
|
|
1017
|
-
*
|
|
1018
|
-
* @param {string} name - Provider name.
|
|
1019
|
-
* @param {string} providerId - Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
|
|
1020
|
-
* @param {string} apiKey - Vonage API key.
|
|
1021
|
-
* @param {string} apiSecret - Vonage API secret.
|
|
1022
|
-
* @param {boolean} enabled - Set as enabled.
|
|
1023
|
-
* @param {string} from - Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.
|
|
1024
|
-
* @throws {RevenexxAPIRevenexxException}
|
|
1025
|
-
* @returns {Promise<Models.Provider>}
|
|
1026
|
-
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1134
|
+
* @param {string} params.id -
|
|
1135
|
+
* @throws {RevenexxException}
|
|
1136
|
+
* @returns {Promise<Models.Error>}
|
|
1027
1137
|
*/
|
|
1028
|
-
|
|
1138
|
+
layoutShow(params: {
|
|
1139
|
+
id: string;
|
|
1140
|
+
}): Promise<Models.Error>;
|
|
1029
1141
|
/**
|
|
1030
|
-
*
|
|
1142
|
+
* Not market-filtered, deliberately: market scoping is a browsing concern,
|
|
1143
|
+
* and somebody holding an id may read the row. A template pinned to a
|
|
1144
|
+
* layout keeps mailing on it whatever market the reader is looking at.
|
|
1031
1145
|
*
|
|
1032
|
-
* @param {string}
|
|
1033
|
-
* @
|
|
1034
|
-
* @
|
|
1035
|
-
* @
|
|
1036
|
-
* @param {string} params.from - Sender number.
|
|
1037
|
-
* @param {string} params.name - Provider name.
|
|
1038
|
-
* @throws {RevenexxAPIRevenexxException}
|
|
1039
|
-
* @returns {Promise<Models.Provider>}
|
|
1146
|
+
* @param {string} id -
|
|
1147
|
+
* @throws {RevenexxException}
|
|
1148
|
+
* @returns {Promise<Models.Error>}
|
|
1149
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1040
1150
|
*/
|
|
1041
|
-
|
|
1042
|
-
|
|
1043
|
-
|
|
1044
|
-
|
|
1045
|
-
|
|
1046
|
-
|
|
1047
|
-
|
|
1048
|
-
|
|
1049
|
-
|
|
1050
|
-
*
|
|
1051
|
-
*
|
|
1052
|
-
*
|
|
1053
|
-
*
|
|
1054
|
-
*
|
|
1055
|
-
*
|
|
1056
|
-
*
|
|
1057
|
-
*
|
|
1058
|
-
*
|
|
1059
|
-
*
|
|
1151
|
+
layoutShow(id: string): Promise<Models.Error>;
|
|
1152
|
+
/**
|
|
1153
|
+
* The change reaches every template on this layout, including ones saved
|
|
1154
|
+
* months ago and never opened since — which is exactly the change nobody
|
|
1155
|
+
* remembers making when the mails start looking wrong. It is audited for
|
|
1156
|
+
* that reason, and only when something actually changed: an audit line on
|
|
1157
|
+
* every save teaches its readers to ignore the log.
|
|
1158
|
+
*
|
|
1159
|
+
* Two 422s. Clearing `is_default` on the current default is
|
|
1160
|
+
* `layout_default_required` — promoting another layout is the operation
|
|
1161
|
+
* that exists for this, and it clears this one as a side effect, which is
|
|
1162
|
+
* the only way the count stays at exactly one. Giving the default a
|
|
1163
|
+
* validity window or switching it off is `layout_default_always_in_force`,
|
|
1164
|
+
* and the check is made of the OUTCOME, so promoting a layout and dating it
|
|
1165
|
+
* in the same request is caught.
|
|
1166
|
+
*
|
|
1167
|
+
* The structural half of a layout — colours, width, font — is baked into
|
|
1168
|
+
* each template's compiled body, so templates already on it keep the old
|
|
1169
|
+
* one until they are recompiled.
|
|
1170
|
+
*
|
|
1171
|
+
* @param {string} params.id -
|
|
1172
|
+
* @throws {RevenexxException}
|
|
1173
|
+
* @returns {Promise<Models.Error>}
|
|
1174
|
+
*/
|
|
1175
|
+
layoutUpdate(params: {
|
|
1176
|
+
id: string;
|
|
1177
|
+
}): Promise<Models.Error>;
|
|
1178
|
+
/**
|
|
1179
|
+
* The change reaches every template on this layout, including ones saved
|
|
1180
|
+
* months ago and never opened since — which is exactly the change nobody
|
|
1181
|
+
* remembers making when the mails start looking wrong. It is audited for
|
|
1182
|
+
* that reason, and only when something actually changed: an audit line on
|
|
1183
|
+
* every save teaches its readers to ignore the log.
|
|
1184
|
+
*
|
|
1185
|
+
* Two 422s. Clearing `is_default` on the current default is
|
|
1186
|
+
* `layout_default_required` — promoting another layout is the operation
|
|
1187
|
+
* that exists for this, and it clears this one as a side effect, which is
|
|
1188
|
+
* the only way the count stays at exactly one. Giving the default a
|
|
1189
|
+
* validity window or switching it off is `layout_default_always_in_force`,
|
|
1190
|
+
* and the check is made of the OUTCOME, so promoting a layout and dating it
|
|
1191
|
+
* in the same request is caught.
|
|
1192
|
+
*
|
|
1193
|
+
* The structural half of a layout — colours, width, font — is baked into
|
|
1194
|
+
* each template's compiled body, so templates already on it keep the old
|
|
1195
|
+
* one until they are recompiled.
|
|
1196
|
+
*
|
|
1197
|
+
* @param {string} id -
|
|
1198
|
+
* @throws {RevenexxException}
|
|
1199
|
+
* @returns {Promise<Models.Error>}
|
|
1060
1200
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1061
1201
|
*/
|
|
1062
|
-
|
|
1202
|
+
layoutUpdate(id: string): Promise<Models.Error>;
|
|
1063
1203
|
/**
|
|
1064
|
-
*
|
|
1204
|
+
* What the Cockpit's "start from a template" gallery is built from. These
|
|
1205
|
+
* are not the tenant's rows and cannot be edited here: provisioning clones
|
|
1206
|
+
* them into `/v1/templates`, and it is the clone that a tenant owns.
|
|
1065
1207
|
*
|
|
1066
|
-
* @param {string} params.
|
|
1067
|
-
* @
|
|
1068
|
-
* @
|
|
1208
|
+
* @param {string} params.channel -
|
|
1209
|
+
* @param {string} params.locale -
|
|
1210
|
+
* @throws {RevenexxException}
|
|
1211
|
+
* @returns {Promise<Models.Error>}
|
|
1069
1212
|
*/
|
|
1070
|
-
|
|
1071
|
-
|
|
1072
|
-
|
|
1213
|
+
libraryIndex(params?: {
|
|
1214
|
+
channel?: string;
|
|
1215
|
+
locale?: string;
|
|
1216
|
+
}): Promise<Models.Error>;
|
|
1073
1217
|
/**
|
|
1074
|
-
*
|
|
1218
|
+
* What the Cockpit's "start from a template" gallery is built from. These
|
|
1219
|
+
* are not the tenant's rows and cannot be edited here: provisioning clones
|
|
1220
|
+
* them into `/v1/templates`, and it is the clone that a tenant owns.
|
|
1075
1221
|
*
|
|
1076
|
-
* @param {string}
|
|
1077
|
-
* @
|
|
1078
|
-
* @
|
|
1222
|
+
* @param {string} channel -
|
|
1223
|
+
* @param {string} locale -
|
|
1224
|
+
* @throws {RevenexxException}
|
|
1225
|
+
* @returns {Promise<Models.Error>}
|
|
1079
1226
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1080
1227
|
*/
|
|
1081
|
-
|
|
1228
|
+
libraryIndex(channel?: string, locale?: string): Promise<Models.Error>;
|
|
1082
1229
|
/**
|
|
1083
|
-
*
|
|
1230
|
+
* `?channel=` and `?status=` narrow it; `?limit=` is clamped to 200 and
|
|
1231
|
+
* defaults to 50. `?channel=inapp` is the tenant's in-app inbox — the
|
|
1232
|
+
* Message row IS the inbox item, so there is no second store for it.
|
|
1084
1233
|
*
|
|
1234
|
+
* Rows are subject to the deployment's retention window and to erasure
|
|
1235
|
+
* requests, so this is not an archive.
|
|
1085
1236
|
*
|
|
1086
|
-
* @param {string} params.
|
|
1087
|
-
* @
|
|
1088
|
-
* @
|
|
1237
|
+
* @param {string} params.channel -
|
|
1238
|
+
* @param {string} params.status -
|
|
1239
|
+
* @throws {RevenexxException}
|
|
1240
|
+
* @returns {Promise<Models.Error>}
|
|
1089
1241
|
*/
|
|
1090
|
-
|
|
1091
|
-
|
|
1092
|
-
|
|
1242
|
+
messageIndex(params?: {
|
|
1243
|
+
channel?: string;
|
|
1244
|
+
status?: string;
|
|
1245
|
+
}): Promise<Models.Error>;
|
|
1093
1246
|
/**
|
|
1094
|
-
*
|
|
1247
|
+
* `?channel=` and `?status=` narrow it; `?limit=` is clamped to 200 and
|
|
1248
|
+
* defaults to 50. `?channel=inapp` is the tenant's in-app inbox — the
|
|
1249
|
+
* Message row IS the inbox item, so there is no second store for it.
|
|
1095
1250
|
*
|
|
1251
|
+
* Rows are subject to the deployment's retention window and to erasure
|
|
1252
|
+
* requests, so this is not an archive.
|
|
1096
1253
|
*
|
|
1097
|
-
* @param {string}
|
|
1098
|
-
* @
|
|
1099
|
-
* @
|
|
1254
|
+
* @param {string} channel -
|
|
1255
|
+
* @param {string} status -
|
|
1256
|
+
* @throws {RevenexxException}
|
|
1257
|
+
* @returns {Promise<Models.Error>}
|
|
1100
1258
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1101
1259
|
*/
|
|
1102
|
-
|
|
1260
|
+
messageIndex(channel?: string, status?: string): Promise<Models.Error>;
|
|
1103
1261
|
/**
|
|
1104
|
-
*
|
|
1262
|
+
* Carries the render model it was sent with, so "why did this mail say
|
|
1263
|
+
* * that" is answerable after the fact. That is also why the row is personal
|
|
1264
|
+
* data and why it can be erased — see POST /v1/privacy/erasures.
|
|
1105
1265
|
*
|
|
1106
|
-
* @param {string} params.
|
|
1107
|
-
* @
|
|
1108
|
-
* @
|
|
1109
|
-
* @throws {RevenexxAPIRevenexxException}
|
|
1110
|
-
* @returns {Promise<Models.LogList>}
|
|
1266
|
+
* @param {string} params.id -
|
|
1267
|
+
* @throws {RevenexxException}
|
|
1268
|
+
* @returns {Promise<Models.Error>}
|
|
1111
1269
|
*/
|
|
1112
|
-
|
|
1113
|
-
|
|
1114
|
-
|
|
1115
|
-
total?: boolean;
|
|
1116
|
-
}): Promise<Models.LogList>;
|
|
1270
|
+
messageShow(params: {
|
|
1271
|
+
id: string;
|
|
1272
|
+
}): Promise<Models.Error>;
|
|
1117
1273
|
/**
|
|
1118
|
-
*
|
|
1274
|
+
* Carries the render model it was sent with, so "why did this mail say
|
|
1275
|
+
* * that" is answerable after the fact. That is also why the row is personal
|
|
1276
|
+
* data and why it can be erased — see POST /v1/privacy/erasures.
|
|
1119
1277
|
*
|
|
1120
|
-
* @param {string}
|
|
1121
|
-
* @
|
|
1122
|
-
* @
|
|
1123
|
-
* @throws {RevenexxAPIRevenexxException}
|
|
1124
|
-
* @returns {Promise<Models.LogList>}
|
|
1278
|
+
* @param {string} id -
|
|
1279
|
+
* @throws {RevenexxException}
|
|
1280
|
+
* @returns {Promise<Models.Error>}
|
|
1125
1281
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1126
1282
|
*/
|
|
1127
|
-
|
|
1283
|
+
messageShow(id: string): Promise<Models.Error>;
|
|
1128
1284
|
/**
|
|
1129
|
-
*
|
|
1285
|
+
* Answers with the resolved subject, HTML and text exactly as a real send
|
|
1286
|
+
* would produce them, so an editor can show a faithful preview without a
|
|
1287
|
+
* message row, a provider call or a suppression check.
|
|
1130
1288
|
*
|
|
1131
|
-
*
|
|
1132
|
-
*
|
|
1133
|
-
*
|
|
1134
|
-
* @throws {RevenexxAPIRevenexxException}
|
|
1135
|
-
* @returns {Promise<Models.LogList>}
|
|
1136
|
-
*/
|
|
1137
|
-
messagingListSubscriberLogs(params: {
|
|
1138
|
-
subscriberId: string;
|
|
1139
|
-
queries?: string[];
|
|
1140
|
-
total?: boolean;
|
|
1141
|
-
}): Promise<Models.LogList>;
|
|
1142
|
-
/**
|
|
1143
|
-
* Get the subscriber activity logs listed by its unique ID.
|
|
1289
|
+
* Takes no `market`, deliberately: rendering picks no provider, so there is
|
|
1290
|
+
* nothing here for a market to change. Nor `send_at`, `draft` or
|
|
1291
|
+
* `attachments` — all of them are properties of a dispatch, not of a render.
|
|
1144
1292
|
*
|
|
1145
|
-
* @param {string}
|
|
1146
|
-
* @param {string
|
|
1147
|
-
* @param {
|
|
1148
|
-
|
|
1149
|
-
|
|
1293
|
+
* @param {string} params.channel -
|
|
1294
|
+
* @param {string} params.template -
|
|
1295
|
+
* @param {object} params.data - The render model: a free map of variable name to value, resolved against the template's
|
|
1296
|
+
placeholders. Values may be strings, numbers, booleans, or nested objects and arrays —
|
|
1297
|
+
`{{ order.number }}` reads a nested one.
|
|
1298
|
+
|
|
1299
|
+
Not the only source. A tenant's `defaults`, its layout, and the template's own
|
|
1300
|
+
`variable_defaults` are merged underneath, so a placeholder an event did not carry can
|
|
1301
|
+
still resolve. Anything named here wins over all of them.
|
|
1302
|
+
* @param {string} params.locale -
|
|
1303
|
+
* @throws {RevenexxException}
|
|
1304
|
+
* @returns {Promise<Models.Error>}
|
|
1305
|
+
*/
|
|
1306
|
+
sendPreview(params: {
|
|
1307
|
+
channel: string;
|
|
1308
|
+
template: string;
|
|
1309
|
+
data?: object;
|
|
1310
|
+
locale?: string;
|
|
1311
|
+
}): Promise<Models.Error>;
|
|
1312
|
+
/**
|
|
1313
|
+
* Answers with the resolved subject, HTML and text exactly as a real send
|
|
1314
|
+
* would produce them, so an editor can show a faithful preview without a
|
|
1315
|
+
* message row, a provider call or a suppression check.
|
|
1316
|
+
*
|
|
1317
|
+
* Takes no `market`, deliberately: rendering picks no provider, so there is
|
|
1318
|
+
* nothing here for a market to change. Nor `send_at`, `draft` or
|
|
1319
|
+
* `attachments` — all of them are properties of a dispatch, not of a render.
|
|
1320
|
+
*
|
|
1321
|
+
* @param {string} channel -
|
|
1322
|
+
* @param {string} template -
|
|
1323
|
+
* @param {object} data - The render model: a free map of variable name to value, resolved against the template's
|
|
1324
|
+
placeholders. Values may be strings, numbers, booleans, or nested objects and arrays —
|
|
1325
|
+
`{{ order.number }}` reads a nested one.
|
|
1326
|
+
|
|
1327
|
+
Not the only source. A tenant's `defaults`, its layout, and the template's own
|
|
1328
|
+
`variable_defaults` are merged underneath, so a placeholder an event did not carry can
|
|
1329
|
+
still resolve. Anything named here wins over all of them.
|
|
1330
|
+
* @param {string} locale -
|
|
1331
|
+
* @throws {RevenexxException}
|
|
1332
|
+
* @returns {Promise<Models.Error>}
|
|
1333
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1334
|
+
*/
|
|
1335
|
+
sendPreview(channel: string, template: string, data?: object, locale?: string): Promise<Models.Error>;
|
|
1336
|
+
/**
|
|
1337
|
+
* Per (channel, address), because an address is channel-shaped and the rows
|
|
1338
|
+
* it has to line up with are keyed that way. Matching is done on the
|
|
1339
|
+
* normalised form on both sides, so a request for `ada@acme.test` finds a
|
|
1340
|
+
* log written for `Ada@Acme.test` — an erasure that misses on
|
|
1341
|
+
* capitalisation is an erasure that did not happen and reports success.
|
|
1342
|
+
*
|
|
1343
|
+
* Message rows and unsubscribe tokens are DELETED. Suppressions are KEPT
|
|
1344
|
+
* with the clear-text address nulled: matching runs on a keyed hash, so the
|
|
1345
|
+
* row can still block and can no longer identify. Deleting it instead is
|
|
1346
|
+
* the obvious reading of "erase everything about them", and it is the
|
|
1347
|
+
* reading that mails a dead address again next week — or mails somebody who
|
|
1348
|
+
* complained, which is how a sending domain gets blocked.
|
|
1349
|
+
*
|
|
1350
|
+
* Answers with the counts, `suppressions_kept` among them, so the design is
|
|
1351
|
+
* stated in the response rather than only in this paragraph.
|
|
1352
|
+
*
|
|
1353
|
+
* @param {string} params.address -
|
|
1354
|
+
* @param {string} params.channel - Per (channel, address), not per address: an address is
|
|
1355
|
+
channel-shaped, and the suppression and token rows it has to line
|
|
1356
|
+
up with are keyed that way.
|
|
1357
|
+
* @throws {RevenexxException}
|
|
1358
|
+
* @returns {Promise<Models.Error>}
|
|
1359
|
+
*/
|
|
1360
|
+
erasureStore(params: {
|
|
1361
|
+
address: string;
|
|
1362
|
+
channel: string;
|
|
1363
|
+
}): Promise<Models.Error>;
|
|
1364
|
+
/**
|
|
1365
|
+
* Per (channel, address), because an address is channel-shaped and the rows
|
|
1366
|
+
* it has to line up with are keyed that way. Matching is done on the
|
|
1367
|
+
* normalised form on both sides, so a request for `ada@acme.test` finds a
|
|
1368
|
+
* log written for `Ada@Acme.test` — an erasure that misses on
|
|
1369
|
+
* capitalisation is an erasure that did not happen and reports success.
|
|
1370
|
+
*
|
|
1371
|
+
* Message rows and unsubscribe tokens are DELETED. Suppressions are KEPT
|
|
1372
|
+
* with the clear-text address nulled: matching runs on a keyed hash, so the
|
|
1373
|
+
* row can still block and can no longer identify. Deleting it instead is
|
|
1374
|
+
* the obvious reading of "erase everything about them", and it is the
|
|
1375
|
+
* reading that mails a dead address again next week — or mails somebody who
|
|
1376
|
+
* complained, which is how a sending domain gets blocked.
|
|
1377
|
+
*
|
|
1378
|
+
* Answers with the counts, `suppressions_kept` among them, so the design is
|
|
1379
|
+
* stated in the response rather than only in this paragraph.
|
|
1380
|
+
*
|
|
1381
|
+
* @param {string} address -
|
|
1382
|
+
* @param {string} channel - Per (channel, address), not per address: an address is
|
|
1383
|
+
channel-shaped, and the suppression and token rows it has to line
|
|
1384
|
+
up with are keyed that way.
|
|
1385
|
+
* @throws {RevenexxException}
|
|
1386
|
+
* @returns {Promise<Models.Error>}
|
|
1150
1387
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1151
1388
|
*/
|
|
1152
|
-
|
|
1389
|
+
erasureStore(address: string, channel: string): Promise<Models.Error>;
|
|
1153
1390
|
/**
|
|
1154
|
-
*
|
|
1391
|
+
* By endpoint and not by id, because the browser knows its endpoint and has
|
|
1392
|
+
* never seen our id — this is called from a service worker reacting to
|
|
1393
|
+
* `pushsubscriptionchange`, or from a "turn off notifications" button.
|
|
1155
1394
|
*
|
|
1156
|
-
* @param {string
|
|
1157
|
-
* @
|
|
1158
|
-
* @
|
|
1159
|
-
* @throws {RevenexxAPIRevenexxException}
|
|
1160
|
-
* @returns {Promise<Models.TopicList>}
|
|
1395
|
+
* @param {string} params.endpoint -
|
|
1396
|
+
* @throws {RevenexxException}
|
|
1397
|
+
* @returns {Promise<Models.Error>}
|
|
1161
1398
|
*/
|
|
1162
|
-
|
|
1163
|
-
|
|
1164
|
-
|
|
1165
|
-
total?: boolean;
|
|
1166
|
-
}): Promise<Models.TopicList>;
|
|
1399
|
+
pushSubscriptionDestroy(params: {
|
|
1400
|
+
endpoint: string;
|
|
1401
|
+
}): Promise<Models.Error>;
|
|
1167
1402
|
/**
|
|
1168
|
-
*
|
|
1403
|
+
* By endpoint and not by id, because the browser knows its endpoint and has
|
|
1404
|
+
* never seen our id — this is called from a service worker reacting to
|
|
1405
|
+
* `pushsubscriptionchange`, or from a "turn off notifications" button.
|
|
1169
1406
|
*
|
|
1170
|
-
* @param {string
|
|
1171
|
-
* @
|
|
1172
|
-
* @
|
|
1173
|
-
* @throws {RevenexxAPIRevenexxException}
|
|
1174
|
-
* @returns {Promise<Models.TopicList>}
|
|
1407
|
+
* @param {string} endpoint -
|
|
1408
|
+
* @throws {RevenexxException}
|
|
1409
|
+
* @returns {Promise<Models.Error>}
|
|
1175
1410
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1176
1411
|
*/
|
|
1177
|
-
|
|
1412
|
+
pushSubscriptionDestroy(endpoint: string): Promise<Models.Error>;
|
|
1178
1413
|
/**
|
|
1179
|
-
*
|
|
1414
|
+
* `subscriber_id` is required: this is not a list of everybody, and there
|
|
1415
|
+
* is no route that is. The caller is a storefront acting for one visitor
|
|
1416
|
+
* and has no business enumerating the rest.
|
|
1180
1417
|
*
|
|
1181
|
-
*
|
|
1182
|
-
*
|
|
1183
|
-
*
|
|
1184
|
-
*
|
|
1185
|
-
* @
|
|
1418
|
+
* The client key material is never returned — see the `$hidden` list on the
|
|
1419
|
+
* model. A registration that can be read back is a registration somebody
|
|
1420
|
+
* else can push with.
|
|
1421
|
+
*
|
|
1422
|
+
* @param {string} params.subscriberId -
|
|
1423
|
+
* @throws {RevenexxException}
|
|
1424
|
+
* @returns {Promise<Models.Error>}
|
|
1186
1425
|
*/
|
|
1187
|
-
|
|
1188
|
-
|
|
1189
|
-
|
|
1190
|
-
subscribe?: string[];
|
|
1191
|
-
}): Promise<Models.Topic>;
|
|
1426
|
+
pushSubscriptionIndex(params: {
|
|
1427
|
+
subscriberId: string;
|
|
1428
|
+
}): Promise<Models.Error>;
|
|
1192
1429
|
/**
|
|
1193
|
-
*
|
|
1430
|
+
* `subscriber_id` is required: this is not a list of everybody, and there
|
|
1431
|
+
* is no route that is. The caller is a storefront acting for one visitor
|
|
1432
|
+
* and has no business enumerating the rest.
|
|
1194
1433
|
*
|
|
1195
|
-
*
|
|
1196
|
-
*
|
|
1197
|
-
*
|
|
1198
|
-
*
|
|
1199
|
-
* @
|
|
1434
|
+
* The client key material is never returned — see the `$hidden` list on the
|
|
1435
|
+
* model. A registration that can be read back is a registration somebody
|
|
1436
|
+
* else can push with.
|
|
1437
|
+
*
|
|
1438
|
+
* @param {string} subscriberId -
|
|
1439
|
+
* @throws {RevenexxException}
|
|
1440
|
+
* @returns {Promise<Models.Error>}
|
|
1200
1441
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1201
1442
|
*/
|
|
1202
|
-
|
|
1203
|
-
/**
|
|
1204
|
-
*
|
|
1205
|
-
*
|
|
1206
|
-
*
|
|
1207
|
-
*
|
|
1208
|
-
*
|
|
1443
|
+
pushSubscriptionIndex(subscriberId: string): Promise<Models.Error>;
|
|
1444
|
+
/**
|
|
1445
|
+
* Send what `PushManager.subscribe()` handed back — the endpoint and the
|
|
1446
|
+
* two keys — plus the id you know that person by. The VAPID public key the
|
|
1447
|
+
* browser needs to produce it comes from `GET /v1/config`
|
|
1448
|
+
* (`meta.push_public_key`).
|
|
1449
|
+
*
|
|
1450
|
+
* **Idempotent by endpoint**, and the two statuses say which happened: 201
|
|
1451
|
+
* for a browser seen for the first time, 200 for one already registered. A
|
|
1452
|
+
* browser calls `subscribe()` on every page load and hands back the same
|
|
1453
|
+
* endpoint each time; treating that as a new device would give one laptop a
|
|
1454
|
+
* thousand rows and push to it a thousand times.
|
|
1455
|
+
*
|
|
1456
|
+
* @param {string} params.endpoint -
|
|
1457
|
+
* @param {object} params.keys -
|
|
1458
|
+
* @param {string} params.subscriberId -
|
|
1459
|
+
* @param {string} params.userAgent -
|
|
1460
|
+
* @throws {RevenexxException}
|
|
1461
|
+
* @returns {Promise<Models.Error>}
|
|
1462
|
+
*/
|
|
1463
|
+
pushSubscriptionStore(params: {
|
|
1464
|
+
endpoint: string;
|
|
1465
|
+
keys: object;
|
|
1466
|
+
subscriberId: string;
|
|
1467
|
+
userAgent?: string;
|
|
1468
|
+
}): Promise<Models.Error>;
|
|
1469
|
+
/**
|
|
1470
|
+
* Send what `PushManager.subscribe()` handed back — the endpoint and the
|
|
1471
|
+
* two keys — plus the id you know that person by. The VAPID public key the
|
|
1472
|
+
* browser needs to produce it comes from `GET /v1/config`
|
|
1473
|
+
* (`meta.push_public_key`).
|
|
1474
|
+
*
|
|
1475
|
+
* **Idempotent by endpoint**, and the two statuses say which happened: 201
|
|
1476
|
+
* for a browser seen for the first time, 200 for one already registered. A
|
|
1477
|
+
* browser calls `subscribe()` on every page load and hands back the same
|
|
1478
|
+
* endpoint each time; treating that as a new device would give one laptop a
|
|
1479
|
+
* thousand rows and push to it a thousand times.
|
|
1480
|
+
*
|
|
1481
|
+
* @param {string} endpoint -
|
|
1482
|
+
* @param {object} keys -
|
|
1483
|
+
* @param {string} subscriberId -
|
|
1484
|
+
* @param {string} userAgent -
|
|
1485
|
+
* @throws {RevenexxException}
|
|
1486
|
+
* @returns {Promise<Models.Error>}
|
|
1487
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1209
1488
|
*/
|
|
1210
|
-
|
|
1211
|
-
|
|
1212
|
-
|
|
1213
|
-
|
|
1214
|
-
*
|
|
1215
|
-
*
|
|
1216
|
-
*
|
|
1217
|
-
*
|
|
1218
|
-
*
|
|
1489
|
+
pushSubscriptionStore(endpoint: string, keys: object, subscriberId: string, userAgent?: string): Promise<Models.Error>;
|
|
1490
|
+
/**
|
|
1491
|
+
* Renders a tenant template and dispatches it — now, at `send_at`, or at
|
|
1492
|
+
* the end of the tenant's quiet hours.
|
|
1493
|
+
*
|
|
1494
|
+
* The first line is deliberately a title, not a sentence about the
|
|
1495
|
+
* mechanism: Scramble takes it as the operation's `summary`, and a summary
|
|
1496
|
+
* is what an API explorer prints in its route list. The paragraph that used
|
|
1497
|
+
* to be here ran to 119 characters across two lines, which the gateway's
|
|
1498
|
+
* fragment tests reject for exactly that reason.
|
|
1499
|
+
*
|
|
1500
|
+
* Retry-safe when the caller sends an `Idempotency-Key` header. The two
|
|
1501
|
+
* answers are deliberately different:
|
|
1502
|
+
*
|
|
1503
|
+
* 201 — a message was created by THIS call
|
|
1504
|
+
* 200 — this key was already used; here is the message it produced
|
|
1505
|
+
*
|
|
1506
|
+
* A caller has to be able to tell those apart. "Your mail went out" and
|
|
1507
|
+
* "your mail had already gone out" are the same outcome and different
|
|
1508
|
+
* facts, and a client reconciling its own records needs the second one.
|
|
1509
|
+
* Same key with a different body is a 422 — see IdempotencyConflict.
|
|
1510
|
+
*
|
|
1511
|
+
* A recipient on the tenant's suppression list is not sent to, and that is
|
|
1512
|
+
* reported as a refusal rather than as a silent success.
|
|
1513
|
+
*
|
|
1514
|
+
* @param {string} params.channel -
|
|
1515
|
+
* @param {string} params.template -
|
|
1516
|
+
* @param {string} params.to -
|
|
1517
|
+
* @param {object[]} params.attachments - Files travelling with the message. Base64 content, never a URL:
|
|
1518
|
+
fetching an address that arrives in a request body would make
|
|
1519
|
+
this service a request-forwarder inside the platform network —
|
|
1520
|
+
see App\Support\Attachment.
|
|
1521
|
+
* @param {object} params.data - The render model: a free map of variable name to value, resolved against the template's
|
|
1522
|
+
placeholders. Values may be strings, numbers, booleans, or nested objects and arrays —
|
|
1523
|
+
`{{ order.number }}` reads a nested one.
|
|
1524
|
+
|
|
1525
|
+
Not the only source. A tenant's `defaults`, its layout, and the template's own
|
|
1526
|
+
`variable_defaults` are merged underneath, so a placeholder an event did not carry can
|
|
1527
|
+
still resolve. Anything named here wins over all of them.
|
|
1528
|
+
* @param {boolean} params.draft - A TEST SEND. Renders the draft instead of the published snapshot,
|
|
1529
|
+
which is the only way an author can check a correction in a real
|
|
1530
|
+
mail client before it goes live to everybody. Deliberately a flag on this route and not a route of its own:
|
|
1531
|
+
everything else about it — suppression, quiet hours, the
|
|
1532
|
+
language chain, idempotency — has to behave exactly as a real
|
|
1533
|
+
send, and a second endpoint is a second set of those rules that
|
|
1534
|
+
drifts. The one difference is which fassung is rendered.
|
|
1535
|
+
* @param {string} params.locale - The language the CALLER states — step 1 of the resolution order,
|
|
1536
|
+
ahead of anything in the payload. Absent is normal and is not
|
|
1537
|
+
"English": it means the recipient's own language decides.
|
|
1538
|
+
* @param {string} params.market - Which market this send belongs to. Absent means the GLOBAL
|
|
1539
|
+
market, which is what every send was before markets reached this
|
|
1540
|
+
path — so a caller that never heard of them keeps working and
|
|
1541
|
+
gets the credentials it always had. The caller states it; nothing here derives it. A country code on
|
|
1542
|
+
a phone number is a fact and a domain on an address is a guess,
|
|
1543
|
+
and a guess that decides which carrier carries a message would
|
|
1544
|
+
look exactly like a decision somebody made.
|
|
1545
|
+
|
|
1546
|
+
Not on `preview`: rendering picks no provider, so there is
|
|
1547
|
+
nothing there for a market to change.
|
|
1548
|
+
* @param {string} params.sendAt - Send later. A time in the past is accepted and means now — a
|
|
1549
|
+
client retrying a request it built ten minutes ago is asking for
|
|
1550
|
+
the same send, and refusing it turns a late retry into a lost
|
|
1551
|
+
message.
|
|
1552
|
+
* @throws {RevenexxException}
|
|
1553
|
+
* @returns {Promise<Models.Error>}
|
|
1554
|
+
*/
|
|
1555
|
+
sendSend(params: {
|
|
1556
|
+
channel: string;
|
|
1557
|
+
template: string;
|
|
1558
|
+
to: string;
|
|
1559
|
+
attachments?: object[];
|
|
1560
|
+
data?: object;
|
|
1561
|
+
draft?: boolean;
|
|
1562
|
+
locale?: string;
|
|
1563
|
+
market?: string;
|
|
1564
|
+
sendAt?: string;
|
|
1565
|
+
}): Promise<Models.Error>;
|
|
1566
|
+
/**
|
|
1567
|
+
* Renders a tenant template and dispatches it — now, at `send_at`, or at
|
|
1568
|
+
* the end of the tenant's quiet hours.
|
|
1569
|
+
*
|
|
1570
|
+
* The first line is deliberately a title, not a sentence about the
|
|
1571
|
+
* mechanism: Scramble takes it as the operation's `summary`, and a summary
|
|
1572
|
+
* is what an API explorer prints in its route list. The paragraph that used
|
|
1573
|
+
* to be here ran to 119 characters across two lines, which the gateway's
|
|
1574
|
+
* fragment tests reject for exactly that reason.
|
|
1575
|
+
*
|
|
1576
|
+
* Retry-safe when the caller sends an `Idempotency-Key` header. The two
|
|
1577
|
+
* answers are deliberately different:
|
|
1578
|
+
*
|
|
1579
|
+
* 201 — a message was created by THIS call
|
|
1580
|
+
* 200 — this key was already used; here is the message it produced
|
|
1581
|
+
*
|
|
1582
|
+
* A caller has to be able to tell those apart. "Your mail went out" and
|
|
1583
|
+
* "your mail had already gone out" are the same outcome and different
|
|
1584
|
+
* facts, and a client reconciling its own records needs the second one.
|
|
1585
|
+
* Same key with a different body is a 422 — see IdempotencyConflict.
|
|
1586
|
+
*
|
|
1587
|
+
* A recipient on the tenant's suppression list is not sent to, and that is
|
|
1588
|
+
* reported as a refusal rather than as a silent success.
|
|
1589
|
+
*
|
|
1590
|
+
* @param {string} channel -
|
|
1591
|
+
* @param {string} template -
|
|
1592
|
+
* @param {string} to -
|
|
1593
|
+
* @param {object[]} attachments - Files travelling with the message. Base64 content, never a URL:
|
|
1594
|
+
fetching an address that arrives in a request body would make
|
|
1595
|
+
this service a request-forwarder inside the platform network —
|
|
1596
|
+
see App\Support\Attachment.
|
|
1597
|
+
* @param {object} data - The render model: a free map of variable name to value, resolved against the template's
|
|
1598
|
+
placeholders. Values may be strings, numbers, booleans, or nested objects and arrays —
|
|
1599
|
+
`{{ order.number }}` reads a nested one.
|
|
1600
|
+
|
|
1601
|
+
Not the only source. A tenant's `defaults`, its layout, and the template's own
|
|
1602
|
+
`variable_defaults` are merged underneath, so a placeholder an event did not carry can
|
|
1603
|
+
still resolve. Anything named here wins over all of them.
|
|
1604
|
+
* @param {boolean} draft - A TEST SEND. Renders the draft instead of the published snapshot,
|
|
1605
|
+
which is the only way an author can check a correction in a real
|
|
1606
|
+
mail client before it goes live to everybody. Deliberately a flag on this route and not a route of its own:
|
|
1607
|
+
everything else about it — suppression, quiet hours, the
|
|
1608
|
+
language chain, idempotency — has to behave exactly as a real
|
|
1609
|
+
send, and a second endpoint is a second set of those rules that
|
|
1610
|
+
drifts. The one difference is which fassung is rendered.
|
|
1611
|
+
* @param {string} locale - The language the CALLER states — step 1 of the resolution order,
|
|
1612
|
+
ahead of anything in the payload. Absent is normal and is not
|
|
1613
|
+
"English": it means the recipient's own language decides.
|
|
1614
|
+
* @param {string} market - Which market this send belongs to. Absent means the GLOBAL
|
|
1615
|
+
market, which is what every send was before markets reached this
|
|
1616
|
+
path — so a caller that never heard of them keeps working and
|
|
1617
|
+
gets the credentials it always had. The caller states it; nothing here derives it. A country code on
|
|
1618
|
+
a phone number is a fact and a domain on an address is a guess,
|
|
1619
|
+
and a guess that decides which carrier carries a message would
|
|
1620
|
+
look exactly like a decision somebody made.
|
|
1621
|
+
|
|
1622
|
+
Not on `preview`: rendering picks no provider, so there is
|
|
1623
|
+
nothing there for a market to change.
|
|
1624
|
+
* @param {string} sendAt - Send later. A time in the past is accepted and means now — a
|
|
1625
|
+
client retrying a request it built ten minutes ago is asking for
|
|
1626
|
+
the same send, and refusing it turns a late retry into a lost
|
|
1627
|
+
message.
|
|
1628
|
+
* @throws {RevenexxException}
|
|
1629
|
+
* @returns {Promise<Models.Error>}
|
|
1219
1630
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1220
1631
|
*/
|
|
1221
|
-
|
|
1222
|
-
/**
|
|
1223
|
-
*
|
|
1224
|
-
*
|
|
1225
|
-
*
|
|
1226
|
-
*
|
|
1227
|
-
*
|
|
1228
|
-
*
|
|
1632
|
+
sendSend(channel: string, template: string, to: string, attachments?: object[], data?: object, draft?: boolean, locale?: string, market?: string, sendAt?: string): Promise<Models.Error>;
|
|
1633
|
+
/**
|
|
1634
|
+
* Either `days` (a window ending now, default 30) or an explicit `from`/`to`
|
|
1635
|
+
* span. Both ends of the span or neither: `from` alone would be an open
|
|
1636
|
+
* range and the service would have to guess which end was meant.
|
|
1637
|
+
*
|
|
1638
|
+
* Three numbers are deliberately not the naive ones, and the `window` block
|
|
1639
|
+
* says so rather than leaving a chart to imply otherwise. The window is
|
|
1640
|
+
* CLAMPED to the tenant's retention, and `clamped_by_retention` says when
|
|
1641
|
+
* that happened — 90 days on a 30-day retention is 30 days of data wearing
|
|
1642
|
+
* a 90-day label, and the trend line it draws invents a collapse that never
|
|
1643
|
+
* happened. Opens are counted only over channels that can report them; SMS
|
|
1644
|
+
* and push have no such thing, so dividing opens by all messages would
|
|
1645
|
+
* quietly halve every open rate the moment a tenant adds a second channel.
|
|
1646
|
+
* The delivery rate is sent ÷ (sent + failed): suppressed is the service
|
|
1647
|
+
* doing what it was told, and counting it as a failure would punish a
|
|
1648
|
+
* tenant for having a working unsubscribe list.
|
|
1649
|
+
*
|
|
1650
|
+
* `previous` is the same window again immediately before this one, which is
|
|
1651
|
+
* what turns a figure into a direction. **It is null** whenever the
|
|
1652
|
+
* preceding window is not entirely inside retention: the query would answer
|
|
1653
|
+
* zero rather than fail, and zero against 1,337 renders as a triumphant
|
|
1654
|
+
* +100 % beside every tile on the screen. Show no trend rather than a
|
|
1655
|
+
* flattering one.
|
|
1656
|
+
*
|
|
1657
|
+
* Nothing here names a recipient. That is the delivery log, which is a
|
|
1658
|
+
* different endpoint with a different question.
|
|
1659
|
+
*
|
|
1660
|
+
* @param {number} params.days - Clamped and possibly shortened by retention inside the service,
|
|
1661
|
+
which reports what it actually used.
|
|
1662
|
+
* @param {string} params.from - An explicit span, for a window that does not end today. Both
|
|
1663
|
+
ends or neither: `from` alone would be an open range, and the
|
|
1664
|
+
service would have to guess which end was meant.
|
|
1665
|
+
`nullable` rather than `sometimes`, so `required_with` still
|
|
1666
|
+
runs when the OTHER end is missing. With `sometimes` an absent
|
|
1667
|
+
field is skipped entirely, and `?from=` alone sailed through to
|
|
1668
|
+
become a window nobody asked for.
|
|
1669
|
+
* @param {string} params.to - The other end of the same span, inclusive: the whole of this day
|
|
1670
|
+
is inside the window whatever time its rows carry. A span running
|
|
1671
|
+
past today ends today — there is no data ahead of now, and a
|
|
1672
|
+
window with a future edge draws the series short against an axis
|
|
1673
|
+
claiming a month nobody has lived through.
|
|
1674
|
+
* @throws {RevenexxException}
|
|
1675
|
+
* @returns {Promise<Models.Error>}
|
|
1676
|
+
*/
|
|
1677
|
+
statsIndex(params?: {
|
|
1678
|
+
days?: number;
|
|
1679
|
+
from?: string;
|
|
1680
|
+
to?: string;
|
|
1681
|
+
}): Promise<Models.Error>;
|
|
1682
|
+
/**
|
|
1683
|
+
* Either `days` (a window ending now, default 30) or an explicit `from`/`to`
|
|
1684
|
+
* span. Both ends of the span or neither: `from` alone would be an open
|
|
1685
|
+
* range and the service would have to guess which end was meant.
|
|
1686
|
+
*
|
|
1687
|
+
* Three numbers are deliberately not the naive ones, and the `window` block
|
|
1688
|
+
* says so rather than leaving a chart to imply otherwise. The window is
|
|
1689
|
+
* CLAMPED to the tenant's retention, and `clamped_by_retention` says when
|
|
1690
|
+
* that happened — 90 days on a 30-day retention is 30 days of data wearing
|
|
1691
|
+
* a 90-day label, and the trend line it draws invents a collapse that never
|
|
1692
|
+
* happened. Opens are counted only over channels that can report them; SMS
|
|
1693
|
+
* and push have no such thing, so dividing opens by all messages would
|
|
1694
|
+
* quietly halve every open rate the moment a tenant adds a second channel.
|
|
1695
|
+
* The delivery rate is sent ÷ (sent + failed): suppressed is the service
|
|
1696
|
+
* doing what it was told, and counting it as a failure would punish a
|
|
1697
|
+
* tenant for having a working unsubscribe list.
|
|
1698
|
+
*
|
|
1699
|
+
* `previous` is the same window again immediately before this one, which is
|
|
1700
|
+
* what turns a figure into a direction. **It is null** whenever the
|
|
1701
|
+
* preceding window is not entirely inside retention: the query would answer
|
|
1702
|
+
* zero rather than fail, and zero against 1,337 renders as a triumphant
|
|
1703
|
+
* +100 % beside every tile on the screen. Show no trend rather than a
|
|
1704
|
+
* flattering one.
|
|
1705
|
+
*
|
|
1706
|
+
* Nothing here names a recipient. That is the delivery log, which is a
|
|
1707
|
+
* different endpoint with a different question.
|
|
1708
|
+
*
|
|
1709
|
+
* @param {number} days - Clamped and possibly shortened by retention inside the service,
|
|
1710
|
+
which reports what it actually used.
|
|
1711
|
+
* @param {string} from - An explicit span, for a window that does not end today. Both
|
|
1712
|
+
ends or neither: `from` alone would be an open range, and the
|
|
1713
|
+
service would have to guess which end was meant.
|
|
1714
|
+
`nullable` rather than `sometimes`, so `required_with` still
|
|
1715
|
+
runs when the OTHER end is missing. With `sometimes` an absent
|
|
1716
|
+
field is skipped entirely, and `?from=` alone sailed through to
|
|
1717
|
+
become a window nobody asked for.
|
|
1718
|
+
* @param {string} to - The other end of the same span, inclusive: the whole of this day
|
|
1719
|
+
is inside the window whatever time its rows carry. A span running
|
|
1720
|
+
past today ends today — there is no data ahead of now, and a
|
|
1721
|
+
window with a future edge draws the series short against an axis
|
|
1722
|
+
claiming a month nobody has lived through.
|
|
1723
|
+
* @throws {RevenexxException}
|
|
1724
|
+
* @returns {Promise<Models.Error>}
|
|
1725
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1229
1726
|
*/
|
|
1230
|
-
|
|
1231
|
-
|
|
1232
|
-
|
|
1233
|
-
|
|
1234
|
-
*
|
|
1235
|
-
*
|
|
1236
|
-
*
|
|
1237
|
-
*
|
|
1238
|
-
* @
|
|
1239
|
-
* @
|
|
1727
|
+
statsIndex(days?: number, from?: string, to?: string): Promise<Models.Error>;
|
|
1728
|
+
/**
|
|
1729
|
+
* Filterable by `channel`, `scope`, `reason` and `address`. The address
|
|
1730
|
+
* filter is looked up by FINGERPRINT rather than against the address
|
|
1731
|
+
* column, which is what makes "why did this person stop getting our mail"
|
|
1732
|
+
* answerable for somebody who has since been erased: the row has no
|
|
1733
|
+
* address left to match on, and the question is still the same question.
|
|
1734
|
+
*
|
|
1735
|
+
* @param {string} params.channel -
|
|
1736
|
+
* @param {Scope} params.scope -
|
|
1737
|
+
* @param {Reason} params.reason -
|
|
1738
|
+
* @param {string} params.address -
|
|
1739
|
+
* @param {number} params.limit -
|
|
1740
|
+
* @throws {RevenexxException}
|
|
1741
|
+
* @returns {Promise<Models.Error>}
|
|
1742
|
+
*/
|
|
1743
|
+
suppressionIndex(params?: {
|
|
1744
|
+
channel?: string;
|
|
1745
|
+
scope?: Scope;
|
|
1746
|
+
reason?: Reason;
|
|
1747
|
+
address?: string;
|
|
1748
|
+
limit?: number;
|
|
1749
|
+
}): Promise<Models.Error>;
|
|
1750
|
+
/**
|
|
1751
|
+
* Filterable by `channel`, `scope`, `reason` and `address`. The address
|
|
1752
|
+
* filter is looked up by FINGERPRINT rather than against the address
|
|
1753
|
+
* column, which is what makes "why did this person stop getting our mail"
|
|
1754
|
+
* answerable for somebody who has since been erased: the row has no
|
|
1755
|
+
* address left to match on, and the question is still the same question.
|
|
1756
|
+
*
|
|
1757
|
+
* @param {string} channel -
|
|
1758
|
+
* @param {Scope} scope -
|
|
1759
|
+
* @param {Reason} reason -
|
|
1760
|
+
* @param {string} address -
|
|
1761
|
+
* @param {number} limit -
|
|
1762
|
+
* @throws {RevenexxException}
|
|
1763
|
+
* @returns {Promise<Models.Error>}
|
|
1240
1764
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1241
1765
|
*/
|
|
1242
|
-
|
|
1766
|
+
suppressionIndex(channel?: string, scope?: Scope, reason?: Reason, address?: string, limit?: number): Promise<Models.Error>;
|
|
1767
|
+
/**
|
|
1768
|
+
* 201 for a row this call created, 200 for an address that was already on
|
|
1769
|
+
* the list — so a client can tell whether it changed anything.
|
|
1770
|
+
*
|
|
1771
|
+
* The `scope` follows from the `reason` for every reason but `manual`, and
|
|
1772
|
+
* asking for a different one is 422 `suppression_scope_fixed` rather than
|
|
1773
|
+
* being quietly corrected: a caller who asked for `marketing` on a hard
|
|
1774
|
+
* bounce has the model wrong, and a silent upgrade to `all` would leave
|
|
1775
|
+
* them believing transactional mail still flows to an address that does not
|
|
1776
|
+
* exist.
|
|
1777
|
+
*
|
|
1778
|
+
* @param {string} params.address -
|
|
1779
|
+
* @param {string} params.channel -
|
|
1780
|
+
* @param {Reason} params.reason -
|
|
1781
|
+
* @param {string} params.expiresAt -
|
|
1782
|
+
* @param {string} params.note -
|
|
1783
|
+
* @param {Scope} params.scope -
|
|
1784
|
+
* @throws {RevenexxException}
|
|
1785
|
+
* @returns {Promise<Models.Error>}
|
|
1786
|
+
*/
|
|
1787
|
+
suppressionStore(params: {
|
|
1788
|
+
address: string;
|
|
1789
|
+
channel: string;
|
|
1790
|
+
reason: Reason;
|
|
1791
|
+
expiresAt?: string;
|
|
1792
|
+
note?: string;
|
|
1793
|
+
scope?: Scope;
|
|
1794
|
+
}): Promise<Models.Error>;
|
|
1795
|
+
/**
|
|
1796
|
+
* 201 for a row this call created, 200 for an address that was already on
|
|
1797
|
+
* the list — so a client can tell whether it changed anything.
|
|
1798
|
+
*
|
|
1799
|
+
* The `scope` follows from the `reason` for every reason but `manual`, and
|
|
1800
|
+
* asking for a different one is 422 `suppression_scope_fixed` rather than
|
|
1801
|
+
* being quietly corrected: a caller who asked for `marketing` on a hard
|
|
1802
|
+
* bounce has the model wrong, and a silent upgrade to `all` would leave
|
|
1803
|
+
* them believing transactional mail still flows to an address that does not
|
|
1804
|
+
* exist.
|
|
1805
|
+
*
|
|
1806
|
+
* @param {string} address -
|
|
1807
|
+
* @param {string} channel -
|
|
1808
|
+
* @param {Reason} reason -
|
|
1809
|
+
* @param {string} expiresAt -
|
|
1810
|
+
* @param {string} note -
|
|
1811
|
+
* @param {Scope} scope -
|
|
1812
|
+
* @throws {RevenexxException}
|
|
1813
|
+
* @returns {Promise<Models.Error>}
|
|
1814
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1815
|
+
*/
|
|
1816
|
+
suppressionStore(address: string, channel: string, reason: Reason, expiresAt?: string, note?: string, scope?: Scope): Promise<Models.Error>;
|
|
1243
1817
|
/**
|
|
1244
|
-
*
|
|
1245
|
-
*
|
|
1818
|
+
* Audited, unlike most deletes in this service. Removing a row here is the
|
|
1819
|
+
* one operation that makes the service mail an address something decided
|
|
1820
|
+
* not to mail — if a complaint turns into a spam report later, "who took
|
|
1821
|
+
* * this off the list, and when" is the whole investigation.
|
|
1246
1822
|
*
|
|
1247
|
-
* @param {string} params.
|
|
1248
|
-
* @
|
|
1249
|
-
* @
|
|
1250
|
-
* @throws {RevenexxAPIRevenexxException}
|
|
1251
|
-
* @returns {Promise<Models.Topic>}
|
|
1823
|
+
* @param {string} params.id -
|
|
1824
|
+
* @throws {RevenexxException}
|
|
1825
|
+
* @returns {Promise<Models.Error>}
|
|
1252
1826
|
*/
|
|
1253
|
-
|
|
1254
|
-
|
|
1255
|
-
|
|
1256
|
-
subscribe?: string[];
|
|
1257
|
-
}): Promise<Models.Topic>;
|
|
1827
|
+
suppressionDestroy(params: {
|
|
1828
|
+
id: string;
|
|
1829
|
+
}): Promise<Models.Error>;
|
|
1258
1830
|
/**
|
|
1259
|
-
*
|
|
1831
|
+
* Audited, unlike most deletes in this service. Removing a row here is the
|
|
1832
|
+
* one operation that makes the service mail an address something decided
|
|
1833
|
+
* not to mail — if a complaint turns into a spam report later, "who took
|
|
1834
|
+
* * this off the list, and when" is the whole investigation.
|
|
1260
1835
|
*
|
|
1261
|
-
*
|
|
1262
|
-
* @
|
|
1263
|
-
* @
|
|
1264
|
-
* @param {string[]} subscribe - An array of role strings with subscribe permission. By default all users are granted with any subscribe permission. [learn more about roles](https://appwrite.io/docs/permissions#permission-roles). Maximum of 100 roles are allowed, each 64 characters long.
|
|
1265
|
-
* @throws {RevenexxAPIRevenexxException}
|
|
1266
|
-
* @returns {Promise<Models.Topic>}
|
|
1836
|
+
* @param {string} id -
|
|
1837
|
+
* @throws {RevenexxException}
|
|
1838
|
+
* @returns {Promise<Models.Error>}
|
|
1267
1839
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1268
1840
|
*/
|
|
1269
|
-
|
|
1841
|
+
suppressionDestroy(id: string): Promise<Models.Error>;
|
|
1270
1842
|
/**
|
|
1271
|
-
*
|
|
1843
|
+
* `address` may be null: that is a person who has been erased
|
|
1844
|
+
* (POST /v1/privacy/erasures). The row survives as a hash, which is the
|
|
1845
|
+
* point — the clear text is gone and the address is still blocked.
|
|
1272
1846
|
*
|
|
1273
|
-
* @param {string} params.
|
|
1274
|
-
* @
|
|
1275
|
-
* @
|
|
1276
|
-
* @throws {RevenexxAPIRevenexxException}
|
|
1277
|
-
* @returns {Promise<Models.LogList>}
|
|
1847
|
+
* @param {string} params.id -
|
|
1848
|
+
* @throws {RevenexxException}
|
|
1849
|
+
* @returns {Promise<Models.Error>}
|
|
1278
1850
|
*/
|
|
1279
|
-
|
|
1280
|
-
|
|
1281
|
-
|
|
1282
|
-
total?: boolean;
|
|
1283
|
-
}): Promise<Models.LogList>;
|
|
1851
|
+
suppressionShow(params: {
|
|
1852
|
+
id: string;
|
|
1853
|
+
}): Promise<Models.Error>;
|
|
1284
1854
|
/**
|
|
1285
|
-
*
|
|
1855
|
+
* `address` may be null: that is a person who has been erased
|
|
1856
|
+
* (POST /v1/privacy/erasures). The row survives as a hash, which is the
|
|
1857
|
+
* point — the clear text is gone and the address is still blocked.
|
|
1286
1858
|
*
|
|
1287
|
-
* @param {string}
|
|
1288
|
-
* @
|
|
1289
|
-
* @
|
|
1290
|
-
* @
|
|
1291
|
-
|
|
1859
|
+
* @param {string} id -
|
|
1860
|
+
* @throws {RevenexxException}
|
|
1861
|
+
* @returns {Promise<Models.Error>}
|
|
1862
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1863
|
+
*/
|
|
1864
|
+
suppressionShow(id: string): Promise<Models.Error>;
|
|
1865
|
+
/**
|
|
1866
|
+
* `?channel=` narrows to one channel. Market-scoped as a BROWSING filter:
|
|
1867
|
+
* with `X-Revenexx-Market` the list is the global rows plus that market's,
|
|
1868
|
+
* without it the global rows only, and `?markets=all` is the unscoped read.
|
|
1869
|
+
* Never a boundary — the tenant is fixed by the credential and by row-level
|
|
1870
|
+
* security, and no value of either parameter reaches another tenant's rows.
|
|
1871
|
+
*
|
|
1872
|
+
* @param {string} params.channel -
|
|
1873
|
+
* @param {string} params.markets - Set to `all` for the unscoped read: every row whatever its markets, ignoring the `X-Revenexx-Market` header. The deliberate admin case, spelled in the query string so it is asked for rather than fallen into. No other value has any effect.
|
|
1874
|
+
* @throws {RevenexxException}
|
|
1875
|
+
* @returns {Promise<Models.Error>}
|
|
1876
|
+
*/
|
|
1877
|
+
templateIndex(params?: {
|
|
1878
|
+
channel?: string;
|
|
1879
|
+
markets?: string;
|
|
1880
|
+
}): Promise<Models.Error>;
|
|
1881
|
+
/**
|
|
1882
|
+
* `?channel=` narrows to one channel. Market-scoped as a BROWSING filter:
|
|
1883
|
+
* with `X-Revenexx-Market` the list is the global rows plus that market's,
|
|
1884
|
+
* without it the global rows only, and `?markets=all` is the unscoped read.
|
|
1885
|
+
* Never a boundary — the tenant is fixed by the credential and by row-level
|
|
1886
|
+
* security, and no value of either parameter reaches another tenant's rows.
|
|
1887
|
+
*
|
|
1888
|
+
* @param {string} channel -
|
|
1889
|
+
* @param {string} markets - Set to `all` for the unscoped read: every row whatever its markets, ignoring the `X-Revenexx-Market` header. The deliberate admin case, spelled in the query string so it is asked for rather than fallen into. No other value has any effect.
|
|
1890
|
+
* @throws {RevenexxException}
|
|
1891
|
+
* @returns {Promise<Models.Error>}
|
|
1292
1892
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1293
1893
|
*/
|
|
1294
|
-
|
|
1894
|
+
templateIndex(channel?: string, markets?: string): Promise<Models.Error>;
|
|
1895
|
+
/**
|
|
1896
|
+
* Send a `design` document and the service compiles it against the
|
|
1897
|
+
* template's layout — or send `body_html` and `body_text` yourself and skip
|
|
1898
|
+
* compilation entirely.
|
|
1899
|
+
*
|
|
1900
|
+
* A design that the compiler refuses is 422 and NOTHING is written, with
|
|
1901
|
+
* `error.details` naming the offending block. That order is deliberate: a
|
|
1902
|
+
* save whose compile failed must leave the row alone, because storing the
|
|
1903
|
+
* design while keeping a stale body would hand the next send a mail that no
|
|
1904
|
+
* longer matches the document it claims to be built from, and nothing would
|
|
1905
|
+
* ever surface it. A sidecar that is down is 503 `mjml_unavailable`, which
|
|
1906
|
+
* is worth retrying; a rejected design is not.
|
|
1907
|
+
*
|
|
1908
|
+
* The row this creates is a DRAFT and sends nothing until it is published.
|
|
1909
|
+
*
|
|
1910
|
+
* @param {string} params.channel -
|
|
1911
|
+
* @param {string} params.key -
|
|
1912
|
+
* @param {string} params.bodyHtml -
|
|
1913
|
+
* @param {string} params.bodyText -
|
|
1914
|
+
* @param {string} params.contentSid - The Meta-approved template this one is sent as. Outside the
|
|
1915
|
+
24-hour service window it is the only thing WhatsApp carries.
|
|
1916
|
+
* @param {string[]} params.design - The design document (v2). Validated as "an array" and no further:
|
|
1917
|
+
the compiler is the authority on the block schema and answers with
|
|
1918
|
+
the offending block, which is a better error than anything a
|
|
1919
|
+
validation rule list could restate here.
|
|
1920
|
+
* @param {boolean} params.enabled -
|
|
1921
|
+
* @param {string} params.layoutId - Which letterhead this template is mailed on. Null (or absent) is
|
|
1922
|
+
not "no layout" — it means the tenant's default, resolved on
|
|
1923
|
+
every compile and every send, so the template keeps following
|
|
1924
|
+
that default when it changes.
|
|
1925
|
+
* @param {string} params.locale -
|
|
1926
|
+
* @param {string[]} params.markets - Which markets this template is browsed in. `[]` — the default —
|
|
1927
|
+
is global, so this is never nullable: null would be a second
|
|
1928
|
+
empty next to the one that already carries the meaning.
|
|
1929
|
+
* @param {MessageClass} params.messageClass - What messages from this template ARE. Defaulted in the column
|
|
1930
|
+
rather than here, so a client that has never heard of the field
|
|
1931
|
+
keeps sending transactional mail — which is what every template
|
|
1932
|
+
written before this field existed was.
|
|
1933
|
+
* @param {string} params.subject -
|
|
1934
|
+
* @param {boolean} params.testMode - When this template is in force — see App\Models\Template. `after_or_equal` and not `after`: a window of a single instant is
|
|
1935
|
+
a legitimate thing to write while somebody is lining two
|
|
1936
|
+
templates up back to back, and rejecting it would only make them
|
|
1937
|
+
add a second nobody can see. A window that runs BACKWARDS is
|
|
1938
|
+
refused, because it is a template that can never send and looks
|
|
1939
|
+
from the list exactly like one that can.
|
|
1940
|
+
* @param {string} params.title - What the template is CALLED, as opposed to `key`, which is what
|
|
1941
|
+
it is addressed by. Without it a list has to derive a name from
|
|
1942
|
+
the key, and `order-confirmation` becomes "Order Confirmation" —
|
|
1943
|
+
passable English by accident and wrong in every other language.
|
|
1944
|
+
* @param {string} params.validFrom -
|
|
1945
|
+
* @param {string} params.validUntil -
|
|
1946
|
+
* @param {string[]} params.variableDefaults - Fallbacks for the placeholders an event did not fill — a map of
|
|
1947
|
+
variable name → string. Nullable, unlike `markets`: an empty map
|
|
1948
|
+
and no map are the same thing (nothing to fall back to), so there
|
|
1949
|
+
is no second state for a null to confuse anybody with.
|
|
1950
|
+
* @param {string[]} params.variables -
|
|
1951
|
+
* @param {WhatsappCategory} params.whatsappCategory - What a WhatsApp template is to Meta, which is what every message
|
|
1952
|
+
from it COSTS: marketing runs about five times utility, and in
|
|
1953
|
+
Germany that is roughly $0.12 against $0.025 a message. Refused
|
|
1954
|
+
rather than coerced when it is not one of Meta's four — a
|
|
1955
|
+
misspelled category that quietly became the default would be
|
|
1956
|
+
wrong on an invoice nobody reads until the quarter closes.
|
|
1957
|
+
Nullable: it is not a fact about an e-mail template, and what an
|
|
1958
|
+
unset one means is decided on read (Template::whatsappCategory).
|
|
1959
|
+
* @throws {RevenexxException}
|
|
1960
|
+
* @returns {Promise<Models.Error>}
|
|
1961
|
+
*/
|
|
1962
|
+
templateStore(params: {
|
|
1963
|
+
channel: string;
|
|
1964
|
+
key: string;
|
|
1965
|
+
bodyHtml?: string;
|
|
1966
|
+
bodyText?: string;
|
|
1967
|
+
contentSid?: string;
|
|
1968
|
+
design?: string[];
|
|
1969
|
+
enabled?: boolean;
|
|
1970
|
+
layoutId?: string;
|
|
1971
|
+
locale?: string;
|
|
1972
|
+
markets?: string[];
|
|
1973
|
+
messageClass?: MessageClass;
|
|
1974
|
+
subject?: string;
|
|
1975
|
+
testMode?: boolean;
|
|
1976
|
+
title?: string;
|
|
1977
|
+
validFrom?: string;
|
|
1978
|
+
validUntil?: string;
|
|
1979
|
+
variableDefaults?: string[];
|
|
1980
|
+
variables?: string[];
|
|
1981
|
+
whatsappCategory?: WhatsappCategory;
|
|
1982
|
+
}): Promise<Models.Error>;
|
|
1983
|
+
/**
|
|
1984
|
+
* Send a `design` document and the service compiles it against the
|
|
1985
|
+
* template's layout — or send `body_html` and `body_text` yourself and skip
|
|
1986
|
+
* compilation entirely.
|
|
1987
|
+
*
|
|
1988
|
+
* A design that the compiler refuses is 422 and NOTHING is written, with
|
|
1989
|
+
* `error.details` naming the offending block. That order is deliberate: a
|
|
1990
|
+
* save whose compile failed must leave the row alone, because storing the
|
|
1991
|
+
* design while keeping a stale body would hand the next send a mail that no
|
|
1992
|
+
* longer matches the document it claims to be built from, and nothing would
|
|
1993
|
+
* ever surface it. A sidecar that is down is 503 `mjml_unavailable`, which
|
|
1994
|
+
* is worth retrying; a rejected design is not.
|
|
1995
|
+
*
|
|
1996
|
+
* The row this creates is a DRAFT and sends nothing until it is published.
|
|
1997
|
+
*
|
|
1998
|
+
* @param {string} channel -
|
|
1999
|
+
* @param {string} key -
|
|
2000
|
+
* @param {string} bodyHtml -
|
|
2001
|
+
* @param {string} bodyText -
|
|
2002
|
+
* @param {string} contentSid - The Meta-approved template this one is sent as. Outside the
|
|
2003
|
+
24-hour service window it is the only thing WhatsApp carries.
|
|
2004
|
+
* @param {string[]} design - The design document (v2). Validated as "an array" and no further:
|
|
2005
|
+
the compiler is the authority on the block schema and answers with
|
|
2006
|
+
the offending block, which is a better error than anything a
|
|
2007
|
+
validation rule list could restate here.
|
|
2008
|
+
* @param {boolean} enabled -
|
|
2009
|
+
* @param {string} layoutId - Which letterhead this template is mailed on. Null (or absent) is
|
|
2010
|
+
not "no layout" — it means the tenant's default, resolved on
|
|
2011
|
+
every compile and every send, so the template keeps following
|
|
2012
|
+
that default when it changes.
|
|
2013
|
+
* @param {string} locale -
|
|
2014
|
+
* @param {string[]} markets - Which markets this template is browsed in. `[]` — the default —
|
|
2015
|
+
is global, so this is never nullable: null would be a second
|
|
2016
|
+
empty next to the one that already carries the meaning.
|
|
2017
|
+
* @param {MessageClass} messageClass - What messages from this template ARE. Defaulted in the column
|
|
2018
|
+
rather than here, so a client that has never heard of the field
|
|
2019
|
+
keeps sending transactional mail — which is what every template
|
|
2020
|
+
written before this field existed was.
|
|
2021
|
+
* @param {string} subject -
|
|
2022
|
+
* @param {boolean} testMode - When this template is in force — see App\Models\Template. `after_or_equal` and not `after`: a window of a single instant is
|
|
2023
|
+
a legitimate thing to write while somebody is lining two
|
|
2024
|
+
templates up back to back, and rejecting it would only make them
|
|
2025
|
+
add a second nobody can see. A window that runs BACKWARDS is
|
|
2026
|
+
refused, because it is a template that can never send and looks
|
|
2027
|
+
from the list exactly like one that can.
|
|
2028
|
+
* @param {string} title - What the template is CALLED, as opposed to `key`, which is what
|
|
2029
|
+
it is addressed by. Without it a list has to derive a name from
|
|
2030
|
+
the key, and `order-confirmation` becomes "Order Confirmation" —
|
|
2031
|
+
passable English by accident and wrong in every other language.
|
|
2032
|
+
* @param {string} validFrom -
|
|
2033
|
+
* @param {string} validUntil -
|
|
2034
|
+
* @param {string[]} variableDefaults - Fallbacks for the placeholders an event did not fill — a map of
|
|
2035
|
+
variable name → string. Nullable, unlike `markets`: an empty map
|
|
2036
|
+
and no map are the same thing (nothing to fall back to), so there
|
|
2037
|
+
is no second state for a null to confuse anybody with.
|
|
2038
|
+
* @param {string[]} variables -
|
|
2039
|
+
* @param {WhatsappCategory} whatsappCategory - What a WhatsApp template is to Meta, which is what every message
|
|
2040
|
+
from it COSTS: marketing runs about five times utility, and in
|
|
2041
|
+
Germany that is roughly $0.12 against $0.025 a message. Refused
|
|
2042
|
+
rather than coerced when it is not one of Meta's four — a
|
|
2043
|
+
misspelled category that quietly became the default would be
|
|
2044
|
+
wrong on an invoice nobody reads until the quarter closes.
|
|
2045
|
+
Nullable: it is not a fact about an e-mail template, and what an
|
|
2046
|
+
unset one means is decided on read (Template::whatsappCategory).
|
|
2047
|
+
* @throws {RevenexxException}
|
|
2048
|
+
* @returns {Promise<Models.Error>}
|
|
2049
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
2050
|
+
*/
|
|
2051
|
+
templateStore(channel: string, key: string, bodyHtml?: string, bodyText?: string, contentSid?: string, design?: string[], enabled?: boolean, layoutId?: string, locale?: string, markets?: string[], messageClass?: MessageClass, subject?: string, testMode?: boolean, title?: string, validFrom?: string, validUntil?: string, variableDefaults?: string[], variables?: string[], whatsappCategory?: WhatsappCategory): Promise<Models.Error>;
|
|
1295
2052
|
/**
|
|
1296
|
-
*
|
|
2053
|
+
* Any binding still naming this template's key will find nothing when its
|
|
2054
|
+
* event next arrives. Audited under the KEY as well as the id: after the
|
|
2055
|
+
* delete the id resolves to nothing, and "deleted tmpl_01J…" is not
|
|
2056
|
+
* something an operator can act on six weeks later.
|
|
1297
2057
|
*
|
|
1298
|
-
* @param {string} params.
|
|
1299
|
-
* @
|
|
1300
|
-
* @
|
|
1301
|
-
* @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
1302
|
-
* @throws {RevenexxAPIRevenexxException}
|
|
1303
|
-
* @returns {Promise<Models.SubscriberList>}
|
|
2058
|
+
* @param {string} params.id -
|
|
2059
|
+
* @throws {RevenexxException}
|
|
2060
|
+
* @returns {Promise<Models.Error>}
|
|
1304
2061
|
*/
|
|
1305
|
-
|
|
1306
|
-
|
|
1307
|
-
|
|
1308
|
-
search?: string;
|
|
1309
|
-
total?: boolean;
|
|
1310
|
-
}): Promise<Models.SubscriberList>;
|
|
2062
|
+
templateDestroy(params: {
|
|
2063
|
+
id: string;
|
|
2064
|
+
}): Promise<Models.Error>;
|
|
1311
2065
|
/**
|
|
1312
|
-
*
|
|
2066
|
+
* Any binding still naming this template's key will find nothing when its
|
|
2067
|
+
* event next arrives. Audited under the KEY as well as the id: after the
|
|
2068
|
+
* delete the id resolves to nothing, and "deleted tmpl_01J…" is not
|
|
2069
|
+
* something an operator can act on six weeks later.
|
|
1313
2070
|
*
|
|
1314
|
-
* @param {string}
|
|
1315
|
-
* @
|
|
1316
|
-
* @
|
|
1317
|
-
* @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
1318
|
-
* @throws {RevenexxAPIRevenexxException}
|
|
1319
|
-
* @returns {Promise<Models.SubscriberList>}
|
|
2071
|
+
* @param {string} id -
|
|
2072
|
+
* @throws {RevenexxException}
|
|
2073
|
+
* @returns {Promise<Models.Error>}
|
|
1320
2074
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1321
2075
|
*/
|
|
1322
|
-
|
|
2076
|
+
templateDestroy(id: string): Promise<Models.Error>;
|
|
1323
2077
|
/**
|
|
1324
|
-
*
|
|
2078
|
+
* What customers are receiving is the published snapshot; see
|
|
2079
|
+
* `GET /v1/templates/{id}/versions`, whose `meta.has_unpublished_changes`
|
|
2080
|
+
* says whether the two differ.
|
|
2081
|
+
*
|
|
2082
|
+
* Not market-filtered, deliberately: market scoping is a browsing concern
|
|
2083
|
+
* and somebody holding an id may read the row.
|
|
1325
2084
|
*
|
|
1326
|
-
* @param {string} params.
|
|
1327
|
-
* @
|
|
1328
|
-
* @
|
|
1329
|
-
* @throws {RevenexxAPIRevenexxException}
|
|
1330
|
-
* @returns {Promise<Models.Subscriber>}
|
|
2085
|
+
* @param {string} params.id -
|
|
2086
|
+
* @throws {RevenexxException}
|
|
2087
|
+
* @returns {Promise<Models.Error>}
|
|
1331
2088
|
*/
|
|
1332
|
-
|
|
1333
|
-
|
|
1334
|
-
|
|
1335
|
-
targetId: string;
|
|
1336
|
-
}): Promise<Models.Subscriber>;
|
|
2089
|
+
templateShow(params: {
|
|
2090
|
+
id: string;
|
|
2091
|
+
}): Promise<Models.Error>;
|
|
1337
2092
|
/**
|
|
1338
|
-
*
|
|
2093
|
+
* What customers are receiving is the published snapshot; see
|
|
2094
|
+
* `GET /v1/templates/{id}/versions`, whose `meta.has_unpublished_changes`
|
|
2095
|
+
* says whether the two differ.
|
|
1339
2096
|
*
|
|
1340
|
-
*
|
|
1341
|
-
*
|
|
1342
|
-
*
|
|
1343
|
-
* @
|
|
1344
|
-
* @
|
|
2097
|
+
* Not market-filtered, deliberately: market scoping is a browsing concern
|
|
2098
|
+
* and somebody holding an id may read the row.
|
|
2099
|
+
*
|
|
2100
|
+
* @param {string} id -
|
|
2101
|
+
* @throws {RevenexxException}
|
|
2102
|
+
* @returns {Promise<Models.Error>}
|
|
2103
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
2104
|
+
*/
|
|
2105
|
+
templateShow(id: string): Promise<Models.Error>;
|
|
2106
|
+
/**
|
|
2107
|
+
* Only the fields sent are written, and the change is audited only when
|
|
2108
|
+
* something actually changed — a PATCH that resent the same values records
|
|
2109
|
+
* nothing, because an audit line on every save teaches its readers to
|
|
2110
|
+
* ignore the log.
|
|
2111
|
+
*
|
|
2112
|
+
* Moving a template to another layout recompiles it against the NEW one,
|
|
2113
|
+
* even when nothing else changed: colours, width and font come from the
|
|
2114
|
+
* layout and are already inlined, so a template that merely changed hands
|
|
2115
|
+
* would otherwise keep showing the old letterhead until somebody happened
|
|
2116
|
+
* to press save on it again.
|
|
2117
|
+
*
|
|
2118
|
+
* Changes nothing customers receive until the template is published.
|
|
2119
|
+
*
|
|
2120
|
+
* This path answers on `PUT` and `PATCH`, both routed to the same action.
|
|
2121
|
+
*
|
|
2122
|
+
* @param {string} params.id -
|
|
2123
|
+
* @param {string} params.bodyHtml -
|
|
2124
|
+
* @param {string} params.bodyText -
|
|
2125
|
+
* @param {string} params.contentSid -
|
|
2126
|
+
* @param {string[]} params.design -
|
|
2127
|
+
* @param {boolean} params.enabled -
|
|
2128
|
+
* @param {string} params.layoutId -
|
|
2129
|
+
* @param {string[]} params.markets -
|
|
2130
|
+
* @param {MessageClass} params.messageClass -
|
|
2131
|
+
* @param {string} params.subject -
|
|
2132
|
+
* @param {boolean} params.testMode - When this template is in force — see App\Models\Template. `after_or_equal` and not `after`: a window of a single instant is
|
|
2133
|
+
a legitimate thing to write while somebody is lining two
|
|
2134
|
+
templates up back to back, and rejecting it would only make them
|
|
2135
|
+
add a second nobody can see. A window that runs BACKWARDS is
|
|
2136
|
+
refused, because it is a template that can never send and looks
|
|
2137
|
+
from the list exactly like one that can.
|
|
2138
|
+
* @param {string} params.title - Reclassifying is allowed and changes nothing that already went
|
|
2139
|
+
out: `messages.message_class` was copied onto each row at
|
|
2140
|
+
dispatch, so the log keeps saying what each message was.
|
|
2141
|
+
* @param {string} params.validFrom -
|
|
2142
|
+
* @param {string} params.validUntil -
|
|
2143
|
+
* @param {string[]} params.variableDefaults -
|
|
2144
|
+
* @param {string[]} params.variables -
|
|
2145
|
+
* @param {WhatsappCategory} params.whatsappCategory - Recategorising is allowed and takes effect on the next send: Meta
|
|
2146
|
+
move templates between categories on their own schedule, and a
|
|
2147
|
+
row that could not follow them would go on quoting a price that
|
|
2148
|
+
stopped being true.
|
|
2149
|
+
* @throws {RevenexxException}
|
|
2150
|
+
* @returns {Promise<Models.Error>}
|
|
2151
|
+
*/
|
|
2152
|
+
templateUpdatePatch(params: {
|
|
2153
|
+
id: string;
|
|
2154
|
+
bodyHtml?: string;
|
|
2155
|
+
bodyText?: string;
|
|
2156
|
+
contentSid?: string;
|
|
2157
|
+
design?: string[];
|
|
2158
|
+
enabled?: boolean;
|
|
2159
|
+
layoutId?: string;
|
|
2160
|
+
markets?: string[];
|
|
2161
|
+
messageClass?: MessageClass;
|
|
2162
|
+
subject?: string;
|
|
2163
|
+
testMode?: boolean;
|
|
2164
|
+
title?: string;
|
|
2165
|
+
validFrom?: string;
|
|
2166
|
+
validUntil?: string;
|
|
2167
|
+
variableDefaults?: string[];
|
|
2168
|
+
variables?: string[];
|
|
2169
|
+
whatsappCategory?: WhatsappCategory;
|
|
2170
|
+
}): Promise<Models.Error>;
|
|
2171
|
+
/**
|
|
2172
|
+
* Only the fields sent are written, and the change is audited only when
|
|
2173
|
+
* something actually changed — a PATCH that resent the same values records
|
|
2174
|
+
* nothing, because an audit line on every save teaches its readers to
|
|
2175
|
+
* ignore the log.
|
|
2176
|
+
*
|
|
2177
|
+
* Moving a template to another layout recompiles it against the NEW one,
|
|
2178
|
+
* even when nothing else changed: colours, width and font come from the
|
|
2179
|
+
* layout and are already inlined, so a template that merely changed hands
|
|
2180
|
+
* would otherwise keep showing the old letterhead until somebody happened
|
|
2181
|
+
* to press save on it again.
|
|
2182
|
+
*
|
|
2183
|
+
* Changes nothing customers receive until the template is published.
|
|
2184
|
+
*
|
|
2185
|
+
* This path answers on `PUT` and `PATCH`, both routed to the same action.
|
|
2186
|
+
*
|
|
2187
|
+
* @param {string} id -
|
|
2188
|
+
* @param {string} bodyHtml -
|
|
2189
|
+
* @param {string} bodyText -
|
|
2190
|
+
* @param {string} contentSid -
|
|
2191
|
+
* @param {string[]} design -
|
|
2192
|
+
* @param {boolean} enabled -
|
|
2193
|
+
* @param {string} layoutId -
|
|
2194
|
+
* @param {string[]} markets -
|
|
2195
|
+
* @param {MessageClass} messageClass -
|
|
2196
|
+
* @param {string} subject -
|
|
2197
|
+
* @param {boolean} testMode - When this template is in force — see App\Models\Template. `after_or_equal` and not `after`: a window of a single instant is
|
|
2198
|
+
a legitimate thing to write while somebody is lining two
|
|
2199
|
+
templates up back to back, and rejecting it would only make them
|
|
2200
|
+
add a second nobody can see. A window that runs BACKWARDS is
|
|
2201
|
+
refused, because it is a template that can never send and looks
|
|
2202
|
+
from the list exactly like one that can.
|
|
2203
|
+
* @param {string} title - Reclassifying is allowed and changes nothing that already went
|
|
2204
|
+
out: `messages.message_class` was copied onto each row at
|
|
2205
|
+
dispatch, so the log keeps saying what each message was.
|
|
2206
|
+
* @param {string} validFrom -
|
|
2207
|
+
* @param {string} validUntil -
|
|
2208
|
+
* @param {string[]} variableDefaults -
|
|
2209
|
+
* @param {string[]} variables -
|
|
2210
|
+
* @param {WhatsappCategory} whatsappCategory - Recategorising is allowed and takes effect on the next send: Meta
|
|
2211
|
+
move templates between categories on their own schedule, and a
|
|
2212
|
+
row that could not follow them would go on quoting a price that
|
|
2213
|
+
stopped being true.
|
|
2214
|
+
* @throws {RevenexxException}
|
|
2215
|
+
* @returns {Promise<Models.Error>}
|
|
2216
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
2217
|
+
*/
|
|
2218
|
+
templateUpdatePatch(id: string, bodyHtml?: string, bodyText?: string, contentSid?: string, design?: string[], enabled?: boolean, layoutId?: string, markets?: string[], messageClass?: MessageClass, subject?: string, testMode?: boolean, title?: string, validFrom?: string, validUntil?: string, variableDefaults?: string[], variables?: string[], whatsappCategory?: WhatsappCategory): Promise<Models.Error>;
|
|
2219
|
+
/**
|
|
2220
|
+
* Only the fields sent are written, and the change is audited only when
|
|
2221
|
+
* something actually changed — a PATCH that resent the same values records
|
|
2222
|
+
* nothing, because an audit line on every save teaches its readers to
|
|
2223
|
+
* ignore the log.
|
|
2224
|
+
*
|
|
2225
|
+
* Moving a template to another layout recompiles it against the NEW one,
|
|
2226
|
+
* even when nothing else changed: colours, width and font come from the
|
|
2227
|
+
* layout and are already inlined, so a template that merely changed hands
|
|
2228
|
+
* would otherwise keep showing the old letterhead until somebody happened
|
|
2229
|
+
* to press save on it again.
|
|
2230
|
+
*
|
|
2231
|
+
* Changes nothing customers receive until the template is published.
|
|
2232
|
+
*
|
|
2233
|
+
* This path answers on `PUT` and `PATCH`, both routed to the same action.
|
|
2234
|
+
*
|
|
2235
|
+
* @param {string} params.id -
|
|
2236
|
+
* @param {string} params.bodyHtml -
|
|
2237
|
+
* @param {string} params.bodyText -
|
|
2238
|
+
* @param {string} params.contentSid -
|
|
2239
|
+
* @param {string[]} params.design -
|
|
2240
|
+
* @param {boolean} params.enabled -
|
|
2241
|
+
* @param {string} params.layoutId -
|
|
2242
|
+
* @param {string[]} params.markets -
|
|
2243
|
+
* @param {MessageClass} params.messageClass -
|
|
2244
|
+
* @param {string} params.subject -
|
|
2245
|
+
* @param {boolean} params.testMode - When this template is in force — see App\Models\Template. `after_or_equal` and not `after`: a window of a single instant is
|
|
2246
|
+
a legitimate thing to write while somebody is lining two
|
|
2247
|
+
templates up back to back, and rejecting it would only make them
|
|
2248
|
+
add a second nobody can see. A window that runs BACKWARDS is
|
|
2249
|
+
refused, because it is a template that can never send and looks
|
|
2250
|
+
from the list exactly like one that can.
|
|
2251
|
+
* @param {string} params.title - Reclassifying is allowed and changes nothing that already went
|
|
2252
|
+
out: `messages.message_class` was copied onto each row at
|
|
2253
|
+
dispatch, so the log keeps saying what each message was.
|
|
2254
|
+
* @param {string} params.validFrom -
|
|
2255
|
+
* @param {string} params.validUntil -
|
|
2256
|
+
* @param {string[]} params.variableDefaults -
|
|
2257
|
+
* @param {string[]} params.variables -
|
|
2258
|
+
* @param {WhatsappCategory} params.whatsappCategory - Recategorising is allowed and takes effect on the next send: Meta
|
|
2259
|
+
move templates between categories on their own schedule, and a
|
|
2260
|
+
row that could not follow them would go on quoting a price that
|
|
2261
|
+
stopped being true.
|
|
2262
|
+
* @throws {RevenexxException}
|
|
2263
|
+
* @returns {Promise<Models.Error>}
|
|
2264
|
+
*/
|
|
2265
|
+
templateUpdate(params: {
|
|
2266
|
+
id: string;
|
|
2267
|
+
bodyHtml?: string;
|
|
2268
|
+
bodyText?: string;
|
|
2269
|
+
contentSid?: string;
|
|
2270
|
+
design?: string[];
|
|
2271
|
+
enabled?: boolean;
|
|
2272
|
+
layoutId?: string;
|
|
2273
|
+
markets?: string[];
|
|
2274
|
+
messageClass?: MessageClass;
|
|
2275
|
+
subject?: string;
|
|
2276
|
+
testMode?: boolean;
|
|
2277
|
+
title?: string;
|
|
2278
|
+
validFrom?: string;
|
|
2279
|
+
validUntil?: string;
|
|
2280
|
+
variableDefaults?: string[];
|
|
2281
|
+
variables?: string[];
|
|
2282
|
+
whatsappCategory?: WhatsappCategory;
|
|
2283
|
+
}): Promise<Models.Error>;
|
|
2284
|
+
/**
|
|
2285
|
+
* Only the fields sent are written, and the change is audited only when
|
|
2286
|
+
* something actually changed — a PATCH that resent the same values records
|
|
2287
|
+
* nothing, because an audit line on every save teaches its readers to
|
|
2288
|
+
* ignore the log.
|
|
2289
|
+
*
|
|
2290
|
+
* Moving a template to another layout recompiles it against the NEW one,
|
|
2291
|
+
* even when nothing else changed: colours, width and font come from the
|
|
2292
|
+
* layout and are already inlined, so a template that merely changed hands
|
|
2293
|
+
* would otherwise keep showing the old letterhead until somebody happened
|
|
2294
|
+
* to press save on it again.
|
|
2295
|
+
*
|
|
2296
|
+
* Changes nothing customers receive until the template is published.
|
|
2297
|
+
*
|
|
2298
|
+
* This path answers on `PUT` and `PATCH`, both routed to the same action.
|
|
2299
|
+
*
|
|
2300
|
+
* @param {string} id -
|
|
2301
|
+
* @param {string} bodyHtml -
|
|
2302
|
+
* @param {string} bodyText -
|
|
2303
|
+
* @param {string} contentSid -
|
|
2304
|
+
* @param {string[]} design -
|
|
2305
|
+
* @param {boolean} enabled -
|
|
2306
|
+
* @param {string} layoutId -
|
|
2307
|
+
* @param {string[]} markets -
|
|
2308
|
+
* @param {MessageClass} messageClass -
|
|
2309
|
+
* @param {string} subject -
|
|
2310
|
+
* @param {boolean} testMode - When this template is in force — see App\Models\Template. `after_or_equal` and not `after`: a window of a single instant is
|
|
2311
|
+
a legitimate thing to write while somebody is lining two
|
|
2312
|
+
templates up back to back, and rejecting it would only make them
|
|
2313
|
+
add a second nobody can see. A window that runs BACKWARDS is
|
|
2314
|
+
refused, because it is a template that can never send and looks
|
|
2315
|
+
from the list exactly like one that can.
|
|
2316
|
+
* @param {string} title - Reclassifying is allowed and changes nothing that already went
|
|
2317
|
+
out: `messages.message_class` was copied onto each row at
|
|
2318
|
+
dispatch, so the log keeps saying what each message was.
|
|
2319
|
+
* @param {string} validFrom -
|
|
2320
|
+
* @param {string} validUntil -
|
|
2321
|
+
* @param {string[]} variableDefaults -
|
|
2322
|
+
* @param {string[]} variables -
|
|
2323
|
+
* @param {WhatsappCategory} whatsappCategory - Recategorising is allowed and takes effect on the next send: Meta
|
|
2324
|
+
move templates between categories on their own schedule, and a
|
|
2325
|
+
row that could not follow them would go on quoting a price that
|
|
2326
|
+
stopped being true.
|
|
2327
|
+
* @throws {RevenexxException}
|
|
2328
|
+
* @returns {Promise<Models.Error>}
|
|
1345
2329
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1346
2330
|
*/
|
|
1347
|
-
|
|
2331
|
+
templateUpdate(id: string, bodyHtml?: string, bodyText?: string, contentSid?: string, design?: string[], enabled?: boolean, layoutId?: string, markets?: string[], messageClass?: MessageClass, subject?: string, testMode?: boolean, title?: string, validFrom?: string, validUntil?: string, variableDefaults?: string[], variables?: string[], whatsappCategory?: WhatsappCategory): Promise<Models.Error>;
|
|
1348
2332
|
/**
|
|
1349
|
-
*
|
|
2333
|
+
* Answers 200 with the version already live when there was nothing to
|
|
2334
|
+
* publish, and 201 when a new one was written — so a client can tell
|
|
2335
|
+
* whether its press did anything without diffing the payload.
|
|
1350
2336
|
*
|
|
1351
|
-
* @param {string} params.
|
|
1352
|
-
* @param {string} params.
|
|
1353
|
-
* @throws {
|
|
1354
|
-
* @returns {Promise<
|
|
2337
|
+
* @param {string} params.templateId -
|
|
2338
|
+
* @param {string} params.note -
|
|
2339
|
+
* @throws {RevenexxException}
|
|
2340
|
+
* @returns {Promise<Models.Error>}
|
|
1355
2341
|
*/
|
|
1356
|
-
|
|
1357
|
-
|
|
1358
|
-
|
|
1359
|
-
}): Promise<
|
|
2342
|
+
templateVersionStore(params: {
|
|
2343
|
+
templateId: string;
|
|
2344
|
+
note?: string;
|
|
2345
|
+
}): Promise<Models.Error>;
|
|
1360
2346
|
/**
|
|
1361
|
-
*
|
|
2347
|
+
* Answers 200 with the version already live when there was nothing to
|
|
2348
|
+
* publish, and 201 when a new one was written — so a client can tell
|
|
2349
|
+
* whether its press did anything without diffing the payload.
|
|
1362
2350
|
*
|
|
1363
|
-
* @param {string}
|
|
1364
|
-
* @param {string}
|
|
1365
|
-
* @throws {
|
|
1366
|
-
* @returns {Promise<
|
|
2351
|
+
* @param {string} templateId -
|
|
2352
|
+
* @param {string} note -
|
|
2353
|
+
* @throws {RevenexxException}
|
|
2354
|
+
* @returns {Promise<Models.Error>}
|
|
1367
2355
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1368
2356
|
*/
|
|
1369
|
-
|
|
2357
|
+
templateVersionStore(templateId: string, note?: string): Promise<Models.Error>;
|
|
2358
|
+
/**
|
|
2359
|
+
* Summaries only: version, subject, message class, layout, who published it
|
|
2360
|
+
* and when, and their note. The BODIES are deliberately absent — a compiled
|
|
2361
|
+
* `body_html` runs to tens of kilobytes, and a template with forty versions
|
|
2362
|
+
* would make this a several-megabyte download that nobody scrolls to the
|
|
2363
|
+
* end of. `GET /v1/templates/{id}/versions/{version}` serves the full
|
|
2364
|
+
* snapshot for the one somebody actually opened.
|
|
2365
|
+
*
|
|
2366
|
+
* `meta.published_version_id` says which of them is live — a property of
|
|
2367
|
+
* the template, said once, rather than a flag repeated on every row that
|
|
2368
|
+
* two rows could then claim. `meta.has_unpublished_changes` says whether
|
|
2369
|
+
* the draft has moved on since.
|
|
2370
|
+
*
|
|
2371
|
+
* @param {string} params.templateId -
|
|
2372
|
+
* @throws {RevenexxException}
|
|
2373
|
+
* @returns {Promise<Models.Error>}
|
|
2374
|
+
*/
|
|
2375
|
+
templateVersionIndex(params: {
|
|
2376
|
+
templateId: string;
|
|
2377
|
+
}): Promise<Models.Error>;
|
|
2378
|
+
/**
|
|
2379
|
+
* Summaries only: version, subject, message class, layout, who published it
|
|
2380
|
+
* and when, and their note. The BODIES are deliberately absent — a compiled
|
|
2381
|
+
* `body_html` runs to tens of kilobytes, and a template with forty versions
|
|
2382
|
+
* would make this a several-megabyte download that nobody scrolls to the
|
|
2383
|
+
* end of. `GET /v1/templates/{id}/versions/{version}` serves the full
|
|
2384
|
+
* snapshot for the one somebody actually opened.
|
|
2385
|
+
*
|
|
2386
|
+
* `meta.published_version_id` says which of them is live — a property of
|
|
2387
|
+
* the template, said once, rather than a flag repeated on every row that
|
|
2388
|
+
* two rows could then claim. `meta.has_unpublished_changes` says whether
|
|
2389
|
+
* the draft has moved on since.
|
|
2390
|
+
*
|
|
2391
|
+
* @param {string} templateId -
|
|
2392
|
+
* @throws {RevenexxException}
|
|
2393
|
+
* @returns {Promise<Models.Error>}
|
|
2394
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
2395
|
+
*/
|
|
2396
|
+
templateVersionIndex(templateId: string): Promise<Models.Error>;
|
|
1370
2397
|
/**
|
|
1371
|
-
*
|
|
2398
|
+
* Addressed by its VERSION NUMBER — the small integer on the history row,
|
|
2399
|
+
* not the snapshot's id — because that is the number an author has in front
|
|
2400
|
+
* of them.
|
|
1372
2401
|
*
|
|
2402
|
+
* This is what sends actually rendered while that version was live, so it
|
|
2403
|
+
* is the thing to read when the question is "what did the mail we sent in
|
|
2404
|
+
* * March say".
|
|
1373
2405
|
*
|
|
1374
|
-
* @param {string} params.
|
|
1375
|
-
* @param {string} params.
|
|
1376
|
-
* @throws {
|
|
1377
|
-
* @returns {Promise<Models.
|
|
2406
|
+
* @param {string} params.templateId -
|
|
2407
|
+
* @param {string} params.version -
|
|
2408
|
+
* @throws {RevenexxException}
|
|
2409
|
+
* @returns {Promise<Models.Error>}
|
|
1378
2410
|
*/
|
|
1379
|
-
|
|
1380
|
-
|
|
1381
|
-
|
|
1382
|
-
}): Promise<Models.
|
|
2411
|
+
templateVersionShow(params: {
|
|
2412
|
+
templateId: string;
|
|
2413
|
+
version: string;
|
|
2414
|
+
}): Promise<Models.Error>;
|
|
1383
2415
|
/**
|
|
1384
|
-
*
|
|
2416
|
+
* Addressed by its VERSION NUMBER — the small integer on the history row,
|
|
2417
|
+
* not the snapshot's id — because that is the number an author has in front
|
|
2418
|
+
* of them.
|
|
1385
2419
|
*
|
|
2420
|
+
* This is what sends actually rendered while that version was live, so it
|
|
2421
|
+
* is the thing to read when the question is "what did the mail we sent in
|
|
2422
|
+
* * March say".
|
|
1386
2423
|
*
|
|
1387
|
-
* @param {string}
|
|
1388
|
-
* @param {string}
|
|
1389
|
-
* @throws {
|
|
1390
|
-
* @returns {Promise<Models.
|
|
2424
|
+
* @param {string} templateId -
|
|
2425
|
+
* @param {string} version -
|
|
2426
|
+
* @throws {RevenexxException}
|
|
2427
|
+
* @returns {Promise<Models.Error>}
|
|
2428
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
2429
|
+
*/
|
|
2430
|
+
templateVersionShow(templateId: string, version: string): Promise<Models.Error>;
|
|
2431
|
+
/**
|
|
2432
|
+
* `publish: true` makes it live in the same transaction — see
|
|
2433
|
+
* TemplatePublisher::restore for why that flag exists rather than asking
|
|
2434
|
+
* the caller for a second round trip.
|
|
2435
|
+
*
|
|
2436
|
+
* @param {string} params.templateId -
|
|
2437
|
+
* @param {string} params.version -
|
|
2438
|
+
* @param {boolean} params.publish -
|
|
2439
|
+
* @throws {RevenexxException}
|
|
2440
|
+
* @returns {Promise<Models.Error>}
|
|
2441
|
+
*/
|
|
2442
|
+
templateVersionRestore(params: {
|
|
2443
|
+
templateId: string;
|
|
2444
|
+
version: string;
|
|
2445
|
+
publish?: boolean;
|
|
2446
|
+
}): Promise<Models.Error>;
|
|
2447
|
+
/**
|
|
2448
|
+
* `publish: true` makes it live in the same transaction — see
|
|
2449
|
+
* TemplatePublisher::restore for why that flag exists rather than asking
|
|
2450
|
+
* the caller for a second round trip.
|
|
2451
|
+
*
|
|
2452
|
+
* @param {string} templateId -
|
|
2453
|
+
* @param {string} version -
|
|
2454
|
+
* @param {boolean} publish -
|
|
2455
|
+
* @throws {RevenexxException}
|
|
2456
|
+
* @returns {Promise<Models.Error>}
|
|
1391
2457
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1392
2458
|
*/
|
|
1393
|
-
|
|
2459
|
+
templateVersionRestore(templateId: string, version: string, publish?: boolean): Promise<Models.Error>;
|
|
1394
2460
|
}
|
|
1395
2461
|
|
|
1396
2462
|
export { Messaging };
|