@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
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/service/helpers/translatable-saver/translatable-saver.ts" sourceLine="55" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
|
-
A helper which contains methods for creating and updating entities which implement the
|
|
7
|
+
A helper which contains methods for creating and updating entities which implement the [Translatable](/reference/typescript-api/entities/interfaces#translatable) interface.
|
|
8
8
|
|
|
9
9
|
*Example*
|
|
10
10
|
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/service/services/administrator.service.ts" sourceLine="41" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
|
-
Contains methods relating to
|
|
7
|
+
Contains methods relating to [Administrator](/reference/typescript-api/entities/administrator#administrator) entities.
|
|
8
8
|
|
|
9
9
|
```ts title="Signature"
|
|
10
10
|
class AdministratorService {
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/service/services/asset.service.ts" sourceLine="91" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
|
-
Contains methods relating to
|
|
7
|
+
Contains methods relating to [Asset](/reference/typescript-api/entities/asset#asset) entities.
|
|
8
8
|
|
|
9
9
|
```ts title="Signature"
|
|
10
10
|
class AssetService {
|
|
@@ -117,7 +117,7 @@ interface EntityWithAssets extends VendureEntity {
|
|
|
117
117
|
assets: OrderableAsset[];
|
|
118
118
|
}
|
|
119
119
|
```
|
|
120
|
-
* Extends:
|
|
120
|
+
* Extends: [`VendureEntity`](/reference/typescript-api/entities/vendure-entity#vendureentity)
|
|
121
121
|
|
|
122
122
|
|
|
123
123
|
|
|
@@ -138,7 +138,7 @@ interface EntityWithAssets extends VendureEntity {
|
|
|
138
138
|
</div>
|
|
139
139
|
<GenerationInfo sourceFile="packages/core/src/service/services/asset.service.ts" sourceLine="79" packageName="@vendure/core" />
|
|
140
140
|
|
|
141
|
-
Used when updating entities which implement
|
|
141
|
+
Used when updating entities which implement [EntityWithAssets](/reference/typescript-api/services/asset-service#entitywithassets).
|
|
142
142
|
|
|
143
143
|
```ts title="Signature"
|
|
144
144
|
interface EntityAssetInput {
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/service/services/auth.service.ts" sourceLine="37" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
|
-
Contains methods relating to
|
|
7
|
+
Contains methods relating to [Session](/reference/typescript-api/entities/session#session), [AuthenticatedSession](/reference/typescript-api/entities/authenticated-session#authenticatedsession) & [AnonymousSession](/reference/typescript-api/entities/anonymous-session#anonymoussession) entities.
|
|
8
8
|
|
|
9
9
|
```ts title="Signature"
|
|
10
10
|
class AuthService {
|
|
@@ -27,7 +27,7 @@ class AuthService {
|
|
|
27
27
|
|
|
28
28
|
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, apiType: <a href='/reference/typescript-api/request/api-type#apitype'>ApiType</a>, authenticationMethod: string, authenticationData: any) => Promise<<a href='/reference/typescript-api/entities/authenticated-session#authenticatedsession'>AuthenticatedSession</a> | InvalidCredentialsError | NotVerifiedError>`} />
|
|
29
29
|
|
|
30
|
-
Authenticates a user's credentials and if okay, creates a new
|
|
30
|
+
Authenticates a user's credentials and if okay, creates a new [AuthenticatedSession](/reference/typescript-api/entities/authenticated-session#authenticatedsession).
|
|
31
31
|
### createAuthenticatedSessionForUser
|
|
32
32
|
|
|
33
33
|
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, user: <a href='/reference/typescript-api/entities/user#user'>User</a>, authenticationStrategyName: string) => Promise<<a href='/reference/typescript-api/entities/authenticated-session#authenticatedsession'>AuthenticatedSession</a> | NotVerifiedError>`} />
|
|
@@ -38,7 +38,7 @@ Authenticates a user's credentials and if okay, creates a new <DocsLink href="/r
|
|
|
38
38
|
<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>, password: string) => Promise<boolean | InvalidCredentialsError | ShopInvalidCredentialsError>`} />
|
|
39
39
|
|
|
40
40
|
Verify the provided password against the one we have for the given user. Requires
|
|
41
|
-
the
|
|
41
|
+
the [NativeAuthenticationStrategy](/reference/typescript-api/auth/native-authentication-strategy#nativeauthenticationstrategy) to be configured.
|
|
42
42
|
### destroyAuthenticatedSession
|
|
43
43
|
|
|
44
44
|
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, sessionToken: string) => Promise<void>`} />
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/service/services/channel.service.ts" sourceLine="54" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
|
-
Contains methods relating to
|
|
7
|
+
Contains methods relating to [Channel](/reference/typescript-api/entities/channel#channel) entities.
|
|
8
8
|
|
|
9
9
|
```ts title="Signature"
|
|
10
10
|
class ChannelService {
|
|
@@ -54,7 +54,7 @@ Removes the entity from the given Channels and saves.
|
|
|
54
54
|
<MemberInfo kind="method" type={`(token: string) => Promise<<a href='/reference/typescript-api/entities/channel#channel'>Channel</a>>`} />
|
|
55
55
|
|
|
56
56
|
Given a channel token, returns the corresponding Channel if it exists, else will throw
|
|
57
|
-
a
|
|
57
|
+
a [ChannelNotFoundError](/reference/typescript-api/errors/error-types#channelnotfounderror).
|
|
58
58
|
### getChannelFromToken
|
|
59
59
|
|
|
60
60
|
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, token: string) => Promise<<a href='/reference/typescript-api/entities/channel#channel'>Channel</a>>`} />
|
|
@@ -100,7 +100,7 @@ Returns the default Channel.
|
|
|
100
100
|
<MemberInfo kind="method" type={`(entity: <a href='/reference/typescript-api/entities/vendure-entity#vendureentity'>VendureEntity</a>) => entity is <a href='/reference/typescript-api/entities/vendure-entity#vendureentity'>VendureEntity</a> & <a href='/reference/typescript-api/entities/interfaces#channelaware'>ChannelAware</a>`} />
|
|
101
101
|
|
|
102
102
|
Type guard method which returns true if the given entity is an
|
|
103
|
-
instance of a class which implements the
|
|
103
|
+
instance of a class which implements the [ChannelAware](/reference/typescript-api/entities/interfaces#channelaware) interface.
|
|
104
104
|
|
|
105
105
|
|
|
106
106
|
</div>
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/service/services/collection.service.ts" sourceLine="77" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
|
-
Contains methods relating to
|
|
7
|
+
Contains methods relating to [Collection](/reference/typescript-api/entities/collection#collection) entities.
|
|
8
8
|
|
|
9
9
|
```ts title="Signature"
|
|
10
10
|
class CollectionService implements OnModuleInit {
|
|
@@ -69,7 +69,7 @@ class CollectionService implements OnModuleInit {
|
|
|
69
69
|
|
|
70
70
|
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => ConfigurableOperationDefinition[]`} />
|
|
71
71
|
|
|
72
|
-
Returns all configured CollectionFilters, as specified by the
|
|
72
|
+
Returns all configured CollectionFilters, as specified by the [CatalogOptions](/reference/typescript-api/products-stock/catalog-options#catalogoptions).
|
|
73
73
|
### getParent
|
|
74
74
|
|
|
75
75
|
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, collectionId: <a href='/reference/typescript-api/common/id#id'>ID</a>) => Promise<<a href='/reference/typescript-api/entities/collection#collection'>Collection</a> | undefined>`} />
|
|
@@ -144,7 +144,7 @@ its siblings.
|
|
|
144
144
|
<MemberInfo kind="method" type={`(applyAllFiltersOnProductUpdates: boolean) => `} since="3.1.3" />
|
|
145
145
|
|
|
146
146
|
By default, whenever product data is updated (as determined by subscribing to the
|
|
147
|
-
|
|
147
|
+
[ProductEvent](/reference/typescript-api/events/event-types#productevent) and [ProductVariantEvent](/reference/typescript-api/events/event-types#productvariantevent) events), the CollectionFilters are re-applied
|
|
148
148
|
to all Collections.
|
|
149
149
|
|
|
150
150
|
In certain scenarios, such as when a large number of products are updated at once due to
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/service/services/country.service.ts" sourceLine="33" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
|
-
Contains methods relating to
|
|
7
|
+
Contains methods relating to [Country](/reference/typescript-api/entities/country#country) entities.
|
|
8
8
|
|
|
9
9
|
```ts title="Signature"
|
|
10
10
|
class CountryService {
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/service/services/customer-group.service.ts" sourceLine="38" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
|
-
Contains methods relating to
|
|
7
|
+
Contains methods relating to [CustomerGroup](/reference/typescript-api/entities/customer-group#customergroup) entities.
|
|
8
8
|
|
|
9
9
|
```ts title="Signature"
|
|
10
10
|
class CustomerGroupService {
|
|
@@ -41,7 +41,7 @@ class CustomerGroupService {
|
|
|
41
41
|
|
|
42
42
|
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, customerGroupId: <a href='/reference/typescript-api/common/id#id'>ID</a>, options?: CustomerListOptions) => Promise<<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a><<a href='/reference/typescript-api/entities/customer#customer'>Customer</a>>>`} />
|
|
43
43
|
|
|
44
|
-
Returns a
|
|
44
|
+
Returns a [PaginatedList](/reference/typescript-api/common/paginated-list#paginatedlist) of all the Customers in the group.
|
|
45
45
|
### create
|
|
46
46
|
|
|
47
47
|
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: CreateCustomerGroupInput) => Promise<<a href='/reference/typescript-api/entities/customer-group#customergroup'>CustomerGroup</a>>`} />
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/service/services/customer.service.ts" sourceLine="80" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
|
-
Contains methods relating to
|
|
7
|
+
Contains methods relating to [Customer](/reference/typescript-api/entities/customer#customer) entities.
|
|
8
8
|
|
|
9
9
|
```ts title="Signature"
|
|
10
10
|
class CustomerService {
|
|
@@ -67,12 +67,12 @@ to the current active Channel only.
|
|
|
67
67
|
|
|
68
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>[]>`} />
|
|
69
69
|
|
|
70
|
-
Returns all
|
|
70
|
+
Returns all [Address](/reference/typescript-api/entities/address#address) entities associated with the specified Customer.
|
|
71
71
|
### getCustomerGroups
|
|
72
72
|
|
|
73
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>[]>`} />
|
|
74
74
|
|
|
75
|
-
Returns a list of all
|
|
75
|
+
Returns a list of all [CustomerGroup](/reference/typescript-api/entities/customer-group#customergroup) entities.
|
|
76
76
|
### create
|
|
77
77
|
|
|
78
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>>>`} />
|
|
@@ -80,7 +80,7 @@ Returns a list of all <DocsLink href="/reference/typescript-api/entities/custome
|
|
|
80
80
|
Creates a new Customer, including creation of a new User with the special `customer` Role.
|
|
81
81
|
|
|
82
82
|
If the `password` argument is specified, the Customer will be immediately verified. If not,
|
|
83
|
-
then an
|
|
83
|
+
then an [AccountRegistrationEvent](/reference/typescript-api/events/event-types#accountregistrationevent) is published, so that the customer can have their
|
|
84
84
|
email address verified and set their password in a later step using the `verifyCustomerEmailAddress()`
|
|
85
85
|
method.
|
|
86
86
|
|
|
@@ -104,9 +104,9 @@ This method is intended to be used in admin-created Customer flows.
|
|
|
104
104
|
|
|
105
105
|
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: RegisterCustomerInput) => Promise<RegisterCustomerAccountResult | EmailAddressConflictError | PasswordValidationError>`} />
|
|
106
106
|
|
|
107
|
-
Registers a new Customer account with the
|
|
108
|
-
the email verification flow (unless
|
|
109
|
-
by publishing an
|
|
107
|
+
Registers a new Customer account with the [NativeAuthenticationStrategy](/reference/typescript-api/auth/native-authentication-strategy#nativeauthenticationstrategy) and starts
|
|
108
|
+
the email verification flow (unless [AuthOptions](/reference/typescript-api/auth/auth-options#authoptions) `requireVerification` is set to `false`)
|
|
109
|
+
by publishing an [AccountRegistrationEvent](/reference/typescript-api/events/event-types#accountregistrationevent).
|
|
110
110
|
|
|
111
111
|
This method is intended to be used in storefront Customer-creation flows.
|
|
112
112
|
### refreshVerificationToken
|
|
@@ -114,18 +114,18 @@ This method is intended to be used in storefront Customer-creation flows.
|
|
|
114
114
|
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, emailAddress: string) => Promise<void>`} />
|
|
115
115
|
|
|
116
116
|
Refreshes a stale email address verification token by generating a new one and
|
|
117
|
-
publishing a
|
|
117
|
+
publishing a [AccountRegistrationEvent](/reference/typescript-api/events/event-types#accountregistrationevent).
|
|
118
118
|
### verifyCustomerEmailAddress
|
|
119
119
|
|
|
120
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>>>`} />
|
|
121
121
|
|
|
122
|
-
Given a valid verification token which has been published in an
|
|
122
|
+
Given a valid verification token which has been published in an [AccountRegistrationEvent](/reference/typescript-api/events/event-types#accountregistrationevent), this
|
|
123
123
|
method is used to set the Customer as `verified` as part of the account registration flow.
|
|
124
124
|
### requestPasswordReset
|
|
125
125
|
|
|
126
126
|
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, emailAddress: string) => Promise<void>`} />
|
|
127
127
|
|
|
128
|
-
Publishes a new
|
|
128
|
+
Publishes a new [PasswordResetEvent](/reference/typescript-api/events/event-types#passwordresetevent) for the given email address. This event creates
|
|
129
129
|
a token which can be used in the `resetPassword()` method.
|
|
130
130
|
### resetPassword
|
|
131
131
|
|
|
@@ -137,14 +137,14 @@ this method will change the Customer's password to that given as the `password`
|
|
|
137
137
|
|
|
138
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>`} />
|
|
139
139
|
|
|
140
|
-
Publishes a
|
|
140
|
+
Publishes a [IdentifierChangeRequestEvent](/reference/typescript-api/events/event-types#identifierchangerequestevent) for the given User. This event contains a token
|
|
141
141
|
which is then used in the `updateEmailAddress()` method to change the email address of the User &
|
|
142
142
|
Customer.
|
|
143
143
|
### updateEmailAddress
|
|
144
144
|
|
|
145
145
|
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, token: string) => Promise<boolean | IdentifierChangeTokenInvalidError | IdentifierChangeTokenExpiredError>`} />
|
|
146
146
|
|
|
147
|
-
Given a valid email update token published in a
|
|
147
|
+
Given a valid email update token published in a [IdentifierChangeRequestEvent](/reference/typescript-api/events/event-types#identifierchangerequestevent), this method
|
|
148
148
|
will update the Customer & User email address.
|
|
149
149
|
### createOrUpdate
|
|
150
150
|
|
|
@@ -155,7 +155,7 @@ For guest checkouts, we assume that a matching email address is the same custome
|
|
|
155
155
|
|
|
156
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>>`} />
|
|
157
157
|
|
|
158
|
-
Creates a new
|
|
158
|
+
Creates a new [Address](/reference/typescript-api/entities/address#address) for the given Customer.
|
|
159
159
|
### updateAddress
|
|
160
160
|
|
|
161
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>>`} />
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/service/services/facet.service.ts" sourceLine="45" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
|
-
Contains methods relating to
|
|
7
|
+
Contains methods relating to [Facet](/reference/typescript-api/entities/facet#facet) entities.
|
|
8
8
|
|
|
9
9
|
```ts title="Signature"
|
|
10
10
|
class FacetService {
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/service/services/facet-value.service.ts" sourceLine="40" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
|
-
Contains methods relating to
|
|
7
|
+
Contains methods relating to [FacetValue](/reference/typescript-api/entities/facet-value#facetvalue) entities.
|
|
8
8
|
|
|
9
9
|
```ts title="Signature"
|
|
10
10
|
class FacetValueService {
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/service/services/fulfillment.service.ts" sourceLine="34" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
|
-
Contains methods relating to
|
|
7
|
+
Contains methods relating to [Fulfillment](/reference/typescript-api/entities/fulfillment#fulfillment) entities.
|
|
8
8
|
|
|
9
9
|
```ts title="Signature"
|
|
10
10
|
class FulfillmentService {
|
|
@@ -37,7 +37,7 @@ class FulfillmentService {
|
|
|
37
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>`} />
|
|
38
38
|
|
|
39
39
|
Creates a new Fulfillment for the given Orders and OrderItems, using the specified
|
|
40
|
-
|
|
40
|
+
[FulfillmentHandler](/reference/typescript-api/fulfillment/fulfillment-handler#fulfillmenthandler).
|
|
41
41
|
### getFulfillmentLines
|
|
42
42
|
|
|
43
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>[]>`} />
|
|
@@ -53,7 +53,7 @@ Creates a new Fulfillment for the given Orders and OrderItems, using the specifi
|
|
|
53
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 >`} />
|
|
54
54
|
|
|
55
55
|
Transitions the specified Fulfillment to a new state and upon successful transition
|
|
56
|
-
publishes a
|
|
56
|
+
publishes a [FulfillmentStateTransitionEvent](/reference/typescript-api/events/event-types#fulfillmentstatetransitionevent).
|
|
57
57
|
### getNextStates
|
|
58
58
|
|
|
59
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>[]`} />
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/service/services/global-settings.service.ts" sourceLine="23" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
|
-
Contains methods relating to the
|
|
7
|
+
Contains methods relating to the [GlobalSettings](/reference/typescript-api/entities/global-settings#globalsettings) entity.
|
|
8
8
|
|
|
9
9
|
```ts title="Signature"
|
|
10
10
|
class GlobalSettingsService {
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/service/services/history.service.ts" sourceLine="248" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
|
-
Contains methods relating to
|
|
7
|
+
Contains methods relating to [HistoryEntry](/reference/typescript-api/entities/history-entry#historyentry) entities. Histories are timelines of actions
|
|
8
8
|
related to a particular Customer or Order, recording significant events such as creation, state changes,
|
|
9
9
|
notes, etc.
|
|
10
10
|
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/service/services/order.service.ts" sourceLine="141" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
|
-
Contains methods relating to
|
|
7
|
+
Contains methods relating to [Order](/reference/typescript-api/entities/order#order) entities.
|
|
8
8
|
|
|
9
9
|
```ts title="Signature"
|
|
10
10
|
class OrderService {
|
|
@@ -87,8 +87,8 @@ class OrderService {
|
|
|
87
87
|
<MemberInfo kind="method" type={`() => OrderProcessState[]`} />
|
|
88
88
|
|
|
89
89
|
Returns an array of all the configured states and transitions of the order process. This is
|
|
90
|
-
based on the default order process plus all configured
|
|
91
|
-
defined in the
|
|
90
|
+
based on the default order process plus all configured [OrderProcess](/reference/typescript-api/orders/order-process#orderprocess) objects
|
|
91
|
+
defined in the [OrderOptions](/reference/typescript-api/orders/order-options#orderoptions) `process` array.
|
|
92
92
|
### findAll
|
|
93
93
|
|
|
94
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>>>`} />
|
|
@@ -118,17 +118,17 @@ defined in the <DocsLink href="/reference/typescript-api/orders/order-options#or
|
|
|
118
118
|
|
|
119
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>[]>`} />
|
|
120
120
|
|
|
121
|
-
Returns all
|
|
121
|
+
Returns all [Payment](/reference/typescript-api/entities/payment#payment) entities associated with the Order.
|
|
122
122
|
### getOrderModifications
|
|
123
123
|
|
|
124
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>[]>`} />
|
|
125
125
|
|
|
126
|
-
Returns an array of any
|
|
126
|
+
Returns an array of any [OrderModification](/reference/typescript-api/entities/order-modification#ordermodification) entities associated with the Order.
|
|
127
127
|
### getPaymentRefunds
|
|
128
128
|
|
|
129
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>[]>`} />
|
|
130
130
|
|
|
131
|
-
Returns any
|
|
131
|
+
Returns any [Refund](/reference/typescript-api/entities/refund#refund)s associated with a [Payment](/reference/typescript-api/entities/payment#payment).
|
|
132
132
|
### getSellerOrders
|
|
133
133
|
|
|
134
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>[]>`} />
|
|
@@ -229,18 +229,18 @@ Removes all OrderLines from the Order.
|
|
|
229
229
|
|
|
230
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>>`} />
|
|
231
231
|
|
|
232
|
-
Adds a
|
|
232
|
+
Adds a [Surcharge](/reference/typescript-api/entities/surcharge#surcharge) to the Order.
|
|
233
233
|
### removeSurchargeFromOrder
|
|
234
234
|
|
|
235
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>>`} />
|
|
236
236
|
|
|
237
|
-
Removes a
|
|
237
|
+
Removes a [Surcharge](/reference/typescript-api/entities/surcharge#surcharge) from the Order.
|
|
238
238
|
### applyCouponCode
|
|
239
239
|
|
|
240
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>>>`} />
|
|
241
241
|
|
|
242
242
|
Applies a coupon code to the Order, which should be a valid coupon code as specified in the configuration
|
|
243
|
-
of an active
|
|
243
|
+
of an active [Promotion](/reference/typescript-api/entities/promotion#promotion).
|
|
244
244
|
### removeCouponCode
|
|
245
245
|
|
|
246
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) => `} />
|
|
@@ -250,7 +250,7 @@ Removes a coupon code from the Order.
|
|
|
250
250
|
|
|
251
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>[]>`} />
|
|
252
252
|
|
|
253
|
-
Returns all
|
|
253
|
+
Returns all [Promotion](/reference/typescript-api/entities/promotion#promotion)s associated with an Order.
|
|
254
254
|
### getNextOrderStates
|
|
255
255
|
|
|
256
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>[]`} />
|
|
@@ -280,16 +280,16 @@ Unsets the billing address for the Order.
|
|
|
280
280
|
|
|
281
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[]>`} />
|
|
282
282
|
|
|
283
|
-
Returns an array of quotes stating which
|
|
284
|
-
This is determined by the configured
|
|
283
|
+
Returns an array of quotes stating which [ShippingMethod](/reference/typescript-api/entities/shipping-method#shippingmethod)s may be applied to this Order.
|
|
284
|
+
This is determined by the configured [ShippingEligibilityChecker](/reference/typescript-api/shipping/shipping-eligibility-checker#shippingeligibilitychecker) of each ShippingMethod.
|
|
285
285
|
|
|
286
286
|
The quote also includes a price for each method, as determined by the configured
|
|
287
|
-
|
|
287
|
+
[ShippingCalculator](/reference/typescript-api/shipping/shipping-calculator#shippingcalculator) of each eligible ShippingMethod.
|
|
288
288
|
### getEligiblePaymentMethods
|
|
289
289
|
|
|
290
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[]>`} />
|
|
291
291
|
|
|
292
|
-
Returns an array of quotes stating which
|
|
292
|
+
Returns an array of quotes stating which [PaymentMethod](/reference/typescript-api/entities/payment-method#paymentmethod)s may be used on this Order.
|
|
293
293
|
### setShippingMethod
|
|
294
294
|
|
|
295
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>>>`} />
|
|
@@ -319,7 +319,7 @@ Allows the Order to be modified, which allows several aspects of the Order to be
|
|
|
319
319
|
|
|
320
320
|
* Changes to OrderLine quantities
|
|
321
321
|
* New OrderLines being added
|
|
322
|
-
* Arbitrary
|
|
322
|
+
* Arbitrary [Surcharge](/reference/typescript-api/entities/surcharge#surcharge)s being added
|
|
323
323
|
* Shipping or billing address changes
|
|
324
324
|
|
|
325
325
|
Setting the `dryRun` input property to `true` will apply all changes, including updating the price of the
|
|
@@ -330,7 +330,7 @@ __Using dryRun option, you must wrap function call in transaction manually.__
|
|
|
330
330
|
|
|
331
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>>>`} />
|
|
332
332
|
|
|
333
|
-
Transitions the given
|
|
333
|
+
Transitions the given [Payment](/reference/typescript-api/entities/payment#payment) to a new state.
|
|
334
334
|
### addPaymentToOrder
|
|
335
335
|
|
|
336
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>>>`} />
|
|
@@ -351,13 +351,13 @@ dashboard of your payment provider.
|
|
|
351
351
|
|
|
352
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>>>`} />
|
|
353
353
|
|
|
354
|
-
Settles a payment by invoking the
|
|
354
|
+
Settles a payment by invoking the [PaymentMethodHandler](/reference/typescript-api/payment/payment-method-handler#paymentmethodhandler)'s `settlePayment()` method. Automatically
|
|
355
355
|
transitions the Order state if all Payments are settled.
|
|
356
356
|
### cancelPayment
|
|
357
357
|
|
|
358
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>>>`} />
|
|
359
359
|
|
|
360
|
-
Cancels a payment by invoking the
|
|
360
|
+
Cancels a payment by invoking the [PaymentMethodHandler](/reference/typescript-api/payment/payment-method-handler#paymentmethodhandler)'s `cancelPayment()` method (if defined), and transitions the Payment to
|
|
361
361
|
the `Cancelled` state.
|
|
362
362
|
### createFulfillment
|
|
363
363
|
|
|
@@ -379,13 +379,13 @@ Returns an array of all Surcharges associated with the Order.
|
|
|
379
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>>>`} />
|
|
380
380
|
|
|
381
381
|
Cancels an Order by transitioning it to the `Cancelled` state. If stock is being tracked for the ProductVariants
|
|
382
|
-
in the Order, then new
|
|
382
|
+
in the Order, then new [StockMovement](/reference/typescript-api/entities/stock-movement#stockmovement)s will be created to correct the stock levels.
|
|
383
383
|
### refundOrder
|
|
384
384
|
|
|
385
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>>>`} />
|
|
386
386
|
|
|
387
|
-
Creates a
|
|
388
|
-
|
|
387
|
+
Creates a [Refund](/reference/typescript-api/entities/refund#refund) against the order and in doing so invokes the `createRefund()` method of the
|
|
388
|
+
[PaymentMethodHandler](/reference/typescript-api/payment/payment-method-handler#paymentmethodhandler).
|
|
389
389
|
### settleRefund
|
|
390
390
|
|
|
391
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>>`} />
|
|
@@ -400,7 +400,7 @@ Associates a Customer with the Order.
|
|
|
400
400
|
|
|
401
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>>`} />
|
|
402
402
|
|
|
403
|
-
Creates a new "ORDER_NOTE" type
|
|
403
|
+
Creates a new "ORDER_NOTE" type [OrderHistoryEntry](/reference/typescript-api/entities/order-history-entry#orderhistoryentry) in the Order's history timeline.
|
|
404
404
|
### updateOrderNote
|
|
405
405
|
|
|
406
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>>`} />
|
|
@@ -423,13 +423,13 @@ Deletes an Order, ensuring that any Sessions that reference this Order are deref
|
|
|
423
423
|
When a guest user with an anonymous Order signs in and has an existing Order associated with that Customer,
|
|
424
424
|
we need to reconcile the contents of the two orders.
|
|
425
425
|
|
|
426
|
-
The logic used to do the merging is specified in the
|
|
426
|
+
The logic used to do the merging is specified in the [OrderOptions](/reference/typescript-api/orders/order-options#orderoptions) `mergeStrategy` config setting.
|
|
427
427
|
### applyPriceAdjustments
|
|
428
428
|
|
|
429
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>>`} />
|
|
430
430
|
|
|
431
431
|
Applies promotions, taxes and shipping to the Order. If the `updatedOrderLines` argument is passed in,
|
|
432
|
-
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 [OrderItemPriceCalculationStrategy](/reference/typescript-api/orders/order-item-price-calculation-strategy#orderitempricecalculationstrategy).
|
|
433
433
|
|
|
434
434
|
|
|
435
435
|
</div>
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/service/services/payment-method.service.ts" sourceLine="47" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
|
-
Contains methods relating to
|
|
7
|
+
Contains methods relating to [PaymentMethod](/reference/typescript-api/entities/payment-method#paymentmethod) entities.
|
|
8
8
|
|
|
9
9
|
```ts title="Signature"
|
|
10
10
|
class PaymentMethodService {
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/service/services/payment.service.ts" sourceLine="43" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
|
-
Contains methods relating to
|
|
7
|
+
Contains methods relating to [Payment](/reference/typescript-api/entities/payment#payment) entities.
|
|
8
8
|
|
|
9
9
|
```ts title="Signature"
|
|
10
10
|
class PaymentService {
|
|
@@ -45,7 +45,7 @@ class PaymentService {
|
|
|
45
45
|
Transitions a Payment to the given state.
|
|
46
46
|
|
|
47
47
|
When updating a Payment in the context of an Order, it is
|
|
48
|
-
preferable to use the
|
|
48
|
+
preferable to use the [OrderService](/reference/typescript-api/services/order-service#orderservice) `transitionPaymentToState()` method, which will also handle
|
|
49
49
|
updating the Order state too.
|
|
50
50
|
### getNextStates
|
|
51
51
|
|
|
@@ -59,7 +59,7 @@ updating the Order state too.
|
|
|
59
59
|
Creates a new Payment.
|
|
60
60
|
|
|
61
61
|
When creating a Payment in the context of an Order, it is
|
|
62
|
-
preferable to use the
|
|
62
|
+
preferable to use the [OrderService](/reference/typescript-api/services/order-service#orderservice) `addPaymentToOrder()` method, which will also handle
|
|
63
63
|
updating the Order state too.
|
|
64
64
|
### settlePayment
|
|
65
65
|
|
|
@@ -68,7 +68,7 @@ updating the Order state too.
|
|
|
68
68
|
Settles a Payment.
|
|
69
69
|
|
|
70
70
|
When settling a Payment in the context of an Order, it is
|
|
71
|
-
preferable to use the
|
|
71
|
+
preferable to use the [OrderService](/reference/typescript-api/services/order-service#orderservice) `settlePayment()` method, which will also handle
|
|
72
72
|
updating the Order state too.
|
|
73
73
|
### cancelPayment
|
|
74
74
|
|
|
@@ -82,7 +82,7 @@ updating the Order state too.
|
|
|
82
82
|
Creates a Payment from the manual payment mutation in the Admin API
|
|
83
83
|
|
|
84
84
|
When creating a manual Payment in the context of an Order, it is
|
|
85
|
-
preferable to use the
|
|
85
|
+
preferable to use the [OrderService](/reference/typescript-api/services/order-service#orderservice) `addManualPaymentToOrder()` method, which will also handle
|
|
86
86
|
updating the Order state too.
|
|
87
87
|
### createRefund
|
|
88
88
|
|
|
@@ -93,7 +93,7 @@ specified Payment (in the case of multiple payments on a single Order), then the
|
|
|
93
93
|
refund amount will be refunded against the next available Payment from the Order.
|
|
94
94
|
|
|
95
95
|
When creating a Refund in the context of an Order, it is
|
|
96
|
-
preferable to use the
|
|
96
|
+
preferable to use the [OrderService](/reference/typescript-api/services/order-service#orderservice) `refundOrder()` method, which performs additional
|
|
97
97
|
validation.
|
|
98
98
|
|
|
99
99
|
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/service/services/product-option-group.service.ts" sourceLine="35" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
|
-
Contains methods relating to
|
|
7
|
+
Contains methods relating to [ProductOptionGroup](/reference/typescript-api/entities/product-option-group#productoptiongroup) entities.
|
|
8
8
|
|
|
9
9
|
```ts title="Signature"
|
|
10
10
|
class ProductOptionGroupService {
|