@vendure/docs 0.0.0-202601211551 → 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
|
@@ -25,23 +25,23 @@ class AuthService {
|
|
|
25
25
|
|
|
26
26
|
### authenticate
|
|
27
27
|
|
|
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
|
|
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
30
|
Authenticates a user's credentials and if okay, creates a new <DocsLink href="/reference/typescript-api/entities/authenticated-session#authenticatedsession">AuthenticatedSession</DocsLink>.
|
|
31
31
|
### createAuthenticatedSessionForUser
|
|
32
32
|
|
|
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
|
|
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>``} />
|
|
34
34
|
|
|
35
35
|
|
|
36
36
|
### verifyUserPassword
|
|
37
37
|
|
|
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
|
|
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
41
|
the <DocsLink href="/reference/typescript-api/auth/native-authentication-strategy#nativeauthenticationstrategy">NativeAuthenticationStrategy</DocsLink> to be configured.
|
|
42
42
|
### destroyAuthenticatedSession
|
|
43
43
|
|
|
44
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, sessionToken: string) => Promise<void
|
|
44
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, sessionToken: string) => `Promise<void>``} />
|
|
45
45
|
|
|
46
46
|
Deletes all sessions for the user associated with the given session token.
|
|
47
47
|
|
|
@@ -34,65 +34,65 @@ class ChannelService {
|
|
|
34
34
|
|
|
35
35
|
### assignToCurrentChannel
|
|
36
36
|
|
|
37
|
-
<MemberInfo kind="method" type={`(entity: T, ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => Promise<T
|
|
37
|
+
<MemberInfo kind="method" type={`(entity: T, ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => `Promise<T>``} />
|
|
38
38
|
|
|
39
39
|
Assigns a ChannelAware entity to the default Channel as well as any channel
|
|
40
40
|
specified in the RequestContext. This method will not save the entity to the database, but
|
|
41
41
|
assigns the `channels` property of the entity.
|
|
42
42
|
### assignToChannels
|
|
43
43
|
|
|
44
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, entityType: Type<T
|
|
44
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, entityType: `Type<T>`, entityId: <a href='/reference/typescript-api/common/id#id'>ID</a>, channelIds: <a href='/reference/typescript-api/common/id#id'>ID</a>[]) => `Promise<T>``} />
|
|
45
45
|
|
|
46
46
|
Assigns the entity to the given Channels and saves all changes to the database.
|
|
47
47
|
### removeFromChannels
|
|
48
48
|
|
|
49
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, entityType: Type<T
|
|
49
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, entityType: `Type<T>`, entityId: <a href='/reference/typescript-api/common/id#id'>ID</a>, channelIds: <a href='/reference/typescript-api/common/id#id'>ID</a>[]) => `Promise<T | undefined>``} />
|
|
50
50
|
|
|
51
51
|
Removes the entity from the given Channels and saves.
|
|
52
52
|
### getChannelFromToken
|
|
53
53
|
|
|
54
|
-
<MemberInfo kind="method" type={`(token: string) => Promise
|
|
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
57
|
a <DocsLink href="/reference/typescript-api/errors/error-types#channelnotfounderror">ChannelNotFoundError</DocsLink>.
|
|
58
58
|
### getChannelFromToken
|
|
59
59
|
|
|
60
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, token: string) => Promise
|
|
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>`>``} />
|
|
61
61
|
|
|
62
62
|
|
|
63
63
|
### getChannelFromToken
|
|
64
64
|
|
|
65
|
-
<MemberInfo kind="method" type={`(ctxOrToken: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a> | string, token?: string) => Promise
|
|
65
|
+
<MemberInfo kind="method" type={`(ctxOrToken: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a> | string, token?: string) => `Promise<`<a href='/reference/typescript-api/entities/channel#channel'>Channel</a>`>``} />
|
|
66
66
|
|
|
67
67
|
|
|
68
68
|
### getDefaultChannel
|
|
69
69
|
|
|
70
|
-
<MemberInfo kind="method" type={`(ctx?: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => Promise
|
|
70
|
+
<MemberInfo kind="method" type={`(ctx?: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => `Promise<`<a href='/reference/typescript-api/entities/channel#channel'>Channel</a>`>``} />
|
|
71
71
|
|
|
72
72
|
Returns the default Channel.
|
|
73
73
|
### findAll
|
|
74
74
|
|
|
75
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, options?: ListQueryOptions
|
|
75
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, options?: `ListQueryOptions<`<a href='/reference/typescript-api/entities/channel#channel'>Channel</a>`>`, relations?: `RelationPaths<`<a href='/reference/typescript-api/entities/channel#channel'>Channel</a>`>`) => `Promise<`<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a>`<`<a href='/reference/typescript-api/entities/channel#channel'>Channel</a>`>>``} />
|
|
76
76
|
|
|
77
77
|
|
|
78
78
|
### findOne
|
|
79
79
|
|
|
80
|
-
<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
|
|
80
|
+
<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/channel#channel'>Channel</a>` | undefined>``} />
|
|
81
81
|
|
|
82
82
|
|
|
83
83
|
### create
|
|
84
84
|
|
|
85
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: CreateChannelInput) => Promise
|
|
85
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: CreateChannelInput) => `Promise<`<a href='/reference/typescript-api/errors/error-result-union#errorresultunion'>ErrorResultUnion</a>`<CreateChannelResult, `<a href='/reference/typescript-api/entities/channel#channel'>Channel</a>`>>``} />
|
|
86
86
|
|
|
87
87
|
|
|
88
88
|
### update
|
|
89
89
|
|
|
90
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: UpdateChannelInput) => Promise
|
|
90
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: UpdateChannelInput) => `Promise<`<a href='/reference/typescript-api/errors/error-result-union#errorresultunion'>ErrorResultUnion</a>`<UpdateChannelResult, `<a href='/reference/typescript-api/entities/channel#channel'>Channel</a>`>>``} />
|
|
91
91
|
|
|
92
92
|
|
|
93
93
|
### delete
|
|
94
94
|
|
|
95
|
-
<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<DeletionResponse
|
|
95
|
+
<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<DeletionResponse>``} />
|
|
96
96
|
|
|
97
97
|
|
|
98
98
|
### isChannelAware
|
|
@@ -47,22 +47,22 @@ class CollectionService implements OnModuleInit {
|
|
|
47
47
|
|
|
48
48
|
### findAll
|
|
49
49
|
|
|
50
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, options?: ListQueryOptions
|
|
50
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, options?: `ListQueryOptions<`<a href='/reference/typescript-api/entities/collection#collection'>Collection</a>`> & { topLevelOnly?: boolean }`, relations?: `RelationPaths<`<a href='/reference/typescript-api/entities/collection#collection'>Collection</a>`>`) => `Promise<`<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a>`<Translated<`<a href='/reference/typescript-api/entities/collection#collection'>Collection</a>`>>>``} />
|
|
51
51
|
|
|
52
52
|
|
|
53
53
|
### findOne
|
|
54
54
|
|
|
55
|
-
<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>, relations?: RelationPaths
|
|
55
|
+
<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>, relations?: `RelationPaths<`<a href='/reference/typescript-api/entities/collection#collection'>Collection</a>`>`) => `Promise<Translated<`<a href='/reference/typescript-api/entities/collection#collection'>Collection</a>`> | undefined>``} />
|
|
56
56
|
|
|
57
57
|
|
|
58
58
|
### findByIds
|
|
59
59
|
|
|
60
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, ids: <a href='/reference/typescript-api/common/id#id'>ID</a>[], relations?: RelationPaths
|
|
60
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, ids: <a href='/reference/typescript-api/common/id#id'>ID</a>[], relations?: `RelationPaths<`<a href='/reference/typescript-api/entities/collection#collection'>Collection</a>`>`) => `Promise<Array<Translated<`<a href='/reference/typescript-api/entities/collection#collection'>Collection</a>`>>>``} />
|
|
61
61
|
|
|
62
62
|
|
|
63
63
|
### findOneBySlug
|
|
64
64
|
|
|
65
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, slug: string, relations?: RelationPaths
|
|
65
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, slug: string, relations?: `RelationPaths<`<a href='/reference/typescript-api/entities/collection#collection'>Collection</a>`>`) => `Promise<Translated<`<a href='/reference/typescript-api/entities/collection#collection'>Collection</a>`> | undefined>``} />
|
|
66
66
|
|
|
67
67
|
|
|
68
68
|
### getAvailableFilters
|
|
@@ -72,70 +72,70 @@ class CollectionService implements OnModuleInit {
|
|
|
72
72
|
Returns all configured CollectionFilters, as specified by the <DocsLink href="/reference/typescript-api/products-stock/catalog-options#catalogoptions">CatalogOptions</DocsLink>.
|
|
73
73
|
### getParent
|
|
74
74
|
|
|
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
|
|
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>``} />
|
|
76
76
|
|
|
77
77
|
|
|
78
78
|
### getChildren
|
|
79
79
|
|
|
80
|
-
<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
|
|
80
|
+
<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>`[]>``} />
|
|
81
81
|
|
|
82
82
|
Returns all child Collections of the Collection with the given id.
|
|
83
83
|
### getBreadcrumbs
|
|
84
84
|
|
|
85
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, collection: <a href='/reference/typescript-api/entities/collection#collection'>Collection</a>) => Promise<Array<{ name: string; id:
|
|
85
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, collection: <a href='/reference/typescript-api/entities/collection#collection'>Collection</a>) => `Promise<Array<{ name: string; id: `<a href='/reference/typescript-api/common/id#id'>ID</a>`; slug: string }>>``} />
|
|
86
86
|
|
|
87
87
|
Returns an array of name/id pairs representing all ancestor Collections up
|
|
88
88
|
to the Root Collection.
|
|
89
89
|
### getCollectionsByProductId
|
|
90
90
|
|
|
91
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, productId: <a href='/reference/typescript-api/common/id#id'>ID</a>, publicOnly: boolean) => Promise<Array<Translated
|
|
91
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, productId: <a href='/reference/typescript-api/common/id#id'>ID</a>, publicOnly: boolean) => `Promise<Array<Translated<`<a href='/reference/typescript-api/entities/collection#collection'>Collection</a>`>>>``} />
|
|
92
92
|
|
|
93
93
|
Returns all Collections which are associated with the given Product ID.
|
|
94
94
|
### getDescendants
|
|
95
95
|
|
|
96
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, rootId: <a href='/reference/typescript-api/common/id#id'>ID</a>, maxDepth: number = Number.MAX_SAFE_INTEGER) => Promise<Array<Translated
|
|
96
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, rootId: <a href='/reference/typescript-api/common/id#id'>ID</a>, maxDepth: number = Number.MAX_SAFE_INTEGER) => `Promise<Array<Translated<`<a href='/reference/typescript-api/entities/collection#collection'>Collection</a>`>>>``} />
|
|
97
97
|
|
|
98
98
|
Returns the descendants of a Collection as a flat array. The depth of the traversal can be limited
|
|
99
99
|
with the maxDepth argument. So to get only the immediate children, set maxDepth = 1.
|
|
100
100
|
### getAncestors
|
|
101
101
|
|
|
102
|
-
<MemberInfo kind="method" type={`(collectionId: <a href='/reference/typescript-api/common/id#id'>ID</a>) => Promise
|
|
102
|
+
<MemberInfo kind="method" type={`(collectionId: <a href='/reference/typescript-api/common/id#id'>ID</a>) => `Promise<`<a href='/reference/typescript-api/entities/collection#collection'>Collection</a>`[]>``} />
|
|
103
103
|
|
|
104
104
|
Gets the ancestors of a given collection. Note that since ProductCategories are implemented as an adjacency list, this method
|
|
105
105
|
will produce more queries the deeper the collection is in the tree.
|
|
106
106
|
### getAncestors
|
|
107
107
|
|
|
108
|
-
<MemberInfo kind="method" type={`(collectionId: <a href='/reference/typescript-api/common/id#id'>ID</a>, ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => Promise<Array<Translated
|
|
108
|
+
<MemberInfo kind="method" type={`(collectionId: <a href='/reference/typescript-api/common/id#id'>ID</a>, ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => `Promise<Array<Translated<`<a href='/reference/typescript-api/entities/collection#collection'>Collection</a>`>>>``} />
|
|
109
109
|
|
|
110
110
|
|
|
111
111
|
### getAncestors
|
|
112
112
|
|
|
113
|
-
<MemberInfo kind="method" type={`(collectionId: <a href='/reference/typescript-api/common/id#id'>ID</a>, ctx?: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => Promise<Array<Translated
|
|
113
|
+
<MemberInfo kind="method" type={`(collectionId: <a href='/reference/typescript-api/common/id#id'>ID</a>, ctx?: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => `Promise<Array<Translated<`<a href='/reference/typescript-api/entities/collection#collection'>Collection</a>`> | `<a href='/reference/typescript-api/entities/collection#collection'>Collection</a>`>>``} />
|
|
114
114
|
|
|
115
115
|
|
|
116
116
|
### previewCollectionVariants
|
|
117
117
|
|
|
118
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: PreviewCollectionVariantsInput, options?: ListQueryOptions
|
|
118
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: PreviewCollectionVariantsInput, options?: `ListQueryOptions<`<a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>`>`, relations?: `RelationPaths<`<a href='/reference/typescript-api/entities/collection#collection'>Collection</a>`>`) => `Promise<`<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a>`<`<a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>`>>``} />
|
|
119
119
|
|
|
120
120
|
|
|
121
121
|
### create
|
|
122
122
|
|
|
123
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: CreateCollectionInput) => Promise<Translated
|
|
123
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: CreateCollectionInput) => `Promise<Translated<`<a href='/reference/typescript-api/entities/collection#collection'>Collection</a>`>>``} />
|
|
124
124
|
|
|
125
125
|
|
|
126
126
|
### update
|
|
127
127
|
|
|
128
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: UpdateCollectionInput) => Promise<Translated
|
|
128
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: UpdateCollectionInput) => `Promise<Translated<`<a href='/reference/typescript-api/entities/collection#collection'>Collection</a>`>>``} />
|
|
129
129
|
|
|
130
130
|
|
|
131
131
|
### delete
|
|
132
132
|
|
|
133
|
-
<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<DeletionResponse
|
|
133
|
+
<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<DeletionResponse>``} />
|
|
134
134
|
|
|
135
135
|
|
|
136
136
|
### move
|
|
137
137
|
|
|
138
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: MoveCollectionInput) => Promise<Translated
|
|
138
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: MoveCollectionInput) => `Promise<Translated<`<a href='/reference/typescript-api/entities/collection#collection'>Collection</a>`>>``} />
|
|
139
139
|
|
|
140
140
|
Moves a Collection by specifying the parent Collection ID, and an index representing the order amongst
|
|
141
141
|
its siblings.
|
|
@@ -163,17 +163,17 @@ of the specified collections to be re-evaluated against their filters.
|
|
|
163
163
|
If no `collectionIds` option is passed, then all collections will be re-evaluated.
|
|
164
164
|
### getCollectionProductVariantIds
|
|
165
165
|
|
|
166
|
-
<MemberInfo kind="method" type={`(collection: <a href='/reference/typescript-api/entities/collection#collection'>Collection</a>, ctx?: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => Promise
|
|
166
|
+
<MemberInfo kind="method" type={`(collection: <a href='/reference/typescript-api/entities/collection#collection'>Collection</a>, ctx?: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => `Promise<`<a href='/reference/typescript-api/common/id#id'>ID</a>`[]>``} />
|
|
167
167
|
|
|
168
168
|
|
|
169
169
|
### assignCollectionsToChannel
|
|
170
170
|
|
|
171
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: AssignCollectionsToChannelInput) => Promise<Array<Translated
|
|
171
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: AssignCollectionsToChannelInput) => `Promise<Array<Translated<`<a href='/reference/typescript-api/entities/collection#collection'>Collection</a>`>>>``} />
|
|
172
172
|
|
|
173
173
|
Assigns Collections to the specified Channel
|
|
174
174
|
### removeCollectionsFromChannel
|
|
175
175
|
|
|
176
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: RemoveCollectionsFromChannelInput) => Promise<Array<Translated
|
|
176
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: RemoveCollectionsFromChannelInput) => `Promise<Array<Translated<`<a href='/reference/typescript-api/entities/collection#collection'>Collection</a>`>>>``} />
|
|
177
177
|
|
|
178
178
|
Remove Collections from the specified Channel
|
|
179
179
|
|
|
@@ -28,37 +28,37 @@ class CountryService {
|
|
|
28
28
|
|
|
29
29
|
### findAll
|
|
30
30
|
|
|
31
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, options?: ListQueryOptions
|
|
31
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, options?: `ListQueryOptions<`<a href='/reference/typescript-api/entities/country#country'>Country</a>`>`, relations: `RelationPaths<`<a href='/reference/typescript-api/entities/country#country'>Country</a>`>` = []) => `Promise<`<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a>`<Translated<`<a href='/reference/typescript-api/entities/country#country'>Country</a>`>>>``} />
|
|
32
32
|
|
|
33
33
|
|
|
34
34
|
### findOne
|
|
35
35
|
|
|
36
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, countryId: <a href='/reference/typescript-api/common/id#id'>ID</a>, relations: RelationPaths
|
|
36
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, countryId: <a href='/reference/typescript-api/common/id#id'>ID</a>, relations: `RelationPaths<`<a href='/reference/typescript-api/entities/country#country'>Country</a>`>` = []) => `Promise<Translated<`<a href='/reference/typescript-api/entities/country#country'>Country</a>`> | undefined>``} />
|
|
37
37
|
|
|
38
38
|
|
|
39
39
|
### findAllAvailable
|
|
40
40
|
|
|
41
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => Promise<Array<Translated
|
|
41
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => `Promise<Array<Translated<`<a href='/reference/typescript-api/entities/country#country'>Country</a>`>>>``} />
|
|
42
42
|
|
|
43
43
|
Returns an array of enabled Countries, intended for use in a public-facing (ie. Shop) API.
|
|
44
44
|
### findOneByCode
|
|
45
45
|
|
|
46
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, countryCode: string) => Promise<Translated
|
|
46
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, countryCode: string) => `Promise<Translated<`<a href='/reference/typescript-api/entities/country#country'>Country</a>`>>``} />
|
|
47
47
|
|
|
48
48
|
Returns a Country based on its ISO country code.
|
|
49
49
|
### create
|
|
50
50
|
|
|
51
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: CreateCountryInput) => Promise<Translated
|
|
51
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: CreateCountryInput) => `Promise<Translated<`<a href='/reference/typescript-api/entities/country#country'>Country</a>`>>``} />
|
|
52
52
|
|
|
53
53
|
|
|
54
54
|
### update
|
|
55
55
|
|
|
56
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: UpdateCountryInput) => Promise<Translated
|
|
56
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: UpdateCountryInput) => `Promise<Translated<`<a href='/reference/typescript-api/entities/country#country'>Country</a>`>>``} />
|
|
57
57
|
|
|
58
58
|
|
|
59
59
|
### delete
|
|
60
60
|
|
|
61
|
-
<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<DeletionResponse
|
|
61
|
+
<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<DeletionResponse>``} />
|
|
62
62
|
|
|
63
63
|
|
|
64
64
|
|
|
@@ -29,42 +29,42 @@ class CustomerGroupService {
|
|
|
29
29
|
|
|
30
30
|
### findAll
|
|
31
31
|
|
|
32
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, options?: CustomerGroupListOptions, relations: RelationPaths
|
|
32
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, options?: CustomerGroupListOptions, relations: `RelationPaths<`<a href='/reference/typescript-api/entities/customer-group#customergroup'>CustomerGroup</a>`>` = []) => `Promise<`<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a>`<`<a href='/reference/typescript-api/entities/customer-group#customergroup'>CustomerGroup</a>`>>``} />
|
|
33
33
|
|
|
34
34
|
|
|
35
35
|
### findOne
|
|
36
36
|
|
|
37
|
-
<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>, relations: RelationPaths
|
|
37
|
+
<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>, relations: `RelationPaths<`<a href='/reference/typescript-api/entities/customer-group#customergroup'>CustomerGroup</a>`>` = []) => `Promise<`<a href='/reference/typescript-api/entities/customer-group#customergroup'>CustomerGroup</a>` | undefined>``} />
|
|
38
38
|
|
|
39
39
|
|
|
40
40
|
### getGroupCustomers
|
|
41
41
|
|
|
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
|
|
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
44
|
Returns a <DocsLink href="/reference/typescript-api/common/paginated-list#paginatedlist">PaginatedList</DocsLink> of all the Customers in the group.
|
|
45
45
|
### create
|
|
46
46
|
|
|
47
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: CreateCustomerGroupInput) => Promise
|
|
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>`>``} />
|
|
48
48
|
|
|
49
49
|
|
|
50
50
|
### update
|
|
51
51
|
|
|
52
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: UpdateCustomerGroupInput) => Promise
|
|
52
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: UpdateCustomerGroupInput) => `Promise<`<a href='/reference/typescript-api/entities/customer-group#customergroup'>CustomerGroup</a>`>``} />
|
|
53
53
|
|
|
54
54
|
|
|
55
55
|
### delete
|
|
56
56
|
|
|
57
|
-
<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<DeletionResponse
|
|
57
|
+
<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<DeletionResponse>``} />
|
|
58
58
|
|
|
59
59
|
|
|
60
60
|
### addCustomersToGroup
|
|
61
61
|
|
|
62
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: MutationAddCustomersToGroupArgs) => Promise
|
|
62
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: MutationAddCustomersToGroupArgs) => `Promise<`<a href='/reference/typescript-api/entities/customer-group#customergroup'>CustomerGroup</a>`>``} />
|
|
63
63
|
|
|
64
64
|
|
|
65
65
|
### removeCustomersFromGroup
|
|
66
66
|
|
|
67
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: MutationRemoveCustomersFromGroupArgs) => Promise
|
|
67
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: MutationRemoveCustomersFromGroupArgs) => `Promise<`<a href='/reference/typescript-api/entities/customer-group#customergroup'>CustomerGroup</a>`>``} />
|
|
68
68
|
|
|
69
69
|
|
|
70
70
|
|
|
@@ -48,34 +48,34 @@ class CustomerService {
|
|
|
48
48
|
|
|
49
49
|
### findAll
|
|
50
50
|
|
|
51
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, options: ListQueryOptions
|
|
51
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, options: `ListQueryOptions<`<a href='/reference/typescript-api/entities/customer#customer'>Customer</a>`> | undefined`, relations: `RelationPaths<`<a href='/reference/typescript-api/entities/customer#customer'>Customer</a>`>` = []) => `Promise<`<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a>`<`<a href='/reference/typescript-api/entities/customer#customer'>Customer</a>`>>``} />
|
|
52
52
|
|
|
53
53
|
|
|
54
54
|
### findOne
|
|
55
55
|
|
|
56
|
-
<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>, relations: RelationPaths
|
|
56
|
+
<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>, relations: `RelationPaths<`<a href='/reference/typescript-api/entities/customer#customer'>Customer</a>`>` = []) => `Promise<`<a href='/reference/typescript-api/entities/customer#customer'>Customer</a>` | undefined>``} />
|
|
57
57
|
|
|
58
58
|
|
|
59
59
|
### findOneByUserId
|
|
60
60
|
|
|
61
|
-
<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>, filterOnChannel: = true) => Promise
|
|
61
|
+
<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>, filterOnChannel: = true) => `Promise<`<a href='/reference/typescript-api/entities/customer#customer'>Customer</a>` | undefined>``} />
|
|
62
62
|
|
|
63
63
|
Returns the Customer entity associated with the given userId, if one exists.
|
|
64
64
|
Setting `filterOnChannel` to `true` will limit the results to Customers which are assigned
|
|
65
65
|
to the current active Channel only.
|
|
66
66
|
### findAddressesByCustomerId
|
|
67
67
|
|
|
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
|
|
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
70
|
Returns all <DocsLink href="/reference/typescript-api/entities/address#address">Address</DocsLink> entities associated with the specified Customer.
|
|
71
71
|
### getCustomerGroups
|
|
72
72
|
|
|
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
|
|
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
75
|
Returns a list of all <DocsLink href="/reference/typescript-api/entities/customer-group#customergroup">CustomerGroup</DocsLink> entities.
|
|
76
76
|
### create
|
|
77
77
|
|
|
78
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: CreateCustomerInput, password?: string) => Promise
|
|
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>`>>``} />
|
|
79
79
|
|
|
80
80
|
Creates a new Customer, including creation of a new User with the special `customer` Role.
|
|
81
81
|
|
|
@@ -87,22 +87,22 @@ method.
|
|
|
87
87
|
This method is intended to be used in admin-created Customer flows.
|
|
88
88
|
### update
|
|
89
89
|
|
|
90
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: UpdateCustomerShopInput & { id: <a href='/reference/typescript-api/common/id#id'>ID</a> }) => Promise
|
|
90
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: UpdateCustomerShopInput & { id: <a href='/reference/typescript-api/common/id#id'>ID</a> }) => `Promise<`<a href='/reference/typescript-api/entities/customer#customer'>Customer</a>`>``} />
|
|
91
91
|
|
|
92
92
|
|
|
93
93
|
### update
|
|
94
94
|
|
|
95
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: UpdateCustomerInput) => Promise
|
|
95
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: UpdateCustomerInput) => `Promise<`<a href='/reference/typescript-api/errors/error-result-union#errorresultunion'>ErrorResultUnion</a>`<UpdateCustomerResult, `<a href='/reference/typescript-api/entities/customer#customer'>Customer</a>`>>``} />
|
|
96
96
|
|
|
97
97
|
|
|
98
98
|
### update
|
|
99
99
|
|
|
100
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: UpdateCustomerInput | (UpdateCustomerShopInput & { id: <a href='/reference/typescript-api/common/id#id'>ID</a> })) => Promise
|
|
100
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: UpdateCustomerInput | (UpdateCustomerShopInput & { id: <a href='/reference/typescript-api/common/id#id'>ID</a> })) => `Promise<`<a href='/reference/typescript-api/errors/error-result-union#errorresultunion'>ErrorResultUnion</a>`<UpdateCustomerResult, `<a href='/reference/typescript-api/entities/customer#customer'>Customer</a>`>>``} />
|
|
101
101
|
|
|
102
102
|
|
|
103
103
|
### registerCustomerAccount
|
|
104
104
|
|
|
105
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: RegisterCustomerInput) => Promise<RegisterCustomerAccountResult | EmailAddressConflictError | PasswordValidationError
|
|
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
107
|
Registers a new Customer account with the <DocsLink href="/reference/typescript-api/auth/native-authentication-strategy#nativeauthenticationstrategy">NativeAuthenticationStrategy</DocsLink> and starts
|
|
108
108
|
the email verification flow (unless <DocsLink href="/reference/typescript-api/auth/auth-options#authoptions">AuthOptions</DocsLink> `requireVerification` is set to `false`)
|
|
@@ -111,64 +111,64 @@ by publishing an <DocsLink href="/reference/typescript-api/events/event-types#ac
|
|
|
111
111
|
This method is intended to be used in storefront Customer-creation flows.
|
|
112
112
|
### refreshVerificationToken
|
|
113
113
|
|
|
114
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, emailAddress: string) => Promise<void
|
|
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
117
|
publishing a <DocsLink href="/reference/typescript-api/events/event-types#accountregistrationevent">AccountRegistrationEvent</DocsLink>.
|
|
118
118
|
### verifyCustomerEmailAddress
|
|
119
119
|
|
|
120
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, verificationToken: string, password?: string) => Promise
|
|
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
122
|
Given a valid verification token which has been published in an <DocsLink href="/reference/typescript-api/events/event-types#accountregistrationevent">AccountRegistrationEvent</DocsLink>, 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
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, emailAddress: string) => Promise<void
|
|
126
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, emailAddress: string) => `Promise<void>``} />
|
|
127
127
|
|
|
128
128
|
Publishes a new <DocsLink href="/reference/typescript-api/events/event-types#passwordresetevent">PasswordResetEvent</DocsLink> 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
|
|
|
132
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, passwordResetToken: string, password: string) => Promise<
|
|
132
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, passwordResetToken: string, password: string) => `Promise< `<a href='/reference/typescript-api/entities/user#user'>User</a>` | PasswordResetTokenExpiredError | PasswordResetTokenInvalidError | PasswordValidationError >``} />
|
|
133
133
|
|
|
134
134
|
Given a valid password reset token created by a call to the `requestPasswordReset()` method,
|
|
135
135
|
this method will change the Customer's password to that given as the `password` argument.
|
|
136
136
|
### requestUpdateEmailAddress
|
|
137
137
|
|
|
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
|
|
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
140
|
Publishes a <DocsLink href="/reference/typescript-api/events/event-types#identifierchangerequestevent">IdentifierChangeRequestEvent</DocsLink> 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
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, token: string) => Promise<boolean | IdentifierChangeTokenInvalidError | IdentifierChangeTokenExpiredError
|
|
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
147
|
Given a valid email update token published in a <DocsLink href="/reference/typescript-api/events/event-types#identifierchangerequestevent">IdentifierChangeRequestEvent</DocsLink>, this method
|
|
148
148
|
will update the Customer & User email address.
|
|
149
149
|
### createOrUpdate
|
|
150
150
|
|
|
151
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: Partial<CreateCustomerInput> & { emailAddress: string }
|
|
151
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: `Partial<CreateCustomerInput> & { emailAddress: string }`, errorOnExistingUser: boolean = false) => `Promise<`<a href='/reference/typescript-api/entities/customer#customer'>Customer</a>` | EmailAddressConflictError>``} />
|
|
152
152
|
|
|
153
153
|
For guest checkouts, we assume that a matching email address is the same customer.
|
|
154
154
|
### createAddress
|
|
155
155
|
|
|
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
|
|
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
158
|
Creates a new <DocsLink href="/reference/typescript-api/entities/address#address">Address</DocsLink> for the given Customer.
|
|
159
159
|
### updateAddress
|
|
160
160
|
|
|
161
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: UpdateAddressInput) => Promise
|
|
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>`>``} />
|
|
162
162
|
|
|
163
163
|
|
|
164
164
|
### deleteAddress
|
|
165
165
|
|
|
166
|
-
<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<boolean
|
|
166
|
+
<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<boolean>``} />
|
|
167
167
|
|
|
168
168
|
|
|
169
169
|
### softDelete
|
|
170
170
|
|
|
171
|
-
<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<DeletionResponse
|
|
171
|
+
<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<DeletionResponse>``} />
|
|
172
172
|
|
|
173
173
|
|
|
174
174
|
### createAddressesForNewCustomer
|
|
@@ -180,17 +180,17 @@ this method will create new Address(es) based on the Order's shipping & billing
|
|
|
180
180
|
addresses.
|
|
181
181
|
### addNoteToCustomer
|
|
182
182
|
|
|
183
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: AddNoteToCustomerInput) => Promise
|
|
183
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: AddNoteToCustomerInput) => `Promise<`<a href='/reference/typescript-api/entities/customer#customer'>Customer</a>`>``} />
|
|
184
184
|
|
|
185
185
|
|
|
186
186
|
### updateCustomerNote
|
|
187
187
|
|
|
188
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: UpdateCustomerNoteInput) => Promise
|
|
188
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: UpdateCustomerNoteInput) => `Promise<`<a href='/reference/typescript-api/entities/history-entry#historyentry'>HistoryEntry</a>`>``} />
|
|
189
189
|
|
|
190
190
|
|
|
191
191
|
### deleteCustomerNote
|
|
192
192
|
|
|
193
|
-
<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<DeletionResponse
|
|
193
|
+
<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<DeletionResponse>``} />
|
|
194
194
|
|
|
195
195
|
|
|
196
196
|
|