@vendure/docs 0.0.0-202601211535 → 0.0.0-202601211551

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.
Files changed (100) hide show
  1. package/docs/guides/extending-the-dashboard/migration/index.mdx +1 -1
  2. package/docs/reference/admin-ui-api/bulk-actions/bulk-action.mdx +3 -3
  3. package/docs/reference/admin-ui-api/components/asset-picker-dialog-component.mdx +1 -1
  4. package/docs/reference/admin-ui-api/directives/if-permissions-directive.mdx +1 -1
  5. package/docs/reference/admin-ui-api/list-detail-views/detail-component-with-resolver.mdx +1 -1
  6. package/docs/reference/admin-ui-api/react-extensions/register-react-route-component.mdx +1 -1
  7. package/docs/reference/admin-ui-api/routes/register-route-component.mdx +1 -1
  8. package/docs/reference/admin-ui-api/services/data-service.mdx +3 -3
  9. package/docs/reference/admin-ui-api/services/modal-service.mdx +2 -2
  10. package/docs/reference/admin-ui-api/ui-devkit/admin-ui-extension.mdx +1 -1
  11. package/docs/reference/core-plugins/elasticsearch-plugin/elasticsearch-options.mdx +2 -2
  12. package/docs/reference/core-plugins/email-plugin/email-event-handler-with-async-data.mdx +1 -1
  13. package/docs/reference/core-plugins/email-plugin/email-event-handler.mdx +13 -13
  14. package/docs/reference/core-plugins/email-plugin/email-event-listener.mdx +1 -1
  15. package/docs/reference/core-plugins/email-plugin/email-plugin-options.mdx +2 -2
  16. package/docs/reference/core-plugins/stellate-plugin/purge-rule.mdx +1 -1
  17. package/docs/reference/dashboard/detail-views/detail-page.mdx +1 -1
  18. package/docs/reference/dashboard/detail-views/use-detail-page.mdx +1 -1
  19. package/docs/reference/dashboard/detail-views/use-generated-form.mdx +1 -1
  20. package/docs/reference/dashboard/form-components/form-field-wrapper.mdx +1 -1
  21. package/docs/reference/dashboard/list-views/data-table.mdx +1 -1
  22. package/docs/reference/dashboard/list-views/list-page.mdx +1 -1
  23. package/docs/reference/dashboard/list-views/paginated-list-data-table.mdx +1 -1
  24. package/docs/reference/typescript-api/cache/self-refreshing-cache.mdx +1 -1
  25. package/docs/reference/typescript-api/configurable-operation-def/index.mdx +1 -1
  26. package/docs/reference/typescript-api/configuration/entity-duplicator.mdx +2 -2
  27. package/docs/reference/typescript-api/configuration/entity-options.mdx +2 -2
  28. package/docs/reference/typescript-api/configuration/runtime-vendure-config.mdx +1 -1
  29. package/docs/reference/typescript-api/configuration/vendure-config.mdx +1 -1
  30. package/docs/reference/typescript-api/data-access/entity-hydrator.mdx +1 -1
  31. package/docs/reference/typescript-api/data-access/hydrate-options.mdx +1 -1
  32. package/docs/reference/typescript-api/data-access/list-query-builder.mdx +1 -1
  33. package/docs/reference/typescript-api/data-access/transactional-connection.mdx +1 -1
  34. package/docs/reference/typescript-api/entities/promotion.mdx +1 -1
  35. package/docs/reference/typescript-api/events/event-bus.mdx +1 -1
  36. package/docs/reference/typescript-api/events/event-types.mdx +29 -29
  37. package/docs/reference/typescript-api/fulfillment/fulfillment-handler.mdx +3 -3
  38. package/docs/reference/typescript-api/fulfillment/fulfillment-process.mdx +4 -4
  39. package/docs/reference/typescript-api/import-export/import-parser.mdx +1 -1
  40. package/docs/reference/typescript-api/job-queue/in-memory-job-queue-strategy.mdx +2 -2
  41. package/docs/reference/typescript-api/job-queue/index.mdx +2 -2
  42. package/docs/reference/typescript-api/job-queue/inspectable-job-queue-strategy.mdx +1 -1
  43. package/docs/reference/typescript-api/job-queue/job-buffer.mdx +2 -2
  44. package/docs/reference/typescript-api/job-queue/job-queue-service.mdx +5 -5
  45. package/docs/reference/typescript-api/job-queue/job-queue-strategy.mdx +3 -3
  46. package/docs/reference/typescript-api/job-queue/job.mdx +3 -3
  47. package/docs/reference/typescript-api/job-queue/polling-job-queue-strategy.mdx +2 -2
  48. package/docs/reference/typescript-api/job-queue/sql-job-queue-strategy.mdx +3 -3
  49. package/docs/reference/typescript-api/job-queue/subscribable-job.mdx +2 -2
  50. package/docs/reference/typescript-api/job-queue/types.mdx +1 -1
  51. package/docs/reference/typescript-api/orders/default-guest-checkout-strategy.mdx +1 -1
  52. package/docs/reference/typescript-api/orders/guest-checkout-strategy.mdx +1 -1
  53. package/docs/reference/typescript-api/orders/order-options.mdx +2 -2
  54. package/docs/reference/typescript-api/orders/order-process.mdx +4 -4
  55. package/docs/reference/typescript-api/payment/payment-method-config-options.mdx +5 -5
  56. package/docs/reference/typescript-api/payment/payment-method-eligibility-checker.mdx +2 -2
  57. package/docs/reference/typescript-api/payment/payment-method-handler.mdx +1 -1
  58. package/docs/reference/typescript-api/payment/payment-options.mdx +3 -3
  59. package/docs/reference/typescript-api/payment/payment-process.mdx +4 -4
  60. package/docs/reference/typescript-api/payment/refund-process.mdx +4 -4
  61. package/docs/reference/typescript-api/products-stock/catalog-options.mdx +1 -1
  62. package/docs/reference/typescript-api/promotions/promotion-action.mdx +11 -11
  63. package/docs/reference/typescript-api/promotions/promotion-condition.mdx +2 -2
  64. package/docs/reference/typescript-api/promotions/promotion-options.mdx +2 -2
  65. package/docs/reference/typescript-api/scheduled-tasks/scheduled-task.mdx +3 -3
  66. package/docs/reference/typescript-api/services/administrator-service.mdx +1 -1
  67. package/docs/reference/typescript-api/services/asset-service.mdx +1 -1
  68. package/docs/reference/typescript-api/services/channel-service.mdx +3 -3
  69. package/docs/reference/typescript-api/services/collection-service.mdx +2 -2
  70. package/docs/reference/typescript-api/services/country-service.mdx +1 -1
  71. package/docs/reference/typescript-api/services/customer-group-service.mdx +2 -2
  72. package/docs/reference/typescript-api/services/customer-service.mdx +5 -5
  73. package/docs/reference/typescript-api/services/facet-service.mdx +2 -2
  74. package/docs/reference/typescript-api/services/facet-value-service.mdx +2 -2
  75. package/docs/reference/typescript-api/services/history-service.mdx +2 -2
  76. package/docs/reference/typescript-api/services/order-service.mdx +18 -18
  77. package/docs/reference/typescript-api/services/payment-method-service.mdx +1 -1
  78. package/docs/reference/typescript-api/services/product-option-service.mdx +1 -1
  79. package/docs/reference/typescript-api/services/product-service.mdx +2 -2
  80. package/docs/reference/typescript-api/services/product-variant-service.mdx +3 -3
  81. package/docs/reference/typescript-api/services/promotion-service.mdx +3 -3
  82. package/docs/reference/typescript-api/services/province-service.mdx +1 -1
  83. package/docs/reference/typescript-api/services/role-service.mdx +1 -1
  84. package/docs/reference/typescript-api/services/seller-service.mdx +1 -1
  85. package/docs/reference/typescript-api/services/settings-store-service.mdx +6 -6
  86. package/docs/reference/typescript-api/services/shipping-method-service.mdx +1 -1
  87. package/docs/reference/typescript-api/services/stock-location-service.mdx +1 -1
  88. package/docs/reference/typescript-api/services/stock-movement-service.mdx +1 -1
  89. package/docs/reference/typescript-api/services/tag-service.mdx +1 -1
  90. package/docs/reference/typescript-api/services/tax-category-service.mdx +1 -1
  91. package/docs/reference/typescript-api/services/tax-rate-service.mdx +1 -1
  92. package/docs/reference/typescript-api/services/user-service.mdx +1 -1
  93. package/docs/reference/typescript-api/services/zone-service.mdx +1 -1
  94. package/docs/reference/typescript-api/shipping/shipping-eligibility-checker-config.mdx +2 -2
  95. package/docs/reference/typescript-api/shipping/shipping-eligibility-checker.mdx +1 -1
  96. package/docs/reference/typescript-api/shipping/shipping-options.mdx +5 -5
  97. package/docs/reference/typescript-api/state-machine/fsm.mdx +1 -1
  98. package/docs/reference/typescript-api/state-machine/state-machine-config.mdx +4 -4
  99. package/docs/reference/typescript-api/testing/register-initializer.mdx +1 -1
  100. package/package.json +1 -1
@@ -57,7 +57,7 @@ Defines the logic used to calculate the unit price of an OrderLine when adding a
57
57
  item to an Order.
58
58
  ### process
59
59
 
60
- <MemberInfo kind="property" type={`Array<<a href='/reference/typescript-api/orders/order-process#orderprocess'>OrderProcess</a><any>>`} default={`[]`} />
60
+ <MemberInfo kind="property" type={`Array<<a href='/reference/typescript-api/orders/order-process#orderprocess'>OrderProcess</a>`<any>`>`} default={`[]`} />
61
61
 
62
62
  Allows the definition of custom states and transition logic for the order process state machine.
63
63
  Takes an array of objects implementing the <DocsLink href="/reference/typescript-api/orders/order-process#orderprocess">OrderProcess</DocsLink> interface.
@@ -113,7 +113,7 @@ will be reflected in the GraphQL `OrderLine.unitPrice[WithTax]ChangeSinceAdded`
113
113
  Defines the point of the order process at which the Order is set as "placed".
114
114
  ### activeOrderStrategy
115
115
 
116
- <MemberInfo kind="property" type={`<a href='/reference/typescript-api/orders/active-order-strategy#activeorderstrategy'>ActiveOrderStrategy</a><any> | Array<<a href='/reference/typescript-api/orders/active-order-strategy#activeorderstrategy'>ActiveOrderStrategy</a><any>>`} default={`<a href='/reference/typescript-api/orders/default-active-order-strategy#defaultactiveorderstrategy'>DefaultActiveOrderStrategy</a>`} since="1.9.0" />
116
+ <MemberInfo kind="property" type={`<a href='/reference/typescript-api/orders/active-order-strategy#activeorderstrategy'>ActiveOrderStrategy</a>`<any>` | Array<<a href='/reference/typescript-api/orders/active-order-strategy#activeorderstrategy'>ActiveOrderStrategy</a>`<any>`>`} default={`<a href='/reference/typescript-api/orders/default-active-order-strategy#defaultactiveorderstrategy'>DefaultActiveOrderStrategy</a>`} since="1.9.0" />
117
117
 
118
118
  Defines the strategy used to determine the active Order when interacting with Shop API operations
119
119
  such as `activeOrder` and `addItemToOrder`. By default, the strategy uses the active Session.
@@ -34,22 +34,22 @@ interface OrderProcess<State extends keyof CustomOrderStates | string> extends I
34
34
 
35
35
  ### transitions
36
36
 
37
- <MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/transitions#transitions'>Transitions</a><State, State | <a href='/reference/typescript-api/orders/order-process#orderstate'>OrderState</a>> &#38; Partial<<a href='/reference/typescript-api/state-machine/transitions#transitions'>Transitions</a><<a href='/reference/typescript-api/orders/order-process#orderstate'>OrderState</a> | State>>`} />
37
+ <MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/transitions#transitions'>Transitions</a>`<State, State | <a href='/reference/typescript-api/orders/order-process#orderstate'>`OrderState</a>> &#38; Partial<<a href='/reference/typescript-api/state-machine/transitions#transitions'>Transitions</a>`<<a href='/reference/typescript-api/orders/order-process#orderstate'>`OrderState</a> | State>>`} />
38
38
 
39
39
 
40
40
  ### onTransitionStart
41
41
 
42
- <MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionstartfn'>OnTransitionStartFn</a><State | <a href='/reference/typescript-api/orders/order-process#orderstate'>OrderState</a>, <a href='/reference/typescript-api/orders/order-process#ordertransitiondata'>OrderTransitionData</a>>`} />
42
+ <MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionstartfn'>OnTransitionStartFn</a>`<State | <a href='/reference/typescript-api/orders/order-process#orderstate'>`OrderState</a>, <a href='/reference/typescript-api/orders/order-process#ordertransitiondata'>OrderTransitionData</a>>`} />
43
43
 
44
44
 
45
45
  ### onTransitionEnd
46
46
 
47
- <MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionendfn'>OnTransitionEndFn</a><State | <a href='/reference/typescript-api/orders/order-process#orderstate'>OrderState</a>, <a href='/reference/typescript-api/orders/order-process#ordertransitiondata'>OrderTransitionData</a>>`} />
47
+ <MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionendfn'>OnTransitionEndFn</a>`<State | <a href='/reference/typescript-api/orders/order-process#orderstate'>`OrderState</a>, <a href='/reference/typescript-api/orders/order-process#ordertransitiondata'>OrderTransitionData</a>>`} />
48
48
 
49
49
 
50
50
  ### onTransitionError
51
51
 
52
- <MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionerrorfn'>OnTransitionErrorFn</a><State | <a href='/reference/typescript-api/orders/order-process#orderstate'>OrderState</a>>`} />
52
+ <MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionerrorfn'>OnTransitionErrorFn</a>`<State | <a href='/reference/typescript-api/orders/order-process#orderstate'>`OrderState</a>>`} />
53
53
 
54
54
 
55
55
 
@@ -23,14 +23,14 @@ interface PaymentMethodConfigOptions<T extends ConfigArgs> extends ConfigurableO
23
23
 
24
24
  ### createPayment
25
25
 
26
- <MemberInfo kind="property" type={`<a href='/reference/typescript-api/payment/payment-method-types#createpaymentfn'>CreatePaymentFn</a><T>`} />
26
+ <MemberInfo kind="property" type={`<a href='/reference/typescript-api/payment/payment-method-types#createpaymentfn'>CreatePaymentFn</a>`<T>``} />
27
27
 
28
28
  This function provides the logic for creating a payment. For example,
29
29
  it may call out to a third-party service with the data and should return a
30
30
  <DocsLink href="/reference/typescript-api/payment/payment-method-types#createpaymentresult">CreatePaymentResult</DocsLink> object contains the details of the payment.
31
31
  ### settlePayment
32
32
 
33
- <MemberInfo kind="property" type={`<a href='/reference/typescript-api/payment/payment-method-types#settlepaymentfn'>SettlePaymentFn</a><T>`} />
33
+ <MemberInfo kind="property" type={`<a href='/reference/typescript-api/payment/payment-method-types#settlepaymentfn'>SettlePaymentFn</a>`<T>``} />
34
34
 
35
35
  This function provides the logic for settling a payment, also known as "capturing".
36
36
  For payment integrations that settle/capture the payment on creation (i.e. the
@@ -38,7 +38,7 @@ For payment integrations that settle/capture the payment on creation (i.e. the
38
38
  need only return `{ success: true }`.
39
39
  ### cancelPayment
40
40
 
41
- <MemberInfo kind="property" type={`<a href='/reference/typescript-api/payment/payment-method-types#cancelpaymentfn'>CancelPaymentFn</a><T>`} since="1.7.0" />
41
+ <MemberInfo kind="property" type={`<a href='/reference/typescript-api/payment/payment-method-types#cancelpaymentfn'>CancelPaymentFn</a>`<T>``} since="1.7.0" />
42
42
 
43
43
  This function provides the logic for cancelling a payment, which would be invoked when a call is
44
44
  made to the `cancelPayment` mutation in the Admin API. Cancelling a payment can apply
@@ -47,7 +47,7 @@ completed the payment. It allows the incomplete payment to be cleaned up on the
47
47
  if it gets cancelled via Vendure.
48
48
  ### createRefund
49
49
 
50
- <MemberInfo kind="property" type={`<a href='/reference/typescript-api/payment/payment-method-types#createrefundfn'>CreateRefundFn</a><T>`} />
50
+ <MemberInfo kind="property" type={`<a href='/reference/typescript-api/payment/payment-method-types#createrefundfn'>CreateRefundFn</a>`<T>``} />
51
51
 
52
52
  This function provides the logic for refunding a payment created with this
53
53
  payment method. Some payment providers may not provide the facility to
@@ -55,7 +55,7 @@ programmatically create a refund. In such a case, this method should be
55
55
  omitted and any Refunds will have to be settled manually by an administrator.
56
56
  ### onStateTransitionStart
57
57
 
58
- <MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionstartfn'>OnTransitionStartFn</a><<a href='/reference/typescript-api/payment/payment-state#paymentstate'>PaymentState</a>, <a href='/reference/typescript-api/payment/payment-transition-data#paymenttransitiondata'>PaymentTransitionData</a>>`} />
58
+ <MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionstartfn'>OnTransitionStartFn</a>`<<a href='/reference/typescript-api/payment/payment-state#paymentstate'>`PaymentState</a>, <a href='/reference/typescript-api/payment/payment-transition-data#paymenttransitiondata'>PaymentTransitionData</a>>`} />
59
59
 
60
60
  This function, when specified, will be invoked before any transition from one <DocsLink href="/reference/typescript-api/payment/payment-state#paymentstate">PaymentState</DocsLink> to another.
61
61
  The return value (a sync / async `boolean`) is used to determine whether the transition is permitted.
@@ -35,7 +35,7 @@ class PaymentMethodEligibilityChecker<T extends ConfigArgs = ConfigArgs> extends
35
35
 
36
36
  ### constructor
37
37
 
38
- <MemberInfo kind="method" type={`(config: <a href='/reference/typescript-api/payment/payment-method-eligibility-checker#paymentmethodeligibilitycheckerconfig'>PaymentMethodEligibilityCheckerConfig</a><T>) => PaymentMethodEligibilityChecker`} />
38
+ <MemberInfo kind="method" type={`(config: <a href='/reference/typescript-api/payment/payment-method-eligibility-checker#paymentmethodeligibilitycheckerconfig'>PaymentMethodEligibilityCheckerConfig</a>`<T>`) => PaymentMethodEligibilityChecker`} />
39
39
 
40
40
 
41
41
 
@@ -59,7 +59,7 @@ interface PaymentMethodEligibilityCheckerConfig<T extends ConfigArgs> extends Co
59
59
 
60
60
  ### check
61
61
 
62
- <MemberInfo kind="property" type={`<a href='/reference/typescript-api/payment/payment-method-eligibility-checker#checkpaymentmethodeligibilitycheckerfn'>CheckPaymentMethodEligibilityCheckerFn</a><T>`} />
62
+ <MemberInfo kind="property" type={`<a href='/reference/typescript-api/payment/payment-method-eligibility-checker#checkpaymentmethodeligibilitycheckerfn'>CheckPaymentMethodEligibilityCheckerFn</a>`<T>``} />
63
63
 
64
64
 
65
65
 
@@ -70,7 +70,7 @@ class PaymentMethodHandler<T extends ConfigArgs = ConfigArgs> extends Configurab
70
70
 
71
71
  ### constructor
72
72
 
73
- <MemberInfo kind="method" type={`(config: <a href='/reference/typescript-api/payment/payment-method-config-options#paymentmethodconfigoptions'>PaymentMethodConfigOptions</a><T>) => PaymentMethodHandler`} />
73
+ <MemberInfo kind="method" type={`(config: <a href='/reference/typescript-api/payment/payment-method-config-options#paymentmethodconfigoptions'>PaymentMethodConfigOptions</a>`<T>`) => PaymentMethodHandler`} />
74
74
 
75
75
 
76
76
 
@@ -32,18 +32,18 @@ Defines which <DocsLink href="/reference/typescript-api/payment/payment-method-e
32
32
  <DocsLink href="/reference/typescript-api/entities/payment-method#paymentmethod">PaymentMethod</DocsLink>s
33
33
  ### customPaymentProcess
34
34
 
35
- <MemberInfo kind="property" type={`Array<<a href='/reference/typescript-api/payment/payment-process#paymentprocess'>PaymentProcess</a><any>>`} />
35
+ <MemberInfo kind="property" type={`Array<<a href='/reference/typescript-api/payment/payment-process#paymentprocess'>PaymentProcess</a>`<any>`>`} />
36
36
 
37
37
 
38
38
  ### process
39
39
 
40
- <MemberInfo kind="property" type={`Array<<a href='/reference/typescript-api/payment/payment-process#paymentprocess'>PaymentProcess</a><any>>`} default={`<a href='/reference/typescript-api/payment/default-payment-process#defaultpaymentprocess'>defaultPaymentProcess</a>`} since="2.0.0" />
40
+ <MemberInfo kind="property" type={`Array<<a href='/reference/typescript-api/payment/payment-process#paymentprocess'>PaymentProcess</a>`<any>`>`} default={`<a href='/reference/typescript-api/payment/default-payment-process#defaultpaymentprocess'>defaultPaymentProcess</a>`} since="2.0.0" />
41
41
 
42
42
  Allows the definition of custom states and transition logic for the payment process state machine.
43
43
  Takes an array of objects implementing the <DocsLink href="/reference/typescript-api/payment/payment-process#paymentprocess">PaymentProcess</DocsLink> interface.
44
44
  ### refundProcess
45
45
 
46
- <MemberInfo kind="property" type={`Array<<a href='/reference/typescript-api/payment/refund-process#refundprocess'>RefundProcess</a><any>>`} default={`<a href='/reference/typescript-api/payment/default-refund-process#defaultrefundprocess'>defaultRefundProcess</a>`} />
46
+ <MemberInfo kind="property" type={`Array<<a href='/reference/typescript-api/payment/refund-process#refundprocess'>RefundProcess</a>`<any>`>`} default={`<a href='/reference/typescript-api/payment/default-refund-process#defaultrefundprocess'>defaultRefundProcess</a>`} />
47
47
 
48
48
  Allows the definition of custom states and transition logic for the refund process state machine.
49
49
  Takes an array of objects implementing the <DocsLink href="/reference/typescript-api/payment/refund-process#refundprocess">RefundProcess</DocsLink> interface.
@@ -34,22 +34,22 @@ interface PaymentProcess<State extends keyof CustomPaymentStates | string> exten
34
34
 
35
35
  ### transitions
36
36
 
37
- <MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/transitions#transitions'>Transitions</a><State, State | <a href='/reference/typescript-api/payment/payment-state#paymentstate'>PaymentState</a>> &#38; Partial<<a href='/reference/typescript-api/state-machine/transitions#transitions'>Transitions</a><<a href='/reference/typescript-api/payment/payment-state#paymentstate'>PaymentState</a> | State>>`} />
37
+ <MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/transitions#transitions'>Transitions</a>`<State, State | <a href='/reference/typescript-api/payment/payment-state#paymentstate'>`PaymentState</a>> &#38; Partial<<a href='/reference/typescript-api/state-machine/transitions#transitions'>Transitions</a>`<<a href='/reference/typescript-api/payment/payment-state#paymentstate'>`PaymentState</a> | State>>`} />
38
38
 
39
39
 
40
40
  ### onTransitionStart
41
41
 
42
- <MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionstartfn'>OnTransitionStartFn</a><State | <a href='/reference/typescript-api/payment/payment-state#paymentstate'>PaymentState</a>, <a href='/reference/typescript-api/payment/payment-transition-data#paymenttransitiondata'>PaymentTransitionData</a>>`} />
42
+ <MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionstartfn'>OnTransitionStartFn</a>`<State | <a href='/reference/typescript-api/payment/payment-state#paymentstate'>`PaymentState</a>, <a href='/reference/typescript-api/payment/payment-transition-data#paymenttransitiondata'>PaymentTransitionData</a>>`} />
43
43
 
44
44
 
45
45
  ### onTransitionEnd
46
46
 
47
- <MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionendfn'>OnTransitionEndFn</a><State | <a href='/reference/typescript-api/payment/payment-state#paymentstate'>PaymentState</a>, <a href='/reference/typescript-api/payment/payment-transition-data#paymenttransitiondata'>PaymentTransitionData</a>>`} />
47
+ <MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionendfn'>OnTransitionEndFn</a>`<State | <a href='/reference/typescript-api/payment/payment-state#paymentstate'>`PaymentState</a>, <a href='/reference/typescript-api/payment/payment-transition-data#paymenttransitiondata'>PaymentTransitionData</a>>`} />
48
48
 
49
49
 
50
50
  ### onTransitionError
51
51
 
52
- <MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionerrorfn'>OnTransitionErrorFn</a><State | <a href='/reference/typescript-api/payment/payment-state#paymentstate'>PaymentState</a>>`} />
52
+ <MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionerrorfn'>OnTransitionErrorFn</a>`<State | <a href='/reference/typescript-api/payment/payment-state#paymentstate'>`PaymentState</a>>`} />
53
53
 
54
54
 
55
55
 
@@ -27,22 +27,22 @@ interface RefundProcess<State extends keyof CustomRefundStates | string> extends
27
27
 
28
28
  ### transitions
29
29
 
30
- <MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/transitions#transitions'>Transitions</a><State, State | <a href='/reference/typescript-api/payment/refund-state#refundstate'>RefundState</a>> &#38; Partial<<a href='/reference/typescript-api/state-machine/transitions#transitions'>Transitions</a><<a href='/reference/typescript-api/payment/refund-state#refundstate'>RefundState</a> | State>>`} />
30
+ <MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/transitions#transitions'>Transitions</a>`<State, State | <a href='/reference/typescript-api/payment/refund-state#refundstate'>`RefundState</a>> &#38; Partial<<a href='/reference/typescript-api/state-machine/transitions#transitions'>Transitions</a>`<<a href='/reference/typescript-api/payment/refund-state#refundstate'>`RefundState</a> | State>>`} />
31
31
 
32
32
 
33
33
  ### onTransitionStart
34
34
 
35
- <MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionstartfn'>OnTransitionStartFn</a><State | <a href='/reference/typescript-api/payment/refund-state#refundstate'>RefundState</a>, <a href='/reference/typescript-api/payment/refund-transition-data#refundtransitiondata'>RefundTransitionData</a>>`} />
35
+ <MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionstartfn'>OnTransitionStartFn</a>`<State | <a href='/reference/typescript-api/payment/refund-state#refundstate'>`RefundState</a>, <a href='/reference/typescript-api/payment/refund-transition-data#refundtransitiondata'>RefundTransitionData</a>>`} />
36
36
 
37
37
 
38
38
  ### onTransitionEnd
39
39
 
40
- <MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionendfn'>OnTransitionEndFn</a><State | <a href='/reference/typescript-api/payment/refund-state#refundstate'>RefundState</a>, <a href='/reference/typescript-api/payment/refund-transition-data#refundtransitiondata'>RefundTransitionData</a>>`} />
40
+ <MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionendfn'>OnTransitionEndFn</a>`<State | <a href='/reference/typescript-api/payment/refund-state#refundstate'>`RefundState</a>, <a href='/reference/typescript-api/payment/refund-transition-data#refundtransitiondata'>RefundTransitionData</a>>`} />
41
41
 
42
42
 
43
43
  ### onTransitionError
44
44
 
45
- <MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionerrorfn'>OnTransitionErrorFn</a><State | <a href='/reference/typescript-api/payment/refund-state#refundstate'>RefundState</a>>`} />
45
+ <MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionerrorfn'>OnTransitionErrorFn</a>`<State | <a href='/reference/typescript-api/payment/refund-state#refundstate'>`RefundState</a>>`} />
46
46
 
47
47
 
48
48
 
@@ -21,7 +21,7 @@ interface CatalogOptions {
21
21
 
22
22
  ### collectionFilters
23
23
 
24
- <MemberInfo kind="property" type={`Array<<a href='/reference/typescript-api/configuration/collection-filter#collectionfilter'>CollectionFilter</a><any>>`} default={`defaultCollectionFilters`} />
24
+ <MemberInfo kind="property" type={`Array<<a href='/reference/typescript-api/configuration/collection-filter#collectionfilter'>CollectionFilter</a>`<any>`>`} default={`defaultCollectionFilters`} />
25
25
 
26
26
  Allows custom <DocsLink href="/reference/typescript-api/configuration/collection-filter#collectionfilter">CollectionFilter</DocsLink>s to be defined.
27
27
  ### productVariantPriceSelectionStrategy
@@ -28,7 +28,7 @@ on the same Order. See the <DocsLink href="/reference/typescript-api/entities/pr
28
28
  more information.
29
29
  ### constructor
30
30
 
31
- <MemberInfo kind="method" type={`(config: <a href='/reference/typescript-api/promotions/promotion-action#promotionactionconfig'>PromotionActionConfig</a><T, U>) => PromotionAction`} />
31
+ <MemberInfo kind="method" type={`(config: <a href='/reference/typescript-api/promotions/promotion-action#promotionactionconfig'>PromotionActionConfig</a>`<T, U>`) => PromotionAction`} />
32
32
 
33
33
 
34
34
 
@@ -65,7 +65,7 @@ class PromotionItemAction<T extends ConfigArgs = ConfigArgs, U extends Array<Pro
65
65
 
66
66
  ### constructor
67
67
 
68
- <MemberInfo kind="method" type={`(config: <a href='/reference/typescript-api/promotions/promotion-action#promotionitemactionconfig'>PromotionItemActionConfig</a><T, U>) => PromotionItemAction`} />
68
+ <MemberInfo kind="method" type={`(config: <a href='/reference/typescript-api/promotions/promotion-action#promotionitemactionconfig'>PromotionItemActionConfig</a>`<T, U>`) => PromotionItemAction`} />
69
69
 
70
70
 
71
71
 
@@ -102,7 +102,7 @@ class PromotionOrderAction<T extends ConfigArgs = ConfigArgs, U extends Promotio
102
102
 
103
103
  ### constructor
104
104
 
105
- <MemberInfo kind="method" type={`(config: <a href='/reference/typescript-api/promotions/promotion-action#promotionorderactionconfig'>PromotionOrderActionConfig</a><T, U>) => PromotionOrderAction`} />
105
+ <MemberInfo kind="method" type={`(config: <a href='/reference/typescript-api/promotions/promotion-action#promotionorderactionconfig'>PromotionOrderActionConfig</a>`<T, U>`) => PromotionOrderAction`} />
106
106
 
107
107
 
108
108
 
@@ -125,7 +125,7 @@ class PromotionShippingAction<T extends ConfigArgs = ConfigArgs, U extends Promo
125
125
 
126
126
  ### constructor
127
127
 
128
- <MemberInfo kind="method" type={`(config: <a href='/reference/typescript-api/promotions/promotion-action#promotionshippingactionconfig'>PromotionShippingActionConfig</a><T, U>) => PromotionShippingAction`} />
128
+ <MemberInfo kind="method" type={`(config: <a href='/reference/typescript-api/promotions/promotion-action#promotionshippingactionconfig'>PromotionShippingActionConfig</a>`<T, U>`) => PromotionShippingAction`} />
129
129
 
130
130
 
131
131
 
@@ -237,7 +237,7 @@ on which it depends.
237
237
  the return values of the PromotionConditions' `check()` function.
238
238
  ### onActivate
239
239
 
240
- <MemberInfo kind="property" type={`<a href='/reference/typescript-api/promotions/promotion-action#promotionactionsideeffectfn'>PromotionActionSideEffectFn</a><T>`} since="1.8.0" experimental="true" />
240
+ <MemberInfo kind="property" type={`<a href='/reference/typescript-api/promotions/promotion-action#promotionactionsideeffectfn'>PromotionActionSideEffectFn</a>`<T>``} since="1.8.0" experimental="true" />
241
241
 
242
242
  An optional side effect function which is invoked when the promotion
243
243
  becomes active. It can be used for things like adding a free gift to the order
@@ -247,7 +247,7 @@ If used, make sure to use the corresponding `onDeactivate` function to clean up
247
247
  or reverse any side effects as needed.
248
248
  ### onDeactivate
249
249
 
250
- <MemberInfo kind="property" type={`<a href='/reference/typescript-api/promotions/promotion-action#promotionactionsideeffectfn'>PromotionActionSideEffectFn</a><T>`} since="1.8.0" experimental="true" />
250
+ <MemberInfo kind="property" type={`<a href='/reference/typescript-api/promotions/promotion-action#promotionactionsideeffectfn'>PromotionActionSideEffectFn</a>`<T>``} since="1.8.0" experimental="true" />
251
251
 
252
252
  Used to reverse or clean up any side effects executed as part of the `onActivate` function.
253
253
 
@@ -270,7 +270,7 @@ interface PromotionItemActionConfig<T extends ConfigArgs, U extends PromotionCon
270
270
 
271
271
  ### execute
272
272
 
273
- <MemberInfo kind="property" type={`<a href='/reference/typescript-api/promotions/promotion-action#executepromotionitemactionfn'>ExecutePromotionItemActionFn</a><T, U>`} />
273
+ <MemberInfo kind="property" type={`<a href='/reference/typescript-api/promotions/promotion-action#executepromotionitemactionfn'>ExecutePromotionItemActionFn</a>`<T, U>``} />
274
274
 
275
275
  The function which contains the promotion calculation logic.
276
276
  Should resolve to a number which represents the amount by which to discount
@@ -295,7 +295,7 @@ interface PromotionLineActionConfig<T extends ConfigArgs, U extends PromotionCon
295
295
 
296
296
  ### execute
297
297
 
298
- <MemberInfo kind="property" type={`<a href='/reference/typescript-api/promotions/promotion-action#executepromotionlineactionfn'>ExecutePromotionLineActionFn</a><T, U>`} />
298
+ <MemberInfo kind="property" type={`<a href='/reference/typescript-api/promotions/promotion-action#executepromotionlineactionfn'>ExecutePromotionLineActionFn</a>`<T, U>``} />
299
299
 
300
300
  The function which contains the promotion calculation logic.
301
301
  Should resolve to a number which represents the amount by which to discount
@@ -320,7 +320,7 @@ interface PromotionOrderActionConfig<T extends ConfigArgs, U extends PromotionCo
320
320
 
321
321
  ### execute
322
322
 
323
- <MemberInfo kind="property" type={`<a href='/reference/typescript-api/promotions/promotion-action#executepromotionorderactionfn'>ExecutePromotionOrderActionFn</a><T, U>`} />
323
+ <MemberInfo kind="property" type={`<a href='/reference/typescript-api/promotions/promotion-action#executepromotionorderactionfn'>ExecutePromotionOrderActionFn</a>`<T, U>``} />
324
324
 
325
325
  The function which contains the promotion calculation logic.
326
326
  Should resolve to a number which represents the amount by which to discount
@@ -345,7 +345,7 @@ interface PromotionShippingActionConfig<T extends ConfigArgs, U extends Promotio
345
345
 
346
346
  ### execute
347
347
 
348
- <MemberInfo kind="property" type={`<a href='/reference/typescript-api/promotions/promotion-action#executepromotionshippingactionfn'>ExecutePromotionShippingActionFn</a><T, U>`} />
348
+ <MemberInfo kind="property" type={`<a href='/reference/typescript-api/promotions/promotion-action#executepromotionshippingactionfn'>ExecutePromotionShippingActionFn</a>`<T, U>``} />
349
349
 
350
350
  The function which contains the promotion calculation logic.
351
351
  Should resolve to a number which represents the amount by which to discount
@@ -385,7 +385,7 @@ class PromotionLineAction<T extends ConfigArgs = ConfigArgs, U extends Array<Pro
385
385
 
386
386
  ### constructor
387
387
 
388
- <MemberInfo kind="method" type={`(config: <a href='/reference/typescript-api/promotions/promotion-action#promotionlineactionconfig'>PromotionLineActionConfig</a><T, U>) => PromotionLineAction`} />
388
+ <MemberInfo kind="method" type={`(config: <a href='/reference/typescript-api/promotions/promotion-action#promotionlineactionconfig'>PromotionLineActionConfig</a>`<T, U>`) => PromotionLineAction`} />
389
389
 
390
390
 
391
391
 
@@ -36,7 +36,7 @@ more information.
36
36
 
37
37
  ### constructor
38
38
 
39
- <MemberInfo kind="method" type={`(config: <a href='/reference/typescript-api/promotions/promotion-condition#promotionconditionconfig'>PromotionConditionConfig</a><T, C, R>) => PromotionCondition`} />
39
+ <MemberInfo kind="method" type={`(config: <a href='/reference/typescript-api/promotions/promotion-condition#promotionconditionconfig'>PromotionConditionConfig</a>`<T, C, R>`) => PromotionCondition`} />
40
40
 
41
41
 
42
42
  ### check
@@ -72,7 +72,7 @@ interface PromotionConditionConfig<T extends ConfigArgs, C extends string, R ext
72
72
 
73
73
  ### check
74
74
 
75
- <MemberInfo kind="property" type={`<a href='/reference/typescript-api/promotions/promotion-condition#checkpromotionconditionfn'>CheckPromotionConditionFn</a><T, R>`} />
75
+ <MemberInfo kind="property" type={`<a href='/reference/typescript-api/promotions/promotion-condition#checkpromotionconditionfn'>CheckPromotionConditionFn</a>`<T, R>``} />
76
76
 
77
77
 
78
78
  ### priorityValue
@@ -17,12 +17,12 @@ interface PromotionOptions {
17
17
 
18
18
  ### promotionConditions
19
19
 
20
- <MemberInfo kind="property" type={`Array<<a href='/reference/typescript-api/promotions/promotion-condition#promotioncondition'>PromotionCondition</a><any>>`} />
20
+ <MemberInfo kind="property" type={`Array<<a href='/reference/typescript-api/promotions/promotion-condition#promotioncondition'>PromotionCondition</a>`<any>`>`} />
21
21
 
22
22
  An array of conditions which can be used to construct Promotions
23
23
  ### promotionActions
24
24
 
25
- <MemberInfo kind="property" type={`Array<<a href='/reference/typescript-api/promotions/promotion-action#promotionaction'>PromotionAction</a><any>>`} />
25
+ <MemberInfo kind="property" type={`Array<<a href='/reference/typescript-api/promotions/promotion-action#promotionaction'>PromotionAction</a>`<any>`>`} />
26
26
 
27
27
  An array of actions which can be used to construct Promotions
28
28
 
@@ -34,7 +34,7 @@ class ScheduledTask<C extends Record<string, any> = Record<string, any>> {
34
34
 
35
35
  ### constructor
36
36
 
37
- <MemberInfo kind="method" type={`(config: <a href='/reference/typescript-api/scheduled-tasks/scheduled-task#scheduledtaskconfig'>ScheduledTaskConfig</a><C>) => ScheduledTask`} />
37
+ <MemberInfo kind="method" type={`(config: <a href='/reference/typescript-api/scheduled-tasks/scheduled-task#scheduledtaskconfig'>ScheduledTaskConfig</a>`<C>`) => ScheduledTask`} />
38
38
 
39
39
 
40
40
  ### id
@@ -54,7 +54,7 @@ class ScheduledTask<C extends Record<string, any> = Record<string, any>> {
54
54
 
55
55
  ### configure
56
56
 
57
- <MemberInfo kind="method" type={`(additionalConfig: Partial<Pick<<a href='/reference/typescript-api/scheduled-tasks/scheduled-task#scheduledtaskconfig'>ScheduledTaskConfig</a><C>, 'schedule' | 'timeout' | 'params'>>) => `} />
57
+ <MemberInfo kind="method" type={`(additionalConfig: Partial<Pick<<a href='/reference/typescript-api/scheduled-tasks/scheduled-task#scheduledtaskconfig'>ScheduledTaskConfig</a>`<C>`, 'schedule' | 'timeout' | 'params'>>) => `} />
58
58
 
59
59
  This method allows you to further configure existing scheduled tasks. For example, you may
60
60
  wish to change the schedule or timeout of a task, without having to define a new task.
@@ -175,7 +175,7 @@ will be considered to have failed with a timeout error.
175
175
  Whether the scheduled task should be prevented from running if it is already running.
176
176
  ### execute
177
177
 
178
- <MemberInfo kind="method" type={`(args: <a href='/reference/typescript-api/scheduled-tasks/scheduled-task#scheduledtaskexecutionargs'>ScheduledTaskExecutionArgs</a><C>) => Promise<any>`} />
178
+ <MemberInfo kind="method" type={`(args: <a href='/reference/typescript-api/scheduled-tasks/scheduled-task#scheduledtaskexecutionargs'>ScheduledTaskExecutionArgs</a>`<C>`) => Promise<any>`} />
179
179
 
180
180
  The function that will be executed when the scheduled task is run.
181
181
 
@@ -28,7 +28,7 @@ class AdministratorService {
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<<a href='/reference/typescript-api/entities/administrator#administrator'>Administrator</a>>, relations?: RelationPaths<<a href='/reference/typescript-api/entities/administrator#administrator'>Administrator</a>>) => Promise<<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a><<a href='/reference/typescript-api/entities/administrator#administrator'>Administrator</a>>>`} />
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/administrator#administrator'>Administrator</a>>, relations?: RelationPaths<<a href='/reference/typescript-api/entities/administrator#administrator'>Administrator</a>>) => Promise<<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a>`<<a href='/reference/typescript-api/entities/administrator#administrator'>`Administrator</a>>>`} />
32
32
 
33
33
  Get a paginated list of Administrators.
34
34
  ### findOne
@@ -39,7 +39,7 @@ class AssetService {
39
39
 
40
40
  ### findAll
41
41
 
42
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, options?: AssetListOptions, relations?: RelationPaths<<a href='/reference/typescript-api/entities/asset#asset'>Asset</a>>) => Promise<<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a><<a href='/reference/typescript-api/entities/asset#asset'>Asset</a>>>`} />
42
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, options?: AssetListOptions, relations?: RelationPaths<<a href='/reference/typescript-api/entities/asset#asset'>Asset</a>>) => Promise<<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a>`<<a href='/reference/typescript-api/entities/asset#asset'>`Asset</a>>>`} />
43
43
 
44
44
 
45
45
  ### getFeaturedAsset
@@ -72,7 +72,7 @@ a <DocsLink href="/reference/typescript-api/errors/error-types#channelnotfounder
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<<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>>>`} />
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
@@ -82,12 +82,12 @@ Returns the default Channel.
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<<a href='/reference/typescript-api/errors/error-result-union#errorresultunion'>ErrorResultUnion</a><CreateChannelResult, <a href='/reference/typescript-api/entities/channel#channel'>Channel</a>>>`} />
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<<a href='/reference/typescript-api/errors/error-result-union#errorresultunion'>ErrorResultUnion</a><UpdateChannelResult, <a href='/reference/typescript-api/entities/channel#channel'>Channel</a>>>`} />
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
@@ -47,7 +47,7 @@ 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<<a href='/reference/typescript-api/entities/collection#collection'>Collection</a>> &#38; { 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>>>>`} />
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>> &#38; { 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
@@ -115,7 +115,7 @@ will produce more queries the deeper the collection is in the tree.
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<<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>>>`} />
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
@@ -28,7 +28,7 @@ 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<<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>>>>`} />
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
@@ -29,7 +29,7 @@ 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<<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>>>`} />
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
@@ -39,7 +39,7 @@ class CustomerGroupService {
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<<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a><<a href='/reference/typescript-api/entities/customer#customer'>Customer</a>>>`} />
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
@@ -48,7 +48,7 @@ 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<<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>>>`} />
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
@@ -75,7 +75,7 @@ Returns all <DocsLink href="/reference/typescript-api/entities/address#address">
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<<a href='/reference/typescript-api/errors/error-result-union#errorresultunion'>ErrorResultUnion</a><CreateCustomerResult, <a href='/reference/typescript-api/entities/customer#customer'>Customer</a>>>`} />
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
 
@@ -92,12 +92,12 @@ This method is intended to be used in admin-created Customer flows.
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<<a href='/reference/typescript-api/errors/error-result-union#errorresultunion'>ErrorResultUnion</a><UpdateCustomerResult, <a href='/reference/typescript-api/entities/customer#customer'>Customer</a>>>`} />
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 &#38; { 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>>>`} />
100
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: UpdateCustomerInput | (UpdateCustomerShopInput &#38; { 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
@@ -117,7 +117,7 @@ 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<<a href='/reference/typescript-api/errors/error-result-union#errorresultunion'>ErrorResultUnion</a><VerifyCustomerAccountResult, <a href='/reference/typescript-api/entities/customer#customer'>Customer</a>>>`} />
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.
@@ -32,7 +32,7 @@ class FacetService {
32
32
 
33
33
  ### findAll
34
34
 
35
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, options?: ListQueryOptions<<a href='/reference/typescript-api/entities/facet#facet'>Facet</a>>, relations?: RelationPaths<<a href='/reference/typescript-api/entities/facet#facet'>Facet</a>>) => Promise<<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a><Translated<<a href='/reference/typescript-api/entities/facet#facet'>Facet</a>>>>`} />
35
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, options?: ListQueryOptions<<a href='/reference/typescript-api/entities/facet#facet'>Facet</a>>, relations?: RelationPaths<<a href='/reference/typescript-api/entities/facet#facet'>Facet</a>>) => Promise<<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a>`<Translated<<a href='/reference/typescript-api/entities/facet#facet'>`Facet</a>>>>`} />
36
36
 
37
37
 
38
38
  ### findOne
@@ -82,7 +82,7 @@ Returns the Facet which contains the given FacetValue id.
82
82
  Assigns Facets to the specified Channel
83
83
  ### removeFacetsFromChannel
84
84
 
85
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: RemoveFacetsFromChannelInput) => Promise<Array<<a href='/reference/typescript-api/errors/error-result-union#errorresultunion'>ErrorResultUnion</a><RemoveFacetFromChannelResult, <a href='/reference/typescript-api/entities/facet#facet'>Facet</a>>>>`} />
85
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: RemoveFacetsFromChannelInput) => Promise<Array<<a href='/reference/typescript-api/errors/error-result-union#errorresultunion'>ErrorResultUnion</a>`<RemoveFacetFromChannelResult, <a href='/reference/typescript-api/entities/facet#facet'>`Facet</a>>>>`} />
86
86
 
87
87
  Remove Facets from the specified Channel
88
88