@vendure/docs 0.0.0-202601280949 → 0.0.0-202601281114
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/dist/dates.generated.js +385 -385
- package/docs/reference/admin-ui-api/action-bar/action-bar-context.mdx +2 -2
- package/docs/reference/admin-ui-api/action-bar/action-bar-dropdown-menu-item.mdx +1 -1
- package/docs/reference/admin-ui-api/action-bar/action-bar-item.mdx +1 -1
- package/docs/reference/admin-ui-api/action-bar/action-bar-location-id.mdx +1 -1
- package/docs/reference/admin-ui-api/action-bar/router-link-definition.mdx +1 -1
- package/docs/reference/admin-ui-api/alerts/alert-context.mdx +1 -1
- package/docs/reference/admin-ui-api/alerts/register-alert.mdx +1 -1
- package/docs/reference/admin-ui-api/bulk-actions/bulk-action.mdx +2 -2
- package/docs/reference/admin-ui-api/bulk-actions/register-bulk-action.mdx +1 -1
- package/docs/reference/admin-ui-api/components/asset-picker-dialog-component.mdx +1 -1
- package/docs/reference/admin-ui-api/components/data-table-component.mdx +2 -2
- package/docs/reference/admin-ui-api/components/data-table2component.mdx +1 -1
- package/docs/reference/admin-ui-api/custom-detail-components/custom-detail-component-config.mdx +1 -1
- package/docs/reference/admin-ui-api/custom-detail-components/custom-detail-component-location-id.mdx +1 -1
- package/docs/reference/admin-ui-api/custom-detail-components/register-custom-detail-component.mdx +1 -1
- package/docs/reference/admin-ui-api/custom-history-entry-components/customer-history-entry-component.mdx +2 -2
- package/docs/reference/admin-ui-api/custom-history-entry-components/history-entry-component.mdx +1 -1
- package/docs/reference/admin-ui-api/custom-history-entry-components/history-entry-config.mdx +1 -1
- package/docs/reference/admin-ui-api/custom-history-entry-components/order-history-entry-component.mdx +2 -2
- package/docs/reference/admin-ui-api/custom-history-entry-components/register-history-entry-component.mdx +1 -1
- package/docs/reference/admin-ui-api/custom-input-components/default-inputs.mdx +19 -19
- package/docs/reference/admin-ui-api/custom-input-components/register-form-input-component.mdx +2 -2
- package/docs/reference/admin-ui-api/custom-table-components/data-table-component-config.mdx +2 -2
- package/docs/reference/admin-ui-api/custom-table-components/register-data-table-component.mdx +1 -1
- package/docs/reference/admin-ui-api/dashboard-widgets/register-dashboard-widget.mdx +1 -1
- package/docs/reference/admin-ui-api/directives/if-permissions-directive.mdx +1 -1
- package/docs/reference/admin-ui-api/list-detail-views/base-detail-component.mdx +1 -1
- package/docs/reference/admin-ui-api/list-detail-views/base-entity-resolver.mdx +1 -1
- package/docs/reference/admin-ui-api/list-detail-views/base-list-component.mdx +1 -1
- package/docs/reference/admin-ui-api/list-detail-views/detail-component-with-resolver.mdx +1 -1
- package/docs/reference/admin-ui-api/list-detail-views/typed-base-detail-component.mdx +2 -2
- package/docs/reference/admin-ui-api/list-detail-views/typed-base-list-component.mdx +2 -2
- package/docs/reference/admin-ui-api/nav-menu/nav-menu-section.mdx +1 -1
- package/docs/reference/admin-ui-api/react-extensions/react-data-table-component-config.mdx +1 -1
- package/docs/reference/admin-ui-api/react-extensions/register-react-custom-detail-component.mdx +1 -1
- package/docs/reference/admin-ui-api/react-extensions/register-react-form-input-component.mdx +1 -1
- package/docs/reference/admin-ui-api/services/data-service.mdx +1 -1
- package/docs/reference/admin-ui-api/services/modal-service.mdx +1 -1
- package/docs/reference/admin-ui-api/ui-devkit/admin-ui-extension.mdx +6 -8
- package/docs/reference/admin-ui-api/ui-devkit/ui-extension-build-command.mdx +1 -1
- package/docs/reference/admin-ui-api/ui-devkit/ui-extension-compiler-options.mdx +2 -2
- package/docs/reference/admin-ui-api/ui-devkit/ui-extension-compiler-process-argument.mdx +1 -1
- package/docs/reference/core-plugins/admin-ui-plugin/admin-ui-plugin-options.mdx +1 -1
- package/docs/reference/core-plugins/asset-server-plugin/asset-server-options.mdx +5 -5
- package/docs/reference/core-plugins/asset-server-plugin/hashed-asset-naming-strategy.mdx +2 -2
- package/docs/reference/core-plugins/asset-server-plugin/image-transform-strategy.mdx +1 -1
- package/docs/reference/core-plugins/asset-server-plugin/index.mdx +3 -3
- package/docs/reference/core-plugins/asset-server-plugin/local-asset-storage-strategy.mdx +1 -1
- package/docs/reference/core-plugins/asset-server-plugin/preset-only-strategy.mdx +3 -3
- package/docs/reference/core-plugins/asset-server-plugin/s3asset-storage-strategy.mdx +5 -5
- package/docs/reference/core-plugins/asset-server-plugin/sharp-asset-preview-strategy.mdx +3 -3
- package/docs/reference/core-plugins/dashboard-plugin/dashboard-plugin-options.mdx +1 -1
- package/docs/reference/core-plugins/elasticsearch-plugin/elasticsearch-options.mdx +1 -1
- package/docs/reference/core-plugins/elasticsearch-plugin/index.mdx +1 -1
- package/docs/reference/core-plugins/email-plugin/email-event-handler-with-async-data.mdx +2 -2
- package/docs/reference/core-plugins/email-plugin/email-event-handler.mdx +10 -10
- package/docs/reference/core-plugins/email-plugin/email-event-listener.mdx +1 -1
- package/docs/reference/core-plugins/email-plugin/email-generator.mdx +2 -2
- package/docs/reference/core-plugins/email-plugin/email-plugin-options.mdx +2 -2
- package/docs/reference/core-plugins/email-plugin/email-plugin-types.mdx +9 -9
- package/docs/reference/core-plugins/email-plugin/email-send-event.mdx +1 -1
- package/docs/reference/core-plugins/email-plugin/email-sender.mdx +3 -3
- package/docs/reference/core-plugins/email-plugin/index.mdx +4 -4
- package/docs/reference/core-plugins/email-plugin/template-loader.mdx +1 -1
- package/docs/reference/core-plugins/email-plugin/transport-options.mdx +2 -2
- package/docs/reference/core-plugins/harden-plugin/harden-plugin-options.mdx +1 -1
- package/docs/reference/core-plugins/harden-plugin/index.mdx +2 -2
- package/docs/reference/core-plugins/job-queue-plugin/bull-mqjob-queue-strategy.mdx +1 -1
- package/docs/reference/core-plugins/job-queue-plugin/bull-mqplugin-options.mdx +1 -1
- package/docs/reference/core-plugins/job-queue-plugin/pub-sub-job-queue-strategy.mdx +1 -1
- package/docs/reference/core-plugins/payments-plugin/stripe-plugin.mdx +1 -1
- package/docs/reference/core-plugins/sentry-plugin/sentry-plugin-options.mdx +1 -1
- package/docs/reference/core-plugins/stellate-plugin/index.mdx +3 -3
- package/docs/reference/core-plugins/stellate-plugin/purge-rule.mdx +3 -3
- package/docs/reference/core-plugins/stellate-plugin/stellate-plugin-options.mdx +1 -1
- package/docs/reference/core-plugins/telemetry-plugin/otel-logger.mdx +1 -1
- package/docs/reference/core-plugins/telemetry-plugin/register-method-hooks.mdx +1 -1
- package/docs/reference/core-plugins/telemetry-plugin/telemetry-plugin-options.mdx +1 -1
- package/docs/reference/dashboard/components/asset-gallery.mdx +1 -1
- package/docs/reference/dashboard/components/asset-picker-dialog.mdx +1 -1
- package/docs/reference/dashboard/components/vendure-image.mdx +5 -5
- package/docs/reference/dashboard/detail-views/detail-page.mdx +2 -2
- package/docs/reference/dashboard/detail-views/use-generated-form.mdx +1 -1
- package/docs/reference/dashboard/extensions-api/form-components.mdx +1 -1
- package/docs/reference/dashboard/extensions-api/history-entries.mdx +3 -3
- package/docs/reference/dashboard/form-components/form-field-wrapper.mdx +1 -1
- package/docs/reference/dashboard/form-components/translatable-form-field-wrapper.mdx +1 -1
- package/docs/reference/dashboard/hooks/use-auth.mdx +1 -1
- package/docs/reference/dashboard/hooks/use-channel.mdx +1 -1
- package/docs/reference/dashboard/list-views/data-table.mdx +1 -1
- package/docs/reference/dashboard/list-views/list-page.mdx +2 -2
- package/docs/reference/dashboard/list-views/paginated-list-data-table.mdx +2 -2
- package/docs/reference/dashboard/page-layout/index.mdx +2 -2
- package/docs/reference/dashboard/page-layout/page-action-bar.mdx +2 -2
- package/docs/reference/dashboard/page-layout/page-block.mdx +4 -4
- package/docs/reference/dashboard/page-layout/page-title.mdx +1 -1
- package/docs/reference/dashboard/page-layout/page.mdx +4 -4
- package/docs/reference/dashboard/vite-plugin/vendure-dashboard-plugin.mdx +4 -4
- package/docs/reference/typescript-api/assets/asset-naming-strategy.mdx +1 -1
- package/docs/reference/typescript-api/assets/asset-preview-strategy.mdx +1 -1
- package/docs/reference/typescript-api/assets/asset-storage-strategy.mdx +1 -1
- package/docs/reference/typescript-api/assets/default-asset-naming-strategy.mdx +1 -1
- package/docs/reference/typescript-api/auth/auth-options.mdx +4 -4
- package/docs/reference/typescript-api/auth/authentication-strategy.mdx +2 -2
- package/docs/reference/typescript-api/auth/bcrypt-password-hashing-strategy.mdx +1 -1
- package/docs/reference/typescript-api/auth/default-password-validation-strategy.mdx +1 -1
- package/docs/reference/typescript-api/auth/default-session-cache-strategy.mdx +4 -4
- package/docs/reference/typescript-api/auth/default-verification-token-strategy.mdx +1 -1
- package/docs/reference/typescript-api/auth/external-authentication-service.mdx +1 -1
- package/docs/reference/typescript-api/auth/in-memory-session-cache-strategy.mdx +1 -1
- package/docs/reference/typescript-api/auth/native-authentication-strategy.mdx +1 -1
- package/docs/reference/typescript-api/auth/noop-session-cache-strategy.mdx +1 -1
- package/docs/reference/typescript-api/auth/password-hashing-strategy.mdx +2 -2
- package/docs/reference/typescript-api/auth/password-validation-strategy.mdx +2 -2
- package/docs/reference/typescript-api/auth/permission-definition.mdx +12 -12
- package/docs/reference/typescript-api/auth/session-cache-strategy.mdx +5 -5
- package/docs/reference/typescript-api/auth/verification-token-strategy.mdx +1 -1
- package/docs/reference/typescript-api/cache/cache-config.mdx +1 -1
- package/docs/reference/typescript-api/cache/cache-service.mdx +2 -2
- package/docs/reference/typescript-api/cache/cache-strategy.mdx +2 -2
- package/docs/reference/typescript-api/cache/default-cache-plugin.mdx +3 -3
- package/docs/reference/typescript-api/cache/index.mdx +2 -2
- package/docs/reference/typescript-api/cache/redis-cache-plugin.mdx +3 -3
- package/docs/reference/typescript-api/cache/redis-cache-strategy.mdx +2 -2
- package/docs/reference/typescript-api/cache/self-refreshing-cache.mdx +2 -2
- package/docs/reference/typescript-api/cache/sql-cache-strategy.mdx +3 -3
- package/docs/reference/typescript-api/common/admin-ui/admin-ui-config.mdx +1 -1
- package/docs/reference/typescript-api/common/id.mdx +1 -1
- package/docs/reference/typescript-api/common/injectable-strategy.mdx +1 -1
- package/docs/reference/typescript-api/common/middleware.mdx +1 -1
- package/docs/reference/typescript-api/common/permission.mdx +1 -1
- package/docs/reference/typescript-api/common/price-calculation-result.mdx +2 -2
- package/docs/reference/typescript-api/configurable-operation-def/config-arg-type.mdx +1 -1
- package/docs/reference/typescript-api/configurable-operation-def/config-args.mdx +3 -3
- package/docs/reference/typescript-api/configurable-operation-def/configurable-operation-def-options.mdx +3 -3
- package/docs/reference/typescript-api/configurable-operation-def/index.mdx +10 -10
- package/docs/reference/typescript-api/configurable-operation-def/localized-string-array.mdx +1 -1
- package/docs/reference/typescript-api/configuration/api-options.mdx +1 -1
- package/docs/reference/typescript-api/configuration/collection-filter.mdx +1 -1
- package/docs/reference/typescript-api/configuration/default-slug-strategy.mdx +1 -1
- package/docs/reference/typescript-api/configuration/entity-duplicator.mdx +2 -2
- package/docs/reference/typescript-api/configuration/entity-id-strategy.mdx +5 -5
- package/docs/reference/typescript-api/configuration/entity-options.mdx +2 -2
- package/docs/reference/typescript-api/configuration/product-variant-price-selection-strategy.mdx +2 -2
- package/docs/reference/typescript-api/configuration/product-variant-price-update-strategy.mdx +4 -4
- package/docs/reference/typescript-api/configuration/runtime-vendure-config.mdx +2 -2
- package/docs/reference/typescript-api/configuration/settings-store-fields.mdx +1 -1
- package/docs/reference/typescript-api/configuration/slug-strategy.mdx +1 -1
- package/docs/reference/typescript-api/configuration/system-options.mdx +3 -3
- package/docs/reference/typescript-api/configuration/vendure-config.mdx +2 -2
- package/docs/reference/typescript-api/custom-fields/index.mdx +1 -1
- package/docs/reference/typescript-api/custom-fields/typed-custom-single-field-config.mdx +1 -1
- package/docs/reference/typescript-api/data-access/calculated.mdx +2 -2
- package/docs/reference/typescript-api/data-access/entity-hydrator.mdx +1 -1
- package/docs/reference/typescript-api/data-access/get-entity-or-throw-options.mdx +2 -2
- package/docs/reference/typescript-api/data-access/hydrate-options.mdx +1 -1
- package/docs/reference/typescript-api/data-access/list-query-builder.mdx +1 -1
- package/docs/reference/typescript-api/data-access/transactional-connection.mdx +7 -7
- package/docs/reference/typescript-api/default-search-plugin/default-search-plugin-init-options.mdx +2 -2
- package/docs/reference/typescript-api/default-search-plugin/mysql-search-strategy.mdx +1 -1
- package/docs/reference/typescript-api/default-search-plugin/postgres-search-strategy.mdx +1 -1
- package/docs/reference/typescript-api/default-search-plugin/search-strategy.mdx +2 -2
- package/docs/reference/typescript-api/default-search-plugin/sqlite-search-strategy.mdx +1 -1
- package/docs/reference/typescript-api/entities/address.mdx +2 -2
- package/docs/reference/typescript-api/entities/administrator.mdx +3 -3
- package/docs/reference/typescript-api/entities/anonymous-session.mdx +1 -1
- package/docs/reference/typescript-api/entities/asset.mdx +2 -2
- package/docs/reference/typescript-api/entities/authenticated-session.mdx +3 -3
- package/docs/reference/typescript-api/entities/authentication-method.mdx +5 -5
- package/docs/reference/typescript-api/entities/channel.mdx +1 -1
- package/docs/reference/typescript-api/entities/collection.mdx +3 -3
- package/docs/reference/typescript-api/entities/country.mdx +4 -4
- package/docs/reference/typescript-api/entities/customer-group.mdx +2 -2
- package/docs/reference/typescript-api/entities/customer-history-entry.mdx +2 -2
- package/docs/reference/typescript-api/entities/customer.mdx +3 -3
- package/docs/reference/typescript-api/entities/facet-value.mdx +3 -3
- package/docs/reference/typescript-api/entities/facet.mdx +4 -4
- package/docs/reference/typescript-api/entities/fulfillment.mdx +2 -2
- package/docs/reference/typescript-api/entities/global-settings.mdx +1 -1
- package/docs/reference/typescript-api/entities/history-entry.mdx +3 -3
- package/docs/reference/typescript-api/entities/order-history-entry.mdx +2 -2
- package/docs/reference/typescript-api/entities/order-line-reference.mdx +8 -8
- package/docs/reference/typescript-api/entities/order-line.mdx +8 -8
- package/docs/reference/typescript-api/entities/order-modification.mdx +1 -1
- package/docs/reference/typescript-api/entities/order.mdx +9 -9
- package/docs/reference/typescript-api/entities/orderable-asset.mdx +2 -2
- package/docs/reference/typescript-api/entities/payment-method.mdx +4 -4
- package/docs/reference/typescript-api/entities/payment.mdx +2 -2
- package/docs/reference/typescript-api/entities/product-option-group.mdx +3 -3
- package/docs/reference/typescript-api/entities/product-option.mdx +3 -3
- package/docs/reference/typescript-api/entities/product-variant-price.mdx +1 -1
- package/docs/reference/typescript-api/entities/product-variant.mdx +3 -3
- package/docs/reference/typescript-api/entities/product.mdx +3 -3
- package/docs/reference/typescript-api/entities/promotion.mdx +3 -3
- package/docs/reference/typescript-api/entities/province.mdx +2 -2
- package/docs/reference/typescript-api/entities/refund.mdx +1 -1
- package/docs/reference/typescript-api/entities/region.mdx +4 -4
- package/docs/reference/typescript-api/entities/role.mdx +3 -3
- package/docs/reference/typescript-api/entities/seller.mdx +3 -3
- package/docs/reference/typescript-api/entities/session.mdx +3 -3
- package/docs/reference/typescript-api/entities/settings-store-entry.mdx +1 -1
- package/docs/reference/typescript-api/entities/shipping-line.mdx +2 -2
- package/docs/reference/typescript-api/entities/shipping-method.mdx +4 -4
- package/docs/reference/typescript-api/entities/stock-level.mdx +3 -3
- package/docs/reference/typescript-api/entities/stock-location.mdx +4 -4
- package/docs/reference/typescript-api/entities/stock-movement.mdx +7 -7
- package/docs/reference/typescript-api/entities/surcharge.mdx +2 -2
- package/docs/reference/typescript-api/entities/tag.mdx +1 -1
- package/docs/reference/typescript-api/entities/tax-category.mdx +2 -2
- package/docs/reference/typescript-api/entities/tax-rate.mdx +5 -5
- package/docs/reference/typescript-api/entities/user.mdx +3 -3
- package/docs/reference/typescript-api/entities/vendure-entity.mdx +1 -1
- package/docs/reference/typescript-api/entities/zone.mdx +2 -2
- package/docs/reference/typescript-api/errors/error-handler-strategy.mdx +1 -1
- package/docs/reference/typescript-api/errors/error-types.mdx +8 -8
- package/docs/reference/typescript-api/errors/is-graph-ql-error-result.mdx +1 -1
- package/docs/reference/typescript-api/events/event-bus.mdx +6 -6
- package/docs/reference/typescript-api/events/event-types.mdx +109 -109
- package/docs/reference/typescript-api/events/vendure-entity-event.mdx +1 -1
- package/docs/reference/typescript-api/fulfillment/fulfillment-handler.mdx +5 -5
- package/docs/reference/typescript-api/fulfillment/fulfillment-process.mdx +5 -5
- package/docs/reference/typescript-api/fulfillment/fulfillment-state.mdx +1 -1
- package/docs/reference/typescript-api/fulfillment/fulfillment-states.mdx +1 -1
- package/docs/reference/typescript-api/health-check/health-check-registry-service.mdx +3 -3
- package/docs/reference/typescript-api/health-check/health-check-strategy.mdx +2 -2
- package/docs/reference/typescript-api/health-check/http-health-check-strategy.mdx +2 -2
- package/docs/reference/typescript-api/health-check/type-ormhealth-check-strategy.mdx +2 -2
- package/docs/reference/typescript-api/import-export/asset-import-strategy.mdx +3 -3
- package/docs/reference/typescript-api/import-export/asset-importer.mdx +2 -2
- package/docs/reference/typescript-api/import-export/default-asset-import-strategy.mdx +1 -1
- package/docs/reference/typescript-api/import-export/import-export-options.mdx +1 -1
- package/docs/reference/typescript-api/import-export/import-parser.mdx +8 -8
- package/docs/reference/typescript-api/import-export/importer.mdx +2 -2
- package/docs/reference/typescript-api/import-export/populate.mdx +3 -3
- package/docs/reference/typescript-api/import-export/populator.mdx +2 -2
- package/docs/reference/typescript-api/job-queue/default-job-queue-plugin.mdx +5 -5
- package/docs/reference/typescript-api/job-queue/in-memory-job-buffer-storage-strategy.mdx +4 -4
- package/docs/reference/typescript-api/job-queue/in-memory-job-queue-strategy.mdx +4 -4
- package/docs/reference/typescript-api/job-queue/index.mdx +4 -4
- package/docs/reference/typescript-api/job-queue/inspectable-job-queue-strategy.mdx +1 -1
- package/docs/reference/typescript-api/job-queue/job-buffer-storage-strategy.mdx +2 -2
- package/docs/reference/typescript-api/job-queue/job-buffer.mdx +2 -2
- package/docs/reference/typescript-api/job-queue/job-queue-service.mdx +4 -4
- package/docs/reference/typescript-api/job-queue/job-queue-strategy.mdx +2 -2
- package/docs/reference/typescript-api/job-queue/job.mdx +2 -2
- package/docs/reference/typescript-api/job-queue/polling-job-queue-strategy.mdx +3 -3
- package/docs/reference/typescript-api/job-queue/sql-job-queue-strategy.mdx +4 -4
- package/docs/reference/typescript-api/job-queue/subscribable-job.mdx +5 -5
- package/docs/reference/typescript-api/job-queue/types.mdx +5 -5
- package/docs/reference/typescript-api/logger/default-logger.mdx +1 -1
- package/docs/reference/typescript-api/logger/index.mdx +3 -3
- package/docs/reference/typescript-api/migration/migration-options.mdx +1 -1
- package/docs/reference/typescript-api/money/big-int-money-strategy.mdx +3 -3
- package/docs/reference/typescript-api/money/default-money-strategy.mdx +2 -2
- package/docs/reference/typescript-api/money/money-decorator.mdx +1 -1
- package/docs/reference/typescript-api/money/money-strategy.mdx +5 -5
- package/docs/reference/typescript-api/money/round-money.mdx +1 -1
- package/docs/reference/typescript-api/orders/active-order-service.mdx +1 -1
- package/docs/reference/typescript-api/orders/active-order-strategy.mdx +2 -2
- package/docs/reference/typescript-api/orders/changed-price-handling-strategy.mdx +2 -2
- package/docs/reference/typescript-api/orders/custom-order-states.mdx +1 -1
- package/docs/reference/typescript-api/orders/default-active-order-strategy.mdx +2 -2
- package/docs/reference/typescript-api/orders/default-guest-checkout-strategy.mdx +3 -3
- package/docs/reference/typescript-api/orders/default-order-item-price-calculation-strategy.mdx +2 -2
- package/docs/reference/typescript-api/orders/default-order-placed-strategy.mdx +2 -2
- package/docs/reference/typescript-api/orders/default-stock-allocation-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/guest-checkout-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/merge-strategies.mdx +4 -4
- package/docs/reference/typescript-api/orders/order-by-code-access-strategy.mdx +2 -2
- package/docs/reference/typescript-api/orders/order-code-strategy.mdx +2 -2
- package/docs/reference/typescript-api/orders/order-interceptor.mdx +5 -5
- package/docs/reference/typescript-api/orders/order-item-price-calculation-strategy.mdx +3 -3
- package/docs/reference/typescript-api/orders/order-merge-strategy.mdx +2 -2
- package/docs/reference/typescript-api/orders/order-options.mdx +2 -2
- package/docs/reference/typescript-api/orders/order-placed-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/order-process.mdx +13 -13
- package/docs/reference/typescript-api/orders/order-seller-strategy.mdx +5 -5
- package/docs/reference/typescript-api/orders/stock-allocation-strategy.mdx +1 -1
- package/docs/reference/typescript-api/payment/default-payment-process.mdx +1 -1
- package/docs/reference/typescript-api/payment/default-refund-process.mdx +1 -1
- package/docs/reference/typescript-api/payment/payment-method-config-options.mdx +4 -4
- package/docs/reference/typescript-api/payment/payment-method-eligibility-checker.mdx +5 -5
- package/docs/reference/typescript-api/payment/payment-method-handler.mdx +2 -2
- package/docs/reference/typescript-api/payment/payment-method-types.mdx +16 -16
- package/docs/reference/typescript-api/payment/payment-options.mdx +7 -7
- package/docs/reference/typescript-api/payment/payment-process.mdx +2 -2
- package/docs/reference/typescript-api/payment/payment-states.mdx +1 -1
- package/docs/reference/typescript-api/payment/refund-process.mdx +2 -2
- package/docs/reference/typescript-api/payment/refund-states.mdx +1 -1
- package/docs/reference/typescript-api/plugin/plugin-common-module.mdx +3 -3
- package/docs/reference/typescript-api/plugin/plugin-utilities.mdx +1 -1
- package/docs/reference/typescript-api/plugin/vendure-plugin-metadata.mdx +3 -3
- package/docs/reference/typescript-api/products-stock/catalog-options.mdx +1 -1
- package/docs/reference/typescript-api/products-stock/default-product-variant-price-calculation-strategy.mdx +1 -1
- package/docs/reference/typescript-api/products-stock/default-stock-display-strategy.mdx +1 -1
- package/docs/reference/typescript-api/products-stock/default-stock-location-strategy.mdx +2 -2
- package/docs/reference/typescript-api/products-stock/multi-channel-stock-location-strategy.mdx +2 -2
- package/docs/reference/typescript-api/products-stock/product-variant-price-calculation-strategy.mdx +2 -2
- package/docs/reference/typescript-api/products-stock/stock-display-strategy.mdx +1 -1
- package/docs/reference/typescript-api/products-stock/stock-location-strategy.mdx +5 -5
- package/docs/reference/typescript-api/promotions/facet-value-checker.mdx +3 -3
- package/docs/reference/typescript-api/promotions/promotion-action.mdx +20 -20
- package/docs/reference/typescript-api/promotions/promotion-condition.mdx +6 -6
- package/docs/reference/typescript-api/request/allow-decorator.mdx +1 -1
- package/docs/reference/typescript-api/request/api-decorator.mdx +1 -1
- package/docs/reference/typescript-api/request/ctx-decorator.mdx +1 -1
- package/docs/reference/typescript-api/request/relations-decorator.mdx +1 -1
- package/docs/reference/typescript-api/request/request-context-service.mdx +1 -1
- package/docs/reference/typescript-api/request/request-context.mdx +5 -5
- package/docs/reference/typescript-api/request/transaction-decorator.mdx +2 -2
- package/docs/reference/typescript-api/scheduled-tasks/clean-sessions-task.mdx +1 -1
- package/docs/reference/typescript-api/scheduled-tasks/default-scheduler-plugin.mdx +1 -1
- package/docs/reference/typescript-api/scheduled-tasks/default-scheduler-strategy.mdx +3 -3
- package/docs/reference/typescript-api/scheduled-tasks/scheduler-options.mdx +2 -2
- package/docs/reference/typescript-api/scheduled-tasks/scheduler-strategy.mdx +4 -4
- package/docs/reference/typescript-api/service-helpers/entity-duplicator-service.mdx +3 -3
- package/docs/reference/typescript-api/service-helpers/order-modifier.mdx +1 -1
- package/docs/reference/typescript-api/service-helpers/product-price-applicator.mdx +1 -1
- package/docs/reference/typescript-api/service-helpers/slug-validator.mdx +1 -1
- package/docs/reference/typescript-api/service-helpers/translatable-saver.mdx +1 -1
- package/docs/reference/typescript-api/services/administrator-service.mdx +1 -1
- package/docs/reference/typescript-api/services/asset-service.mdx +3 -3
- package/docs/reference/typescript-api/services/auth-service.mdx +3 -3
- package/docs/reference/typescript-api/services/channel-service.mdx +3 -3
- package/docs/reference/typescript-api/services/collection-service.mdx +3 -3
- package/docs/reference/typescript-api/services/country-service.mdx +1 -1
- package/docs/reference/typescript-api/services/customer-group-service.mdx +2 -2
- package/docs/reference/typescript-api/services/customer-service.mdx +13 -13
- package/docs/reference/typescript-api/services/facet-service.mdx +1 -1
- package/docs/reference/typescript-api/services/facet-value-service.mdx +1 -1
- package/docs/reference/typescript-api/services/fulfillment-service.mdx +3 -3
- package/docs/reference/typescript-api/services/global-settings-service.mdx +1 -1
- package/docs/reference/typescript-api/services/history-service.mdx +1 -1
- package/docs/reference/typescript-api/services/order-service.mdx +24 -24
- package/docs/reference/typescript-api/services/payment-method-service.mdx +1 -1
- package/docs/reference/typescript-api/services/payment-service.mdx +6 -6
- package/docs/reference/typescript-api/services/product-option-group-service.mdx +1 -1
- package/docs/reference/typescript-api/services/product-option-service.mdx +1 -1
- package/docs/reference/typescript-api/services/product-service.mdx +2 -2
- package/docs/reference/typescript-api/services/product-variant-service.mdx +7 -7
- package/docs/reference/typescript-api/services/promotion-service.mdx +1 -1
- package/docs/reference/typescript-api/services/province-service.mdx +1 -1
- package/docs/reference/typescript-api/services/role-service.mdx +1 -1
- package/docs/reference/typescript-api/services/seller-service.mdx +1 -1
- package/docs/reference/typescript-api/services/session-service.mdx +4 -4
- package/docs/reference/typescript-api/services/shipping-method-service.mdx +1 -1
- package/docs/reference/typescript-api/services/stock-level-service.mdx +5 -5
- package/docs/reference/typescript-api/services/stock-location-service.mdx +5 -5
- package/docs/reference/typescript-api/services/stock-movement-service.mdx +8 -8
- package/docs/reference/typescript-api/services/tag-service.mdx +1 -1
- package/docs/reference/typescript-api/services/tax-category-service.mdx +1 -1
- package/docs/reference/typescript-api/services/tax-rate-service.mdx +1 -1
- package/docs/reference/typescript-api/services/user-service.mdx +8 -8
- package/docs/reference/typescript-api/services/zone-service.mdx +1 -1
- package/docs/reference/typescript-api/settings-store/index.mdx +1 -1
- package/docs/reference/typescript-api/shipping/check-shipping-eligibility-checker-fn.mdx +2 -2
- package/docs/reference/typescript-api/shipping/default-shipping-line-assignment-strategy.mdx +2 -2
- package/docs/reference/typescript-api/shipping/shipping-calculator.mdx +5 -5
- package/docs/reference/typescript-api/shipping/shipping-eligibility-checker-config.mdx +2 -2
- package/docs/reference/typescript-api/shipping/shipping-eligibility-checker.mdx +2 -2
- package/docs/reference/typescript-api/shipping/shipping-line-assignment-strategy.mdx +3 -3
- package/docs/reference/typescript-api/shipping/shipping-options.mdx +3 -3
- package/docs/reference/typescript-api/state-machine/state-machine-config.mdx +1 -1
- package/docs/reference/typescript-api/state-machine/transitions.mdx +2 -2
- package/docs/reference/typescript-api/tax/address-based-tax-zone-strategy.mdx +3 -3
- package/docs/reference/typescript-api/tax/default-tax-line-calculation-strategy.mdx +3 -3
- package/docs/reference/typescript-api/tax/default-tax-zone-strategy.mdx +2 -2
- package/docs/reference/typescript-api/tax/tax-line-calculation-strategy.mdx +3 -3
- package/docs/reference/typescript-api/tax/tax-zone-strategy.mdx +2 -2
- package/docs/reference/typescript-api/telemetry/instrument.mdx +1 -1
- package/docs/reference/typescript-api/telemetry/instrumentation-strategy.mdx +2 -2
- package/docs/reference/typescript-api/telemetry/wrapped-method-args.mdx +1 -1
- package/docs/reference/typescript-api/testing/create-error-result-guard.mdx +1 -1
- package/docs/reference/typescript-api/testing/create-test-environment.mdx +2 -2
- package/docs/reference/typescript-api/testing/get-superadmin-context.mdx +1 -1
- package/docs/reference/typescript-api/testing/register-initializer.mdx +2 -2
- package/docs/reference/typescript-api/testing/test-config.mdx +1 -1
- package/docs/reference/typescript-api/testing/test-db-initializer.mdx +1 -1
- package/docs/reference/typescript-api/testing/test-environment.mdx +1 -1
- package/docs/reference/typescript-api/testing/test-server-options.mdx +1 -1
- package/docs/reference/typescript-api/testing/testing-logger.mdx +1 -1
- package/docs/reference/typescript-api/worker/bootstrap-worker.mdx +2 -2
- package/docs/reference/typescript-api/worker/vendure-worker.mdx +1 -1
- package/package.json +1 -1
- package/src/dates.generated.ts +385 -385
|
@@ -12,7 +12,7 @@ class AccountRegistrationEvent extends VendureEvent {
|
|
|
12
12
|
constructor(ctx: RequestContext, user: User)
|
|
13
13
|
}
|
|
14
14
|
```
|
|
15
|
-
* Extends:
|
|
15
|
+
* Extends: [`VendureEvent`](/reference/typescript-api/events/vendure-event#vendureevent)
|
|
16
16
|
|
|
17
17
|
|
|
18
18
|
|
|
@@ -36,7 +36,7 @@ class AccountVerifiedEvent extends VendureEvent {
|
|
|
36
36
|
constructor(ctx: RequestContext, customer: Customer)
|
|
37
37
|
}
|
|
38
38
|
```
|
|
39
|
-
* Extends:
|
|
39
|
+
* Extends: [`VendureEvent`](/reference/typescript-api/events/vendure-event#vendureevent)
|
|
40
40
|
|
|
41
41
|
|
|
42
42
|
|
|
@@ -52,14 +52,14 @@ class AccountVerifiedEvent extends VendureEvent {
|
|
|
52
52
|
</div>
|
|
53
53
|
<GenerationInfo sourceFile="packages/core/src/event-bus/events/administrator-event.ts" sourceLine="18" packageName="@vendure/core" since="1.4" />
|
|
54
54
|
|
|
55
|
-
This event is fired whenever a
|
|
55
|
+
This event is fired whenever a [Administrator](/reference/typescript-api/entities/administrator#administrator) is added, updated or deleted.
|
|
56
56
|
|
|
57
57
|
```ts title="Signature"
|
|
58
58
|
class AdministratorEvent extends VendureEntityEvent<Administrator, AdministratorInputTypes> {
|
|
59
59
|
constructor(ctx: RequestContext, entity: Administrator, type: 'created' | 'updated' | 'deleted', input?: AdministratorInputTypes)
|
|
60
60
|
}
|
|
61
61
|
```
|
|
62
|
-
* Extends:
|
|
62
|
+
* Extends: [`VendureEntityEvent`](/reference/typescript-api/events/vendure-entity-event#vendureentityevent)`<`[`Administrator`](/reference/typescript-api/entities/administrator#administrator)`, AdministratorInputTypes>`
|
|
63
63
|
|
|
64
64
|
|
|
65
65
|
|
|
@@ -75,7 +75,7 @@ class AdministratorEvent extends VendureEntityEvent<Administrator, Administrator
|
|
|
75
75
|
</div>
|
|
76
76
|
<GenerationInfo sourceFile="packages/core/src/event-bus/events/asset-channel-event.ts" sourceLine="15" packageName="@vendure/core" />
|
|
77
77
|
|
|
78
|
-
This event is fired whenever an
|
|
78
|
+
This event is fired whenever an [Asset](/reference/typescript-api/entities/asset#asset) is assigned or removed
|
|
79
79
|
From a channel.
|
|
80
80
|
|
|
81
81
|
```ts title="Signature"
|
|
@@ -83,7 +83,7 @@ class AssetChannelEvent extends VendureEvent {
|
|
|
83
83
|
constructor(ctx: RequestContext, asset: Asset, channelId: ID, type: 'assigned' | 'removed')
|
|
84
84
|
}
|
|
85
85
|
```
|
|
86
|
-
* Extends:
|
|
86
|
+
* Extends: [`VendureEvent`](/reference/typescript-api/events/vendure-event#vendureevent)
|
|
87
87
|
|
|
88
88
|
|
|
89
89
|
|
|
@@ -99,7 +99,7 @@ class AssetChannelEvent extends VendureEvent {
|
|
|
99
99
|
</div>
|
|
100
100
|
<GenerationInfo sourceFile="packages/core/src/event-bus/events/asset-event.ts" sourceLine="18" packageName="@vendure/core" since="1.4" />
|
|
101
101
|
|
|
102
|
-
This event is fired whenever a
|
|
102
|
+
This event is fired whenever a [Asset](/reference/typescript-api/entities/asset#asset) is added, updated or deleted.
|
|
103
103
|
|
|
104
104
|
```ts title="Signature"
|
|
105
105
|
class AssetEvent extends VendureEntityEvent<Asset, AssetInputTypes> {
|
|
@@ -107,7 +107,7 @@ class AssetEvent extends VendureEntityEvent<Asset, AssetInputTypes> {
|
|
|
107
107
|
asset: Asset
|
|
108
108
|
}
|
|
109
109
|
```
|
|
110
|
-
* Extends:
|
|
110
|
+
* Extends: [`VendureEntityEvent`](/reference/typescript-api/events/vendure-entity-event#vendureentityevent)`<`[`Asset`](/reference/typescript-api/entities/asset#asset)`, AssetInputTypes>`
|
|
111
111
|
|
|
112
112
|
|
|
113
113
|
|
|
@@ -137,7 +137,7 @@ class AttemptedLoginEvent extends VendureEvent {
|
|
|
137
137
|
constructor(ctx: RequestContext, strategy: string, identifier?: string)
|
|
138
138
|
}
|
|
139
139
|
```
|
|
140
|
-
* Extends:
|
|
140
|
+
* Extends: [`VendureEvent`](/reference/typescript-api/events/vendure-event#vendureevent)
|
|
141
141
|
|
|
142
142
|
|
|
143
143
|
|
|
@@ -153,7 +153,7 @@ class AttemptedLoginEvent extends VendureEvent {
|
|
|
153
153
|
</div>
|
|
154
154
|
<GenerationInfo sourceFile="packages/core/src/event-bus/events/change-channel-event.ts" sourceLine="17" packageName="@vendure/core" since="1.4" />
|
|
155
155
|
|
|
156
|
-
This event is fired whenever an
|
|
156
|
+
This event is fired whenever an [ChannelAware](/reference/typescript-api/entities/interfaces#channelaware) entity is assigned or removed
|
|
157
157
|
from a channel. The entity property contains the value before updating the channels.
|
|
158
158
|
|
|
159
159
|
```ts title="Signature"
|
|
@@ -161,7 +161,7 @@ class ChangeChannelEvent<T extends ChannelAware & VendureEntity> extends Vendure
|
|
|
161
161
|
constructor(ctx: RequestContext, entity: T, channelIds: ID[], type: 'assigned' | 'removed', entityType?: Type<T>)
|
|
162
162
|
}
|
|
163
163
|
```
|
|
164
|
-
* Extends:
|
|
164
|
+
* Extends: [`VendureEvent`](/reference/typescript-api/events/vendure-event#vendureevent)
|
|
165
165
|
|
|
166
166
|
|
|
167
167
|
|
|
@@ -177,14 +177,14 @@ class ChangeChannelEvent<T extends ChannelAware & VendureEntity> extends Vendure
|
|
|
177
177
|
</div>
|
|
178
178
|
<GenerationInfo sourceFile="packages/core/src/event-bus/events/channel-event.ts" sourceLine="18" packageName="@vendure/core" since="1.4" />
|
|
179
179
|
|
|
180
|
-
This event is fired whenever a
|
|
180
|
+
This event is fired whenever a [Channel](/reference/typescript-api/entities/channel#channel) is added, updated or deleted.
|
|
181
181
|
|
|
182
182
|
```ts title="Signature"
|
|
183
183
|
class ChannelEvent extends VendureEntityEvent<Channel, ChannelInputTypes> {
|
|
184
184
|
constructor(ctx: RequestContext, entity: Channel, type: 'created' | 'updated' | 'deleted', input?: ChannelInputTypes)
|
|
185
185
|
}
|
|
186
186
|
```
|
|
187
|
-
* Extends:
|
|
187
|
+
* Extends: [`VendureEntityEvent`](/reference/typescript-api/events/vendure-entity-event#vendureentityevent)`<`[`Channel`](/reference/typescript-api/entities/channel#channel)`, ChannelInputTypes>`
|
|
188
188
|
|
|
189
189
|
|
|
190
190
|
|
|
@@ -200,14 +200,14 @@ class ChannelEvent extends VendureEntityEvent<Channel, ChannelInputTypes> {
|
|
|
200
200
|
</div>
|
|
201
201
|
<GenerationInfo sourceFile="packages/core/src/event-bus/events/collection-event.ts" sourceLine="18" packageName="@vendure/core" since="1.4" />
|
|
202
202
|
|
|
203
|
-
This event is fired whenever a
|
|
203
|
+
This event is fired whenever a [Collection](/reference/typescript-api/entities/collection#collection) is added, updated or deleted.
|
|
204
204
|
|
|
205
205
|
```ts title="Signature"
|
|
206
206
|
class CollectionEvent extends VendureEntityEvent<Collection, CollectionInputTypes> {
|
|
207
207
|
constructor(ctx: RequestContext, entity: Collection, type: 'created' | 'updated' | 'deleted', input?: CollectionInputTypes)
|
|
208
208
|
}
|
|
209
209
|
```
|
|
210
|
-
* Extends:
|
|
210
|
+
* Extends: [`VendureEntityEvent`](/reference/typescript-api/events/vendure-entity-event#vendureentityevent)`<`[`Collection`](/reference/typescript-api/entities/collection#collection)`, CollectionInputTypes>`
|
|
211
211
|
|
|
212
212
|
|
|
213
213
|
|
|
@@ -234,7 +234,7 @@ class CollectionModificationEvent extends VendureEvent {
|
|
|
234
234
|
constructor(ctx: RequestContext, collection: Collection, productVariantIds: ID[])
|
|
235
235
|
}
|
|
236
236
|
```
|
|
237
|
-
* Extends:
|
|
237
|
+
* Extends: [`VendureEvent`](/reference/typescript-api/events/vendure-event#vendureevent)
|
|
238
238
|
|
|
239
239
|
|
|
240
240
|
|
|
@@ -250,14 +250,14 @@ class CollectionModificationEvent extends VendureEvent {
|
|
|
250
250
|
</div>
|
|
251
251
|
<GenerationInfo sourceFile="packages/core/src/event-bus/events/country-event.ts" sourceLine="18" packageName="@vendure/core" since="1.4" />
|
|
252
252
|
|
|
253
|
-
This event is fired whenever a
|
|
253
|
+
This event is fired whenever a [Country](/reference/typescript-api/entities/country#country) is added, updated or deleted.
|
|
254
254
|
|
|
255
255
|
```ts title="Signature"
|
|
256
256
|
class CountryEvent extends VendureEntityEvent<Country, CountryInputTypes> {
|
|
257
257
|
constructor(ctx: RequestContext, entity: Country, type: 'created' | 'updated' | 'deleted', input?: CountryInputTypes)
|
|
258
258
|
}
|
|
259
259
|
```
|
|
260
|
-
* Extends:
|
|
260
|
+
* Extends: [`VendureEntityEvent`](/reference/typescript-api/events/vendure-entity-event#vendureentityevent)`<`[`Country`](/reference/typescript-api/entities/country#country)`, CountryInputTypes>`
|
|
261
261
|
|
|
262
262
|
|
|
263
263
|
|
|
@@ -273,15 +273,15 @@ class CountryEvent extends VendureEntityEvent<Country, CountryInputTypes> {
|
|
|
273
273
|
</div>
|
|
274
274
|
<GenerationInfo sourceFile="packages/core/src/event-bus/events/coupon-code-event.ts" sourceLine="15" packageName="@vendure/core" since="1.4" />
|
|
275
275
|
|
|
276
|
-
This event is fired whenever an coupon code of an active
|
|
277
|
-
is assigned or removed to an
|
|
276
|
+
This event is fired whenever an coupon code of an active [Promotion](/reference/typescript-api/entities/promotion#promotion)
|
|
277
|
+
is assigned or removed to an [Order](/reference/typescript-api/entities/order#order).
|
|
278
278
|
|
|
279
279
|
```ts title="Signature"
|
|
280
280
|
class CouponCodeEvent extends VendureEvent {
|
|
281
281
|
constructor(ctx: RequestContext, couponCode: string, orderId: ID, type: 'assigned' | 'removed')
|
|
282
282
|
}
|
|
283
283
|
```
|
|
284
|
-
* Extends:
|
|
284
|
+
* Extends: [`VendureEvent`](/reference/typescript-api/events/vendure-event#vendureevent)
|
|
285
285
|
|
|
286
286
|
|
|
287
287
|
|
|
@@ -297,7 +297,7 @@ class CouponCodeEvent extends VendureEvent {
|
|
|
297
297
|
</div>
|
|
298
298
|
<GenerationInfo sourceFile="packages/core/src/event-bus/events/customer-address-event.ts" sourceLine="22" packageName="@vendure/core" since="1.4" />
|
|
299
299
|
|
|
300
|
-
This event is fired whenever a
|
|
300
|
+
This event is fired whenever a [Address](/reference/typescript-api/entities/address#address) is added, updated
|
|
301
301
|
or deleted.
|
|
302
302
|
|
|
303
303
|
```ts title="Signature"
|
|
@@ -306,7 +306,7 @@ class CustomerAddressEvent extends VendureEntityEvent<Address, CustomerAddressIn
|
|
|
306
306
|
address: Address
|
|
307
307
|
}
|
|
308
308
|
```
|
|
309
|
-
* Extends:
|
|
309
|
+
* Extends: [`VendureEntityEvent`](/reference/typescript-api/events/vendure-entity-event#vendureentityevent)`<`[`Address`](/reference/typescript-api/entities/address#address)`, CustomerAddressInputTypes>`
|
|
310
310
|
|
|
311
311
|
|
|
312
312
|
|
|
@@ -327,7 +327,7 @@ class CustomerAddressEvent extends VendureEntityEvent<Address, CustomerAddressIn
|
|
|
327
327
|
</div>
|
|
328
328
|
<GenerationInfo sourceFile="packages/core/src/event-bus/events/customer-event.ts" sourceLine="22" packageName="@vendure/core" />
|
|
329
329
|
|
|
330
|
-
This event is fired whenever a
|
|
330
|
+
This event is fired whenever a [Customer](/reference/typescript-api/entities/customer#customer) is added, updated
|
|
331
331
|
or deleted.
|
|
332
332
|
|
|
333
333
|
```ts title="Signature"
|
|
@@ -336,7 +336,7 @@ class CustomerEvent extends VendureEntityEvent<Customer, CustomerInputTypes> {
|
|
|
336
336
|
customer: Customer
|
|
337
337
|
}
|
|
338
338
|
```
|
|
339
|
-
* Extends:
|
|
339
|
+
* Extends: [`VendureEntityEvent`](/reference/typescript-api/events/vendure-entity-event#vendureentityevent)`<`[`Customer`](/reference/typescript-api/entities/customer#customer)`, CustomerInputTypes>`
|
|
340
340
|
|
|
341
341
|
|
|
342
342
|
|
|
@@ -357,15 +357,15 @@ class CustomerEvent extends VendureEntityEvent<Customer, CustomerInputTypes> {
|
|
|
357
357
|
</div>
|
|
358
358
|
<GenerationInfo sourceFile="packages/core/src/event-bus/events/customer-group-change-event.ts" sourceLine="15" packageName="@vendure/core" since="1.4" />
|
|
359
359
|
|
|
360
|
-
This event is fired whenever one or more
|
|
361
|
-
|
|
360
|
+
This event is fired whenever one or more [Customer](/reference/typescript-api/entities/customer#customer) is assigned to or removed from a
|
|
361
|
+
[CustomerGroup](/reference/typescript-api/entities/customer-group#customergroup).
|
|
362
362
|
|
|
363
363
|
```ts title="Signature"
|
|
364
364
|
class CustomerGroupChangeEvent extends VendureEvent {
|
|
365
365
|
constructor(ctx: RequestContext, customers: Customer[], customGroup: CustomerGroup, type: 'assigned' | 'removed')
|
|
366
366
|
}
|
|
367
367
|
```
|
|
368
|
-
* Extends:
|
|
368
|
+
* Extends: [`VendureEvent`](/reference/typescript-api/events/vendure-event#vendureevent)
|
|
369
369
|
|
|
370
370
|
|
|
371
371
|
|
|
@@ -381,14 +381,14 @@ class CustomerGroupChangeEvent extends VendureEvent {
|
|
|
381
381
|
</div>
|
|
382
382
|
<GenerationInfo sourceFile="packages/core/src/event-bus/events/customer-group-event.ts" sourceLine="18" packageName="@vendure/core" since="1.4" />
|
|
383
383
|
|
|
384
|
-
This event is fired whenever a
|
|
384
|
+
This event is fired whenever a [CustomerGroup](/reference/typescript-api/entities/customer-group#customergroup) is added, updated or deleted.
|
|
385
385
|
|
|
386
386
|
```ts title="Signature"
|
|
387
387
|
class CustomerGroupEvent extends VendureEntityEvent<CustomerGroup, CustomerGroupInputTypes> {
|
|
388
388
|
constructor(ctx: RequestContext, entity: CustomerGroup, type: 'created' | 'updated' | 'deleted', input?: CustomerGroupInputTypes)
|
|
389
389
|
}
|
|
390
390
|
```
|
|
391
|
-
* Extends:
|
|
391
|
+
* Extends: [`VendureEntityEvent`](/reference/typescript-api/events/vendure-entity-event#vendureentityevent)`<`[`CustomerGroup`](/reference/typescript-api/entities/customer-group#customergroup)`, CustomerGroupInputTypes>`
|
|
392
392
|
|
|
393
393
|
|
|
394
394
|
|
|
@@ -404,14 +404,14 @@ class CustomerGroupEvent extends VendureEntityEvent<CustomerGroup, CustomerGroup
|
|
|
404
404
|
</div>
|
|
405
405
|
<GenerationInfo sourceFile="packages/core/src/event-bus/events/facet-event.ts" sourceLine="18" packageName="@vendure/core" since="1.4" />
|
|
406
406
|
|
|
407
|
-
This event is fired whenever a
|
|
407
|
+
This event is fired whenever a [Facet](/reference/typescript-api/entities/facet#facet) is added, updated or deleted.
|
|
408
408
|
|
|
409
409
|
```ts title="Signature"
|
|
410
410
|
class FacetEvent extends VendureEntityEvent<Facet, FacetInputTypes> {
|
|
411
411
|
constructor(ctx: RequestContext, entity: Facet, type: 'created' | 'updated' | 'deleted', input?: FacetInputTypes)
|
|
412
412
|
}
|
|
413
413
|
```
|
|
414
|
-
* Extends:
|
|
414
|
+
* Extends: [`VendureEntityEvent`](/reference/typescript-api/events/vendure-entity-event#vendureentityevent)`<`[`Facet`](/reference/typescript-api/entities/facet#facet)`, FacetInputTypes>`
|
|
415
415
|
|
|
416
416
|
|
|
417
417
|
|
|
@@ -427,14 +427,14 @@ class FacetEvent extends VendureEntityEvent<Facet, FacetInputTypes> {
|
|
|
427
427
|
</div>
|
|
428
428
|
<GenerationInfo sourceFile="packages/core/src/event-bus/events/facet-value-event.ts" sourceLine="26" packageName="@vendure/core" since="1.4" />
|
|
429
429
|
|
|
430
|
-
This event is fired whenever a
|
|
430
|
+
This event is fired whenever a [FacetValue](/reference/typescript-api/entities/facet-value#facetvalue) is added, updated or deleted.
|
|
431
431
|
|
|
432
432
|
```ts title="Signature"
|
|
433
433
|
class FacetValueEvent extends VendureEntityEvent<FacetValue, FacetValueInputTypes> {
|
|
434
434
|
constructor(ctx: RequestContext, entity: FacetValue, type: 'created' | 'updated' | 'deleted', input?: FacetValueInputTypes)
|
|
435
435
|
}
|
|
436
436
|
```
|
|
437
|
-
* Extends:
|
|
437
|
+
* Extends: [`VendureEntityEvent`](/reference/typescript-api/events/vendure-entity-event#vendureentityevent)`<`[`FacetValue`](/reference/typescript-api/entities/facet-value#facetvalue)`, FacetValueInputTypes>`
|
|
438
438
|
|
|
439
439
|
|
|
440
440
|
|
|
@@ -450,14 +450,14 @@ class FacetValueEvent extends VendureEntityEvent<FacetValue, FacetValueInputType
|
|
|
450
450
|
</div>
|
|
451
451
|
<GenerationInfo sourceFile="packages/core/src/event-bus/events/fulfillment-event.ts" sourceLine="27" packageName="@vendure/core" since="1.4" />
|
|
452
452
|
|
|
453
|
-
This event is fired whenever a
|
|
453
|
+
This event is fired whenever a [Fulfillment](/reference/typescript-api/entities/fulfillment#fulfillment) is added. The type is always `created`.
|
|
454
454
|
|
|
455
455
|
```ts title="Signature"
|
|
456
456
|
class FulfillmentEvent extends VendureEntityEvent<Fulfillment, CreateFulfillmentInput> {
|
|
457
457
|
constructor(ctx: RequestContext, entity: Fulfillment, input?: CreateFulfillmentInput)
|
|
458
458
|
}
|
|
459
459
|
```
|
|
460
|
-
* Extends:
|
|
460
|
+
* Extends: [`VendureEntityEvent`](/reference/typescript-api/events/vendure-entity-event#vendureentityevent)`<`[`Fulfillment`](/reference/typescript-api/entities/fulfillment#fulfillment)`, CreateFulfillmentInput>`
|
|
461
461
|
|
|
462
462
|
|
|
463
463
|
|
|
@@ -473,14 +473,14 @@ class FulfillmentEvent extends VendureEntityEvent<Fulfillment, CreateFulfillment
|
|
|
473
473
|
</div>
|
|
474
474
|
<GenerationInfo sourceFile="packages/core/src/event-bus/events/fulfillment-state-transition-event.ts" sourceLine="13" packageName="@vendure/core" />
|
|
475
475
|
|
|
476
|
-
This event is fired whenever an
|
|
476
|
+
This event is fired whenever an [Fulfillment](/reference/typescript-api/entities/fulfillment#fulfillment) transitions from one [FulfillmentState](/reference/typescript-api/fulfillment/fulfillment-state#fulfillmentstate) to another.
|
|
477
477
|
|
|
478
478
|
```ts title="Signature"
|
|
479
479
|
class FulfillmentStateTransitionEvent extends VendureEvent {
|
|
480
480
|
constructor(fromState: FulfillmentState, toState: FulfillmentState, ctx: RequestContext, fulfillment: Fulfillment)
|
|
481
481
|
}
|
|
482
482
|
```
|
|
483
|
-
* Extends:
|
|
483
|
+
* Extends: [`VendureEvent`](/reference/typescript-api/events/vendure-event#vendureevent)
|
|
484
484
|
|
|
485
485
|
|
|
486
486
|
|
|
@@ -496,7 +496,7 @@ class FulfillmentStateTransitionEvent extends VendureEvent {
|
|
|
496
496
|
</div>
|
|
497
497
|
<GenerationInfo sourceFile="packages/core/src/event-bus/events/global-settings-event.ts" sourceLine="16" packageName="@vendure/core" since="1.4" />
|
|
498
498
|
|
|
499
|
-
This event is fired whenever a
|
|
499
|
+
This event is fired whenever a [GlobalSettings](/reference/typescript-api/entities/global-settings#globalsettings) is added. The type is always `updated`, because it's
|
|
500
500
|
only created once and never deleted.
|
|
501
501
|
|
|
502
502
|
```ts title="Signature"
|
|
@@ -504,7 +504,7 @@ class GlobalSettingsEvent extends VendureEntityEvent<GlobalSettings, UpdateGloba
|
|
|
504
504
|
constructor(ctx: RequestContext, entity: GlobalSettings, input?: UpdateGlobalSettingsInput)
|
|
505
505
|
}
|
|
506
506
|
```
|
|
507
|
-
* Extends:
|
|
507
|
+
* Extends: [`VendureEntityEvent`](/reference/typescript-api/events/vendure-entity-event#vendureentityevent)`<`[`GlobalSettings`](/reference/typescript-api/entities/global-settings#globalsettings)`, UpdateGlobalSettingsInput>`
|
|
508
508
|
|
|
509
509
|
|
|
510
510
|
|
|
@@ -520,7 +520,7 @@ class GlobalSettingsEvent extends VendureEntityEvent<GlobalSettings, UpdateGloba
|
|
|
520
520
|
</div>
|
|
521
521
|
<GenerationInfo sourceFile="packages/core/src/event-bus/events/history-entry-event.ts" sourceLine="23" packageName="@vendure/core" since="1.4" />
|
|
522
522
|
|
|
523
|
-
This event is fired whenever one
|
|
523
|
+
This event is fired whenever one [HistoryEntry](/reference/typescript-api/entities/history-entry#historyentry) is added, updated or deleted.
|
|
524
524
|
|
|
525
525
|
```ts title="Signature"
|
|
526
526
|
class HistoryEntryEvent extends VendureEntityEvent<HistoryEntry, HistoryInput> {
|
|
@@ -528,7 +528,7 @@ class HistoryEntryEvent extends VendureEntityEvent<HistoryEntry, HistoryInput> {
|
|
|
528
528
|
constructor(ctx: RequestContext, entity: HistoryEntry, type: 'created' | 'updated' | 'deleted', historyType: 'order' | 'customer' | string, input?: HistoryInput)
|
|
529
529
|
}
|
|
530
530
|
```
|
|
531
|
-
* Extends:
|
|
531
|
+
* Extends: [`VendureEntityEvent`](/reference/typescript-api/events/vendure-entity-event#vendureentityevent)`<`[`HistoryEntry`](/reference/typescript-api/entities/history-entry#historyentry)`, HistoryInput>`
|
|
532
532
|
|
|
533
533
|
|
|
534
534
|
|
|
@@ -557,7 +557,7 @@ class IdentifierChangeEvent extends VendureEvent {
|
|
|
557
557
|
constructor(ctx: RequestContext, user: User, oldIdentifier: string)
|
|
558
558
|
}
|
|
559
559
|
```
|
|
560
|
-
* Extends:
|
|
560
|
+
* Extends: [`VendureEvent`](/reference/typescript-api/events/vendure-event#vendureevent)
|
|
561
561
|
|
|
562
562
|
|
|
563
563
|
|
|
@@ -581,7 +581,7 @@ class IdentifierChangeRequestEvent extends VendureEvent {
|
|
|
581
581
|
constructor(ctx: RequestContext, user: User)
|
|
582
582
|
}
|
|
583
583
|
```
|
|
584
|
-
* Extends:
|
|
584
|
+
* Extends: [`VendureEvent`](/reference/typescript-api/events/vendure-event#vendureevent)
|
|
585
585
|
|
|
586
586
|
|
|
587
587
|
|
|
@@ -597,14 +597,14 @@ class IdentifierChangeRequestEvent extends VendureEvent {
|
|
|
597
597
|
</div>
|
|
598
598
|
<GenerationInfo sourceFile="packages/core/src/event-bus/events/initializer-event.ts" sourceLine="11" packageName="@vendure/core" since="1.7.0" />
|
|
599
599
|
|
|
600
|
-
This event is fired when vendure finished initializing its services inside the
|
|
600
|
+
This event is fired when vendure finished initializing its services inside the [InitializerService](/reference/typescript-api/services/initializer-service#initializerservice)
|
|
601
601
|
|
|
602
602
|
```ts title="Signature"
|
|
603
603
|
class InitializerEvent extends VendureEvent {
|
|
604
604
|
constructor()
|
|
605
605
|
}
|
|
606
606
|
```
|
|
607
|
-
* Extends:
|
|
607
|
+
* Extends: [`VendureEvent`](/reference/typescript-api/events/vendure-event#vendureevent)
|
|
608
608
|
|
|
609
609
|
|
|
610
610
|
|
|
@@ -627,7 +627,7 @@ class LoginEvent extends VendureEvent {
|
|
|
627
627
|
constructor(ctx: RequestContext, user: User)
|
|
628
628
|
}
|
|
629
629
|
```
|
|
630
|
-
* Extends:
|
|
630
|
+
* Extends: [`VendureEvent`](/reference/typescript-api/events/vendure-event#vendureevent)
|
|
631
631
|
|
|
632
632
|
|
|
633
633
|
|
|
@@ -650,7 +650,7 @@ class LogoutEvent extends VendureEvent {
|
|
|
650
650
|
constructor(ctx: RequestContext)
|
|
651
651
|
}
|
|
652
652
|
```
|
|
653
|
-
* Extends:
|
|
653
|
+
* Extends: [`VendureEvent`](/reference/typescript-api/events/vendure-event#vendureevent)
|
|
654
654
|
|
|
655
655
|
|
|
656
656
|
|
|
@@ -666,7 +666,7 @@ class LogoutEvent extends VendureEvent {
|
|
|
666
666
|
</div>
|
|
667
667
|
<GenerationInfo sourceFile="packages/core/src/event-bus/events/order-event.ts" sourceLine="17" packageName="@vendure/core" />
|
|
668
668
|
|
|
669
|
-
This event is fired whenever an
|
|
669
|
+
This event is fired whenever an [Order](/reference/typescript-api/entities/order#order) is added, updated
|
|
670
670
|
or deleted.
|
|
671
671
|
|
|
672
672
|
```ts title="Signature"
|
|
@@ -675,7 +675,7 @@ class OrderEvent extends VendureEntityEvent<Order, OrderInputTypes> {
|
|
|
675
675
|
order: Order
|
|
676
676
|
}
|
|
677
677
|
```
|
|
678
|
-
* Extends:
|
|
678
|
+
* Extends: [`VendureEntityEvent`](/reference/typescript-api/events/vendure-entity-event#vendureentityevent)`<`[`Order`](/reference/typescript-api/entities/order#order)`, OrderInputTypes>`
|
|
679
679
|
|
|
680
680
|
|
|
681
681
|
|
|
@@ -696,7 +696,7 @@ class OrderEvent extends VendureEntityEvent<Order, OrderInputTypes> {
|
|
|
696
696
|
</div>
|
|
697
697
|
<GenerationInfo sourceFile="packages/core/src/event-bus/events/order-line-event.ts" sourceLine="13" packageName="@vendure/core" />
|
|
698
698
|
|
|
699
|
-
This event is fired whenever an
|
|
699
|
+
This event is fired whenever an [OrderLine](/reference/typescript-api/entities/order-line#orderline) is added, updated
|
|
700
700
|
or deleted.
|
|
701
701
|
|
|
702
702
|
```ts title="Signature"
|
|
@@ -704,7 +704,7 @@ class OrderLineEvent extends VendureEvent {
|
|
|
704
704
|
constructor(ctx: RequestContext, order: Order, orderLine: OrderLine, type: 'created' | 'updated' | 'deleted' | 'cancelled')
|
|
705
705
|
}
|
|
706
706
|
```
|
|
707
|
-
* Extends:
|
|
707
|
+
* Extends: [`VendureEvent`](/reference/typescript-api/events/vendure-event#vendureevent)
|
|
708
708
|
|
|
709
709
|
|
|
710
710
|
|
|
@@ -720,18 +720,18 @@ class OrderLineEvent extends VendureEvent {
|
|
|
720
720
|
</div>
|
|
721
721
|
<GenerationInfo sourceFile="packages/core/src/event-bus/events/order-placed-event.ts" sourceLine="17" packageName="@vendure/core" />
|
|
722
722
|
|
|
723
|
-
This event is fired whenever an
|
|
723
|
+
This event is fired whenever an [Order](/reference/typescript-api/entities/order#order) is set as "placed", which by default is
|
|
724
724
|
when it transitions from 'ArrangingPayment' to either 'PaymentAuthorized' or 'PaymentSettled'.
|
|
725
725
|
|
|
726
726
|
Note that the exact point that it is set as "placed" can be configured according to the
|
|
727
|
-
|
|
727
|
+
[OrderPlacedStrategy](/reference/typescript-api/orders/order-placed-strategy#orderplacedstrategy).
|
|
728
728
|
|
|
729
729
|
```ts title="Signature"
|
|
730
730
|
class OrderPlacedEvent extends VendureEvent {
|
|
731
731
|
constructor(fromState: OrderState, toState: OrderState, ctx: RequestContext, order: Order)
|
|
732
732
|
}
|
|
733
733
|
```
|
|
734
|
-
* Extends:
|
|
734
|
+
* Extends: [`VendureEvent`](/reference/typescript-api/events/vendure-event#vendureevent)
|
|
735
735
|
|
|
736
736
|
|
|
737
737
|
|
|
@@ -747,14 +747,14 @@ class OrderPlacedEvent extends VendureEvent {
|
|
|
747
747
|
</div>
|
|
748
748
|
<GenerationInfo sourceFile="packages/core/src/event-bus/events/order-state-transition-event.ts" sourceLine="13" packageName="@vendure/core" />
|
|
749
749
|
|
|
750
|
-
This event is fired whenever an
|
|
750
|
+
This event is fired whenever an [Order](/reference/typescript-api/entities/order#order) transitions from one [OrderState](/reference/typescript-api/orders/order-process#orderstate) to another.
|
|
751
751
|
|
|
752
752
|
```ts title="Signature"
|
|
753
753
|
class OrderStateTransitionEvent extends VendureEvent {
|
|
754
754
|
constructor(fromState: OrderState, toState: OrderState, ctx: RequestContext, order: Order)
|
|
755
755
|
}
|
|
756
756
|
```
|
|
757
|
-
* Extends:
|
|
757
|
+
* Extends: [`VendureEvent`](/reference/typescript-api/events/vendure-event#vendureevent)
|
|
758
758
|
|
|
759
759
|
|
|
760
760
|
|
|
@@ -777,7 +777,7 @@ class PasswordResetEvent extends VendureEvent {
|
|
|
777
777
|
constructor(ctx: RequestContext, user: User)
|
|
778
778
|
}
|
|
779
779
|
```
|
|
780
|
-
* Extends:
|
|
780
|
+
* Extends: [`VendureEvent`](/reference/typescript-api/events/vendure-event#vendureevent)
|
|
781
781
|
|
|
782
782
|
|
|
783
783
|
|
|
@@ -800,7 +800,7 @@ class PasswordResetVerifiedEvent extends VendureEvent {
|
|
|
800
800
|
constructor(ctx: RequestContext, user: User)
|
|
801
801
|
}
|
|
802
802
|
```
|
|
803
|
-
* Extends:
|
|
803
|
+
* Extends: [`VendureEvent`](/reference/typescript-api/events/vendure-event#vendureevent)
|
|
804
804
|
|
|
805
805
|
|
|
806
806
|
|
|
@@ -816,7 +816,7 @@ class PasswordResetVerifiedEvent extends VendureEvent {
|
|
|
816
816
|
</div>
|
|
817
817
|
<GenerationInfo sourceFile="packages/core/src/event-bus/events/payment-method-event.ts" sourceLine="18" packageName="@vendure/core" />
|
|
818
818
|
|
|
819
|
-
This event is fired whenever a
|
|
819
|
+
This event is fired whenever a [PaymentMethod](/reference/typescript-api/entities/payment-method#paymentmethod) is added, updated
|
|
820
820
|
or deleted.
|
|
821
821
|
|
|
822
822
|
```ts title="Signature"
|
|
@@ -824,7 +824,7 @@ class PaymentMethodEvent extends VendureEntityEvent<PaymentMethod, PaymentMethod
|
|
|
824
824
|
constructor(ctx: RequestContext, entity: PaymentMethod, type: 'created' | 'updated' | 'deleted', input?: PaymentMethodInputTypes)
|
|
825
825
|
}
|
|
826
826
|
```
|
|
827
|
-
* Extends:
|
|
827
|
+
* Extends: [`VendureEntityEvent`](/reference/typescript-api/events/vendure-entity-event#vendureentityevent)`<`[`PaymentMethod`](/reference/typescript-api/entities/payment-method#paymentmethod)`, PaymentMethodInputTypes>`
|
|
828
828
|
|
|
829
829
|
|
|
830
830
|
|
|
@@ -840,7 +840,7 @@ class PaymentMethodEvent extends VendureEntityEvent<PaymentMethod, PaymentMethod
|
|
|
840
840
|
</div>
|
|
841
841
|
<GenerationInfo sourceFile="packages/core/src/event-bus/events/payment-state-transition-event.ts" sourceLine="15" packageName="@vendure/core" />
|
|
842
842
|
|
|
843
|
-
This event is fired whenever a
|
|
843
|
+
This event is fired whenever a [Payment](/reference/typescript-api/entities/payment#payment) transitions from one [PaymentState](/reference/typescript-api/payment/payment-state#paymentstate) to another, e.g.
|
|
844
844
|
a Payment is authorized by the payment provider.
|
|
845
845
|
|
|
846
846
|
```ts title="Signature"
|
|
@@ -848,7 +848,7 @@ class PaymentStateTransitionEvent extends VendureEvent {
|
|
|
848
848
|
constructor(fromState: PaymentState, toState: PaymentState, ctx: RequestContext, payment: Payment, order: Order)
|
|
849
849
|
}
|
|
850
850
|
```
|
|
851
|
-
* Extends:
|
|
851
|
+
* Extends: [`VendureEvent`](/reference/typescript-api/events/vendure-event#vendureevent)
|
|
852
852
|
|
|
853
853
|
|
|
854
854
|
|
|
@@ -864,7 +864,7 @@ class PaymentStateTransitionEvent extends VendureEvent {
|
|
|
864
864
|
</div>
|
|
865
865
|
<GenerationInfo sourceFile="packages/core/src/event-bus/events/product-channel-event.ts" sourceLine="15" packageName="@vendure/core" />
|
|
866
866
|
|
|
867
|
-
This event is fired whenever a
|
|
867
|
+
This event is fired whenever a [Product](/reference/typescript-api/entities/product#product) is added, updated
|
|
868
868
|
or deleted.
|
|
869
869
|
|
|
870
870
|
```ts title="Signature"
|
|
@@ -872,7 +872,7 @@ class ProductChannelEvent extends VendureEvent {
|
|
|
872
872
|
constructor(ctx: RequestContext, product: Product, channelId: ID, type: 'assigned' | 'removed')
|
|
873
873
|
}
|
|
874
874
|
```
|
|
875
|
-
* Extends:
|
|
875
|
+
* Extends: [`VendureEvent`](/reference/typescript-api/events/vendure-event#vendureevent)
|
|
876
876
|
|
|
877
877
|
|
|
878
878
|
|
|
@@ -888,7 +888,7 @@ class ProductChannelEvent extends VendureEvent {
|
|
|
888
888
|
</div>
|
|
889
889
|
<GenerationInfo sourceFile="packages/core/src/event-bus/events/product-event.ts" sourceLine="18" packageName="@vendure/core" />
|
|
890
890
|
|
|
891
|
-
This event is fired whenever a
|
|
891
|
+
This event is fired whenever a [Product](/reference/typescript-api/entities/product#product) is added, updated
|
|
892
892
|
or deleted.
|
|
893
893
|
|
|
894
894
|
```ts title="Signature"
|
|
@@ -897,7 +897,7 @@ class ProductEvent extends VendureEntityEvent<Product, ProductInputTypes> {
|
|
|
897
897
|
product: Product
|
|
898
898
|
}
|
|
899
899
|
```
|
|
900
|
-
* Extends:
|
|
900
|
+
* Extends: [`VendureEntityEvent`](/reference/typescript-api/events/vendure-entity-event#vendureentityevent)`<`[`Product`](/reference/typescript-api/entities/product#product)`, ProductInputTypes>`
|
|
901
901
|
|
|
902
902
|
|
|
903
903
|
|
|
@@ -918,14 +918,14 @@ class ProductEvent extends VendureEntityEvent<Product, ProductInputTypes> {
|
|
|
918
918
|
</div>
|
|
919
919
|
<GenerationInfo sourceFile="packages/core/src/event-bus/events/product-option-event.ts" sourceLine="26" packageName="@vendure/core" since="1.4" />
|
|
920
920
|
|
|
921
|
-
This event is fired whenever a
|
|
921
|
+
This event is fired whenever a [ProductOption](/reference/typescript-api/entities/product-option#productoption) is added or updated.
|
|
922
922
|
|
|
923
923
|
```ts title="Signature"
|
|
924
924
|
class ProductOptionEvent extends VendureEntityEvent<ProductOption, ProductOptionInputTypes> {
|
|
925
925
|
constructor(ctx: RequestContext, entity: ProductOption, type: 'created' | 'updated' | 'deleted', input?: ProductOptionInputTypes)
|
|
926
926
|
}
|
|
927
927
|
```
|
|
928
|
-
* Extends:
|
|
928
|
+
* Extends: [`VendureEntityEvent`](/reference/typescript-api/events/vendure-entity-event#vendureentityevent)`<`[`ProductOption`](/reference/typescript-api/entities/product-option#productoption)`, ProductOptionInputTypes>`
|
|
929
929
|
|
|
930
930
|
|
|
931
931
|
|
|
@@ -941,14 +941,14 @@ class ProductOptionEvent extends VendureEntityEvent<ProductOption, ProductOption
|
|
|
941
941
|
</div>
|
|
942
942
|
<GenerationInfo sourceFile="packages/core/src/event-bus/events/product-option-group-change-event.ts" sourceLine="15" packageName="@vendure/core" since="1.4" />
|
|
943
943
|
|
|
944
|
-
This event is fired whenever a
|
|
944
|
+
This event is fired whenever a [ProductOptionGroup](/reference/typescript-api/entities/product-option-group#productoptiongroup) is assigned or removed from a [Product](/reference/typescript-api/entities/product#product).
|
|
945
945
|
|
|
946
946
|
```ts title="Signature"
|
|
947
947
|
class ProductOptionGroupChangeEvent extends VendureEvent {
|
|
948
948
|
constructor(ctx: RequestContext, product: Product, optionGroupId: ID, type: 'assigned' | 'removed')
|
|
949
949
|
}
|
|
950
950
|
```
|
|
951
|
-
* Extends:
|
|
951
|
+
* Extends: [`VendureEvent`](/reference/typescript-api/events/vendure-event#vendureevent)
|
|
952
952
|
|
|
953
953
|
|
|
954
954
|
|
|
@@ -964,7 +964,7 @@ class ProductOptionGroupChangeEvent extends VendureEvent {
|
|
|
964
964
|
</div>
|
|
965
965
|
<GenerationInfo sourceFile="packages/core/src/event-bus/events/product-option-group-event.ts" sourceLine="24" packageName="@vendure/core" since="1.4" />
|
|
966
966
|
|
|
967
|
-
This event is fired whenever a
|
|
967
|
+
This event is fired whenever a [ProductOptionGroup](/reference/typescript-api/entities/product-option-group#productoptiongroup) is added or updated.
|
|
968
968
|
|
|
969
969
|
```ts title="Signature"
|
|
970
970
|
class ProductOptionGroupEvent extends VendureEntityEvent<
|
|
@@ -974,7 +974,7 @@ class ProductOptionGroupEvent extends VendureEntityEvent<
|
|
|
974
974
|
constructor(ctx: RequestContext, entity: ProductOptionGroup, type: 'created' | 'updated' | 'deleted', input?: ProductOptionGroupInputTypes)
|
|
975
975
|
}
|
|
976
976
|
```
|
|
977
|
-
* Extends:
|
|
977
|
+
* Extends: [`VendureEntityEvent`](/reference/typescript-api/events/vendure-entity-event#vendureentityevent)`< `[`ProductOptionGroup`](/reference/typescript-api/entities/product-option-group#productoptiongroup)`, ProductOptionGroupInputTypes >`
|
|
978
978
|
|
|
979
979
|
|
|
980
980
|
|
|
@@ -990,14 +990,14 @@ class ProductOptionGroupEvent extends VendureEntityEvent<
|
|
|
990
990
|
</div>
|
|
991
991
|
<GenerationInfo sourceFile="packages/core/src/event-bus/events/product-variant-channel-event.ts" sourceLine="14" packageName="@vendure/core" />
|
|
992
992
|
|
|
993
|
-
This event is fired whenever a
|
|
993
|
+
This event is fired whenever a [ProductVariant](/reference/typescript-api/entities/product-variant#productvariant) is assigned or removed from a [Channel](/reference/typescript-api/entities/channel#channel).
|
|
994
994
|
|
|
995
995
|
```ts title="Signature"
|
|
996
996
|
class ProductVariantChannelEvent extends VendureEvent {
|
|
997
997
|
constructor(ctx: RequestContext, productVariant: ProductVariant, channelId: ID, type: 'assigned' | 'removed')
|
|
998
998
|
}
|
|
999
999
|
```
|
|
1000
|
-
* Extends:
|
|
1000
|
+
* Extends: [`VendureEvent`](/reference/typescript-api/events/vendure-event#vendureevent)
|
|
1001
1001
|
|
|
1002
1002
|
|
|
1003
1003
|
|
|
@@ -1013,7 +1013,7 @@ class ProductVariantChannelEvent extends VendureEvent {
|
|
|
1013
1013
|
</div>
|
|
1014
1014
|
<GenerationInfo sourceFile="packages/core/src/event-bus/events/product-variant-event.ts" sourceLine="18" packageName="@vendure/core" />
|
|
1015
1015
|
|
|
1016
|
-
This event is fired whenever a
|
|
1016
|
+
This event is fired whenever a [ProductVariant](/reference/typescript-api/entities/product-variant#productvariant) is added, updated
|
|
1017
1017
|
or deleted.
|
|
1018
1018
|
|
|
1019
1019
|
```ts title="Signature"
|
|
@@ -1022,7 +1022,7 @@ class ProductVariantEvent extends VendureEntityEvent<ProductVariant[], ProductVa
|
|
|
1022
1022
|
variants: ProductVariant[]
|
|
1023
1023
|
}
|
|
1024
1024
|
```
|
|
1025
|
-
* Extends:
|
|
1025
|
+
* Extends: [`VendureEntityEvent`](/reference/typescript-api/events/vendure-entity-event#vendureentityevent)`<`[`ProductVariant`](/reference/typescript-api/entities/product-variant#productvariant)`[], ProductVariantInputTypes>`
|
|
1026
1026
|
|
|
1027
1027
|
|
|
1028
1028
|
|
|
@@ -1043,7 +1043,7 @@ class ProductVariantEvent extends VendureEntityEvent<ProductVariant[], ProductVa
|
|
|
1043
1043
|
</div>
|
|
1044
1044
|
<GenerationInfo sourceFile="packages/core/src/event-bus/events/product-variant-price-event.ts" sourceLine="17" packageName="@vendure/core" since="2.2.0" />
|
|
1045
1045
|
|
|
1046
|
-
This event is fired whenever a
|
|
1046
|
+
This event is fired whenever a [ProductVariantPrice](/reference/typescript-api/entities/product-variant-price#productvariantprice) is added, updated or deleted.
|
|
1047
1047
|
|
|
1048
1048
|
```ts title="Signature"
|
|
1049
1049
|
class ProductVariantPriceEvent extends VendureEntityEvent<
|
|
@@ -1053,7 +1053,7 @@ class ProductVariantPriceEvent extends VendureEntityEvent<
|
|
|
1053
1053
|
constructor(ctx: RequestContext, entity: ProductVariantPrice[], type: 'created' | 'updated' | 'deleted', input?: ProductVariantInputTypes)
|
|
1054
1054
|
}
|
|
1055
1055
|
```
|
|
1056
|
-
* Extends:
|
|
1056
|
+
* Extends: [`VendureEntityEvent`](/reference/typescript-api/events/vendure-entity-event#vendureentityevent)`< `[`ProductVariantPrice`](/reference/typescript-api/entities/product-variant-price#productvariantprice)`[], ProductVariantInputTypes >`
|
|
1057
1057
|
|
|
1058
1058
|
|
|
1059
1059
|
|
|
@@ -1069,7 +1069,7 @@ class ProductVariantPriceEvent extends VendureEntityEvent<
|
|
|
1069
1069
|
</div>
|
|
1070
1070
|
<GenerationInfo sourceFile="packages/core/src/event-bus/events/promotion-event.ts" sourceLine="18" packageName="@vendure/core" />
|
|
1071
1071
|
|
|
1072
|
-
This event is fired whenever a
|
|
1072
|
+
This event is fired whenever a [Promotion](/reference/typescript-api/entities/promotion#promotion) is added, updated
|
|
1073
1073
|
or deleted.
|
|
1074
1074
|
|
|
1075
1075
|
```ts title="Signature"
|
|
@@ -1077,7 +1077,7 @@ class PromotionEvent extends VendureEntityEvent<Promotion, PromotionInputTypes>
|
|
|
1077
1077
|
constructor(ctx: RequestContext, entity: Promotion, type: 'created' | 'updated' | 'deleted', input?: PromotionInputTypes)
|
|
1078
1078
|
}
|
|
1079
1079
|
```
|
|
1080
|
-
* Extends:
|
|
1080
|
+
* Extends: [`VendureEntityEvent`](/reference/typescript-api/events/vendure-entity-event#vendureentityevent)`<`[`Promotion`](/reference/typescript-api/entities/promotion#promotion)`, PromotionInputTypes>`
|
|
1081
1081
|
|
|
1082
1082
|
|
|
1083
1083
|
|
|
@@ -1093,14 +1093,14 @@ class PromotionEvent extends VendureEntityEvent<Promotion, PromotionInputTypes>
|
|
|
1093
1093
|
</div>
|
|
1094
1094
|
<GenerationInfo sourceFile="packages/core/src/event-bus/events/province-event.ts" sourceLine="18" packageName="@vendure/core" since="2.0" />
|
|
1095
1095
|
|
|
1096
|
-
This event is fired whenever a
|
|
1096
|
+
This event is fired whenever a [Province](/reference/typescript-api/entities/province#province) is added, updated or deleted.
|
|
1097
1097
|
|
|
1098
1098
|
```ts title="Signature"
|
|
1099
1099
|
class ProvinceEvent extends VendureEntityEvent<Province, ProvinceInputTypes> {
|
|
1100
1100
|
constructor(ctx: RequestContext, entity: Province, type: 'created' | 'updated' | 'deleted', input?: ProvinceInputTypes)
|
|
1101
1101
|
}
|
|
1102
1102
|
```
|
|
1103
|
-
* Extends:
|
|
1103
|
+
* Extends: [`VendureEntityEvent`](/reference/typescript-api/events/vendure-entity-event#vendureentityevent)`<`[`Province`](/reference/typescript-api/entities/province#province)`, ProvinceInputTypes>`
|
|
1104
1104
|
|
|
1105
1105
|
|
|
1106
1106
|
|
|
@@ -1116,14 +1116,14 @@ class ProvinceEvent extends VendureEntityEvent<Province, ProvinceInputTypes> {
|
|
|
1116
1116
|
</div>
|
|
1117
1117
|
<GenerationInfo sourceFile="packages/core/src/event-bus/events/refund-event.ts" sourceLine="12" packageName="@vendure/core" />
|
|
1118
1118
|
|
|
1119
|
-
This event is fired whenever a
|
|
1119
|
+
This event is fired whenever a [Refund](/reference/typescript-api/entities/refund#refund) is created
|
|
1120
1120
|
|
|
1121
1121
|
```ts title="Signature"
|
|
1122
1122
|
class RefundEvent extends VendureEvent {
|
|
1123
1123
|
constructor(ctx: RequestContext, order: Order, refund: Refund, type: 'created')
|
|
1124
1124
|
}
|
|
1125
1125
|
```
|
|
1126
|
-
* Extends:
|
|
1126
|
+
* Extends: [`VendureEvent`](/reference/typescript-api/events/vendure-event#vendureevent)
|
|
1127
1127
|
|
|
1128
1128
|
|
|
1129
1129
|
|
|
@@ -1139,14 +1139,14 @@ class RefundEvent extends VendureEvent {
|
|
|
1139
1139
|
</div>
|
|
1140
1140
|
<GenerationInfo sourceFile="packages/core/src/event-bus/events/refund-state-transition-event.ts" sourceLine="14" packageName="@vendure/core" />
|
|
1141
1141
|
|
|
1142
|
-
This event is fired whenever a
|
|
1142
|
+
This event is fired whenever a [Refund](/reference/typescript-api/entities/refund#refund) transitions from one [RefundState](/reference/typescript-api/payment/refund-state#refundstate) to another.
|
|
1143
1143
|
|
|
1144
1144
|
```ts title="Signature"
|
|
1145
1145
|
class RefundStateTransitionEvent extends VendureEvent {
|
|
1146
1146
|
constructor(fromState: RefundState, toState: RefundState, ctx: RequestContext, refund: Refund, order: Order)
|
|
1147
1147
|
}
|
|
1148
1148
|
```
|
|
1149
|
-
* Extends:
|
|
1149
|
+
* Extends: [`VendureEvent`](/reference/typescript-api/events/vendure-event#vendureevent)
|
|
1150
1150
|
|
|
1151
1151
|
|
|
1152
1152
|
|
|
@@ -1162,7 +1162,7 @@ class RefundStateTransitionEvent extends VendureEvent {
|
|
|
1162
1162
|
</div>
|
|
1163
1163
|
<GenerationInfo sourceFile="packages/core/src/event-bus/events/role-change-event.ts" sourceLine="16" packageName="@vendure/core" since="1.4" />
|
|
1164
1164
|
|
|
1165
|
-
This event is fired whenever one
|
|
1165
|
+
This event is fired whenever one [Role](/reference/typescript-api/entities/role#role) is assigned or removed from a user.
|
|
1166
1166
|
The property `roleIds` only contains the removed or assigned role ids.
|
|
1167
1167
|
|
|
1168
1168
|
```ts title="Signature"
|
|
@@ -1170,7 +1170,7 @@ class RoleChangeEvent extends VendureEvent {
|
|
|
1170
1170
|
constructor(ctx: RequestContext, admin: Administrator, roleIds: ID[], type: 'assigned' | 'removed')
|
|
1171
1171
|
}
|
|
1172
1172
|
```
|
|
1173
|
-
* Extends:
|
|
1173
|
+
* Extends: [`VendureEvent`](/reference/typescript-api/events/vendure-event#vendureevent)
|
|
1174
1174
|
|
|
1175
1175
|
|
|
1176
1176
|
|
|
@@ -1186,14 +1186,14 @@ class RoleChangeEvent extends VendureEvent {
|
|
|
1186
1186
|
</div>
|
|
1187
1187
|
<GenerationInfo sourceFile="packages/core/src/event-bus/events/role-event.ts" sourceLine="18" packageName="@vendure/core" since="1.4" />
|
|
1188
1188
|
|
|
1189
|
-
This event is fired whenever one
|
|
1189
|
+
This event is fired whenever one [Role](/reference/typescript-api/entities/role#role) is added, updated or deleted.
|
|
1190
1190
|
|
|
1191
1191
|
```ts title="Signature"
|
|
1192
1192
|
class RoleEvent extends VendureEntityEvent<Role, RoleInputTypes> {
|
|
1193
1193
|
constructor(ctx: RequestContext, entity: Role, type: 'created' | 'updated' | 'deleted', input?: RoleInputTypes)
|
|
1194
1194
|
}
|
|
1195
1195
|
```
|
|
1196
|
-
* Extends:
|
|
1196
|
+
* Extends: [`VendureEntityEvent`](/reference/typescript-api/events/vendure-entity-event#vendureentityevent)`<`[`Role`](/reference/typescript-api/entities/role#role)`, RoleInputTypes>`
|
|
1197
1197
|
|
|
1198
1198
|
|
|
1199
1199
|
|
|
@@ -1216,7 +1216,7 @@ class SearchEvent extends VendureEvent {
|
|
|
1216
1216
|
constructor(ctx: RequestContext, input: ExtendedSearchInput)
|
|
1217
1217
|
}
|
|
1218
1218
|
```
|
|
1219
|
-
* Extends:
|
|
1219
|
+
* Extends: [`VendureEvent`](/reference/typescript-api/events/vendure-event#vendureevent)
|
|
1220
1220
|
|
|
1221
1221
|
|
|
1222
1222
|
|
|
@@ -1232,14 +1232,14 @@ class SearchEvent extends VendureEvent {
|
|
|
1232
1232
|
</div>
|
|
1233
1233
|
<GenerationInfo sourceFile="packages/core/src/event-bus/events/seller-event.ts" sourceLine="19" packageName="@vendure/core" since="2.0.1" />
|
|
1234
1234
|
|
|
1235
|
-
This event is fired whenever one
|
|
1235
|
+
This event is fired whenever one [Seller](/reference/typescript-api/entities/seller#seller) is added, updated or deleted.
|
|
1236
1236
|
|
|
1237
1237
|
```ts title="Signature"
|
|
1238
1238
|
class SellerEvent extends VendureEntityEvent<Seller, SellerInputTypes> {
|
|
1239
1239
|
constructor(ctx: RequestContext, entity: Seller, type: 'created' | 'updated' | 'deleted', input?: SellerInputTypes)
|
|
1240
1240
|
}
|
|
1241
1241
|
```
|
|
1242
|
-
* Extends:
|
|
1242
|
+
* Extends: [`VendureEntityEvent`](/reference/typescript-api/events/vendure-entity-event#vendureentityevent)`<`[`Seller`](/reference/typescript-api/entities/seller#seller)`, SellerInputTypes>`
|
|
1243
1243
|
|
|
1244
1244
|
|
|
1245
1245
|
|
|
@@ -1255,7 +1255,7 @@ class SellerEvent extends VendureEntityEvent<Seller, SellerInputTypes> {
|
|
|
1255
1255
|
</div>
|
|
1256
1256
|
<GenerationInfo sourceFile="packages/core/src/event-bus/events/shipping-method-event.ts" sourceLine="18" packageName="@vendure/core" />
|
|
1257
1257
|
|
|
1258
|
-
This event is fired whenever a
|
|
1258
|
+
This event is fired whenever a [ShippingMethod](/reference/typescript-api/entities/shipping-method#shippingmethod) is added, updated
|
|
1259
1259
|
or deleted.
|
|
1260
1260
|
|
|
1261
1261
|
```ts title="Signature"
|
|
@@ -1263,7 +1263,7 @@ class ShippingMethodEvent extends VendureEntityEvent<ShippingMethod, ShippingMet
|
|
|
1263
1263
|
constructor(ctx: RequestContext, entity: ShippingMethod, type: 'created' | 'updated' | 'deleted', input?: ShippingMethodInputTypes)
|
|
1264
1264
|
}
|
|
1265
1265
|
```
|
|
1266
|
-
* Extends:
|
|
1266
|
+
* Extends: [`VendureEntityEvent`](/reference/typescript-api/events/vendure-entity-event#vendureentityevent)`<`[`ShippingMethod`](/reference/typescript-api/entities/shipping-method#shippingmethod)`, ShippingMethodInputTypes>`
|
|
1267
1267
|
|
|
1268
1268
|
|
|
1269
1269
|
|
|
@@ -1279,7 +1279,7 @@ class ShippingMethodEvent extends VendureEntityEvent<ShippingMethod, ShippingMet
|
|
|
1279
1279
|
</div>
|
|
1280
1280
|
<GenerationInfo sourceFile="packages/core/src/event-bus/events/stock-location-event.ts" sourceLine="18" packageName="@vendure/core" />
|
|
1281
1281
|
|
|
1282
|
-
This event is fired whenever a
|
|
1282
|
+
This event is fired whenever a [StockLocation](/reference/typescript-api/entities/stock-location#stocklocation) is added, updated
|
|
1283
1283
|
or deleted.
|
|
1284
1284
|
|
|
1285
1285
|
```ts title="Signature"
|
|
@@ -1287,7 +1287,7 @@ class StockLocationEvent extends VendureEntityEvent<StockLocation, StockLocation
|
|
|
1287
1287
|
constructor(ctx: RequestContext, entity: StockLocation, type: 'created' | 'updated' | 'deleted', input?: StockLocationInputTypes)
|
|
1288
1288
|
}
|
|
1289
1289
|
```
|
|
1290
|
-
* Extends:
|
|
1290
|
+
* Extends: [`VendureEntityEvent`](/reference/typescript-api/events/vendure-entity-event#vendureentityevent)`<`[`StockLocation`](/reference/typescript-api/entities/stock-location#stocklocation)`, StockLocationInputTypes>`
|
|
1291
1291
|
|
|
1292
1292
|
|
|
1293
1293
|
|
|
@@ -1303,7 +1303,7 @@ class StockLocationEvent extends VendureEntityEvent<StockLocation, StockLocation
|
|
|
1303
1303
|
</div>
|
|
1304
1304
|
<GenerationInfo sourceFile="packages/core/src/event-bus/events/stock-movement-event.ts" sourceLine="16" packageName="@vendure/core" since="1.1.0" />
|
|
1305
1305
|
|
|
1306
|
-
This event is fired whenever a
|
|
1306
|
+
This event is fired whenever a [StockMovement](/reference/typescript-api/entities/stock-movement#stockmovement) entity is created, which occurs when the saleable
|
|
1307
1307
|
stock level of a ProductVariant is altered due to things like sales, manual adjustments, and cancellations.
|
|
1308
1308
|
|
|
1309
1309
|
```ts title="Signature"
|
|
@@ -1312,7 +1312,7 @@ class StockMovementEvent extends VendureEvent {
|
|
|
1312
1312
|
constructor(ctx: RequestContext, stockMovements: StockMovement[])
|
|
1313
1313
|
}
|
|
1314
1314
|
```
|
|
1315
|
-
* Extends:
|
|
1315
|
+
* Extends: [`VendureEvent`](/reference/typescript-api/events/vendure-event#vendureevent)
|
|
1316
1316
|
|
|
1317
1317
|
|
|
1318
1318
|
|
|
@@ -1333,7 +1333,7 @@ class StockMovementEvent extends VendureEvent {
|
|
|
1333
1333
|
</div>
|
|
1334
1334
|
<GenerationInfo sourceFile="packages/core/src/event-bus/events/tax-category-event.ts" sourceLine="18" packageName="@vendure/core" />
|
|
1335
1335
|
|
|
1336
|
-
This event is fired whenever a
|
|
1336
|
+
This event is fired whenever a [TaxCategory](/reference/typescript-api/entities/tax-category#taxcategory) is added, updated
|
|
1337
1337
|
or deleted.
|
|
1338
1338
|
|
|
1339
1339
|
```ts title="Signature"
|
|
@@ -1341,7 +1341,7 @@ class TaxCategoryEvent extends VendureEntityEvent<TaxCategory, TaxCategoryInputT
|
|
|
1341
1341
|
constructor(ctx: RequestContext, entity: TaxCategory, type: 'created' | 'updated' | 'deleted', input?: TaxCategoryInputTypes)
|
|
1342
1342
|
}
|
|
1343
1343
|
```
|
|
1344
|
-
* Extends:
|
|
1344
|
+
* Extends: [`VendureEntityEvent`](/reference/typescript-api/events/vendure-entity-event#vendureentityevent)`<`[`TaxCategory`](/reference/typescript-api/entities/tax-category#taxcategory)`, TaxCategoryInputTypes>`
|
|
1345
1345
|
|
|
1346
1346
|
|
|
1347
1347
|
|
|
@@ -1357,7 +1357,7 @@ class TaxCategoryEvent extends VendureEntityEvent<TaxCategory, TaxCategoryInputT
|
|
|
1357
1357
|
</div>
|
|
1358
1358
|
<GenerationInfo sourceFile="packages/core/src/event-bus/events/tax-rate-event.ts" sourceLine="18" packageName="@vendure/core" />
|
|
1359
1359
|
|
|
1360
|
-
This event is fired whenever a
|
|
1360
|
+
This event is fired whenever a [TaxRate](/reference/typescript-api/entities/tax-rate#taxrate) is added, updated
|
|
1361
1361
|
or deleted.
|
|
1362
1362
|
|
|
1363
1363
|
```ts title="Signature"
|
|
@@ -1365,7 +1365,7 @@ class TaxRateEvent extends VendureEntityEvent<TaxRate, TaxRateInputTypes> {
|
|
|
1365
1365
|
constructor(ctx: RequestContext, entity: TaxRate, type: 'created' | 'updated' | 'deleted', input?: TaxRateInputTypes)
|
|
1366
1366
|
}
|
|
1367
1367
|
```
|
|
1368
|
-
* Extends:
|
|
1368
|
+
* Extends: [`VendureEntityEvent`](/reference/typescript-api/events/vendure-entity-event#vendureentityevent)`<`[`TaxRate`](/reference/typescript-api/entities/tax-rate#taxrate)`, TaxRateInputTypes>`
|
|
1369
1369
|
|
|
1370
1370
|
|
|
1371
1371
|
|
|
@@ -1388,7 +1388,7 @@ class TaxRateModificationEvent extends VendureEvent {
|
|
|
1388
1388
|
constructor(ctx: RequestContext, taxRate: TaxRate)
|
|
1389
1389
|
}
|
|
1390
1390
|
```
|
|
1391
|
-
* Extends:
|
|
1391
|
+
* Extends: [`VendureEvent`](/reference/typescript-api/events/vendure-event#vendureevent)
|
|
1392
1392
|
|
|
1393
1393
|
|
|
1394
1394
|
|
|
@@ -1404,7 +1404,7 @@ class TaxRateModificationEvent extends VendureEvent {
|
|
|
1404
1404
|
</div>
|
|
1405
1405
|
<GenerationInfo sourceFile="packages/core/src/event-bus/events/zone-event.ts" sourceLine="18" packageName="@vendure/core" />
|
|
1406
1406
|
|
|
1407
|
-
This event is fired whenever a
|
|
1407
|
+
This event is fired whenever a [Zone](/reference/typescript-api/entities/zone#zone) is added, updated
|
|
1408
1408
|
or deleted.
|
|
1409
1409
|
|
|
1410
1410
|
```ts title="Signature"
|
|
@@ -1412,7 +1412,7 @@ class ZoneEvent extends VendureEntityEvent<Zone, ZoneInputTypes> {
|
|
|
1412
1412
|
constructor(ctx: RequestContext, entity: Zone, type: 'created' | 'updated' | 'deleted', input?: ZoneInputTypes)
|
|
1413
1413
|
}
|
|
1414
1414
|
```
|
|
1415
|
-
* Extends:
|
|
1415
|
+
* Extends: [`VendureEntityEvent`](/reference/typescript-api/events/vendure-entity-event#vendureentityevent)`<`[`Zone`](/reference/typescript-api/entities/zone#zone)`, ZoneInputTypes>`
|
|
1416
1416
|
|
|
1417
1417
|
|
|
1418
1418
|
|
|
@@ -1428,7 +1428,7 @@ class ZoneEvent extends VendureEntityEvent<Zone, ZoneInputTypes> {
|
|
|
1428
1428
|
</div>
|
|
1429
1429
|
<GenerationInfo sourceFile="packages/core/src/event-bus/events/zone-members-event.ts" sourceLine="15" packageName="@vendure/core" />
|
|
1430
1430
|
|
|
1431
|
-
This event is fired whenever a
|
|
1431
|
+
This event is fired whenever a [Zone](/reference/typescript-api/entities/zone#zone) gets [Country](/reference/typescript-api/entities/country#country) members assigned or removed
|
|
1432
1432
|
The `entity` property contains the zone with the already updated member field.
|
|
1433
1433
|
|
|
1434
1434
|
```ts title="Signature"
|
|
@@ -1436,7 +1436,7 @@ class ZoneMembersEvent extends VendureEvent {
|
|
|
1436
1436
|
constructor(ctx: RequestContext, entity: Zone, type: 'assigned' | 'removed', memberIds: ID[])
|
|
1437
1437
|
}
|
|
1438
1438
|
```
|
|
1439
|
-
* Extends:
|
|
1439
|
+
* Extends: [`VendureEvent`](/reference/typescript-api/events/vendure-event#vendureevent)
|
|
1440
1440
|
|
|
1441
1441
|
|
|
1442
1442
|
|