@vendure/docs 0.0.0-202601210957 → 0.0.0-202601211038
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/manifest.d.ts.map +1 -1
- package/dist/manifest.js +2 -0
- package/dist/manifest.js.map +1 -1
- package/docs/reference/admin-ui-api/action-bar/action-bar-context.mdx +2 -6
- package/docs/reference/admin-ui-api/action-bar/action-bar-dropdown-menu-item.mdx +1 -5
- package/docs/reference/admin-ui-api/action-bar/action-bar-item.mdx +1 -5
- package/docs/reference/admin-ui-api/action-bar/action-bar-location-id.mdx +1 -5
- package/docs/reference/admin-ui-api/action-bar/add-action-bar-dropdown-menu-item.mdx +0 -4
- package/docs/reference/admin-ui-api/action-bar/add-action-bar-item.mdx +0 -4
- package/docs/reference/admin-ui-api/action-bar/page-location-id.mdx +0 -4
- package/docs/reference/admin-ui-api/action-bar/router-link-definition.mdx +1 -5
- package/docs/reference/admin-ui-api/alerts/alert-config.mdx +0 -4
- package/docs/reference/admin-ui-api/alerts/alert-context.mdx +1 -5
- package/docs/reference/admin-ui-api/alerts/register-alert.mdx +1 -5
- package/docs/reference/admin-ui-api/bulk-actions/bulk-action.mdx +1 -17
- package/docs/reference/admin-ui-api/bulk-actions/register-bulk-action.mdx +1 -5
- package/docs/reference/admin-ui-api/components/asset-picker-dialog-component.mdx +0 -4
- package/docs/reference/admin-ui-api/components/chip-component.mdx +0 -4
- package/docs/reference/admin-ui-api/components/currency-input-component.mdx +0 -4
- package/docs/reference/admin-ui-api/components/data-table-component.mdx +2 -6
- package/docs/reference/admin-ui-api/components/data-table2component.mdx +1 -5
- package/docs/reference/admin-ui-api/components/datetime-picker-component.mdx +0 -4
- package/docs/reference/admin-ui-api/components/dropdown-component.mdx +0 -4
- package/docs/reference/admin-ui-api/components/facet-value-selector-component.mdx +0 -4
- package/docs/reference/admin-ui-api/components/object-tree-component.mdx +0 -4
- package/docs/reference/admin-ui-api/components/order-state-label-component.mdx +0 -4
- package/docs/reference/admin-ui-api/components/product-variant-selector-component.mdx +0 -4
- package/docs/reference/admin-ui-api/components/rich-text-editor-component.mdx +0 -4
- package/docs/reference/admin-ui-api/components/zone-selector-component.mdx +0 -4
- package/docs/reference/admin-ui-api/custom-detail-components/custom-detail-component-config.mdx +1 -5
- package/docs/reference/admin-ui-api/custom-detail-components/custom-detail-component-location-id.mdx +1 -5
- package/docs/reference/admin-ui-api/custom-detail-components/custom-detail-component.mdx +0 -4
- package/docs/reference/admin-ui-api/custom-detail-components/register-custom-detail-component.mdx +1 -5
- package/docs/reference/admin-ui-api/custom-history-entry-components/customer-history-entry-component.mdx +1 -5
- package/docs/reference/admin-ui-api/custom-history-entry-components/history-entry-component.mdx +1 -5
- package/docs/reference/admin-ui-api/custom-history-entry-components/history-entry-config.mdx +1 -5
- package/docs/reference/admin-ui-api/custom-history-entry-components/order-history-entry-component.mdx +1 -5
- package/docs/reference/admin-ui-api/custom-history-entry-components/register-history-entry-component.mdx +1 -5
- package/docs/reference/admin-ui-api/custom-input-components/default-inputs.mdx +2 -70
- package/docs/reference/admin-ui-api/custom-input-components/form-input-component.mdx +0 -4
- package/docs/reference/admin-ui-api/custom-input-components/register-form-input-component.mdx +2 -6
- package/docs/reference/admin-ui-api/custom-table-components/custom-column-component.mdx +0 -4
- package/docs/reference/admin-ui-api/custom-table-components/data-table-component-config.mdx +2 -6
- package/docs/reference/admin-ui-api/custom-table-components/register-data-table-component.mdx +1 -5
- package/docs/reference/admin-ui-api/dashboard-widgets/dashboard-widget-config.mdx +0 -4
- package/docs/reference/admin-ui-api/dashboard-widgets/register-dashboard-widget.mdx +1 -5
- package/docs/reference/admin-ui-api/dashboard-widgets/set-dashboard-widget-layout.mdx +0 -4
- package/docs/reference/admin-ui-api/dashboard-widgets/widget-layout-definition.mdx +0 -4
- package/docs/reference/admin-ui-api/directives/if-multichannel-directive.mdx +0 -4
- package/docs/reference/admin-ui-api/directives/if-permissions-directive.mdx +0 -4
- package/docs/reference/admin-ui-api/list-detail-views/base-detail-component.mdx +1 -5
- package/docs/reference/admin-ui-api/list-detail-views/base-entity-resolver.mdx +1 -5
- package/docs/reference/admin-ui-api/list-detail-views/base-list-component.mdx +1 -5
- package/docs/reference/admin-ui-api/list-detail-views/detail-component-with-resolver.mdx +1 -5
- package/docs/reference/admin-ui-api/list-detail-views/typed-base-detail-component.mdx +1 -5
- package/docs/reference/admin-ui-api/list-detail-views/typed-base-list-component.mdx +1 -5
- package/docs/reference/admin-ui-api/nav-menu/add-nav-menu-item.mdx +0 -4
- package/docs/reference/admin-ui-api/nav-menu/add-nav-menu-section.mdx +0 -4
- package/docs/reference/admin-ui-api/nav-menu/nav-menu-item.mdx +0 -4
- package/docs/reference/admin-ui-api/nav-menu/nav-menu-section.mdx +1 -5
- package/docs/reference/admin-ui-api/nav-menu/navigation-types.mdx +0 -4
- package/docs/reference/admin-ui-api/pipes/asset-preview-pipe.mdx +0 -4
- package/docs/reference/admin-ui-api/pipes/duration-pipe.mdx +0 -4
- package/docs/reference/admin-ui-api/pipes/file-size-pipe.mdx +0 -4
- package/docs/reference/admin-ui-api/pipes/has-permission-pipe.mdx +0 -4
- package/docs/reference/admin-ui-api/pipes/locale-currency-name-pipe.mdx +0 -4
- package/docs/reference/admin-ui-api/pipes/locale-currency-pipe.mdx +0 -4
- package/docs/reference/admin-ui-api/pipes/locale-date-pipe.mdx +0 -4
- package/docs/reference/admin-ui-api/pipes/locale-language-name-pipe.mdx +0 -4
- package/docs/reference/admin-ui-api/pipes/locale-region-name-pipe.mdx +0 -4
- package/docs/reference/admin-ui-api/pipes/time-ago-pipe.mdx +0 -4
- package/docs/reference/admin-ui-api/react-components/action-bar.mdx +0 -4
- package/docs/reference/admin-ui-api/react-components/card.mdx +0 -4
- package/docs/reference/admin-ui-api/react-components/cds-icon.mdx +0 -4
- package/docs/reference/admin-ui-api/react-components/form-field.mdx +0 -4
- package/docs/reference/admin-ui-api/react-components/link.mdx +0 -4
- package/docs/reference/admin-ui-api/react-components/page-block.mdx +0 -4
- package/docs/reference/admin-ui-api/react-components/page-detail-layout.mdx +0 -4
- package/docs/reference/admin-ui-api/react-components/rich-text-editor.mdx +0 -4
- package/docs/reference/admin-ui-api/react-extensions/react-custom-detail-component-config.mdx +0 -4
- package/docs/reference/admin-ui-api/react-extensions/react-data-table-component-config.mdx +1 -5
- package/docs/reference/admin-ui-api/react-extensions/register-react-custom-detail-component.mdx +1 -5
- package/docs/reference/admin-ui-api/react-extensions/register-react-data-table-component.mdx +0 -4
- package/docs/reference/admin-ui-api/react-extensions/register-react-form-input-component.mdx +1 -5
- package/docs/reference/admin-ui-api/react-extensions/register-react-route-component-options.mdx +0 -4
- package/docs/reference/admin-ui-api/react-extensions/register-react-route-component.mdx +0 -4
- package/docs/reference/admin-ui-api/react-hooks/use-detail-component-data.mdx +0 -4
- package/docs/reference/admin-ui-api/react-hooks/use-form-control.mdx +0 -4
- package/docs/reference/admin-ui-api/react-hooks/use-injector.mdx +0 -4
- package/docs/reference/admin-ui-api/react-hooks/use-lazy-query.mdx +0 -4
- package/docs/reference/admin-ui-api/react-hooks/use-mutation.mdx +0 -4
- package/docs/reference/admin-ui-api/react-hooks/use-page-metadata.mdx +0 -4
- package/docs/reference/admin-ui-api/react-hooks/use-query.mdx +0 -4
- package/docs/reference/admin-ui-api/react-hooks/use-rich-text-editor.mdx +0 -4
- package/docs/reference/admin-ui-api/react-hooks/use-route-params.mdx +0 -4
- package/docs/reference/admin-ui-api/routes/register-route-component-options.mdx +0 -4
- package/docs/reference/admin-ui-api/routes/register-route-component.mdx +0 -4
- package/docs/reference/admin-ui-api/services/data-service.mdx +1 -9
- package/docs/reference/admin-ui-api/services/modal-service.mdx +1 -17
- package/docs/reference/admin-ui-api/services/notification-service.mdx +0 -12
- package/docs/reference/admin-ui-api/tabs/page-tab-config.mdx +0 -4
- package/docs/reference/admin-ui-api/tabs/register-page-tab.mdx +0 -4
- package/docs/reference/admin-ui-api/ui-devkit/admin-ui-extension.mdx +1 -37
- package/docs/reference/admin-ui-api/ui-devkit/compile-ui-extensions.mdx +0 -4
- package/docs/reference/admin-ui-api/ui-devkit/helpers.mdx +0 -4
- package/docs/reference/admin-ui-api/ui-devkit/ui-devkit-client.mdx +0 -20
- package/docs/reference/admin-ui-api/ui-devkit/ui-extension-build-command.mdx +0 -4
- package/docs/reference/admin-ui-api/ui-devkit/ui-extension-compiler-options.mdx +1 -5
- package/docs/reference/admin-ui-api/ui-devkit/ui-extension-compiler-process-argument.mdx +0 -4
- package/docs/reference/core-plugins/admin-ui-plugin/admin-ui-plugin-options.mdx +1 -5
- package/docs/reference/core-plugins/admin-ui-plugin/index.mdx +0 -4
- package/docs/reference/core-plugins/asset-server-plugin/asset-server-options.mdx +5 -9
- package/docs/reference/core-plugins/asset-server-plugin/cache-config.mdx +0 -4
- package/docs/reference/core-plugins/asset-server-plugin/hashed-asset-naming-strategy.mdx +1 -5
- package/docs/reference/core-plugins/asset-server-plugin/image-transform-mode.mdx +0 -4
- package/docs/reference/core-plugins/asset-server-plugin/image-transform-preset.mdx +0 -4
- package/docs/reference/core-plugins/asset-server-plugin/image-transform-strategy.mdx +0 -12
- package/docs/reference/core-plugins/asset-server-plugin/index.mdx +3 -7
- package/docs/reference/core-plugins/asset-server-plugin/local-asset-storage-strategy.mdx +0 -4
- package/docs/reference/core-plugins/asset-server-plugin/preset-only-strategy.mdx +2 -10
- package/docs/reference/core-plugins/asset-server-plugin/s3asset-storage-strategy.mdx +4 -16
- package/docs/reference/core-plugins/asset-server-plugin/sharp-asset-preview-strategy.mdx +2 -10
- package/docs/reference/core-plugins/dashboard-plugin/dashboard-plugin-options.mdx +1 -5
- package/docs/reference/core-plugins/dashboard-plugin/index.mdx +0 -4
- package/docs/reference/core-plugins/elasticsearch-plugin/elasticsearch-options.mdx +1 -13
- package/docs/reference/core-plugins/elasticsearch-plugin/index.mdx +1 -5
- package/docs/reference/core-plugins/email-plugin/email-event-handler-with-async-data.mdx +1 -5
- package/docs/reference/core-plugins/email-plugin/email-event-handler.mdx +10 -14
- package/docs/reference/core-plugins/email-plugin/email-event-listener.mdx +1 -5
- package/docs/reference/core-plugins/email-plugin/email-generator.mdx +0 -8
- package/docs/reference/core-plugins/email-plugin/email-plugin-options.mdx +1 -13
- package/docs/reference/core-plugins/email-plugin/email-plugin-types.mdx +9 -61
- package/docs/reference/core-plugins/email-plugin/email-send-event.mdx +0 -4
- package/docs/reference/core-plugins/email-plugin/email-sender.mdx +1 -9
- package/docs/reference/core-plugins/email-plugin/email-utils.mdx +0 -8
- package/docs/reference/core-plugins/email-plugin/index.mdx +4 -8
- package/docs/reference/core-plugins/email-plugin/template-loader.mdx +0 -8
- package/docs/reference/core-plugins/email-plugin/transport-options.mdx +2 -30
- package/docs/reference/core-plugins/graphiql-plugin/index.mdx +0 -4
- package/docs/reference/core-plugins/harden-plugin/default-vendure-complexity-estimator.mdx +0 -4
- package/docs/reference/core-plugins/harden-plugin/harden-plugin-options.mdx +1 -5
- package/docs/reference/core-plugins/harden-plugin/index.mdx +2 -6
- package/docs/reference/core-plugins/job-queue-plugin/bull-mqjob-queue-plugin.mdx +0 -4
- package/docs/reference/core-plugins/job-queue-plugin/bull-mqjob-queue-strategy.mdx +1 -5
- package/docs/reference/core-plugins/job-queue-plugin/bull-mqplugin-options.mdx +1 -9
- package/docs/reference/core-plugins/job-queue-plugin/pub-sub-job-queue-strategy.mdx +1 -5
- package/docs/reference/core-plugins/job-queue-plugin/pub-sub-plugin.mdx +0 -4
- package/docs/reference/core-plugins/payments-plugin/braintree-plugin.mdx +0 -8
- package/docs/reference/core-plugins/payments-plugin/mollie-plugin.mdx +0 -8
- package/docs/reference/core-plugins/payments-plugin/stripe-plugin.mdx +1 -9
- package/docs/reference/core-plugins/sentry-plugin/index.mdx +0 -4
- package/docs/reference/core-plugins/sentry-plugin/sentry-plugin-options.mdx +1 -5
- package/docs/reference/core-plugins/sentry-plugin/sentry-service.mdx +0 -4
- package/docs/reference/core-plugins/stellate-plugin/index.mdx +3 -7
- package/docs/reference/core-plugins/stellate-plugin/purge-rule.mdx +3 -11
- package/docs/reference/core-plugins/stellate-plugin/stellate-plugin-options.mdx +1 -5
- package/docs/reference/core-plugins/stellate-plugin/stellate-service.mdx +0 -4
- package/docs/reference/core-plugins/telemetry-plugin/get-sdk-configuration.mdx +0 -8
- package/docs/reference/core-plugins/telemetry-plugin/index.mdx +0 -4
- package/docs/reference/core-plugins/telemetry-plugin/otel-logger.mdx +0 -8
- package/docs/reference/core-plugins/telemetry-plugin/register-method-hooks.mdx +1 -5
- package/docs/reference/core-plugins/telemetry-plugin/telemetry-plugin-options.mdx +1 -5
- package/docs/reference/dashboard/components/asset-gallery.mdx +1 -9
- package/docs/reference/dashboard/components/asset-picker-dialog.mdx +1 -9
- package/docs/reference/dashboard/components/channel-chip.mdx +0 -4
- package/docs/reference/dashboard/components/detail-page-button.mdx +0 -4
- package/docs/reference/dashboard/components/facet-value-chip.mdx +0 -4
- package/docs/reference/dashboard/components/facet-value-selector.mdx +0 -8
- package/docs/reference/dashboard/components/permission-guard.mdx +0 -8
- package/docs/reference/dashboard/components/vendure-image.mdx +5 -29
- package/docs/reference/dashboard/detail-views/detail-page.mdx +2 -10
- package/docs/reference/dashboard/detail-views/use-detail-page.mdx +0 -12
- package/docs/reference/dashboard/detail-views/use-generated-form.mdx +1 -9
- package/docs/reference/dashboard/extensions-api/action-bar.mdx +0 -4
- package/docs/reference/dashboard/extensions-api/alerts.mdx +0 -4
- package/docs/reference/dashboard/extensions-api/data-tables.mdx +0 -4
- package/docs/reference/dashboard/extensions-api/define-dashboard-extension.mdx +0 -8
- package/docs/reference/dashboard/extensions-api/detail-forms.mdx +0 -8
- package/docs/reference/dashboard/extensions-api/form-components.mdx +1 -21
- package/docs/reference/dashboard/extensions-api/history-entries.mdx +3 -19
- package/docs/reference/dashboard/extensions-api/login.mdx +0 -16
- package/docs/reference/dashboard/extensions-api/navigation.mdx +0 -8
- package/docs/reference/dashboard/extensions-api/page-blocks.mdx +0 -12
- package/docs/reference/dashboard/extensions-api/routes.mdx +0 -4
- package/docs/reference/dashboard/extensions-api/widgets.mdx +0 -4
- package/docs/reference/dashboard/form-components/affixed-input.mdx +0 -4
- package/docs/reference/dashboard/form-components/boolean-input.mdx +0 -4
- package/docs/reference/dashboard/form-components/checkbox-input.mdx +0 -4
- package/docs/reference/dashboard/form-components/date-time-input.mdx +0 -4
- package/docs/reference/dashboard/form-components/form-field-wrapper.mdx +1 -9
- package/docs/reference/dashboard/form-components/money-input.mdx +0 -4
- package/docs/reference/dashboard/form-components/number-input.mdx +0 -4
- package/docs/reference/dashboard/form-components/password-input.mdx +0 -4
- package/docs/reference/dashboard/form-components/rich-text-input.mdx +0 -4
- package/docs/reference/dashboard/form-components/slug-input.mdx +0 -4
- package/docs/reference/dashboard/form-components/text-input.mdx +0 -4
- package/docs/reference/dashboard/form-components/textarea-input.mdx +0 -4
- package/docs/reference/dashboard/form-components/translatable-form-field-wrapper.mdx +1 -9
- package/docs/reference/dashboard/hooks/use-alerts.mdx +0 -8
- package/docs/reference/dashboard/hooks/use-auth.mdx +1 -9
- package/docs/reference/dashboard/hooks/use-channel.mdx +1 -9
- package/docs/reference/dashboard/hooks/use-custom-field-config.mdx +0 -4
- package/docs/reference/dashboard/hooks/use-display-locale.mdx +0 -4
- package/docs/reference/dashboard/hooks/use-drag-and-drop.mdx +0 -4
- package/docs/reference/dashboard/hooks/use-local-format.mdx +0 -4
- package/docs/reference/dashboard/hooks/use-paginated-list.mdx +0 -4
- package/docs/reference/dashboard/hooks/use-permissions.mdx +0 -4
- package/docs/reference/dashboard/hooks/use-sorted-languages.mdx +0 -4
- package/docs/reference/dashboard/hooks/use-ui-language-loader.mdx +0 -4
- package/docs/reference/dashboard/hooks/use-widget-filters.mdx +0 -4
- package/docs/reference/dashboard/list-views/bulk-actions.mdx +0 -12
- package/docs/reference/dashboard/list-views/data-table-cell-component.mdx +0 -4
- package/docs/reference/dashboard/list-views/data-table.mdx +1 -13
- package/docs/reference/dashboard/list-views/list-page.mdx +2 -10
- package/docs/reference/dashboard/list-views/paginated-list-data-table.mdx +2 -10
- package/docs/reference/dashboard/page-layout/index.mdx +2 -10
- package/docs/reference/dashboard/page-layout/page-action-bar.mdx +2 -14
- package/docs/reference/dashboard/page-layout/page-block.mdx +4 -20
- package/docs/reference/dashboard/page-layout/page-title.mdx +1 -5
- package/docs/reference/dashboard/page-layout/page.mdx +4 -12
- package/docs/reference/dashboard/page-layout/use-page-block.mdx +0 -4
- package/docs/reference/dashboard/vite-plugin/vendure-dashboard-plugin.mdx +4 -28
- package/docs/reference/typescript-api/assets/asset-naming-strategy.mdx +0 -4
- package/docs/reference/typescript-api/assets/asset-options.mdx +0 -4
- package/docs/reference/typescript-api/assets/asset-preview-strategy.mdx +0 -4
- package/docs/reference/typescript-api/assets/asset-storage-strategy.mdx +0 -4
- package/docs/reference/typescript-api/assets/default-asset-naming-strategy.mdx +0 -4
- package/docs/reference/typescript-api/auth/auth-options.mdx +4 -8
- package/docs/reference/typescript-api/auth/authentication-strategy.mdx +1 -5
- package/docs/reference/typescript-api/auth/bcrypt-password-hashing-strategy.mdx +0 -4
- package/docs/reference/typescript-api/auth/cookie-options.mdx +0 -4
- package/docs/reference/typescript-api/auth/default-password-validation-strategy.mdx +0 -4
- package/docs/reference/typescript-api/auth/default-session-cache-strategy.mdx +3 -7
- package/docs/reference/typescript-api/auth/default-verification-token-strategy.mdx +0 -4
- package/docs/reference/typescript-api/auth/external-authentication-service.mdx +1 -5
- package/docs/reference/typescript-api/auth/in-memory-session-cache-strategy.mdx +0 -4
- package/docs/reference/typescript-api/auth/native-authentication-strategy.mdx +0 -4
- package/docs/reference/typescript-api/auth/noop-session-cache-strategy.mdx +0 -4
- package/docs/reference/typescript-api/auth/password-hashing-strategy.mdx +1 -5
- package/docs/reference/typescript-api/auth/password-validation-strategy.mdx +1 -5
- package/docs/reference/typescript-api/auth/permission-definition.mdx +10 -26
- package/docs/reference/typescript-api/auth/session-cache-strategy.mdx +4 -16
- package/docs/reference/typescript-api/auth/superadmin-credentials.mdx +0 -4
- package/docs/reference/typescript-api/auth/verification-token-strategy.mdx +0 -4
- package/docs/reference/typescript-api/cache/cache-config.mdx +1 -5
- package/docs/reference/typescript-api/cache/cache-service.mdx +2 -6
- package/docs/reference/typescript-api/cache/cache-strategy.mdx +1 -9
- package/docs/reference/typescript-api/cache/default-cache-plugin.mdx +3 -11
- package/docs/reference/typescript-api/cache/index.mdx +2 -6
- package/docs/reference/typescript-api/cache/redis-cache-plugin.mdx +3 -11
- package/docs/reference/typescript-api/cache/redis-cache-strategy.mdx +1 -5
- package/docs/reference/typescript-api/cache/request-context-cache-service.mdx +0 -4
- package/docs/reference/typescript-api/cache/self-refreshing-cache.mdx +2 -14
- package/docs/reference/typescript-api/cache/sql-cache-strategy.mdx +2 -6
- package/docs/reference/typescript-api/common/admin-ui/admin-ui-app-config.mdx +0 -4
- package/docs/reference/typescript-api/common/admin-ui/admin-ui-app-dev-mode-config.mdx +0 -4
- package/docs/reference/typescript-api/common/admin-ui/admin-ui-config.mdx +1 -5
- package/docs/reference/typescript-api/common/async-queue.mdx +0 -4
- package/docs/reference/typescript-api/common/bootstrap.mdx +0 -8
- package/docs/reference/typescript-api/common/currency-code.mdx +0 -4
- package/docs/reference/typescript-api/common/entity-relation-paths.mdx +0 -4
- package/docs/reference/typescript-api/common/i18n-service.mdx +0 -8
- package/docs/reference/typescript-api/common/id.mdx +1 -5
- package/docs/reference/typescript-api/common/injectable-strategy.mdx +1 -5
- package/docs/reference/typescript-api/common/injector.mdx +0 -4
- package/docs/reference/typescript-api/common/job-state.mdx +0 -4
- package/docs/reference/typescript-api/common/json-compatible.mdx +0 -4
- package/docs/reference/typescript-api/common/language-code.mdx +0 -4
- package/docs/reference/typescript-api/common/middleware.mdx +1 -5
- package/docs/reference/typescript-api/common/paginated-list.mdx +0 -4
- package/docs/reference/typescript-api/common/permission.mdx +1 -5
- package/docs/reference/typescript-api/common/price-calculation-result.mdx +2 -6
- package/docs/reference/typescript-api/common/process-context.mdx +0 -4
- package/docs/reference/typescript-api/common/vendure_version.mdx +0 -4
- package/docs/reference/typescript-api/configurable-operation-def/config-arg-type.mdx +1 -5
- package/docs/reference/typescript-api/configurable-operation-def/config-args.mdx +3 -7
- package/docs/reference/typescript-api/configurable-operation-def/configurable-operation-def-options.mdx +2 -6
- package/docs/reference/typescript-api/configurable-operation-def/default-form-component-id.mdx +0 -4
- package/docs/reference/typescript-api/configurable-operation-def/default-form-config-hash.mdx +0 -4
- package/docs/reference/typescript-api/configurable-operation-def/index.mdx +10 -14
- package/docs/reference/typescript-api/configurable-operation-def/localized-string-array.mdx +1 -5
- package/docs/reference/typescript-api/configuration/api-options.mdx +1 -5
- package/docs/reference/typescript-api/configuration/collection-filter.mdx +0 -4
- package/docs/reference/typescript-api/configuration/default-config.mdx +0 -4
- package/docs/reference/typescript-api/configuration/default-slug-strategy.mdx +0 -4
- package/docs/reference/typescript-api/configuration/entity-duplicator.mdx +0 -12
- package/docs/reference/typescript-api/configuration/entity-id-decorator.mdx +0 -4
- package/docs/reference/typescript-api/configuration/entity-id-strategy.mdx +2 -14
- package/docs/reference/typescript-api/configuration/entity-options.mdx +2 -10
- package/docs/reference/typescript-api/configuration/merge-config.mdx +0 -4
- package/docs/reference/typescript-api/configuration/product-variant-price-selection-strategy.mdx +0 -8
- package/docs/reference/typescript-api/configuration/product-variant-price-update-strategy.mdx +2 -14
- package/docs/reference/typescript-api/configuration/runtime-vendure-config.mdx +1 -5
- package/docs/reference/typescript-api/configuration/settings-store-fields.mdx +1 -5
- package/docs/reference/typescript-api/configuration/slug-strategy.mdx +0 -4
- package/docs/reference/typescript-api/configuration/system-options.mdx +3 -7
- package/docs/reference/typescript-api/configuration/trust-proxy-options.mdx +0 -4
- package/docs/reference/typescript-api/configuration/vendure-config.mdx +2 -6
- package/docs/reference/typescript-api/custom-fields/custom-field-config.mdx +0 -4
- package/docs/reference/typescript-api/custom-fields/custom-field-type.mdx +0 -4
- package/docs/reference/typescript-api/custom-fields/index.mdx +1 -5
- package/docs/reference/typescript-api/custom-fields/struct-custom-field-config.mdx +0 -4
- package/docs/reference/typescript-api/custom-fields/struct-field-config.mdx +0 -4
- package/docs/reference/typescript-api/custom-fields/typed-custom-single-field-config.mdx +1 -5
- package/docs/reference/typescript-api/data-access/calculated-property-subscriber.mdx +0 -4
- package/docs/reference/typescript-api/data-access/calculated.mdx +2 -10
- package/docs/reference/typescript-api/data-access/entity-hydrator.mdx +1 -5
- package/docs/reference/typescript-api/data-access/get-entity-or-throw-options.mdx +2 -6
- package/docs/reference/typescript-api/data-access/hydrate-options.mdx +1 -5
- package/docs/reference/typescript-api/data-access/list-query-builder.mdx +1 -9
- package/docs/reference/typescript-api/data-access/transactional-connection.mdx +7 -11
- package/docs/reference/typescript-api/default-search-plugin/default-search-plugin-init-options.mdx +2 -6
- package/docs/reference/typescript-api/default-search-plugin/index.mdx +0 -4
- package/docs/reference/typescript-api/default-search-plugin/mysql-search-strategy.mdx +0 -4
- package/docs/reference/typescript-api/default-search-plugin/postgres-search-strategy.mdx +0 -4
- package/docs/reference/typescript-api/default-search-plugin/search-strategy.mdx +1 -5
- package/docs/reference/typescript-api/default-search-plugin/sqlite-search-strategy.mdx +0 -4
- package/docs/reference/typescript-api/entities/address.mdx +1 -5
- package/docs/reference/typescript-api/entities/administrator.mdx +1 -5
- package/docs/reference/typescript-api/entities/anonymous-session.mdx +0 -4
- package/docs/reference/typescript-api/entities/asset.mdx +0 -4
- package/docs/reference/typescript-api/entities/authenticated-session.mdx +2 -6
- package/docs/reference/typescript-api/entities/authentication-method.mdx +2 -14
- package/docs/reference/typescript-api/entities/channel.mdx +0 -4
- package/docs/reference/typescript-api/entities/collection.mdx +1 -5
- package/docs/reference/typescript-api/entities/country.mdx +3 -7
- package/docs/reference/typescript-api/entities/customer-group.mdx +1 -5
- package/docs/reference/typescript-api/entities/customer-history-entry.mdx +1 -5
- package/docs/reference/typescript-api/entities/customer.mdx +1 -5
- package/docs/reference/typescript-api/entities/facet-value.mdx +1 -5
- package/docs/reference/typescript-api/entities/facet.mdx +2 -6
- package/docs/reference/typescript-api/entities/fulfillment.mdx +1 -5
- package/docs/reference/typescript-api/entities/global-settings.mdx +0 -4
- package/docs/reference/typescript-api/entities/history-entry.mdx +2 -6
- package/docs/reference/typescript-api/entities/interfaces.mdx +0 -20
- package/docs/reference/typescript-api/entities/order-history-entry.mdx +1 -5
- package/docs/reference/typescript-api/entities/order-line-reference.mdx +4 -20
- package/docs/reference/typescript-api/entities/order-line.mdx +7 -11
- package/docs/reference/typescript-api/entities/order-modification.mdx +0 -4
- package/docs/reference/typescript-api/entities/order.mdx +7 -11
- package/docs/reference/typescript-api/entities/orderable-asset.mdx +0 -4
- package/docs/reference/typescript-api/entities/payment-method.mdx +2 -6
- package/docs/reference/typescript-api/entities/payment.mdx +1 -5
- package/docs/reference/typescript-api/entities/product-option-group.mdx +1 -5
- package/docs/reference/typescript-api/entities/product-option.mdx +1 -5
- package/docs/reference/typescript-api/entities/product-variant-price.mdx +0 -4
- package/docs/reference/typescript-api/entities/product-variant.mdx +1 -5
- package/docs/reference/typescript-api/entities/product.mdx +1 -5
- package/docs/reference/typescript-api/entities/promotion.mdx +2 -6
- package/docs/reference/typescript-api/entities/province.mdx +1 -5
- package/docs/reference/typescript-api/entities/refund.mdx +0 -4
- package/docs/reference/typescript-api/entities/region.mdx +2 -6
- package/docs/reference/typescript-api/entities/role.mdx +1 -5
- package/docs/reference/typescript-api/entities/seller.mdx +1 -5
- package/docs/reference/typescript-api/entities/session.mdx +2 -6
- package/docs/reference/typescript-api/entities/settings-store-entry.mdx +0 -4
- package/docs/reference/typescript-api/entities/shipping-line.mdx +1 -5
- package/docs/reference/typescript-api/entities/shipping-method.mdx +2 -6
- package/docs/reference/typescript-api/entities/stock-level.mdx +2 -6
- package/docs/reference/typescript-api/entities/stock-location.mdx +2 -6
- package/docs/reference/typescript-api/entities/stock-movement.mdx +1 -25
- package/docs/reference/typescript-api/entities/surcharge.mdx +1 -5
- package/docs/reference/typescript-api/entities/tag.mdx +0 -4
- package/docs/reference/typescript-api/entities/tax-category.mdx +1 -5
- package/docs/reference/typescript-api/entities/tax-rate.mdx +4 -8
- package/docs/reference/typescript-api/entities/user.mdx +1 -5
- package/docs/reference/typescript-api/entities/vendure-entity.mdx +1 -5
- package/docs/reference/typescript-api/entities/zone.mdx +1 -5
- package/docs/reference/typescript-api/errors/error-handler-strategy.mdx +0 -4
- package/docs/reference/typescript-api/errors/error-result-union.mdx +0 -4
- package/docs/reference/typescript-api/errors/error-types.mdx +1 -29
- package/docs/reference/typescript-api/errors/i18n-error.mdx +0 -4
- package/docs/reference/typescript-api/errors/is-graph-ql-error-result.mdx +1 -5
- package/docs/reference/typescript-api/events/blocking-event-handler-options.mdx +0 -4
- package/docs/reference/typescript-api/events/event-bus.mdx +6 -10
- package/docs/reference/typescript-api/events/event-types.mdx +50 -286
- package/docs/reference/typescript-api/events/vendure-entity-event.mdx +0 -4
- package/docs/reference/typescript-api/events/vendure-event.mdx +0 -4
- package/docs/reference/typescript-api/fulfillment/fulfillment-handler.mdx +3 -19
- package/docs/reference/typescript-api/fulfillment/fulfillment-process.mdx +4 -12
- package/docs/reference/typescript-api/fulfillment/fulfillment-state.mdx +1 -5
- package/docs/reference/typescript-api/fulfillment/fulfillment-states.mdx +1 -5
- package/docs/reference/typescript-api/fulfillment/fulfillment-transition-data.mdx +0 -4
- package/docs/reference/typescript-api/health-check/health-check-registry-service.mdx +3 -7
- package/docs/reference/typescript-api/health-check/health-check-strategy.mdx +1 -5
- package/docs/reference/typescript-api/health-check/http-health-check-strategy.mdx +1 -5
- package/docs/reference/typescript-api/health-check/type-ormhealth-check-strategy.mdx +1 -5
- package/docs/reference/typescript-api/import-export/asset-import-strategy.mdx +2 -6
- package/docs/reference/typescript-api/import-export/asset-importer.mdx +2 -6
- package/docs/reference/typescript-api/import-export/default-asset-import-strategy.mdx +0 -4
- package/docs/reference/typescript-api/import-export/fast-importer-service.mdx +0 -4
- package/docs/reference/typescript-api/import-export/import-export-options.mdx +1 -5
- package/docs/reference/typescript-api/import-export/import-parser.mdx +8 -36
- package/docs/reference/typescript-api/import-export/importer.mdx +2 -6
- package/docs/reference/typescript-api/import-export/initial-data.mdx +0 -4
- package/docs/reference/typescript-api/import-export/populate.mdx +3 -7
- package/docs/reference/typescript-api/import-export/populator.mdx +2 -6
- package/docs/reference/typescript-api/job-queue/default-job-queue-plugin.mdx +5 -17
- package/docs/reference/typescript-api/job-queue/in-memory-job-buffer-storage-strategy.mdx +3 -7
- package/docs/reference/typescript-api/job-queue/in-memory-job-queue-strategy.mdx +2 -6
- package/docs/reference/typescript-api/job-queue/index.mdx +4 -8
- package/docs/reference/typescript-api/job-queue/inspectable-job-queue-strategy.mdx +0 -4
- package/docs/reference/typescript-api/job-queue/job-buffer-storage-strategy.mdx +1 -5
- package/docs/reference/typescript-api/job-queue/job-buffer.mdx +2 -6
- package/docs/reference/typescript-api/job-queue/job-queue-options.mdx +0 -4
- package/docs/reference/typescript-api/job-queue/job-queue-service.mdx +4 -8
- package/docs/reference/typescript-api/job-queue/job-queue-strategy.mdx +1 -5
- package/docs/reference/typescript-api/job-queue/job.mdx +2 -14
- package/docs/reference/typescript-api/job-queue/polling-job-queue-strategy.mdx +3 -7
- package/docs/reference/typescript-api/job-queue/sql-job-queue-strategy.mdx +2 -6
- package/docs/reference/typescript-api/job-queue/subscribable-job.mdx +4 -8
- package/docs/reference/typescript-api/job-queue/types.mdx +5 -29
- package/docs/reference/typescript-api/logger/default-logger.mdx +0 -4
- package/docs/reference/typescript-api/logger/index.mdx +3 -7
- package/docs/reference/typescript-api/logger/log-level.mdx +0 -4
- package/docs/reference/typescript-api/logger/vendure-logger.mdx +0 -4
- package/docs/reference/typescript-api/migration/generate-migration.mdx +0 -4
- package/docs/reference/typescript-api/migration/migration-options.mdx +1 -5
- package/docs/reference/typescript-api/migration/revert-last-migration.mdx +0 -4
- package/docs/reference/typescript-api/migration/run-migrations.mdx +0 -4
- package/docs/reference/typescript-api/money/big-int-money-strategy.mdx +2 -6
- package/docs/reference/typescript-api/money/default-money-strategy.mdx +1 -5
- package/docs/reference/typescript-api/money/money-decorator.mdx +1 -5
- package/docs/reference/typescript-api/money/money-strategy.mdx +4 -8
- package/docs/reference/typescript-api/money/round-money.mdx +1 -5
- package/docs/reference/typescript-api/orders/active-order-service.mdx +1 -5
- package/docs/reference/typescript-api/orders/active-order-strategy.mdx +1 -5
- package/docs/reference/typescript-api/orders/changed-price-handling-strategy.mdx +1 -5
- package/docs/reference/typescript-api/orders/custom-order-states.mdx +1 -5
- package/docs/reference/typescript-api/orders/default-active-order-strategy.mdx +1 -5
- package/docs/reference/typescript-api/orders/default-guest-checkout-strategy.mdx +2 -10
- package/docs/reference/typescript-api/orders/default-order-item-price-calculation-strategy.mdx +1 -5
- package/docs/reference/typescript-api/orders/default-order-placed-strategy.mdx +1 -5
- package/docs/reference/typescript-api/orders/default-stock-allocation-strategy.mdx +0 -4
- package/docs/reference/typescript-api/orders/guest-checkout-strategy.mdx +0 -4
- package/docs/reference/typescript-api/orders/merge-strategies.mdx +0 -16
- package/docs/reference/typescript-api/orders/order-by-code-access-strategy.mdx +0 -8
- package/docs/reference/typescript-api/orders/order-code-strategy.mdx +0 -8
- package/docs/reference/typescript-api/orders/order-interceptor.mdx +4 -8
- package/docs/reference/typescript-api/orders/order-item-price-calculation-strategy.mdx +2 -6
- package/docs/reference/typescript-api/orders/order-merge-strategy.mdx +1 -9
- package/docs/reference/typescript-api/orders/order-options.mdx +2 -6
- package/docs/reference/typescript-api/orders/order-placed-strategy.mdx +0 -4
- package/docs/reference/typescript-api/orders/order-process.mdx +12 -40
- package/docs/reference/typescript-api/orders/order-seller-strategy.mdx +3 -15
- package/docs/reference/typescript-api/orders/stock-allocation-strategy.mdx +0 -4
- package/docs/reference/typescript-api/payment/default-payment-process.mdx +1 -5
- package/docs/reference/typescript-api/payment/default-refund-process.mdx +1 -5
- package/docs/reference/typescript-api/payment/dummy-payment-handler.mdx +0 -4
- package/docs/reference/typescript-api/payment/payment-method-config-options.mdx +3 -7
- package/docs/reference/typescript-api/payment/payment-method-eligibility-checker.mdx +3 -15
- package/docs/reference/typescript-api/payment/payment-method-handler.mdx +1 -5
- package/docs/reference/typescript-api/payment/payment-method-types.mdx +16 -60
- package/docs/reference/typescript-api/payment/payment-options.mdx +7 -11
- package/docs/reference/typescript-api/payment/payment-process.mdx +1 -5
- package/docs/reference/typescript-api/payment/payment-state.mdx +0 -4
- package/docs/reference/typescript-api/payment/payment-states.mdx +1 -5
- package/docs/reference/typescript-api/payment/payment-transition-data.mdx +0 -4
- package/docs/reference/typescript-api/payment/refund-process.mdx +1 -5
- package/docs/reference/typescript-api/payment/refund-state.mdx +0 -4
- package/docs/reference/typescript-api/payment/refund-states.mdx +1 -5
- package/docs/reference/typescript-api/payment/refund-transition-data.mdx +0 -4
- package/docs/reference/typescript-api/plugin/plugin-common-module.mdx +3 -7
- package/docs/reference/typescript-api/plugin/plugin-utilities.mdx +1 -9
- package/docs/reference/typescript-api/plugin/vendure-plugin-metadata.mdx +3 -15
- package/docs/reference/typescript-api/plugin/vendure-plugin.mdx +0 -4
- package/docs/reference/typescript-api/products-stock/catalog-options.mdx +1 -5
- package/docs/reference/typescript-api/products-stock/default-product-variant-price-calculation-strategy.mdx +0 -4
- package/docs/reference/typescript-api/products-stock/default-stock-display-strategy.mdx +0 -4
- package/docs/reference/typescript-api/products-stock/default-stock-location-strategy.mdx +2 -6
- package/docs/reference/typescript-api/products-stock/multi-channel-stock-location-strategy.mdx +2 -6
- package/docs/reference/typescript-api/products-stock/product-variant-price-calculation-strategy.mdx +1 -9
- package/docs/reference/typescript-api/products-stock/stock-display-strategy.mdx +0 -4
- package/docs/reference/typescript-api/products-stock/stock-location-strategy.mdx +4 -16
- package/docs/reference/typescript-api/promotions/facet-value-checker.mdx +3 -7
- package/docs/reference/typescript-api/promotions/promotion-action.mdx +10 -70
- package/docs/reference/typescript-api/promotions/promotion-condition.mdx +4 -16
- package/docs/reference/typescript-api/promotions/promotion-options.mdx +0 -4
- package/docs/reference/typescript-api/request/allow-decorator.mdx +1 -5
- package/docs/reference/typescript-api/request/api-decorator.mdx +1 -5
- package/docs/reference/typescript-api/request/api-type.mdx +0 -4
- package/docs/reference/typescript-api/request/ctx-decorator.mdx +1 -5
- package/docs/reference/typescript-api/request/relations-decorator.mdx +1 -5
- package/docs/reference/typescript-api/request/request-context-service.mdx +1 -5
- package/docs/reference/typescript-api/request/request-context.mdx +5 -9
- package/docs/reference/typescript-api/request/transaction-decorator.mdx +2 -14
- package/docs/reference/typescript-api/scheduled-tasks/clean-sessions-task.mdx +1 -5
- package/docs/reference/typescript-api/scheduled-tasks/default-scheduler-plugin.mdx +1 -9
- package/docs/reference/typescript-api/scheduled-tasks/default-scheduler-strategy.mdx +2 -6
- package/docs/reference/typescript-api/scheduled-tasks/scheduled-task.mdx +0 -12
- package/docs/reference/typescript-api/scheduled-tasks/scheduler-options.mdx +2 -6
- package/docs/reference/typescript-api/scheduled-tasks/scheduler-service.mdx +0 -4
- package/docs/reference/typescript-api/scheduled-tasks/scheduler-strategy.mdx +3 -11
- package/docs/reference/typescript-api/service-helpers/entity-duplicator-service.mdx +3 -7
- package/docs/reference/typescript-api/service-helpers/order-calculator.mdx +0 -4
- package/docs/reference/typescript-api/service-helpers/order-modifier.mdx +1 -5
- package/docs/reference/typescript-api/service-helpers/product-price-applicator.mdx +1 -5
- package/docs/reference/typescript-api/service-helpers/slug-validator.mdx +1 -13
- package/docs/reference/typescript-api/service-helpers/translatable-saver.mdx +1 -5
- package/docs/reference/typescript-api/service-helpers/translator-service.mdx +0 -4
- package/docs/reference/typescript-api/services/administrator-service.mdx +1 -5
- package/docs/reference/typescript-api/services/asset-service.mdx +2 -14
- package/docs/reference/typescript-api/services/auth-service.mdx +3 -7
- package/docs/reference/typescript-api/services/channel-service.mdx +3 -7
- package/docs/reference/typescript-api/services/collection-service.mdx +3 -7
- package/docs/reference/typescript-api/services/country-service.mdx +1 -5
- package/docs/reference/typescript-api/services/customer-group-service.mdx +2 -6
- package/docs/reference/typescript-api/services/customer-service.mdx +13 -17
- package/docs/reference/typescript-api/services/entity-slug-service.mdx +0 -4
- package/docs/reference/typescript-api/services/facet-service.mdx +1 -5
- package/docs/reference/typescript-api/services/facet-value-service.mdx +1 -5
- package/docs/reference/typescript-api/services/fulfillment-service.mdx +3 -7
- package/docs/reference/typescript-api/services/global-settings-service.mdx +1 -5
- package/docs/reference/typescript-api/services/history-service.mdx +1 -5
- package/docs/reference/typescript-api/services/initializer-service.mdx +0 -4
- package/docs/reference/typescript-api/services/order-service.mdx +24 -28
- package/docs/reference/typescript-api/services/order-testing-service.mdx +0 -4
- package/docs/reference/typescript-api/services/payment-method-service.mdx +1 -5
- package/docs/reference/typescript-api/services/payment-service.mdx +6 -10
- package/docs/reference/typescript-api/services/product-option-group-service.mdx +1 -5
- package/docs/reference/typescript-api/services/product-option-service.mdx +1 -5
- package/docs/reference/typescript-api/services/product-service.mdx +2 -6
- package/docs/reference/typescript-api/services/product-variant-service.mdx +7 -11
- package/docs/reference/typescript-api/services/promotion-service.mdx +1 -5
- package/docs/reference/typescript-api/services/province-service.mdx +1 -5
- package/docs/reference/typescript-api/services/role-service.mdx +1 -5
- package/docs/reference/typescript-api/services/search-service.mdx +0 -4
- package/docs/reference/typescript-api/services/seller-service.mdx +1 -5
- package/docs/reference/typescript-api/services/session-service.mdx +4 -8
- package/docs/reference/typescript-api/services/settings-store-service.mdx +0 -4
- package/docs/reference/typescript-api/services/shipping-method-service.mdx +1 -5
- package/docs/reference/typescript-api/services/slug-service.mdx +0 -4
- package/docs/reference/typescript-api/services/stock-level-service.mdx +5 -9
- package/docs/reference/typescript-api/services/stock-location-service.mdx +5 -9
- package/docs/reference/typescript-api/services/stock-movement-service.mdx +8 -12
- package/docs/reference/typescript-api/services/tag-service.mdx +1 -5
- package/docs/reference/typescript-api/services/tax-category-service.mdx +1 -5
- package/docs/reference/typescript-api/services/tax-rate-service.mdx +1 -5
- package/docs/reference/typescript-api/services/user-service.mdx +8 -12
- package/docs/reference/typescript-api/services/zone-service.mdx +1 -5
- package/docs/reference/typescript-api/settings-store/cleanup-orphaned-settings-store-entries-options.mdx +0 -4
- package/docs/reference/typescript-api/settings-store/cleanup-orphaned-settings-store-entries-result.mdx +0 -4
- package/docs/reference/typescript-api/settings-store/index.mdx +1 -5
- package/docs/reference/typescript-api/settings-store/orphaned-settings-store-entry.mdx +0 -4
- package/docs/reference/typescript-api/settings-store/set-settings-store-value-result.mdx +0 -4
- package/docs/reference/typescript-api/settings-store/settings-store-field-config.mdx +0 -4
- package/docs/reference/typescript-api/settings-store/settings-store-registration.mdx +0 -4
- package/docs/reference/typescript-api/settings-store/settings-store-scope-function.mdx +0 -4
- package/docs/reference/typescript-api/settings-store/settings-store-scopes.mdx +0 -4
- package/docs/reference/typescript-api/shipping/check-shipping-eligibility-checker-fn.mdx +2 -6
- package/docs/reference/typescript-api/shipping/default-shipping-line-assignment-strategy.mdx +1 -5
- package/docs/reference/typescript-api/shipping/shipping-calculator.mdx +4 -16
- package/docs/reference/typescript-api/shipping/shipping-eligibility-checker-config.mdx +1 -5
- package/docs/reference/typescript-api/shipping/shipping-eligibility-checker.mdx +1 -5
- package/docs/reference/typescript-api/shipping/shipping-line-assignment-strategy.mdx +2 -6
- package/docs/reference/typescript-api/shipping/shipping-options.mdx +3 -7
- package/docs/reference/typescript-api/shipping/should-run-check-fn.mdx +0 -4
- package/docs/reference/typescript-api/state-machine/fsm.mdx +0 -4
- package/docs/reference/typescript-api/state-machine/state-machine-config.mdx +1 -17
- package/docs/reference/typescript-api/state-machine/transitions.mdx +2 -6
- package/docs/reference/typescript-api/tax/address-based-tax-zone-strategy.mdx +2 -6
- package/docs/reference/typescript-api/tax/default-tax-line-calculation-strategy.mdx +2 -6
- package/docs/reference/typescript-api/tax/default-tax-zone-strategy.mdx +1 -5
- package/docs/reference/typescript-api/tax/tax-line-calculation-strategy.mdx +2 -10
- package/docs/reference/typescript-api/tax/tax-options.mdx +0 -4
- package/docs/reference/typescript-api/tax/tax-zone-strategy.mdx +1 -5
- package/docs/reference/typescript-api/telemetry/instrument.mdx +1 -5
- package/docs/reference/typescript-api/telemetry/instrumentation-strategy.mdx +1 -5
- package/docs/reference/typescript-api/telemetry/wrapped-method-args.mdx +1 -5
- package/docs/reference/typescript-api/testing/create-error-result-guard.mdx +1 -5
- package/docs/reference/typescript-api/testing/create-test-environment.mdx +2 -6
- package/docs/reference/typescript-api/testing/error-result-guard.mdx +0 -4
- package/docs/reference/typescript-api/testing/get-superadmin-context.mdx +1 -5
- package/docs/reference/typescript-api/testing/register-initializer.mdx +2 -6
- package/docs/reference/typescript-api/testing/simple-graph-qlclient.mdx +0 -4
- package/docs/reference/typescript-api/testing/test-config.mdx +1 -5
- package/docs/reference/typescript-api/testing/test-db-initializer.mdx +1 -5
- package/docs/reference/typescript-api/testing/test-environment.mdx +1 -5
- package/docs/reference/typescript-api/testing/test-server-options.mdx +1 -5
- package/docs/reference/typescript-api/testing/test-server.mdx +0 -4
- package/docs/reference/typescript-api/testing/testing-logger.mdx +0 -4
- package/docs/reference/typescript-api/worker/bootstrap-worker.mdx +2 -10
- package/docs/reference/typescript-api/worker/vendure-worker.mdx +1 -5
- package/docs/reference/typescript-api/worker/worker-health-check-config.mdx +0 -4
- package/package.json +2 -2
|
@@ -2,13 +2,9 @@
|
|
|
2
2
|
title: "CustomerService"
|
|
3
3
|
generated: true
|
|
4
4
|
---
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
## CustomerService
|
|
8
|
-
|
|
9
5
|
<GenerationInfo sourceFile="packages/core/src/service/services/customer.service.ts" sourceLine="80" packageName="@vendure/core" />
|
|
10
6
|
|
|
11
|
-
Contains methods relating to <
|
|
7
|
+
Contains methods relating to <DocsLink href="/reference/typescript-api/entities/customer#customer">Customer</DocsLink> entities.
|
|
12
8
|
|
|
13
9
|
```ts title="Signature"
|
|
14
10
|
class CustomerService {
|
|
@@ -71,12 +67,12 @@ to the current active Channel only.
|
|
|
71
67
|
|
|
72
68
|
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, customerId: <a href='/reference/typescript-api/common/id#id'>ID</a>) => Promise<<a href='/reference/typescript-api/entities/address#address'>Address</a>[]>`} />
|
|
73
69
|
|
|
74
|
-
Returns all <
|
|
70
|
+
Returns all <DocsLink href="/reference/typescript-api/entities/address#address">Address</DocsLink> entities associated with the specified Customer.
|
|
75
71
|
### getCustomerGroups
|
|
76
72
|
|
|
77
73
|
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, customerId: <a href='/reference/typescript-api/common/id#id'>ID</a>) => Promise<<a href='/reference/typescript-api/entities/customer-group#customergroup'>CustomerGroup</a>[]>`} />
|
|
78
74
|
|
|
79
|
-
Returns a list of all <
|
|
75
|
+
Returns a list of all <DocsLink href="/reference/typescript-api/entities/customer-group#customergroup">CustomerGroup</DocsLink> entities.
|
|
80
76
|
### create
|
|
81
77
|
|
|
82
78
|
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: CreateCustomerInput, password?: string) => Promise<<a href='/reference/typescript-api/errors/error-result-union#errorresultunion'>ErrorResultUnion</a><CreateCustomerResult, <a href='/reference/typescript-api/entities/customer#customer'>Customer</a>>>`} />
|
|
@@ -84,7 +80,7 @@ Returns a list of all <a href='/reference/typescript-api/entities/customer-group
|
|
|
84
80
|
Creates a new Customer, including creation of a new User with the special `customer` Role.
|
|
85
81
|
|
|
86
82
|
If the `password` argument is specified, the Customer will be immediately verified. If not,
|
|
87
|
-
then an <
|
|
83
|
+
then an <DocsLink href="/reference/typescript-api/events/event-types#accountregistrationevent">AccountRegistrationEvent</DocsLink> is published, so that the customer can have their
|
|
88
84
|
email address verified and set their password in a later step using the `verifyCustomerEmailAddress()`
|
|
89
85
|
method.
|
|
90
86
|
|
|
@@ -108,9 +104,9 @@ This method is intended to be used in admin-created Customer flows.
|
|
|
108
104
|
|
|
109
105
|
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: RegisterCustomerInput) => Promise<RegisterCustomerAccountResult | EmailAddressConflictError | PasswordValidationError>`} />
|
|
110
106
|
|
|
111
|
-
Registers a new Customer account with the <
|
|
112
|
-
the email verification flow (unless <
|
|
113
|
-
by publishing an <
|
|
107
|
+
Registers a new Customer account with the <DocsLink href="/reference/typescript-api/auth/native-authentication-strategy#nativeauthenticationstrategy">NativeAuthenticationStrategy</DocsLink> and starts
|
|
108
|
+
the email verification flow (unless <DocsLink href="/reference/typescript-api/auth/auth-options#authoptions">AuthOptions</DocsLink> `requireVerification` is set to `false`)
|
|
109
|
+
by publishing an <DocsLink href="/reference/typescript-api/events/event-types#accountregistrationevent">AccountRegistrationEvent</DocsLink>.
|
|
114
110
|
|
|
115
111
|
This method is intended to be used in storefront Customer-creation flows.
|
|
116
112
|
### refreshVerificationToken
|
|
@@ -118,18 +114,18 @@ This method is intended to be used in storefront Customer-creation flows.
|
|
|
118
114
|
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, emailAddress: string) => Promise<void>`} />
|
|
119
115
|
|
|
120
116
|
Refreshes a stale email address verification token by generating a new one and
|
|
121
|
-
publishing a <
|
|
117
|
+
publishing a <DocsLink href="/reference/typescript-api/events/event-types#accountregistrationevent">AccountRegistrationEvent</DocsLink>.
|
|
122
118
|
### verifyCustomerEmailAddress
|
|
123
119
|
|
|
124
120
|
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, verificationToken: string, password?: string) => Promise<<a href='/reference/typescript-api/errors/error-result-union#errorresultunion'>ErrorResultUnion</a><VerifyCustomerAccountResult, <a href='/reference/typescript-api/entities/customer#customer'>Customer</a>>>`} />
|
|
125
121
|
|
|
126
|
-
Given a valid verification token which has been published in an <
|
|
122
|
+
Given a valid verification token which has been published in an <DocsLink href="/reference/typescript-api/events/event-types#accountregistrationevent">AccountRegistrationEvent</DocsLink>, this
|
|
127
123
|
method is used to set the Customer as `verified` as part of the account registration flow.
|
|
128
124
|
### requestPasswordReset
|
|
129
125
|
|
|
130
126
|
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, emailAddress: string) => Promise<void>`} />
|
|
131
127
|
|
|
132
|
-
Publishes a new <
|
|
128
|
+
Publishes a new <DocsLink href="/reference/typescript-api/events/event-types#passwordresetevent">PasswordResetEvent</DocsLink> for the given email address. This event creates
|
|
133
129
|
a token which can be used in the `resetPassword()` method.
|
|
134
130
|
### resetPassword
|
|
135
131
|
|
|
@@ -141,14 +137,14 @@ this method will change the Customer's password to that given as the `password`
|
|
|
141
137
|
|
|
142
138
|
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, userId: <a href='/reference/typescript-api/common/id#id'>ID</a>, newEmailAddress: string) => Promise<boolean | EmailAddressConflictError>`} />
|
|
143
139
|
|
|
144
|
-
Publishes a <
|
|
140
|
+
Publishes a <DocsLink href="/reference/typescript-api/events/event-types#identifierchangerequestevent">IdentifierChangeRequestEvent</DocsLink> for the given User. This event contains a token
|
|
145
141
|
which is then used in the `updateEmailAddress()` method to change the email address of the User &
|
|
146
142
|
Customer.
|
|
147
143
|
### updateEmailAddress
|
|
148
144
|
|
|
149
145
|
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, token: string) => Promise<boolean | IdentifierChangeTokenInvalidError | IdentifierChangeTokenExpiredError>`} />
|
|
150
146
|
|
|
151
|
-
Given a valid email update token published in a <
|
|
147
|
+
Given a valid email update token published in a <DocsLink href="/reference/typescript-api/events/event-types#identifierchangerequestevent">IdentifierChangeRequestEvent</DocsLink>, this method
|
|
152
148
|
will update the Customer & User email address.
|
|
153
149
|
### createOrUpdate
|
|
154
150
|
|
|
@@ -159,7 +155,7 @@ For guest checkouts, we assume that a matching email address is the same custome
|
|
|
159
155
|
|
|
160
156
|
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, customerId: <a href='/reference/typescript-api/common/id#id'>ID</a>, input: CreateAddressInput) => Promise<<a href='/reference/typescript-api/entities/address#address'>Address</a>>`} />
|
|
161
157
|
|
|
162
|
-
Creates a new <
|
|
158
|
+
Creates a new <DocsLink href="/reference/typescript-api/entities/address#address">Address</DocsLink> for the given Customer.
|
|
163
159
|
### updateAddress
|
|
164
160
|
|
|
165
161
|
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: UpdateAddressInput) => Promise<<a href='/reference/typescript-api/entities/address#address'>Address</a>>`} />
|
|
@@ -2,10 +2,6 @@
|
|
|
2
2
|
title: "EntitySlugService"
|
|
3
3
|
generated: true
|
|
4
4
|
---
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
## EntitySlugService
|
|
8
|
-
|
|
9
5
|
<GenerationInfo sourceFile="packages/core/src/service/helpers/entity-slug.service.ts" sourceLine="41" packageName="@vendure/core" since="3.5.0" />
|
|
10
6
|
|
|
11
7
|
A service that handles slug generation for entities, ensuring uniqueness
|
|
@@ -2,13 +2,9 @@
|
|
|
2
2
|
title: "FacetService"
|
|
3
3
|
generated: true
|
|
4
4
|
---
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
## FacetService
|
|
8
|
-
|
|
9
5
|
<GenerationInfo sourceFile="packages/core/src/service/services/facet.service.ts" sourceLine="45" packageName="@vendure/core" />
|
|
10
6
|
|
|
11
|
-
Contains methods relating to <
|
|
7
|
+
Contains methods relating to <DocsLink href="/reference/typescript-api/entities/facet#facet">Facet</DocsLink> entities.
|
|
12
8
|
|
|
13
9
|
```ts title="Signature"
|
|
14
10
|
class FacetService {
|
|
@@ -2,13 +2,9 @@
|
|
|
2
2
|
title: "FacetValueService"
|
|
3
3
|
generated: true
|
|
4
4
|
---
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
## FacetValueService
|
|
8
|
-
|
|
9
5
|
<GenerationInfo sourceFile="packages/core/src/service/services/facet-value.service.ts" sourceLine="40" packageName="@vendure/core" />
|
|
10
6
|
|
|
11
|
-
Contains methods relating to <
|
|
7
|
+
Contains methods relating to <DocsLink href="/reference/typescript-api/entities/facet-value#facetvalue">FacetValue</DocsLink> entities.
|
|
12
8
|
|
|
13
9
|
```ts title="Signature"
|
|
14
10
|
class FacetValueService {
|
|
@@ -2,13 +2,9 @@
|
|
|
2
2
|
title: "FulfillmentService"
|
|
3
3
|
generated: true
|
|
4
4
|
---
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
## FulfillmentService
|
|
8
|
-
|
|
9
5
|
<GenerationInfo sourceFile="packages/core/src/service/services/fulfillment.service.ts" sourceLine="34" packageName="@vendure/core" />
|
|
10
6
|
|
|
11
|
-
Contains methods relating to <
|
|
7
|
+
Contains methods relating to <DocsLink href="/reference/typescript-api/entities/fulfillment#fulfillment">Fulfillment</DocsLink> entities.
|
|
12
8
|
|
|
13
9
|
```ts title="Signature"
|
|
14
10
|
class FulfillmentService {
|
|
@@ -41,7 +37,7 @@ class FulfillmentService {
|
|
|
41
37
|
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, orders: <a href='/reference/typescript-api/entities/order#order'>Order</a>[], lines: OrderLineInput[], handler: ConfigurableOperationInput) => Promise<<a href='/reference/typescript-api/entities/fulfillment#fulfillment'>Fulfillment</a> | InvalidFulfillmentHandlerError | CreateFulfillmentError>`} />
|
|
42
38
|
|
|
43
39
|
Creates a new Fulfillment for the given Orders and OrderItems, using the specified
|
|
44
|
-
<
|
|
40
|
+
<DocsLink href="/reference/typescript-api/fulfillment/fulfillment-handler#fulfillmenthandler">FulfillmentHandler</DocsLink>.
|
|
45
41
|
### getFulfillmentLines
|
|
46
42
|
|
|
47
43
|
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, id: <a href='/reference/typescript-api/common/id#id'>ID</a>) => Promise<<a href='/reference/typescript-api/entities/order-line-reference#fulfillmentline'>FulfillmentLine</a>[]>`} />
|
|
@@ -57,7 +53,7 @@ Creates a new Fulfillment for the given Orders and OrderItems, using the specifi
|
|
|
57
53
|
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, fulfillmentId: <a href='/reference/typescript-api/common/id#id'>ID</a>, state: <a href='/reference/typescript-api/fulfillment/fulfillment-state#fulfillmentstate'>FulfillmentState</a>) => Promise< | { fulfillment: <a href='/reference/typescript-api/entities/fulfillment#fulfillment'>Fulfillment</a>; orders: <a href='/reference/typescript-api/entities/order#order'>Order</a>[]; fromState: <a href='/reference/typescript-api/fulfillment/fulfillment-state#fulfillmentstate'>FulfillmentState</a>; toState: <a href='/reference/typescript-api/fulfillment/fulfillment-state#fulfillmentstate'>FulfillmentState</a>; } | FulfillmentStateTransitionError >`} />
|
|
58
54
|
|
|
59
55
|
Transitions the specified Fulfillment to a new state and upon successful transition
|
|
60
|
-
publishes a <
|
|
56
|
+
publishes a <DocsLink href="/reference/typescript-api/events/event-types#fulfillmentstatetransitionevent">FulfillmentStateTransitionEvent</DocsLink>.
|
|
61
57
|
### getNextStates
|
|
62
58
|
|
|
63
59
|
<MemberInfo kind="method" type={`(fulfillment: <a href='/reference/typescript-api/entities/fulfillment#fulfillment'>Fulfillment</a>) => readonly <a href='/reference/typescript-api/fulfillment/fulfillment-state#fulfillmentstate'>FulfillmentState</a>[]`} />
|
|
@@ -2,13 +2,9 @@
|
|
|
2
2
|
title: "GlobalSettingsService"
|
|
3
3
|
generated: true
|
|
4
4
|
---
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
## GlobalSettingsService
|
|
8
|
-
|
|
9
5
|
<GenerationInfo sourceFile="packages/core/src/service/services/global-settings.service.ts" sourceLine="23" packageName="@vendure/core" />
|
|
10
6
|
|
|
11
|
-
Contains methods relating to the <
|
|
7
|
+
Contains methods relating to the <DocsLink href="/reference/typescript-api/entities/global-settings#globalsettings">GlobalSettings</DocsLink> entity.
|
|
12
8
|
|
|
13
9
|
```ts title="Signature"
|
|
14
10
|
class GlobalSettingsService {
|
|
@@ -2,13 +2,9 @@
|
|
|
2
2
|
title: "HistoryService"
|
|
3
3
|
generated: true
|
|
4
4
|
---
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
## HistoryService
|
|
8
|
-
|
|
9
5
|
<GenerationInfo sourceFile="packages/core/src/service/services/history.service.ts" sourceLine="248" packageName="@vendure/core" />
|
|
10
6
|
|
|
11
|
-
Contains methods relating to <
|
|
7
|
+
Contains methods relating to <DocsLink href="/reference/typescript-api/entities/history-entry#historyentry">HistoryEntry</DocsLink> entities. Histories are timelines of actions
|
|
12
8
|
related to a particular Customer or Order, recording significant events such as creation, state changes,
|
|
13
9
|
notes, etc.
|
|
14
10
|
|
|
@@ -2,10 +2,6 @@
|
|
|
2
2
|
title: "InitializerService"
|
|
3
3
|
generated: true
|
|
4
4
|
---
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
## InitializerService
|
|
8
|
-
|
|
9
5
|
<GenerationInfo sourceFile="packages/core/src/service/initializer.service.ts" sourceLine="26" packageName="@vendure/core" />
|
|
10
6
|
|
|
11
7
|
Only used internally to run the various service init methods in the correct
|
|
@@ -2,13 +2,9 @@
|
|
|
2
2
|
title: "OrderService"
|
|
3
3
|
generated: true
|
|
4
4
|
---
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
## OrderService
|
|
8
|
-
|
|
9
5
|
<GenerationInfo sourceFile="packages/core/src/service/services/order.service.ts" sourceLine="141" packageName="@vendure/core" />
|
|
10
6
|
|
|
11
|
-
Contains methods relating to <
|
|
7
|
+
Contains methods relating to <DocsLink href="/reference/typescript-api/entities/order#order">Order</DocsLink> entities.
|
|
12
8
|
|
|
13
9
|
```ts title="Signature"
|
|
14
10
|
class OrderService {
|
|
@@ -91,8 +87,8 @@ class OrderService {
|
|
|
91
87
|
<MemberInfo kind="method" type={`() => OrderProcessState[]`} />
|
|
92
88
|
|
|
93
89
|
Returns an array of all the configured states and transitions of the order process. This is
|
|
94
|
-
based on the default order process plus all configured <
|
|
95
|
-
defined in the <
|
|
90
|
+
based on the default order process plus all configured <DocsLink href="/reference/typescript-api/orders/order-process#orderprocess">OrderProcess</DocsLink> objects
|
|
91
|
+
defined in the <DocsLink href="/reference/typescript-api/orders/order-options#orderoptions">OrderOptions</DocsLink> `process` array.
|
|
96
92
|
### findAll
|
|
97
93
|
|
|
98
94
|
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, options?: OrderListOptions, relations?: RelationPaths<<a href='/reference/typescript-api/entities/order#order'>Order</a>>) => Promise<<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a><<a href='/reference/typescript-api/entities/order#order'>Order</a>>>`} />
|
|
@@ -122,17 +118,17 @@ defined in the <a href='/reference/typescript-api/orders/order-options#orderopti
|
|
|
122
118
|
|
|
123
119
|
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, orderId: <a href='/reference/typescript-api/common/id#id'>ID</a>) => Promise<<a href='/reference/typescript-api/entities/payment#payment'>Payment</a>[]>`} />
|
|
124
120
|
|
|
125
|
-
Returns all <
|
|
121
|
+
Returns all <DocsLink href="/reference/typescript-api/entities/payment#payment">Payment</DocsLink> entities associated with the Order.
|
|
126
122
|
### getOrderModifications
|
|
127
123
|
|
|
128
124
|
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, orderId: <a href='/reference/typescript-api/common/id#id'>ID</a>) => Promise<<a href='/reference/typescript-api/entities/order-modification#ordermodification'>OrderModification</a>[]>`} />
|
|
129
125
|
|
|
130
|
-
Returns an array of any <
|
|
126
|
+
Returns an array of any <DocsLink href="/reference/typescript-api/entities/order-modification#ordermodification">OrderModification</DocsLink> entities associated with the Order.
|
|
131
127
|
### getPaymentRefunds
|
|
132
128
|
|
|
133
129
|
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, paymentId: <a href='/reference/typescript-api/common/id#id'>ID</a>) => Promise<<a href='/reference/typescript-api/entities/refund#refund'>Refund</a>[]>`} />
|
|
134
130
|
|
|
135
|
-
Returns any <
|
|
131
|
+
Returns any <DocsLink href="/reference/typescript-api/entities/refund#refund">Refund</DocsLink>s associated with a <DocsLink href="/reference/typescript-api/entities/payment#payment">Payment</DocsLink>.
|
|
136
132
|
### getSellerOrders
|
|
137
133
|
|
|
138
134
|
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, order: <a href='/reference/typescript-api/entities/order#order'>Order</a>) => Promise<<a href='/reference/typescript-api/entities/order#order'>Order</a>[]>`} />
|
|
@@ -233,18 +229,18 @@ Removes all OrderLines from the Order.
|
|
|
233
229
|
|
|
234
230
|
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, orderId: <a href='/reference/typescript-api/common/id#id'>ID</a>, surchargeInput: Partial<Omit<<a href='/reference/typescript-api/entities/surcharge#surcharge'>Surcharge</a>, 'id' | 'createdAt' | 'updatedAt' | 'order'>>) => Promise<<a href='/reference/typescript-api/entities/order#order'>Order</a>>`} />
|
|
235
231
|
|
|
236
|
-
Adds a <
|
|
232
|
+
Adds a <DocsLink href="/reference/typescript-api/entities/surcharge#surcharge">Surcharge</DocsLink> to the Order.
|
|
237
233
|
### removeSurchargeFromOrder
|
|
238
234
|
|
|
239
235
|
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, orderId: <a href='/reference/typescript-api/common/id#id'>ID</a>, surchargeId: <a href='/reference/typescript-api/common/id#id'>ID</a>) => Promise<<a href='/reference/typescript-api/entities/order#order'>Order</a>>`} />
|
|
240
236
|
|
|
241
|
-
Removes a <
|
|
237
|
+
Removes a <DocsLink href="/reference/typescript-api/entities/surcharge#surcharge">Surcharge</DocsLink> from the Order.
|
|
242
238
|
### applyCouponCode
|
|
243
239
|
|
|
244
240
|
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, orderId: <a href='/reference/typescript-api/common/id#id'>ID</a>, couponCode: string) => Promise<<a href='/reference/typescript-api/errors/error-result-union#errorresultunion'>ErrorResultUnion</a><ApplyCouponCodeResult, <a href='/reference/typescript-api/entities/order#order'>Order</a>>>`} />
|
|
245
241
|
|
|
246
242
|
Applies a coupon code to the Order, which should be a valid coupon code as specified in the configuration
|
|
247
|
-
of an active <
|
|
243
|
+
of an active <DocsLink href="/reference/typescript-api/entities/promotion#promotion">Promotion</DocsLink>.
|
|
248
244
|
### removeCouponCode
|
|
249
245
|
|
|
250
246
|
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, orderId: <a href='/reference/typescript-api/common/id#id'>ID</a>, couponCode: string) => `} />
|
|
@@ -254,7 +250,7 @@ Removes a coupon code from the Order.
|
|
|
254
250
|
|
|
255
251
|
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, orderId: <a href='/reference/typescript-api/common/id#id'>ID</a>) => Promise<<a href='/reference/typescript-api/entities/promotion#promotion'>Promotion</a>[]>`} />
|
|
256
252
|
|
|
257
|
-
Returns all <
|
|
253
|
+
Returns all <DocsLink href="/reference/typescript-api/entities/promotion#promotion">Promotion</DocsLink>s associated with an Order.
|
|
258
254
|
### getNextOrderStates
|
|
259
255
|
|
|
260
256
|
<MemberInfo kind="method" type={`(order: <a href='/reference/typescript-api/entities/order#order'>Order</a>) => readonly <a href='/reference/typescript-api/orders/order-process#orderstate'>OrderState</a>[]`} />
|
|
@@ -284,16 +280,16 @@ Unsets the billing address for the Order.
|
|
|
284
280
|
|
|
285
281
|
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, orderId: <a href='/reference/typescript-api/common/id#id'>ID</a>) => Promise<ShippingMethodQuote[]>`} />
|
|
286
282
|
|
|
287
|
-
Returns an array of quotes stating which <
|
|
288
|
-
This is determined by the configured <
|
|
283
|
+
Returns an array of quotes stating which <DocsLink href="/reference/typescript-api/entities/shipping-method#shippingmethod">ShippingMethod</DocsLink>s may be applied to this Order.
|
|
284
|
+
This is determined by the configured <DocsLink href="/reference/typescript-api/shipping/shipping-eligibility-checker#shippingeligibilitychecker">ShippingEligibilityChecker</DocsLink> of each ShippingMethod.
|
|
289
285
|
|
|
290
286
|
The quote also includes a price for each method, as determined by the configured
|
|
291
|
-
<
|
|
287
|
+
<DocsLink href="/reference/typescript-api/shipping/shipping-calculator#shippingcalculator">ShippingCalculator</DocsLink> of each eligible ShippingMethod.
|
|
292
288
|
### getEligiblePaymentMethods
|
|
293
289
|
|
|
294
290
|
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, orderId: <a href='/reference/typescript-api/common/id#id'>ID</a>) => Promise<PaymentMethodQuote[]>`} />
|
|
295
291
|
|
|
296
|
-
Returns an array of quotes stating which <
|
|
292
|
+
Returns an array of quotes stating which <DocsLink href="/reference/typescript-api/entities/payment-method#paymentmethod">PaymentMethod</DocsLink>s may be used on this Order.
|
|
297
293
|
### setShippingMethod
|
|
298
294
|
|
|
299
295
|
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, orderId: <a href='/reference/typescript-api/common/id#id'>ID</a>, shippingMethodIds: <a href='/reference/typescript-api/common/id#id'>ID</a>[]) => Promise<<a href='/reference/typescript-api/errors/error-result-union#errorresultunion'>ErrorResultUnion</a><SetOrderShippingMethodResult, <a href='/reference/typescript-api/entities/order#order'>Order</a>>>`} />
|
|
@@ -323,7 +319,7 @@ Allows the Order to be modified, which allows several aspects of the Order to be
|
|
|
323
319
|
|
|
324
320
|
* Changes to OrderLine quantities
|
|
325
321
|
* New OrderLines being added
|
|
326
|
-
* Arbitrary <
|
|
322
|
+
* Arbitrary <DocsLink href="/reference/typescript-api/entities/surcharge#surcharge">Surcharge</DocsLink>s being added
|
|
327
323
|
* Shipping or billing address changes
|
|
328
324
|
|
|
329
325
|
Setting the `dryRun` input property to `true` will apply all changes, including updating the price of the
|
|
@@ -334,7 +330,7 @@ __Using dryRun option, you must wrap function call in transaction manually.__
|
|
|
334
330
|
|
|
335
331
|
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, paymentId: <a href='/reference/typescript-api/common/id#id'>ID</a>, state: <a href='/reference/typescript-api/payment/payment-state#paymentstate'>PaymentState</a>) => Promise<<a href='/reference/typescript-api/errors/error-result-union#errorresultunion'>ErrorResultUnion</a><TransitionPaymentToStateResult, <a href='/reference/typescript-api/entities/payment#payment'>Payment</a>>>`} />
|
|
336
332
|
|
|
337
|
-
Transitions the given <
|
|
333
|
+
Transitions the given <DocsLink href="/reference/typescript-api/entities/payment#payment">Payment</DocsLink> to a new state.
|
|
338
334
|
### addPaymentToOrder
|
|
339
335
|
|
|
340
336
|
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, orderId: <a href='/reference/typescript-api/common/id#id'>ID</a>, input: PaymentInput) => Promise<<a href='/reference/typescript-api/errors/error-result-union#errorresultunion'>ErrorResultUnion</a><AddPaymentToOrderResult, <a href='/reference/typescript-api/entities/order#order'>Order</a>>>`} />
|
|
@@ -355,13 +351,13 @@ dashboard of your payment provider.
|
|
|
355
351
|
|
|
356
352
|
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, paymentId: <a href='/reference/typescript-api/common/id#id'>ID</a>) => Promise<<a href='/reference/typescript-api/errors/error-result-union#errorresultunion'>ErrorResultUnion</a><<a href='/reference/typescript-api/payment/payment-method-types#settlepaymentresult'>SettlePaymentResult</a>, <a href='/reference/typescript-api/entities/payment#payment'>Payment</a>>>`} />
|
|
357
353
|
|
|
358
|
-
Settles a payment by invoking the <
|
|
354
|
+
Settles a payment by invoking the <DocsLink href="/reference/typescript-api/payment/payment-method-handler#paymentmethodhandler">PaymentMethodHandler</DocsLink>'s `settlePayment()` method. Automatically
|
|
359
355
|
transitions the Order state if all Payments are settled.
|
|
360
356
|
### cancelPayment
|
|
361
357
|
|
|
362
358
|
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, paymentId: <a href='/reference/typescript-api/common/id#id'>ID</a>) => Promise<<a href='/reference/typescript-api/errors/error-result-union#errorresultunion'>ErrorResultUnion</a><<a href='/reference/typescript-api/payment/payment-method-types#cancelpaymentresult'>CancelPaymentResult</a>, <a href='/reference/typescript-api/entities/payment#payment'>Payment</a>>>`} />
|
|
363
359
|
|
|
364
|
-
Cancels a payment by invoking the <
|
|
360
|
+
Cancels a payment by invoking the <DocsLink href="/reference/typescript-api/payment/payment-method-handler#paymentmethodhandler">PaymentMethodHandler</DocsLink>'s `cancelPayment()` method (if defined), and transitions the Payment to
|
|
365
361
|
the `Cancelled` state.
|
|
366
362
|
### createFulfillment
|
|
367
363
|
|
|
@@ -383,13 +379,13 @@ Returns an array of all Surcharges associated with the Order.
|
|
|
383
379
|
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: CancelOrderInput) => Promise<<a href='/reference/typescript-api/errors/error-result-union#errorresultunion'>ErrorResultUnion</a><CancelOrderResult, <a href='/reference/typescript-api/entities/order#order'>Order</a>>>`} />
|
|
384
380
|
|
|
385
381
|
Cancels an Order by transitioning it to the `Cancelled` state. If stock is being tracked for the ProductVariants
|
|
386
|
-
in the Order, then new <
|
|
382
|
+
in the Order, then new <DocsLink href="/reference/typescript-api/entities/stock-movement#stockmovement">StockMovement</DocsLink>s will be created to correct the stock levels.
|
|
387
383
|
### refundOrder
|
|
388
384
|
|
|
389
385
|
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: RefundOrderInput) => Promise<<a href='/reference/typescript-api/errors/error-result-union#errorresultunion'>ErrorResultUnion</a><RefundOrderResult, <a href='/reference/typescript-api/entities/refund#refund'>Refund</a>>>`} />
|
|
390
386
|
|
|
391
|
-
Creates a <
|
|
392
|
-
<
|
|
387
|
+
Creates a <DocsLink href="/reference/typescript-api/entities/refund#refund">Refund</DocsLink> against the order and in doing so invokes the `createRefund()` method of the
|
|
388
|
+
<DocsLink href="/reference/typescript-api/payment/payment-method-handler#paymentmethodhandler">PaymentMethodHandler</DocsLink>.
|
|
393
389
|
### settleRefund
|
|
394
390
|
|
|
395
391
|
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: SettleRefundInput) => Promise<<a href='/reference/typescript-api/entities/refund#refund'>Refund</a>>`} />
|
|
@@ -404,7 +400,7 @@ Associates a Customer with the Order.
|
|
|
404
400
|
|
|
405
401
|
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: AddNoteToOrderInput) => Promise<<a href='/reference/typescript-api/entities/order#order'>Order</a>>`} />
|
|
406
402
|
|
|
407
|
-
Creates a new "ORDER_NOTE" type <
|
|
403
|
+
Creates a new "ORDER_NOTE" type <DocsLink href="/reference/typescript-api/entities/order-history-entry#orderhistoryentry">OrderHistoryEntry</DocsLink> in the Order's history timeline.
|
|
408
404
|
### updateOrderNote
|
|
409
405
|
|
|
410
406
|
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: UpdateOrderNoteInput) => Promise<<a href='/reference/typescript-api/entities/history-entry#historyentry'>HistoryEntry</a>>`} />
|
|
@@ -427,13 +423,13 @@ Deletes an Order, ensuring that any Sessions that reference this Order are deref
|
|
|
427
423
|
When a guest user with an anonymous Order signs in and has an existing Order associated with that Customer,
|
|
428
424
|
we need to reconcile the contents of the two orders.
|
|
429
425
|
|
|
430
|
-
The logic used to do the merging is specified in the <
|
|
426
|
+
The logic used to do the merging is specified in the <DocsLink href="/reference/typescript-api/orders/order-options#orderoptions">OrderOptions</DocsLink> `mergeStrategy` config setting.
|
|
431
427
|
### applyPriceAdjustments
|
|
432
428
|
|
|
433
429
|
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, order: <a href='/reference/typescript-api/entities/order#order'>Order</a>, updatedOrderLines?: <a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a>[], relations?: RelationPaths<<a href='/reference/typescript-api/entities/order#order'>Order</a>>) => Promise<<a href='/reference/typescript-api/entities/order#order'>Order</a>>`} />
|
|
434
430
|
|
|
435
431
|
Applies promotions, taxes and shipping to the Order. If the `updatedOrderLines` argument is passed in,
|
|
436
|
-
then all of those OrderLines will have their prices re-calculated using the configured <
|
|
432
|
+
then all of those OrderLines will have their prices re-calculated using the configured <DocsLink href="/reference/typescript-api/orders/order-item-price-calculation-strategy#orderitempricecalculationstrategy">OrderItemPriceCalculationStrategy</DocsLink>.
|
|
437
433
|
|
|
438
434
|
|
|
439
435
|
</div>
|
|
@@ -2,10 +2,6 @@
|
|
|
2
2
|
title: "OrderTestingService"
|
|
3
3
|
generated: true
|
|
4
4
|
---
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
## OrderTestingService
|
|
8
|
-
|
|
9
5
|
<GenerationInfo sourceFile="packages/core/src/service/services/order-testing.service.ts" sourceLine="35" packageName="@vendure/core" />
|
|
10
6
|
|
|
11
7
|
This service is responsible for creating temporary mock Orders against which tests can be run, such as
|
|
@@ -2,13 +2,9 @@
|
|
|
2
2
|
title: "PaymentMethodService"
|
|
3
3
|
generated: true
|
|
4
4
|
---
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
## PaymentMethodService
|
|
8
|
-
|
|
9
5
|
<GenerationInfo sourceFile="packages/core/src/service/services/payment-method.service.ts" sourceLine="47" packageName="@vendure/core" />
|
|
10
6
|
|
|
11
|
-
Contains methods relating to <
|
|
7
|
+
Contains methods relating to <DocsLink href="/reference/typescript-api/entities/payment-method#paymentmethod">PaymentMethod</DocsLink> entities.
|
|
12
8
|
|
|
13
9
|
```ts title="Signature"
|
|
14
10
|
class PaymentMethodService {
|
|
@@ -2,13 +2,9 @@
|
|
|
2
2
|
title: "PaymentService"
|
|
3
3
|
generated: true
|
|
4
4
|
---
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
## PaymentService
|
|
8
|
-
|
|
9
5
|
<GenerationInfo sourceFile="packages/core/src/service/services/payment.service.ts" sourceLine="43" packageName="@vendure/core" />
|
|
10
6
|
|
|
11
|
-
Contains methods relating to <
|
|
7
|
+
Contains methods relating to <DocsLink href="/reference/typescript-api/entities/payment#payment">Payment</DocsLink> entities.
|
|
12
8
|
|
|
13
9
|
```ts title="Signature"
|
|
14
10
|
class PaymentService {
|
|
@@ -49,7 +45,7 @@ class PaymentService {
|
|
|
49
45
|
Transitions a Payment to the given state.
|
|
50
46
|
|
|
51
47
|
When updating a Payment in the context of an Order, it is
|
|
52
|
-
preferable to use the <
|
|
48
|
+
preferable to use the <DocsLink href="/reference/typescript-api/services/order-service#orderservice">OrderService</DocsLink> `transitionPaymentToState()` method, which will also handle
|
|
53
49
|
updating the Order state too.
|
|
54
50
|
### getNextStates
|
|
55
51
|
|
|
@@ -63,7 +59,7 @@ updating the Order state too.
|
|
|
63
59
|
Creates a new Payment.
|
|
64
60
|
|
|
65
61
|
When creating a Payment in the context of an Order, it is
|
|
66
|
-
preferable to use the <
|
|
62
|
+
preferable to use the <DocsLink href="/reference/typescript-api/services/order-service#orderservice">OrderService</DocsLink> `addPaymentToOrder()` method, which will also handle
|
|
67
63
|
updating the Order state too.
|
|
68
64
|
### settlePayment
|
|
69
65
|
|
|
@@ -72,7 +68,7 @@ updating the Order state too.
|
|
|
72
68
|
Settles a Payment.
|
|
73
69
|
|
|
74
70
|
When settling a Payment in the context of an Order, it is
|
|
75
|
-
preferable to use the <
|
|
71
|
+
preferable to use the <DocsLink href="/reference/typescript-api/services/order-service#orderservice">OrderService</DocsLink> `settlePayment()` method, which will also handle
|
|
76
72
|
updating the Order state too.
|
|
77
73
|
### cancelPayment
|
|
78
74
|
|
|
@@ -86,7 +82,7 @@ updating the Order state too.
|
|
|
86
82
|
Creates a Payment from the manual payment mutation in the Admin API
|
|
87
83
|
|
|
88
84
|
When creating a manual Payment in the context of an Order, it is
|
|
89
|
-
preferable to use the <
|
|
85
|
+
preferable to use the <DocsLink href="/reference/typescript-api/services/order-service#orderservice">OrderService</DocsLink> `addManualPaymentToOrder()` method, which will also handle
|
|
90
86
|
updating the Order state too.
|
|
91
87
|
### createRefund
|
|
92
88
|
|
|
@@ -97,7 +93,7 @@ specified Payment (in the case of multiple payments on a single Order), then the
|
|
|
97
93
|
refund amount will be refunded against the next available Payment from the Order.
|
|
98
94
|
|
|
99
95
|
When creating a Refund in the context of an Order, it is
|
|
100
|
-
preferable to use the <
|
|
96
|
+
preferable to use the <DocsLink href="/reference/typescript-api/services/order-service#orderservice">OrderService</DocsLink> `refundOrder()` method, which performs additional
|
|
101
97
|
validation.
|
|
102
98
|
|
|
103
99
|
|
|
@@ -2,13 +2,9 @@
|
|
|
2
2
|
title: "ProductOptionGroupService"
|
|
3
3
|
generated: true
|
|
4
4
|
---
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
## ProductOptionGroupService
|
|
8
|
-
|
|
9
5
|
<GenerationInfo sourceFile="packages/core/src/service/services/product-option-group.service.ts" sourceLine="35" packageName="@vendure/core" />
|
|
10
6
|
|
|
11
|
-
Contains methods relating to <
|
|
7
|
+
Contains methods relating to <DocsLink href="/reference/typescript-api/entities/product-option-group#productoptiongroup">ProductOptionGroup</DocsLink> entities.
|
|
12
8
|
|
|
13
9
|
```ts title="Signature"
|
|
14
10
|
class ProductOptionGroupService {
|
|
@@ -2,13 +2,9 @@
|
|
|
2
2
|
title: "ProductOptionService"
|
|
3
3
|
generated: true
|
|
4
4
|
---
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
## ProductOptionService
|
|
8
|
-
|
|
9
5
|
<GenerationInfo sourceFile="packages/core/src/service/services/product-option.service.ts" sourceLine="37" packageName="@vendure/core" />
|
|
10
6
|
|
|
11
|
-
Contains methods relating to <
|
|
7
|
+
Contains methods relating to <DocsLink href="/reference/typescript-api/entities/product-option#productoption">ProductOption</DocsLink> entities.
|
|
12
8
|
|
|
13
9
|
```ts title="Signature"
|
|
14
10
|
class ProductOptionService {
|
|
@@ -2,13 +2,9 @@
|
|
|
2
2
|
title: "ProductService"
|
|
3
3
|
generated: true
|
|
4
4
|
---
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
## ProductService
|
|
8
|
-
|
|
9
5
|
<GenerationInfo sourceFile="packages/core/src/service/services/product.service.ts" sourceLine="54" packageName="@vendure/core" />
|
|
10
6
|
|
|
11
|
-
Contains methods relating to <
|
|
7
|
+
Contains methods relating to <DocsLink href="/reference/typescript-api/entities/product#product">Product</DocsLink> entities.
|
|
12
8
|
|
|
13
9
|
```ts title="Signature"
|
|
14
10
|
class ProductService {
|
|
@@ -88,7 +84,7 @@ Returns all Channels to which the Product is assigned.
|
|
|
88
84
|
Assigns a Product to the specified Channel, and optionally uses a `priceFactor` to set the ProductVariantPrices
|
|
89
85
|
on the new Channel.
|
|
90
86
|
|
|
91
|
-
Internally, this method will also call <
|
|
87
|
+
Internally, this method will also call <DocsLink href="/reference/typescript-api/services/product-variant-service#productvariantservice">ProductVariantService</DocsLink> `assignProductVariantsToChannel()` for
|
|
92
88
|
each of the Product's variants, and will assign the Product's Assets to the Channel too.
|
|
93
89
|
### removeProductsFromChannel
|
|
94
90
|
|