@vendure/docs 0.0.0-202601211552 → 0.0.0-202601211609
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/docs/reference/admin-ui-api/action-bar/action-bar-context.mdx +1 -1
- package/docs/reference/admin-ui-api/action-bar/action-bar-dropdown-menu-item.mdx +2 -2
- package/docs/reference/admin-ui-api/action-bar/action-bar-item.mdx +3 -3
- package/docs/reference/admin-ui-api/alerts/alert-config.mdx +5 -5
- package/docs/reference/admin-ui-api/bulk-actions/bulk-action.mdx +5 -5
- package/docs/reference/admin-ui-api/components/asset-picker-dialog-component.mdx +3 -3
- package/docs/reference/admin-ui-api/components/currency-input-component.mdx +4 -4
- package/docs/reference/admin-ui-api/components/data-table-component.mdx +5 -5
- package/docs/reference/admin-ui-api/components/data-table2component.mdx +7 -7
- package/docs/reference/admin-ui-api/components/datetime-picker-component.mdx +7 -7
- package/docs/reference/admin-ui-api/components/dropdown-component.mdx +1 -1
- package/docs/reference/admin-ui-api/components/facet-value-selector-component.mdx +6 -6
- package/docs/reference/admin-ui-api/components/object-tree-component.mdx +1 -1
- package/docs/reference/admin-ui-api/components/product-variant-selector-component.mdx +1 -1
- package/docs/reference/admin-ui-api/components/rich-text-editor-component.mdx +2 -2
- package/docs/reference/admin-ui-api/components/zone-selector-component.mdx +3 -3
- 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.mdx +1 -1
- package/docs/reference/admin-ui-api/custom-history-entry-components/history-entry-component.mdx +4 -4
- package/docs/reference/admin-ui-api/custom-history-entry-components/history-entry-config.mdx +1 -1
- package/docs/reference/admin-ui-api/custom-input-components/default-inputs.mdx +22 -22
- package/docs/reference/admin-ui-api/custom-input-components/register-form-input-component.mdx +1 -1
- package/docs/reference/admin-ui-api/custom-table-components/data-table-component-config.mdx +1 -1
- package/docs/reference/admin-ui-api/dashboard-widgets/dashboard-widget-config.mdx +1 -1
- package/docs/reference/admin-ui-api/directives/if-multichannel-directive.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 +6 -6
- 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 +8 -8
- 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 +6 -6
- package/docs/reference/admin-ui-api/nav-menu/nav-menu-item.mdx +3 -3
- package/docs/reference/admin-ui-api/nav-menu/nav-menu-section.mdx +1 -1
- package/docs/reference/admin-ui-api/react-components/action-bar.mdx +1 -1
- package/docs/reference/admin-ui-api/react-components/card.mdx +1 -1
- package/docs/reference/admin-ui-api/react-components/cds-icon.mdx +1 -1
- package/docs/reference/admin-ui-api/react-components/form-field.mdx +1 -1
- package/docs/reference/admin-ui-api/react-components/link.mdx +1 -1
- package/docs/reference/admin-ui-api/react-components/page-detail-layout.mdx +1 -1
- package/docs/reference/admin-ui-api/react-extensions/react-custom-detail-component-config.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-hooks/use-injector.mdx +1 -1
- package/docs/reference/admin-ui-api/react-hooks/use-lazy-query.mdx +1 -1
- package/docs/reference/admin-ui-api/react-hooks/use-mutation.mdx +1 -1
- package/docs/reference/admin-ui-api/react-hooks/use-query.mdx +1 -1
- package/docs/reference/admin-ui-api/services/data-service.mdx +9 -9
- package/docs/reference/admin-ui-api/services/modal-service.mdx +5 -5
- package/docs/reference/admin-ui-api/tabs/page-tab-config.mdx +1 -1
- package/docs/reference/admin-ui-api/ui-devkit/admin-ui-extension.mdx +1 -1
- package/docs/reference/core-plugins/admin-ui-plugin/admin-ui-plugin-options.mdx +1 -1
- package/docs/reference/core-plugins/admin-ui-plugin/index.mdx +1 -1
- package/docs/reference/core-plugins/asset-server-plugin/asset-server-options.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 +1 -1
- package/docs/reference/core-plugins/asset-server-plugin/local-asset-storage-strategy.mdx +8 -8
- package/docs/reference/core-plugins/asset-server-plugin/preset-only-strategy.mdx +1 -1
- package/docs/reference/core-plugins/asset-server-plugin/s3asset-storage-strategy.mdx +2 -2
- package/docs/reference/core-plugins/asset-server-plugin/sharp-asset-preview-strategy.mdx +1 -1
- package/docs/reference/core-plugins/dashboard-plugin/index.mdx +1 -1
- package/docs/reference/core-plugins/elasticsearch-plugin/elasticsearch-options.mdx +8 -8
- 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 +1 -1
- package/docs/reference/core-plugins/email-plugin/email-event-handler.mdx +6 -6
- 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 +1 -1
- package/docs/reference/core-plugins/email-plugin/email-sender.mdx +1 -1
- package/docs/reference/core-plugins/email-plugin/index.mdx +1 -1
- package/docs/reference/core-plugins/email-plugin/template-loader.mdx +4 -4
- package/docs/reference/core-plugins/email-plugin/transport-options.mdx +1 -1
- package/docs/reference/core-plugins/graphiql-plugin/index.mdx +2 -2
- package/docs/reference/core-plugins/harden-plugin/harden-plugin-options.mdx +1 -1
- package/docs/reference/core-plugins/job-queue-plugin/bull-mqjob-queue-strategy.mdx +9 -9
- package/docs/reference/core-plugins/job-queue-plugin/bull-mqplugin-options.mdx +5 -5
- package/docs/reference/core-plugins/job-queue-plugin/pub-sub-job-queue-strategy.mdx +3 -3
- package/docs/reference/core-plugins/job-queue-plugin/pub-sub-plugin.mdx +1 -1
- package/docs/reference/core-plugins/payments-plugin/braintree-plugin.mdx +2 -2
- package/docs/reference/core-plugins/payments-plugin/mollie-plugin.mdx +1 -1
- package/docs/reference/core-plugins/payments-plugin/stripe-plugin.mdx +5 -5
- package/docs/reference/core-plugins/stellate-plugin/purge-rule.mdx +3 -3
- package/docs/reference/core-plugins/stellate-plugin/stellate-service.mdx +1 -1
- package/docs/reference/core-plugins/telemetry-plugin/get-sdk-configuration.mdx +1 -1
- package/docs/reference/core-plugins/telemetry-plugin/register-method-hooks.mdx +2 -2
- package/docs/reference/core-plugins/telemetry-plugin/telemetry-plugin-options.mdx +1 -1
- package/docs/reference/dashboard/components/asset-gallery.mdx +3 -3
- package/docs/reference/dashboard/components/asset-picker-dialog.mdx +2 -2
- package/docs/reference/dashboard/components/channel-chip.mdx +1 -1
- package/docs/reference/dashboard/components/detail-page-button.mdx +1 -1
- package/docs/reference/dashboard/components/facet-value-selector.mdx +1 -1
- package/docs/reference/dashboard/components/permission-guard.mdx +1 -1
- package/docs/reference/dashboard/components/vendure-image.mdx +1 -1
- package/docs/reference/dashboard/detail-views/detail-page.mdx +2 -2
- package/docs/reference/dashboard/detail-views/use-detail-page.mdx +10 -10
- package/docs/reference/dashboard/detail-views/use-generated-form.mdx +2 -2
- package/docs/reference/dashboard/extensions-api/action-bar.mdx +1 -1
- package/docs/reference/dashboard/extensions-api/alerts.mdx +6 -6
- package/docs/reference/dashboard/extensions-api/data-tables.mdx +1 -1
- package/docs/reference/dashboard/extensions-api/detail-forms.mdx +1 -1
- package/docs/reference/dashboard/extensions-api/history-entries.mdx +2 -2
- package/docs/reference/dashboard/extensions-api/page-blocks.mdx +2 -2
- package/docs/reference/dashboard/extensions-api/routes.mdx +4 -4
- package/docs/reference/dashboard/extensions-api/widgets.mdx +1 -1
- package/docs/reference/dashboard/form-components/affixed-input.mdx +1 -1
- package/docs/reference/dashboard/form-components/boolean-input.mdx +1 -1
- package/docs/reference/dashboard/form-components/checkbox-input.mdx +1 -1
- package/docs/reference/dashboard/form-components/date-time-input.mdx +1 -1
- package/docs/reference/dashboard/form-components/money-input.mdx +1 -1
- package/docs/reference/dashboard/form-components/number-input.mdx +1 -1
- package/docs/reference/dashboard/form-components/password-input.mdx +1 -1
- package/docs/reference/dashboard/form-components/rich-text-input.mdx +1 -1
- package/docs/reference/dashboard/form-components/textarea-input.mdx +1 -1
- package/docs/reference/dashboard/hooks/use-alerts.mdx +1 -1
- package/docs/reference/dashboard/hooks/use-auth.mdx +5 -5
- package/docs/reference/dashboard/hooks/use-channel.mdx +2 -2
- package/docs/reference/dashboard/hooks/use-drag-and-drop.mdx +1 -1
- package/docs/reference/dashboard/list-views/bulk-actions.mdx +3 -3
- package/docs/reference/dashboard/list-views/data-table.mdx +10 -10
- package/docs/reference/dashboard/list-views/list-page.mdx +13 -13
- package/docs/reference/dashboard/list-views/paginated-list-data-table.mdx +17 -17
- package/docs/reference/dashboard/page-layout/index.mdx +1 -1
- package/docs/reference/dashboard/page-layout/page-action-bar.mdx +3 -3
- package/docs/reference/dashboard/page-layout/page-block.mdx +3 -3
- package/docs/reference/dashboard/page-layout/page-title.mdx +1 -1
- package/docs/reference/dashboard/page-layout/page.mdx +2 -2
- package/docs/reference/typescript-api/assets/asset-preview-strategy.mdx +1 -1
- package/docs/reference/typescript-api/assets/asset-storage-strategy.mdx +6 -6
- package/docs/reference/typescript-api/auth/auth-options.mdx +1 -1
- package/docs/reference/typescript-api/auth/authentication-strategy.mdx +2 -2
- package/docs/reference/typescript-api/auth/bcrypt-password-hashing-strategy.mdx +2 -2
- package/docs/reference/typescript-api/auth/default-session-cache-strategy.mdx +4 -4
- package/docs/reference/typescript-api/auth/external-authentication-service.mdx +5 -5
- package/docs/reference/typescript-api/auth/native-authentication-strategy.mdx +2 -2
- package/docs/reference/typescript-api/auth/password-hashing-strategy.mdx +2 -2
- package/docs/reference/typescript-api/auth/password-validation-strategy.mdx +1 -1
- package/docs/reference/typescript-api/auth/permission-definition.mdx +2 -2
- package/docs/reference/typescript-api/auth/session-cache-strategy.mdx +4 -4
- package/docs/reference/typescript-api/auth/verification-token-strategy.mdx +2 -2
- package/docs/reference/typescript-api/cache/cache-config.mdx +1 -1
- package/docs/reference/typescript-api/cache/cache-service.mdx +4 -4
- package/docs/reference/typescript-api/cache/cache-strategy.mdx +4 -4
- package/docs/reference/typescript-api/cache/index.mdx +3 -3
- package/docs/reference/typescript-api/cache/redis-cache-strategy.mdx +4 -4
- package/docs/reference/typescript-api/cache/request-context-cache-service.mdx +2 -2
- package/docs/reference/typescript-api/cache/self-refreshing-cache.mdx +5 -5
- package/docs/reference/typescript-api/cache/sql-cache-strategy.mdx +1 -1
- package/docs/reference/typescript-api/common/admin-ui/admin-ui-app-config.mdx +1 -1
- package/docs/reference/typescript-api/common/admin-ui/admin-ui-app-dev-mode-config.mdx +1 -1
- package/docs/reference/typescript-api/common/async-queue.mdx +1 -1
- package/docs/reference/typescript-api/common/bootstrap.mdx +2 -2
- package/docs/reference/typescript-api/common/injectable-strategy.mdx +2 -2
- package/docs/reference/typescript-api/common/injector.mdx +2 -2
- package/docs/reference/typescript-api/configurable-operation-def/config-args.mdx +1 -1
- package/docs/reference/typescript-api/configurable-operation-def/default-form-config-hash.mdx +11 -11
- package/docs/reference/typescript-api/configurable-operation-def/index.mdx +1 -1
- package/docs/reference/typescript-api/configuration/api-options.mdx +2 -2
- package/docs/reference/typescript-api/configuration/collection-filter.mdx +2 -2
- package/docs/reference/typescript-api/configuration/entity-duplicator.mdx +2 -2
- package/docs/reference/typescript-api/configuration/entity-id-strategy.mdx +2 -2
- package/docs/reference/typescript-api/configuration/entity-options.mdx +1 -1
- package/docs/reference/typescript-api/configuration/product-variant-price-selection-strategy.mdx +1 -1
- package/docs/reference/typescript-api/configuration/product-variant-price-update-strategy.mdx +3 -3
- package/docs/reference/typescript-api/configuration/runtime-vendure-config.mdx +14 -14
- package/docs/reference/typescript-api/configuration/slug-strategy.mdx +1 -1
- package/docs/reference/typescript-api/configuration/vendure-config.mdx +1 -1
- package/docs/reference/typescript-api/data-access/calculated-property-subscriber.mdx +1 -1
- package/docs/reference/typescript-api/data-access/calculated.mdx +1 -1
- package/docs/reference/typescript-api/data-access/entity-hydrator.mdx +1 -1
- package/docs/reference/typescript-api/data-access/hydrate-options.mdx +1 -1
- package/docs/reference/typescript-api/data-access/list-query-builder.mdx +4 -4
- package/docs/reference/typescript-api/data-access/transactional-connection.mdx +9 -9
- package/docs/reference/typescript-api/default-search-plugin/index.mdx +1 -1
- package/docs/reference/typescript-api/default-search-plugin/mysql-search-strategy.mdx +4 -4
- package/docs/reference/typescript-api/default-search-plugin/postgres-search-strategy.mdx +4 -4
- package/docs/reference/typescript-api/default-search-plugin/search-strategy.mdx +4 -4
- package/docs/reference/typescript-api/default-search-plugin/sqlite-search-strategy.mdx +4 -4
- package/docs/reference/typescript-api/entities/address.mdx +1 -1
- package/docs/reference/typescript-api/entities/administrator.mdx +1 -1
- package/docs/reference/typescript-api/entities/anonymous-session.mdx +1 -1
- package/docs/reference/typescript-api/entities/asset.mdx +1 -1
- package/docs/reference/typescript-api/entities/authenticated-session.mdx +1 -1
- package/docs/reference/typescript-api/entities/authentication-method.mdx +2 -2
- package/docs/reference/typescript-api/entities/channel.mdx +1 -1
- package/docs/reference/typescript-api/entities/collection.mdx +2 -2
- package/docs/reference/typescript-api/entities/country.mdx +1 -1
- package/docs/reference/typescript-api/entities/customer-group.mdx +1 -1
- package/docs/reference/typescript-api/entities/customer-history-entry.mdx +1 -1
- package/docs/reference/typescript-api/entities/customer.mdx +1 -1
- package/docs/reference/typescript-api/entities/facet-value.mdx +2 -2
- package/docs/reference/typescript-api/entities/facet.mdx +2 -2
- package/docs/reference/typescript-api/entities/fulfillment.mdx +1 -1
- package/docs/reference/typescript-api/entities/global-settings.mdx +1 -1
- package/docs/reference/typescript-api/entities/interfaces.mdx +1 -1
- package/docs/reference/typescript-api/entities/order-history-entry.mdx +1 -1
- package/docs/reference/typescript-api/entities/order-line-reference.mdx +3 -3
- package/docs/reference/typescript-api/entities/order-line.mdx +1 -1
- package/docs/reference/typescript-api/entities/order-modification.mdx +1 -1
- package/docs/reference/typescript-api/entities/order.mdx +1 -1
- package/docs/reference/typescript-api/entities/orderable-asset.mdx +1 -1
- package/docs/reference/typescript-api/entities/payment-method.mdx +2 -2
- package/docs/reference/typescript-api/entities/payment.mdx +1 -1
- package/docs/reference/typescript-api/entities/product-option-group.mdx +2 -2
- package/docs/reference/typescript-api/entities/product-option.mdx +2 -2
- package/docs/reference/typescript-api/entities/product-variant-price.mdx +1 -1
- package/docs/reference/typescript-api/entities/product-variant.mdx +2 -2
- package/docs/reference/typescript-api/entities/product.mdx +2 -2
- package/docs/reference/typescript-api/entities/promotion.mdx +4 -4
- package/docs/reference/typescript-api/entities/province.mdx +1 -1
- package/docs/reference/typescript-api/entities/refund.mdx +1 -1
- package/docs/reference/typescript-api/entities/region.mdx +1 -1
- package/docs/reference/typescript-api/entities/role.mdx +1 -1
- package/docs/reference/typescript-api/entities/seller.mdx +1 -1
- package/docs/reference/typescript-api/entities/settings-store-entry.mdx +1 -1
- package/docs/reference/typescript-api/entities/shipping-line.mdx +1 -1
- package/docs/reference/typescript-api/entities/shipping-method.mdx +4 -4
- package/docs/reference/typescript-api/entities/stock-level.mdx +1 -1
- package/docs/reference/typescript-api/entities/stock-location.mdx +1 -1
- package/docs/reference/typescript-api/entities/stock-movement.mdx +5 -5
- package/docs/reference/typescript-api/entities/surcharge.mdx +1 -1
- package/docs/reference/typescript-api/entities/tag.mdx +1 -1
- package/docs/reference/typescript-api/entities/tax-category.mdx +1 -1
- package/docs/reference/typescript-api/entities/tax-rate.mdx +1 -1
- package/docs/reference/typescript-api/entities/user.mdx +1 -1
- package/docs/reference/typescript-api/entities/vendure-entity.mdx +1 -1
- package/docs/reference/typescript-api/entities/zone.mdx +1 -1
- package/docs/reference/typescript-api/errors/error-handler-strategy.mdx +2 -2
- package/docs/reference/typescript-api/events/blocking-event-handler-options.mdx +2 -2
- package/docs/reference/typescript-api/events/event-bus.mdx +3 -3
- package/docs/reference/typescript-api/events/event-types.mdx +1 -1
- package/docs/reference/typescript-api/fulfillment/fulfillment-handler.mdx +1 -1
- package/docs/reference/typescript-api/fulfillment/fulfillment-process.mdx +4 -4
- package/docs/reference/typescript-api/import-export/asset-import-strategy.mdx +1 -1
- package/docs/reference/typescript-api/import-export/asset-importer.mdx +1 -1
- package/docs/reference/typescript-api/import-export/fast-importer-service.mdx +4 -4
- package/docs/reference/typescript-api/import-export/import-parser.mdx +5 -5
- package/docs/reference/typescript-api/import-export/importer.mdx +3 -3
- package/docs/reference/typescript-api/import-export/initial-data.mdx +3 -3
- package/docs/reference/typescript-api/import-export/populate.mdx +1 -1
- 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 +3 -3
- package/docs/reference/typescript-api/job-queue/in-memory-job-queue-strategy.mdx +8 -8
- package/docs/reference/typescript-api/job-queue/index.mdx +1 -1
- package/docs/reference/typescript-api/job-queue/inspectable-job-queue-strategy.mdx +5 -5
- package/docs/reference/typescript-api/job-queue/job-buffer-storage-strategy.mdx +3 -3
- 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 +3 -3
- package/docs/reference/typescript-api/job-queue/polling-job-queue-strategy.mdx +8 -8
- package/docs/reference/typescript-api/job-queue/sql-job-queue-strategy.mdx +6 -6
- package/docs/reference/typescript-api/job-queue/subscribable-job.mdx +1 -1
- package/docs/reference/typescript-api/job-queue/types.mdx +1 -1
- package/docs/reference/typescript-api/migration/generate-migration.mdx +1 -1
- package/docs/reference/typescript-api/migration/revert-last-migration.mdx +1 -1
- package/docs/reference/typescript-api/migration/run-migrations.mdx +1 -1
- package/docs/reference/typescript-api/orders/active-order-service.mdx +6 -6
- package/docs/reference/typescript-api/orders/active-order-strategy.mdx +3 -3
- package/docs/reference/typescript-api/orders/changed-price-handling-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/default-guest-checkout-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/default-order-item-price-calculation-strategy.mdx +1 -1
- 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/order-by-code-access-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/order-code-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/order-interceptor.mdx +3 -3
- package/docs/reference/typescript-api/orders/order-item-price-calculation-strategy.mdx +1 -1
- 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 +4 -4
- package/docs/reference/typescript-api/orders/order-seller-strategy.mdx +3 -3
- package/docs/reference/typescript-api/orders/stock-allocation-strategy.mdx +1 -1
- package/docs/reference/typescript-api/payment/payment-method-config-options.mdx +1 -1
- package/docs/reference/typescript-api/payment/payment-method-types.mdx +3 -3
- package/docs/reference/typescript-api/payment/payment-options.mdx +3 -3
- package/docs/reference/typescript-api/payment/payment-process.mdx +4 -4
- package/docs/reference/typescript-api/payment/refund-process.mdx +4 -4
- package/docs/reference/typescript-api/plugin/vendure-plugin-metadata.mdx +4 -4
- 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-location-strategy.mdx +1 -1
- 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 +1 -1
- 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 +1 -1
- package/docs/reference/typescript-api/promotions/promotion-action.mdx +1 -1
- package/docs/reference/typescript-api/promotions/promotion-condition.mdx +1 -1
- package/docs/reference/typescript-api/promotions/promotion-options.mdx +2 -2
- package/docs/reference/typescript-api/request/request-context-service.mdx +2 -2
- package/docs/reference/typescript-api/scheduled-tasks/default-scheduler-strategy.mdx +4 -4
- package/docs/reference/typescript-api/scheduled-tasks/scheduled-task.mdx +3 -3
- package/docs/reference/typescript-api/scheduled-tasks/scheduler-service.mdx +3 -3
- package/docs/reference/typescript-api/scheduled-tasks/scheduler-strategy.mdx +5 -5
- package/docs/reference/typescript-api/service-helpers/entity-duplicator-service.mdx +1 -1
- package/docs/reference/typescript-api/service-helpers/order-calculator.mdx +1 -1
- package/docs/reference/typescript-api/service-helpers/order-modifier.mdx +3 -3
- package/docs/reference/typescript-api/service-helpers/product-price-applicator.mdx +1 -1
- package/docs/reference/typescript-api/service-helpers/slug-validator.mdx +2 -2
- package/docs/reference/typescript-api/service-helpers/translatable-saver.mdx +2 -2
- package/docs/reference/typescript-api/service-helpers/translator-service.mdx +1 -1
- package/docs/reference/typescript-api/services/administrator-service.mdx +6 -6
- package/docs/reference/typescript-api/services/asset-service.mdx +13 -13
- package/docs/reference/typescript-api/services/auth-service.mdx +4 -4
- package/docs/reference/typescript-api/services/channel-service.mdx +12 -12
- package/docs/reference/typescript-api/services/collection-service.mdx +20 -20
- package/docs/reference/typescript-api/services/country-service.mdx +7 -7
- package/docs/reference/typescript-api/services/customer-group-service.mdx +8 -8
- package/docs/reference/typescript-api/services/customer-service.mdx +24 -24
- package/docs/reference/typescript-api/services/entity-slug-service.mdx +1 -1
- package/docs/reference/typescript-api/services/facet-service.mdx +11 -11
- package/docs/reference/typescript-api/services/facet-value-service.mdx +12 -12
- package/docs/reference/typescript-api/services/fulfillment-service.mdx +4 -4
- package/docs/reference/typescript-api/services/global-settings-service.mdx +2 -2
- package/docs/reference/typescript-api/services/history-service.mdx +8 -8
- package/docs/reference/typescript-api/services/order-service.mdx +52 -52
- package/docs/reference/typescript-api/services/order-testing-service.mdx +2 -2
- package/docs/reference/typescript-api/services/payment-method-service.mdx +10 -10
- package/docs/reference/typescript-api/services/payment-service.mdx +7 -7
- package/docs/reference/typescript-api/services/product-option-group-service.mdx +5 -5
- package/docs/reference/typescript-api/services/product-option-service.mdx +5 -5
- package/docs/reference/typescript-api/services/product-service.mdx +13 -13
- package/docs/reference/typescript-api/services/product-variant-service.mdx +22 -22
- package/docs/reference/typescript-api/services/promotion-service.mdx +9 -9
- package/docs/reference/typescript-api/services/province-service.mdx +5 -5
- package/docs/reference/typescript-api/services/role-service.mdx +11 -11
- package/docs/reference/typescript-api/services/search-service.mdx +2 -2
- package/docs/reference/typescript-api/services/seller-service.mdx +3 -3
- package/docs/reference/typescript-api/services/session-service.mdx +8 -8
- package/docs/reference/typescript-api/services/settings-store-service.mdx +15 -15
- package/docs/reference/typescript-api/services/shipping-method-service.mdx +8 -8
- package/docs/reference/typescript-api/services/slug-service.mdx +1 -1
- package/docs/reference/typescript-api/services/stock-level-service.mdx +3 -3
- package/docs/reference/typescript-api/services/stock-location-service.mdx +7 -7
- package/docs/reference/typescript-api/services/stock-movement-service.mdx +7 -7
- package/docs/reference/typescript-api/services/tag-service.mdx +5 -5
- package/docs/reference/typescript-api/services/tax-category-service.mdx +5 -5
- package/docs/reference/typescript-api/services/tax-rate-service.mdx +6 -6
- package/docs/reference/typescript-api/services/user-service.mdx +12 -12
- package/docs/reference/typescript-api/services/zone-service.mdx +8 -8
- package/docs/reference/typescript-api/settings-store/settings-store-field-config.mdx +2 -2
- package/docs/reference/typescript-api/shipping/default-shipping-line-assignment-strategy.mdx +1 -1
- package/docs/reference/typescript-api/shipping/shipping-calculator.mdx +2 -2
- package/docs/reference/typescript-api/shipping/shipping-line-assignment-strategy.mdx +1 -1
- package/docs/reference/typescript-api/shipping/shipping-options.mdx +5 -5
- package/docs/reference/typescript-api/state-machine/fsm.mdx +1 -1
- package/docs/reference/typescript-api/tax/tax-line-calculation-strategy.mdx +1 -1
- package/docs/reference/typescript-api/tax/tax-zone-strategy.mdx +1 -1
- package/docs/reference/typescript-api/telemetry/wrapped-method-args.mdx +2 -2
- package/docs/reference/typescript-api/testing/create-error-result-guard.mdx +1 -1
- package/docs/reference/typescript-api/testing/create-test-environment.mdx +1 -1
- package/docs/reference/typescript-api/testing/error-result-guard.mdx +1 -1
- package/docs/reference/typescript-api/testing/simple-graph-qlclient.mdx +5 -5
- package/docs/reference/typescript-api/testing/test-db-initializer.mdx +3 -3
- package/docs/reference/typescript-api/testing/test-server.mdx +2 -2
- 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 +2 -2
- package/package.json +1 -1
|
@@ -22,7 +22,7 @@ class CustomerHistoryEntry extends HistoryEntry {
|
|
|
22
22
|
|
|
23
23
|
### constructor
|
|
24
24
|
|
|
25
|
-
<MemberInfo kind="method" type={`(input: DeepPartial
|
|
25
|
+
<MemberInfo kind="method" type={`(input: `DeepPartial<`<a href='/reference/typescript-api/entities/customer-history-entry#customerhistoryentry'>CustomerHistoryEntry</a>`>`) => CustomerHistoryEntry`} />
|
|
26
26
|
|
|
27
27
|
|
|
28
28
|
### customer
|
|
@@ -49,7 +49,7 @@ class Customer extends VendureEntity implements ChannelAware, HasCustomFields, S
|
|
|
49
49
|
|
|
50
50
|
### constructor
|
|
51
51
|
|
|
52
|
-
<MemberInfo kind="method" type={`(input?: DeepPartial
|
|
52
|
+
<MemberInfo kind="method" type={`(input?: `DeepPartial<`<a href='/reference/typescript-api/entities/customer#customer'>Customer</a>`>`) => Customer`} />
|
|
53
53
|
|
|
54
54
|
|
|
55
55
|
### deletedAt
|
|
@@ -40,7 +40,7 @@ class FacetValue extends VendureEntity implements Translatable, HasCustomFields,
|
|
|
40
40
|
|
|
41
41
|
### constructor
|
|
42
42
|
|
|
43
|
-
<MemberInfo kind="method" type={`(input?: DeepPartial
|
|
43
|
+
<MemberInfo kind="method" type={`(input?: `DeepPartial<`<a href='/reference/typescript-api/entities/facet-value#facetvalue'>FacetValue</a>`>`) => FacetValue`} />
|
|
44
44
|
|
|
45
45
|
|
|
46
46
|
### name
|
|
@@ -55,7 +55,7 @@ class FacetValue extends VendureEntity implements Translatable, HasCustomFields,
|
|
|
55
55
|
|
|
56
56
|
### translations
|
|
57
57
|
|
|
58
|
-
<MemberInfo kind="property" type={
|
|
58
|
+
<MemberInfo kind="property" type={``Array<Translation<`<a href='/reference/typescript-api/entities/facet-value#facetvalue'>FacetValue</a>`>>``} />
|
|
59
59
|
|
|
60
60
|
|
|
61
61
|
### facet
|
|
@@ -41,7 +41,7 @@ class Facet extends VendureEntity implements Translatable, HasCustomFields, Chan
|
|
|
41
41
|
|
|
42
42
|
### constructor
|
|
43
43
|
|
|
44
|
-
<MemberInfo kind="method" type={`(input?: DeepPartial
|
|
44
|
+
<MemberInfo kind="method" type={`(input?: `DeepPartial<`<a href='/reference/typescript-api/entities/facet#facet'>Facet</a>`>`) => Facet`} />
|
|
45
45
|
|
|
46
46
|
|
|
47
47
|
### name
|
|
@@ -61,7 +61,7 @@ class Facet extends VendureEntity implements Translatable, HasCustomFields, Chan
|
|
|
61
61
|
|
|
62
62
|
### translations
|
|
63
63
|
|
|
64
|
-
<MemberInfo kind="property" type={
|
|
64
|
+
<MemberInfo kind="property" type={``Array<Translation<`<a href='/reference/typescript-api/entities/facet#facet'>Facet</a>`>>``} />
|
|
65
65
|
|
|
66
66
|
|
|
67
67
|
### values
|
|
@@ -36,7 +36,7 @@ class Fulfillment extends VendureEntity implements HasCustomFields {
|
|
|
36
36
|
|
|
37
37
|
### constructor
|
|
38
38
|
|
|
39
|
-
<MemberInfo kind="method" type={`(input?: DeepPartial
|
|
39
|
+
<MemberInfo kind="method" type={`(input?: `DeepPartial<`<a href='/reference/typescript-api/entities/fulfillment#fulfillment'>Fulfillment</a>`>`) => Fulfillment`} />
|
|
40
40
|
|
|
41
41
|
|
|
42
42
|
### state
|
|
@@ -30,7 +30,7 @@ class GlobalSettings extends VendureEntity implements HasCustomFields {
|
|
|
30
30
|
|
|
31
31
|
### constructor
|
|
32
32
|
|
|
33
|
-
<MemberInfo kind="method" type={`(input?: DeepPartial
|
|
33
|
+
<MemberInfo kind="method" type={`(input?: `DeepPartial<`<a href='/reference/typescript-api/entities/global-settings#globalsettings'>GlobalSettings</a>`>`) => GlobalSettings`} />
|
|
34
34
|
|
|
35
35
|
|
|
36
36
|
### availableLanguages
|
|
@@ -96,7 +96,7 @@ interface Translatable {
|
|
|
96
96
|
|
|
97
97
|
### translations
|
|
98
98
|
|
|
99
|
-
<MemberInfo kind="property" type={
|
|
99
|
+
<MemberInfo kind="property" type={``Array<Translation<`<a href='/reference/typescript-api/entities/vendure-entity#vendureentity'>VendureEntity</a>`>>``} />
|
|
100
100
|
|
|
101
101
|
|
|
102
102
|
|
|
@@ -22,7 +22,7 @@ class OrderHistoryEntry extends HistoryEntry {
|
|
|
22
22
|
|
|
23
23
|
### constructor
|
|
24
24
|
|
|
25
|
-
<MemberInfo kind="method" type={`(input: DeepPartial
|
|
25
|
+
<MemberInfo kind="method" type={`(input: `DeepPartial<`<a href='/reference/typescript-api/entities/order-history-entry#orderhistoryentry'>OrderHistoryEntry</a>`>`) => OrderHistoryEntry`} />
|
|
26
26
|
|
|
27
27
|
|
|
28
28
|
### order
|
|
@@ -24,7 +24,7 @@ class FulfillmentLine extends OrderLineReference {
|
|
|
24
24
|
|
|
25
25
|
### constructor
|
|
26
26
|
|
|
27
|
-
<MemberInfo kind="method" type={`(input?: DeepPartial
|
|
27
|
+
<MemberInfo kind="method" type={`(input?: `DeepPartial<`<a href='/reference/typescript-api/entities/order-line-reference#fulfillmentline'>FulfillmentLine</a>`>`) => FulfillmentLine`} />
|
|
28
28
|
|
|
29
29
|
|
|
30
30
|
### fulfillment
|
|
@@ -101,7 +101,7 @@ class OrderModificationLine extends OrderLineReference {
|
|
|
101
101
|
|
|
102
102
|
### constructor
|
|
103
103
|
|
|
104
|
-
<MemberInfo kind="method" type={`(input?: DeepPartial
|
|
104
|
+
<MemberInfo kind="method" type={`(input?: `DeepPartial<`<a href='/reference/typescript-api/entities/order-line-reference#ordermodificationline'>OrderModificationLine</a>`>`) => OrderModificationLine`} />
|
|
105
105
|
|
|
106
106
|
|
|
107
107
|
### modification
|
|
@@ -139,7 +139,7 @@ class RefundLine extends OrderLineReference {
|
|
|
139
139
|
|
|
140
140
|
### constructor
|
|
141
141
|
|
|
142
|
-
<MemberInfo kind="method" type={`(input?: DeepPartial
|
|
142
|
+
<MemberInfo kind="method" type={`(input?: `DeepPartial<`<a href='/reference/typescript-api/entities/order-line-reference#refundline'>RefundLine</a>`>`) => RefundLine`} />
|
|
143
143
|
|
|
144
144
|
|
|
145
145
|
### refund
|
|
@@ -98,7 +98,7 @@ class OrderLine extends VendureEntity implements HasCustomFields {
|
|
|
98
98
|
|
|
99
99
|
### constructor
|
|
100
100
|
|
|
101
|
-
<MemberInfo kind="method" type={`(input?: DeepPartial
|
|
101
|
+
<MemberInfo kind="method" type={`(input?: `DeepPartial<`<a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a>`>`) => OrderLine`} />
|
|
102
102
|
|
|
103
103
|
|
|
104
104
|
### sellerChannel
|
|
@@ -40,7 +40,7 @@ class OrderModification extends VendureEntity {
|
|
|
40
40
|
|
|
41
41
|
### constructor
|
|
42
42
|
|
|
43
|
-
<MemberInfo kind="method" type={`(input?: DeepPartial
|
|
43
|
+
<MemberInfo kind="method" type={`(input?: `DeepPartial<`<a href='/reference/typescript-api/entities/order-modification#ordermodification'>OrderModification</a>`>`) => OrderModification`} />
|
|
44
44
|
|
|
45
45
|
|
|
46
46
|
### note
|
|
@@ -92,7 +92,7 @@ class Order extends VendureEntity implements ChannelAware, HasCustomFields {
|
|
|
92
92
|
|
|
93
93
|
### constructor
|
|
94
94
|
|
|
95
|
-
<MemberInfo kind="method" type={`(input?: DeepPartial
|
|
95
|
+
<MemberInfo kind="method" type={`(input?: `DeepPartial<`<a href='/reference/typescript-api/entities/order#order'>Order</a>`>`) => Order`} />
|
|
96
96
|
|
|
97
97
|
|
|
98
98
|
### type
|
|
@@ -33,7 +33,7 @@ class OrderableAsset extends VendureEntity implements Orderable {
|
|
|
33
33
|
|
|
34
34
|
### constructor
|
|
35
35
|
|
|
36
|
-
<MemberInfo kind="method" type={`(input?: DeepPartial
|
|
36
|
+
<MemberInfo kind="method" type={`(input?: `DeepPartial<`<a href='/reference/typescript-api/entities/orderable-asset#orderableasset'>OrderableAsset</a>`>`) => OrderableAsset`} />
|
|
37
37
|
|
|
38
38
|
|
|
39
39
|
### assetId
|
|
@@ -36,7 +36,7 @@ class PaymentMethod extends VendureEntity implements Translatable, ChannelAware,
|
|
|
36
36
|
|
|
37
37
|
### constructor
|
|
38
38
|
|
|
39
|
-
<MemberInfo kind="method" type={`(input?: DeepPartial
|
|
39
|
+
<MemberInfo kind="method" type={`(input?: `DeepPartial<`<a href='/reference/typescript-api/entities/payment-method#paymentmethod'>PaymentMethod</a>`>`) => PaymentMethod`} />
|
|
40
40
|
|
|
41
41
|
|
|
42
42
|
### name
|
|
@@ -56,7 +56,7 @@ class PaymentMethod extends VendureEntity implements Translatable, ChannelAware,
|
|
|
56
56
|
|
|
57
57
|
### translations
|
|
58
58
|
|
|
59
|
-
<MemberInfo kind="property" type={
|
|
59
|
+
<MemberInfo kind="property" type={``Array<Translation<`<a href='/reference/typescript-api/entities/payment-method#paymentmethod'>PaymentMethod</a>`>>``} />
|
|
60
60
|
|
|
61
61
|
|
|
62
62
|
### enabled
|
|
@@ -38,7 +38,7 @@ class Payment extends VendureEntity implements HasCustomFields {
|
|
|
38
38
|
|
|
39
39
|
### constructor
|
|
40
40
|
|
|
41
|
-
<MemberInfo kind="method" type={`(input?: DeepPartial
|
|
41
|
+
<MemberInfo kind="method" type={`(input?: `DeepPartial<`<a href='/reference/typescript-api/entities/payment#payment'>Payment</a>`>`) => Payment`} />
|
|
42
42
|
|
|
43
43
|
|
|
44
44
|
### method
|
|
@@ -36,7 +36,7 @@ class ProductOptionGroup extends VendureEntity implements Translatable, HasCusto
|
|
|
36
36
|
|
|
37
37
|
### constructor
|
|
38
38
|
|
|
39
|
-
<MemberInfo kind="method" type={`(input?: DeepPartial
|
|
39
|
+
<MemberInfo kind="method" type={`(input?: `DeepPartial<`<a href='/reference/typescript-api/entities/product-option-group#productoptiongroup'>ProductOptionGroup</a>`>`) => ProductOptionGroup`} />
|
|
40
40
|
|
|
41
41
|
|
|
42
42
|
### deletedAt
|
|
@@ -56,7 +56,7 @@ class ProductOptionGroup extends VendureEntity implements Translatable, HasCusto
|
|
|
56
56
|
|
|
57
57
|
### translations
|
|
58
58
|
|
|
59
|
-
<MemberInfo kind="property" type={
|
|
59
|
+
<MemberInfo kind="property" type={``Array<Translation<`<a href='/reference/typescript-api/entities/product-option-group#productoptiongroup'>ProductOptionGroup</a>`>>``} />
|
|
60
60
|
|
|
61
61
|
|
|
62
62
|
### options
|
|
@@ -37,7 +37,7 @@ class ProductOption extends VendureEntity implements Translatable, HasCustomFiel
|
|
|
37
37
|
|
|
38
38
|
### constructor
|
|
39
39
|
|
|
40
|
-
<MemberInfo kind="method" type={`(input?: DeepPartial
|
|
40
|
+
<MemberInfo kind="method" type={`(input?: `DeepPartial<`<a href='/reference/typescript-api/entities/product-option#productoption'>ProductOption</a>`>`) => ProductOption`} />
|
|
41
41
|
|
|
42
42
|
|
|
43
43
|
### deletedAt
|
|
@@ -57,7 +57,7 @@ class ProductOption extends VendureEntity implements Translatable, HasCustomFiel
|
|
|
57
57
|
|
|
58
58
|
### translations
|
|
59
59
|
|
|
60
|
-
<MemberInfo kind="property" type={
|
|
60
|
+
<MemberInfo kind="property" type={``Array<Translation<`<a href='/reference/typescript-api/entities/product-option#productoption'>ProductOption</a>`>>``} />
|
|
61
61
|
|
|
62
62
|
|
|
63
63
|
### group
|
|
@@ -32,7 +32,7 @@ class ProductVariantPrice extends VendureEntity implements HasCustomFields {
|
|
|
32
32
|
|
|
33
33
|
### constructor
|
|
34
34
|
|
|
35
|
-
<MemberInfo kind="method" type={`(input?: DeepPartial
|
|
35
|
+
<MemberInfo kind="method" type={`(input?: `DeepPartial<`<a href='/reference/typescript-api/entities/product-variant-price#productvariantprice'>ProductVariantPrice</a>`>`) => ProductVariantPrice`} />
|
|
36
36
|
|
|
37
37
|
|
|
38
38
|
### price
|
|
@@ -86,7 +86,7 @@ class ProductVariant extends VendureEntity implements Translatable, HasCustomFie
|
|
|
86
86
|
|
|
87
87
|
### constructor
|
|
88
88
|
|
|
89
|
-
<MemberInfo kind="method" type={`(input?: DeepPartial
|
|
89
|
+
<MemberInfo kind="method" type={`(input?: `DeepPartial<`<a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>`>`) => ProductVariant`} />
|
|
90
90
|
|
|
91
91
|
|
|
92
92
|
### deletedAt
|
|
@@ -171,7 +171,7 @@ class ProductVariant extends VendureEntity implements Translatable, HasCustomFie
|
|
|
171
171
|
|
|
172
172
|
### translations
|
|
173
173
|
|
|
174
|
-
<MemberInfo kind="property" type={
|
|
174
|
+
<MemberInfo kind="property" type={``Array<Translation<`<a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>`>>``} />
|
|
175
175
|
|
|
176
176
|
|
|
177
177
|
### product
|
|
@@ -51,7 +51,7 @@ class Product extends VendureEntity implements Translatable, HasCustomFields, Ch
|
|
|
51
51
|
|
|
52
52
|
### constructor
|
|
53
53
|
|
|
54
|
-
<MemberInfo kind="method" type={`(input?: DeepPartial
|
|
54
|
+
<MemberInfo kind="method" type={`(input?: `DeepPartial<`<a href='/reference/typescript-api/entities/product#product'>Product</a>`>`) => Product`} />
|
|
55
55
|
|
|
56
56
|
|
|
57
57
|
### deletedAt
|
|
@@ -96,7 +96,7 @@ class Product extends VendureEntity implements Translatable, HasCustomFields, Ch
|
|
|
96
96
|
|
|
97
97
|
### translations
|
|
98
98
|
|
|
99
|
-
<MemberInfo kind="property" type={
|
|
99
|
+
<MemberInfo kind="property" type={``Array<Translation<`<a href='/reference/typescript-api/entities/product#product'>Product</a>`>>``} />
|
|
100
100
|
|
|
101
101
|
|
|
102
102
|
### variants
|
|
@@ -66,7 +66,7 @@ class Promotion extends AdjustmentSource implements ChannelAware, SoftDeletable,
|
|
|
66
66
|
|
|
67
67
|
### constructor
|
|
68
68
|
|
|
69
|
-
<MemberInfo kind="method" type={`(input?: DeepPartial
|
|
69
|
+
<MemberInfo kind="method" type={`(input?: `DeepPartial<`<a href='/reference/typescript-api/entities/promotion#promotion'>Promotion</a>`> & { promotionConditions?: Array<`<a href='/reference/typescript-api/promotions/promotion-condition#promotioncondition'>PromotionCondition</a>`<any>>; promotionActions?: Array<`<a href='/reference/typescript-api/promotions/promotion-action#promotionaction'>PromotionAction</a>`<any>>; }`) => Promotion`} />
|
|
70
70
|
|
|
71
71
|
|
|
72
72
|
### deletedAt
|
|
@@ -111,7 +111,7 @@ class Promotion extends AdjustmentSource implements ChannelAware, SoftDeletable,
|
|
|
111
111
|
|
|
112
112
|
### translations
|
|
113
113
|
|
|
114
|
-
<MemberInfo kind="property" type={
|
|
114
|
+
<MemberInfo kind="property" type={``Array<Translation<`<a href='/reference/typescript-api/entities/promotion#promotion'>Promotion</a>`>>``} />
|
|
115
115
|
|
|
116
116
|
|
|
117
117
|
### enabled
|
|
@@ -162,12 +162,12 @@ If Promotion 2 is evaluated prior to Promotion 1, then it can trigger the 10% di
|
|
|
162
162
|
if the subsequent application of Promotion 1 brings the order total down to way below $50.
|
|
163
163
|
### apply
|
|
164
164
|
|
|
165
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, args: ApplyOrderActionArgs | ApplyOrderItemActionArgs | ApplyShippingActionArgs, state?: PromotionState) => Promise<Adjustment | undefined
|
|
165
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, args: ApplyOrderActionArgs | ApplyOrderItemActionArgs | ApplyShippingActionArgs, state?: PromotionState) => `Promise<Adjustment | undefined>``} />
|
|
166
166
|
|
|
167
167
|
|
|
168
168
|
### test
|
|
169
169
|
|
|
170
|
-
<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<PromotionTestResult
|
|
170
|
+
<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<PromotionTestResult>``} />
|
|
171
171
|
|
|
172
172
|
|
|
173
173
|
### activate
|
|
@@ -21,7 +21,7 @@ class Province extends Region {
|
|
|
21
21
|
|
|
22
22
|
### constructor
|
|
23
23
|
|
|
24
|
-
<MemberInfo kind="method" type={`(input?: DeepPartial
|
|
24
|
+
<MemberInfo kind="method" type={`(input?: `DeepPartial<`<a href='/reference/typescript-api/entities/province#province'>Province</a>`>`) => Province`} />
|
|
25
25
|
|
|
26
26
|
|
|
27
27
|
### type
|
|
@@ -42,7 +42,7 @@ class Refund extends VendureEntity implements HasCustomFields {
|
|
|
42
42
|
|
|
43
43
|
### constructor
|
|
44
44
|
|
|
45
|
-
<MemberInfo kind="method" type={`(input?: DeepPartial
|
|
45
|
+
<MemberInfo kind="method" type={`(input?: `DeepPartial<`<a href='/reference/typescript-api/entities/refund#refund'>Refund</a>`>`) => Refund`} />
|
|
46
46
|
|
|
47
47
|
|
|
48
48
|
### items
|
|
@@ -69,7 +69,7 @@ a format relevant to the type of province, e.g. a US state code like "CA".
|
|
|
69
69
|
|
|
70
70
|
### translations
|
|
71
71
|
|
|
72
|
-
<MemberInfo kind="property" type={
|
|
72
|
+
<MemberInfo kind="property" type={``Array<Translation<`<a href='/reference/typescript-api/entities/region#region'>Region</a>`>>``} />
|
|
73
73
|
|
|
74
74
|
|
|
75
75
|
### customFields
|
|
@@ -29,7 +29,7 @@ class Role extends VendureEntity implements ChannelAware {
|
|
|
29
29
|
|
|
30
30
|
### constructor
|
|
31
31
|
|
|
32
|
-
<MemberInfo kind="method" type={`(input?: DeepPartial
|
|
32
|
+
<MemberInfo kind="method" type={`(input?: `DeepPartial<`<a href='/reference/typescript-api/entities/role#role'>Role</a>`>`) => Role`} />
|
|
33
33
|
|
|
34
34
|
|
|
35
35
|
### code
|
|
@@ -30,7 +30,7 @@ class Seller extends VendureEntity implements SoftDeletable, HasCustomFields {
|
|
|
30
30
|
|
|
31
31
|
### constructor
|
|
32
32
|
|
|
33
|
-
<MemberInfo kind="method" type={`(input?: DeepPartial
|
|
33
|
+
<MemberInfo kind="method" type={`(input?: `DeepPartial<`<a href='/reference/typescript-api/entities/seller#seller'>Seller</a>`>`) => Seller`} />
|
|
34
34
|
|
|
35
35
|
|
|
36
36
|
### deletedAt
|
|
@@ -29,7 +29,7 @@ class SettingsStoreEntry extends VendureEntity {
|
|
|
29
29
|
|
|
30
30
|
### constructor
|
|
31
31
|
|
|
32
|
-
<MemberInfo kind="method" type={`(input?: Partial
|
|
32
|
+
<MemberInfo kind="method" type={`(input?: `Partial<`<a href='/reference/typescript-api/entities/settings-store-entry#settingsstoreentry'>SettingsStoreEntry</a>`>`) => SettingsStoreEntry`} />
|
|
33
33
|
|
|
34
34
|
|
|
35
35
|
### key
|
|
@@ -52,7 +52,7 @@ class ShippingLine extends VendureEntity implements HasCustomFields {
|
|
|
52
52
|
|
|
53
53
|
### constructor
|
|
54
54
|
|
|
55
|
-
<MemberInfo kind="method" type={`(input?: DeepPartial
|
|
55
|
+
<MemberInfo kind="method" type={`(input?: `DeepPartial<`<a href='/reference/typescript-api/entities/shipping-line#shippingline'>ShippingLine</a>`>`) => ShippingLine`} />
|
|
56
56
|
|
|
57
57
|
|
|
58
58
|
### shippingMethodId
|
|
@@ -45,7 +45,7 @@ class ShippingMethod extends VendureEntity implements ChannelAware, SoftDeletabl
|
|
|
45
45
|
|
|
46
46
|
### constructor
|
|
47
47
|
|
|
48
|
-
<MemberInfo kind="method" type={`(input?: DeepPartial
|
|
48
|
+
<MemberInfo kind="method" type={`(input?: `DeepPartial<`<a href='/reference/typescript-api/entities/shipping-method#shippingmethod'>ShippingMethod</a>`>`) => ShippingMethod`} />
|
|
49
49
|
|
|
50
50
|
|
|
51
51
|
### deletedAt
|
|
@@ -90,7 +90,7 @@ class ShippingMethod extends VendureEntity implements ChannelAware, SoftDeletabl
|
|
|
90
90
|
|
|
91
91
|
### translations
|
|
92
92
|
|
|
93
|
-
<MemberInfo kind="property" type={
|
|
93
|
+
<MemberInfo kind="property" type={``Array<Translation<`<a href='/reference/typescript-api/entities/shipping-method#shippingmethod'>ShippingMethod</a>`>>``} />
|
|
94
94
|
|
|
95
95
|
|
|
96
96
|
### customFields
|
|
@@ -100,12 +100,12 @@ class ShippingMethod extends VendureEntity implements ChannelAware, SoftDeletabl
|
|
|
100
100
|
|
|
101
101
|
### apply
|
|
102
102
|
|
|
103
|
-
<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
|
|
103
|
+
<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/shipping/shipping-calculator#shippingcalculationresult'>ShippingCalculationResult</a>` | undefined>``} />
|
|
104
104
|
|
|
105
105
|
|
|
106
106
|
### test
|
|
107
107
|
|
|
108
|
-
<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<boolean
|
|
108
|
+
<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<boolean>``} />
|
|
109
109
|
|
|
110
110
|
|
|
111
111
|
### toJSON
|
|
@@ -39,7 +39,7 @@ class StockLevel extends VendureEntity implements HasCustomFields {
|
|
|
39
39
|
|
|
40
40
|
### constructor
|
|
41
41
|
|
|
42
|
-
<MemberInfo kind="method" type={`(input: DeepPartial
|
|
42
|
+
<MemberInfo kind="method" type={`(input: `DeepPartial<`<a href='/reference/typescript-api/entities/stock-level#stocklevel'>StockLevel</a>`>`) => StockLevel`} />
|
|
43
43
|
|
|
44
44
|
|
|
45
45
|
### productVariant
|
|
@@ -38,7 +38,7 @@ class StockLocation extends VendureEntity implements HasCustomFields, ChannelAwa
|
|
|
38
38
|
|
|
39
39
|
### constructor
|
|
40
40
|
|
|
41
|
-
<MemberInfo kind="method" type={`(input: DeepPartial
|
|
41
|
+
<MemberInfo kind="method" type={`(input: `DeepPartial<`<a href='/reference/typescript-api/entities/stock-location#stocklocation'>StockLocation</a>`>`) => StockLocation`} />
|
|
42
42
|
|
|
43
43
|
|
|
44
44
|
### name
|
|
@@ -94,7 +94,7 @@ class Allocation extends StockMovement {
|
|
|
94
94
|
|
|
95
95
|
### constructor
|
|
96
96
|
|
|
97
|
-
<MemberInfo kind="method" type={`(input: DeepPartial
|
|
97
|
+
<MemberInfo kind="method" type={`(input: `DeepPartial<`<a href='/reference/typescript-api/entities/stock-movement#allocation'>Allocation</a>`>`) => Allocation`} />
|
|
98
98
|
|
|
99
99
|
|
|
100
100
|
### orderLine
|
|
@@ -130,7 +130,7 @@ class Cancellation extends StockMovement {
|
|
|
130
130
|
|
|
131
131
|
### constructor
|
|
132
132
|
|
|
133
|
-
<MemberInfo kind="method" type={`(input: DeepPartial
|
|
133
|
+
<MemberInfo kind="method" type={`(input: `DeepPartial<`<a href='/reference/typescript-api/entities/stock-movement#cancellation'>Cancellation</a>`>`) => Cancellation`} />
|
|
134
134
|
|
|
135
135
|
|
|
136
136
|
### orderLine
|
|
@@ -167,7 +167,7 @@ class Release extends StockMovement {
|
|
|
167
167
|
|
|
168
168
|
### constructor
|
|
169
169
|
|
|
170
|
-
<MemberInfo kind="method" type={`(input: DeepPartial
|
|
170
|
+
<MemberInfo kind="method" type={`(input: `DeepPartial<`<a href='/reference/typescript-api/entities/stock-movement#release'>Release</a>`>`) => Release`} />
|
|
171
171
|
|
|
172
172
|
|
|
173
173
|
### orderLine
|
|
@@ -203,7 +203,7 @@ class Sale extends StockMovement {
|
|
|
203
203
|
|
|
204
204
|
### constructor
|
|
205
205
|
|
|
206
|
-
<MemberInfo kind="method" type={`(input: DeepPartial
|
|
206
|
+
<MemberInfo kind="method" type={`(input: `DeepPartial<`<a href='/reference/typescript-api/entities/stock-movement#sale'>Sale</a>`>`) => Sale`} />
|
|
207
207
|
|
|
208
208
|
|
|
209
209
|
### orderLine
|
|
@@ -237,7 +237,7 @@ class StockAdjustment extends StockMovement {
|
|
|
237
237
|
|
|
238
238
|
### constructor
|
|
239
239
|
|
|
240
|
-
<MemberInfo kind="method" type={`(input: DeepPartial
|
|
240
|
+
<MemberInfo kind="method" type={`(input: `DeepPartial<`<a href='/reference/typescript-api/entities/stock-movement#stockadjustment'>StockAdjustment</a>`>`) => StockAdjustment`} />
|
|
241
241
|
|
|
242
242
|
|
|
243
243
|
|
|
@@ -39,7 +39,7 @@ class Surcharge extends VendureEntity {
|
|
|
39
39
|
|
|
40
40
|
### constructor
|
|
41
41
|
|
|
42
|
-
<MemberInfo kind="method" type={`(input?: DeepPartial
|
|
42
|
+
<MemberInfo kind="method" type={`(input?: `DeepPartial<`<a href='/reference/typescript-api/entities/surcharge#surcharge'>Surcharge</a>`>`) => Surcharge`} />
|
|
43
43
|
|
|
44
44
|
|
|
45
45
|
### description
|
|
@@ -22,7 +22,7 @@ class Tag extends VendureEntity {
|
|
|
22
22
|
|
|
23
23
|
### constructor
|
|
24
24
|
|
|
25
|
-
<MemberInfo kind="method" type={`(input?: DeepPartial
|
|
25
|
+
<MemberInfo kind="method" type={`(input?: `DeepPartial<`<a href='/reference/typescript-api/entities/tag#tag'>Tag</a>`>`) => Tag`} />
|
|
26
26
|
|
|
27
27
|
|
|
28
28
|
### value
|
|
@@ -30,7 +30,7 @@ class TaxCategory extends VendureEntity implements HasCustomFields {
|
|
|
30
30
|
|
|
31
31
|
### constructor
|
|
32
32
|
|
|
33
|
-
<MemberInfo kind="method" type={`(input?: DeepPartial
|
|
33
|
+
<MemberInfo kind="method" type={`(input?: `DeepPartial<`<a href='/reference/typescript-api/entities/tax-category#taxcategory'>TaxCategory</a>`>`) => TaxCategory`} />
|
|
34
34
|
|
|
35
35
|
|
|
36
36
|
### name
|
|
@@ -50,7 +50,7 @@ class TaxRate extends VendureEntity implements HasCustomFields {
|
|
|
50
50
|
|
|
51
51
|
### constructor
|
|
52
52
|
|
|
53
|
-
<MemberInfo kind="method" type={`(input?: DeepPartial
|
|
53
|
+
<MemberInfo kind="method" type={`(input?: `DeepPartial<`<a href='/reference/typescript-api/entities/tax-rate#taxrate'>TaxRate</a>`>`) => TaxRate`} />
|
|
54
54
|
|
|
55
55
|
|
|
56
56
|
### name
|
|
@@ -43,7 +43,7 @@ class User extends VendureEntity implements HasCustomFields, SoftDeletable {
|
|
|
43
43
|
|
|
44
44
|
### constructor
|
|
45
45
|
|
|
46
|
-
<MemberInfo kind="method" type={`(input?: DeepPartial
|
|
46
|
+
<MemberInfo kind="method" type={`(input?: `DeepPartial<`<a href='/reference/typescript-api/entities/user#user'>User</a>`>`) => User`} />
|
|
47
47
|
|
|
48
48
|
|
|
49
49
|
### deletedAt
|
|
@@ -21,7 +21,7 @@ class VendureEntity {
|
|
|
21
21
|
|
|
22
22
|
### constructor
|
|
23
23
|
|
|
24
|
-
<MemberInfo kind="method" type={`(input?: DeepPartial
|
|
24
|
+
<MemberInfo kind="method" type={`(input?: `DeepPartial<`<a href='/reference/typescript-api/entities/vendure-entity#vendureentity'>VendureEntity</a>`>`) => VendureEntity`} />
|
|
25
25
|
|
|
26
26
|
|
|
27
27
|
### id
|
|
@@ -35,7 +35,7 @@ class Zone extends VendureEntity implements HasCustomFields {
|
|
|
35
35
|
|
|
36
36
|
### constructor
|
|
37
37
|
|
|
38
|
-
<MemberInfo kind="method" type={`(input?: DeepPartial
|
|
38
|
+
<MemberInfo kind="method" type={`(input?: `DeepPartial<`<a href='/reference/typescript-api/entities/zone#zone'>Zone</a>`>`) => Zone`} />
|
|
39
39
|
|
|
40
40
|
|
|
41
41
|
### name
|
|
@@ -68,13 +68,13 @@ interface ErrorHandlerStrategy extends InjectableStrategy {
|
|
|
68
68
|
|
|
69
69
|
### handleServerError
|
|
70
70
|
|
|
71
|
-
<MemberInfo kind="method" type={`(exception: Error, context: { host: ArgumentsHost }) => void | Promise<void
|
|
71
|
+
<MemberInfo kind="method" type={`(exception: Error, context: { host: ArgumentsHost }) => `void | Promise<void>``} />
|
|
72
72
|
|
|
73
73
|
This method will be invoked for any error thrown during the execution of the
|
|
74
74
|
server.
|
|
75
75
|
### handleWorkerError
|
|
76
76
|
|
|
77
|
-
<MemberInfo kind="method" type={`(exception: Error, context: { job: <a href='/reference/typescript-api/job-queue/job#job'>Job</a> }) => void | Promise<void
|
|
77
|
+
<MemberInfo kind="method" type={`(exception: Error, context: { job: <a href='/reference/typescript-api/job-queue/job#job'>Job</a> }) => `void | Promise<void>``} />
|
|
78
78
|
|
|
79
79
|
This method will be invoked for any error thrown during the execution of a
|
|
80
80
|
job on the worker.
|
|
@@ -20,13 +20,13 @@ type BlockingEventHandlerOptions<T extends VendureEvent> = {
|
|
|
20
20
|
|
|
21
21
|
### event
|
|
22
22
|
|
|
23
|
-
<MemberInfo kind="property" type={
|
|
23
|
+
<MemberInfo kind="property" type={``Type<T> | Array<Type<T>>``} />
|
|
24
24
|
|
|
25
25
|
The event type to which the handler should listen.
|
|
26
26
|
Can be a single event type or an array of event types.
|
|
27
27
|
### handler
|
|
28
28
|
|
|
29
|
-
<MemberInfo kind="property" type={
|
|
29
|
+
<MemberInfo kind="property" type={``(event: T) => void | Promise<void>``} />
|
|
30
30
|
|
|
31
31
|
The handler function which will be executed when the event is published.
|
|
32
32
|
If the handler returns a Promise, the event publishing code will wait for the Promise to resolve
|