@vendure/docs 0.0.0-202601201808 → 0.0.0-202601210957

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 (374) hide show
  1. package/docs/reference/admin-ui-api/action-bar/action-bar-context.mdx +1 -1
  2. package/docs/reference/admin-ui-api/action-bar/action-bar-dropdown-menu-item.mdx +2 -2
  3. package/docs/reference/admin-ui-api/action-bar/action-bar-item.mdx +3 -3
  4. package/docs/reference/admin-ui-api/alerts/alert-config.mdx +5 -5
  5. package/docs/reference/admin-ui-api/bulk-actions/bulk-action.mdx +6 -6
  6. package/docs/reference/admin-ui-api/components/asset-picker-dialog-component.mdx +4 -4
  7. package/docs/reference/admin-ui-api/components/currency-input-component.mdx +4 -4
  8. package/docs/reference/admin-ui-api/components/data-table-component.mdx +5 -5
  9. package/docs/reference/admin-ui-api/components/data-table2component.mdx +7 -7
  10. package/docs/reference/admin-ui-api/components/datetime-picker-component.mdx +7 -7
  11. package/docs/reference/admin-ui-api/components/dropdown-component.mdx +1 -1
  12. package/docs/reference/admin-ui-api/components/facet-value-selector-component.mdx +6 -6
  13. package/docs/reference/admin-ui-api/components/object-tree-component.mdx +1 -1
  14. package/docs/reference/admin-ui-api/components/product-variant-selector-component.mdx +1 -1
  15. package/docs/reference/admin-ui-api/components/rich-text-editor-component.mdx +2 -2
  16. package/docs/reference/admin-ui-api/components/zone-selector-component.mdx +3 -3
  17. package/docs/reference/admin-ui-api/custom-detail-components/custom-detail-component-config.mdx +1 -1
  18. package/docs/reference/admin-ui-api/custom-detail-components/custom-detail-component.mdx +1 -1
  19. package/docs/reference/admin-ui-api/custom-history-entry-components/history-entry-component.mdx +4 -4
  20. package/docs/reference/admin-ui-api/custom-history-entry-components/history-entry-config.mdx +1 -1
  21. package/docs/reference/admin-ui-api/custom-input-components/default-inputs.mdx +22 -22
  22. package/docs/reference/admin-ui-api/custom-input-components/register-form-input-component.mdx +1 -1
  23. package/docs/reference/admin-ui-api/custom-table-components/data-table-component-config.mdx +1 -1
  24. package/docs/reference/admin-ui-api/dashboard-widgets/dashboard-widget-config.mdx +1 -1
  25. package/docs/reference/admin-ui-api/directives/if-multichannel-directive.mdx +2 -2
  26. package/docs/reference/admin-ui-api/directives/if-permissions-directive.mdx +2 -2
  27. package/docs/reference/admin-ui-api/list-detail-views/base-detail-component.mdx +6 -6
  28. package/docs/reference/admin-ui-api/list-detail-views/base-entity-resolver.mdx +1 -1
  29. package/docs/reference/admin-ui-api/list-detail-views/base-list-component.mdx +8 -8
  30. package/docs/reference/admin-ui-api/list-detail-views/detail-component-with-resolver.mdx +1 -1
  31. package/docs/reference/admin-ui-api/list-detail-views/typed-base-detail-component.mdx +3 -3
  32. package/docs/reference/admin-ui-api/list-detail-views/typed-base-list-component.mdx +7 -7
  33. package/docs/reference/admin-ui-api/nav-menu/nav-menu-item.mdx +3 -3
  34. package/docs/reference/admin-ui-api/nav-menu/nav-menu-section.mdx +1 -1
  35. package/docs/reference/admin-ui-api/react-components/action-bar.mdx +1 -1
  36. package/docs/reference/admin-ui-api/react-components/card.mdx +1 -1
  37. package/docs/reference/admin-ui-api/react-components/cds-icon.mdx +1 -1
  38. package/docs/reference/admin-ui-api/react-components/form-field.mdx +1 -1
  39. package/docs/reference/admin-ui-api/react-components/link.mdx +1 -1
  40. package/docs/reference/admin-ui-api/react-components/page-detail-layout.mdx +1 -1
  41. package/docs/reference/admin-ui-api/react-extensions/react-custom-detail-component-config.mdx +1 -1
  42. package/docs/reference/admin-ui-api/react-extensions/react-data-table-component-config.mdx +1 -1
  43. package/docs/reference/admin-ui-api/react-extensions/register-react-route-component.mdx +1 -1
  44. package/docs/reference/admin-ui-api/react-hooks/use-injector.mdx +1 -1
  45. package/docs/reference/admin-ui-api/react-hooks/use-lazy-query.mdx +1 -1
  46. package/docs/reference/admin-ui-api/react-hooks/use-mutation.mdx +1 -1
  47. package/docs/reference/admin-ui-api/react-hooks/use-query.mdx +1 -1
  48. package/docs/reference/admin-ui-api/routes/register-route-component.mdx +1 -1
  49. package/docs/reference/admin-ui-api/services/data-service.mdx +10 -10
  50. package/docs/reference/admin-ui-api/services/modal-service.mdx +5 -5
  51. package/docs/reference/admin-ui-api/tabs/page-tab-config.mdx +1 -1
  52. package/docs/reference/admin-ui-api/ui-devkit/admin-ui-extension.mdx +2 -2
  53. package/docs/reference/core-plugins/admin-ui-plugin/admin-ui-plugin-options.mdx +1 -1
  54. package/docs/reference/core-plugins/admin-ui-plugin/index.mdx +1 -1
  55. package/docs/reference/core-plugins/asset-server-plugin/asset-server-options.mdx +2 -2
  56. package/docs/reference/core-plugins/asset-server-plugin/image-transform-strategy.mdx +1 -1
  57. package/docs/reference/core-plugins/asset-server-plugin/index.mdx +1 -1
  58. package/docs/reference/core-plugins/asset-server-plugin/local-asset-storage-strategy.mdx +8 -8
  59. package/docs/reference/core-plugins/asset-server-plugin/preset-only-strategy.mdx +1 -1
  60. package/docs/reference/core-plugins/asset-server-plugin/s3asset-storage-strategy.mdx +2 -2
  61. package/docs/reference/core-plugins/asset-server-plugin/sharp-asset-preview-strategy.mdx +1 -1
  62. package/docs/reference/core-plugins/dashboard-plugin/index.mdx +1 -1
  63. package/docs/reference/core-plugins/elasticsearch-plugin/elasticsearch-options.mdx +8 -8
  64. package/docs/reference/core-plugins/elasticsearch-plugin/index.mdx +1 -1
  65. package/docs/reference/core-plugins/email-plugin/email-event-handler-with-async-data.mdx +2 -2
  66. package/docs/reference/core-plugins/email-plugin/email-event-handler.mdx +13 -13
  67. package/docs/reference/core-plugins/email-plugin/email-event-listener.mdx +1 -1
  68. package/docs/reference/core-plugins/email-plugin/email-generator.mdx +2 -2
  69. package/docs/reference/core-plugins/email-plugin/email-plugin-options.mdx +3 -3
  70. package/docs/reference/core-plugins/email-plugin/email-plugin-types.mdx +1 -1
  71. package/docs/reference/core-plugins/email-plugin/email-sender.mdx +1 -1
  72. package/docs/reference/core-plugins/email-plugin/index.mdx +1 -1
  73. package/docs/reference/core-plugins/email-plugin/template-loader.mdx +4 -4
  74. package/docs/reference/core-plugins/email-plugin/transport-options.mdx +1 -1
  75. package/docs/reference/core-plugins/graphiql-plugin/index.mdx +2 -2
  76. package/docs/reference/core-plugins/harden-plugin/harden-plugin-options.mdx +1 -1
  77. package/docs/reference/core-plugins/job-queue-plugin/bull-mqjob-queue-strategy.mdx +9 -9
  78. package/docs/reference/core-plugins/job-queue-plugin/bull-mqplugin-options.mdx +5 -5
  79. package/docs/reference/core-plugins/job-queue-plugin/pub-sub-job-queue-strategy.mdx +3 -3
  80. package/docs/reference/core-plugins/job-queue-plugin/pub-sub-plugin.mdx +1 -1
  81. package/docs/reference/core-plugins/payments-plugin/braintree-plugin.mdx +2 -2
  82. package/docs/reference/core-plugins/payments-plugin/mollie-plugin.mdx +1 -1
  83. package/docs/reference/core-plugins/payments-plugin/stripe-plugin.mdx +5 -5
  84. package/docs/reference/core-plugins/stellate-plugin/purge-rule.mdx +4 -4
  85. package/docs/reference/core-plugins/stellate-plugin/stellate-service.mdx +1 -1
  86. package/docs/reference/core-plugins/telemetry-plugin/get-sdk-configuration.mdx +1 -1
  87. package/docs/reference/core-plugins/telemetry-plugin/register-method-hooks.mdx +2 -2
  88. package/docs/reference/core-plugins/telemetry-plugin/telemetry-plugin-options.mdx +1 -1
  89. package/docs/reference/dashboard/components/asset-gallery.mdx +3 -3
  90. package/docs/reference/dashboard/components/asset-picker-dialog.mdx +2 -2
  91. package/docs/reference/dashboard/components/channel-chip.mdx +1 -1
  92. package/docs/reference/dashboard/components/detail-page-button.mdx +1 -1
  93. package/docs/reference/dashboard/components/facet-value-selector.mdx +1 -1
  94. package/docs/reference/dashboard/components/permission-guard.mdx +1 -1
  95. package/docs/reference/dashboard/components/vendure-image.mdx +2 -2
  96. package/docs/reference/dashboard/detail-views/detail-page.mdx +3 -3
  97. package/docs/reference/dashboard/detail-views/use-detail-page.mdx +11 -11
  98. package/docs/reference/dashboard/detail-views/use-generated-form.mdx +3 -3
  99. package/docs/reference/dashboard/extensions-api/action-bar.mdx +1 -1
  100. package/docs/reference/dashboard/extensions-api/alerts.mdx +6 -6
  101. package/docs/reference/dashboard/extensions-api/data-tables.mdx +1 -1
  102. package/docs/reference/dashboard/extensions-api/detail-forms.mdx +1 -1
  103. package/docs/reference/dashboard/extensions-api/history-entries.mdx +2 -2
  104. package/docs/reference/dashboard/extensions-api/page-blocks.mdx +2 -2
  105. package/docs/reference/dashboard/extensions-api/routes.mdx +4 -4
  106. package/docs/reference/dashboard/extensions-api/widgets.mdx +1 -1
  107. package/docs/reference/dashboard/form-components/affixed-input.mdx +1 -1
  108. package/docs/reference/dashboard/form-components/boolean-input.mdx +1 -1
  109. package/docs/reference/dashboard/form-components/checkbox-input.mdx +1 -1
  110. package/docs/reference/dashboard/form-components/date-time-input.mdx +1 -1
  111. package/docs/reference/dashboard/form-components/form-field-wrapper.mdx +1 -1
  112. package/docs/reference/dashboard/form-components/money-input.mdx +1 -1
  113. package/docs/reference/dashboard/form-components/number-input.mdx +1 -1
  114. package/docs/reference/dashboard/form-components/password-input.mdx +1 -1
  115. package/docs/reference/dashboard/form-components/rich-text-input.mdx +1 -1
  116. package/docs/reference/dashboard/form-components/textarea-input.mdx +1 -1
  117. package/docs/reference/dashboard/hooks/use-alerts.mdx +1 -1
  118. package/docs/reference/dashboard/hooks/use-auth.mdx +5 -5
  119. package/docs/reference/dashboard/hooks/use-channel.mdx +2 -2
  120. package/docs/reference/dashboard/hooks/use-drag-and-drop.mdx +1 -1
  121. package/docs/reference/dashboard/list-views/bulk-actions.mdx +3 -3
  122. package/docs/reference/dashboard/list-views/data-table.mdx +10 -10
  123. package/docs/reference/dashboard/list-views/list-page.mdx +13 -13
  124. package/docs/reference/dashboard/list-views/paginated-list-data-table.mdx +17 -17
  125. package/docs/reference/dashboard/page-layout/index.mdx +1 -1
  126. package/docs/reference/dashboard/page-layout/page-action-bar.mdx +3 -3
  127. package/docs/reference/dashboard/page-layout/page-block.mdx +3 -3
  128. package/docs/reference/dashboard/page-layout/page-title.mdx +1 -1
  129. package/docs/reference/dashboard/page-layout/page.mdx +3 -3
  130. package/docs/reference/typescript-api/assets/asset-preview-strategy.mdx +1 -1
  131. package/docs/reference/typescript-api/assets/asset-storage-strategy.mdx +6 -6
  132. package/docs/reference/typescript-api/auth/auth-options.mdx +1 -1
  133. package/docs/reference/typescript-api/auth/authentication-strategy.mdx +2 -2
  134. package/docs/reference/typescript-api/auth/bcrypt-password-hashing-strategy.mdx +2 -2
  135. package/docs/reference/typescript-api/auth/default-session-cache-strategy.mdx +4 -4
  136. package/docs/reference/typescript-api/auth/external-authentication-service.mdx +5 -5
  137. package/docs/reference/typescript-api/auth/native-authentication-strategy.mdx +3 -3
  138. package/docs/reference/typescript-api/auth/password-hashing-strategy.mdx +2 -2
  139. package/docs/reference/typescript-api/auth/password-validation-strategy.mdx +1 -1
  140. package/docs/reference/typescript-api/auth/permission-definition.mdx +2 -2
  141. package/docs/reference/typescript-api/auth/session-cache-strategy.mdx +4 -4
  142. package/docs/reference/typescript-api/auth/verification-token-strategy.mdx +2 -2
  143. package/docs/reference/typescript-api/cache/cache-config.mdx +1 -1
  144. package/docs/reference/typescript-api/cache/cache-service.mdx +4 -4
  145. package/docs/reference/typescript-api/cache/cache-strategy.mdx +4 -4
  146. package/docs/reference/typescript-api/cache/index.mdx +3 -3
  147. package/docs/reference/typescript-api/cache/redis-cache-strategy.mdx +4 -4
  148. package/docs/reference/typescript-api/cache/request-context-cache-service.mdx +2 -2
  149. package/docs/reference/typescript-api/cache/self-refreshing-cache.mdx +6 -6
  150. package/docs/reference/typescript-api/cache/sql-cache-strategy.mdx +1 -1
  151. package/docs/reference/typescript-api/common/admin-ui/admin-ui-app-config.mdx +1 -1
  152. package/docs/reference/typescript-api/common/admin-ui/admin-ui-app-dev-mode-config.mdx +1 -1
  153. package/docs/reference/typescript-api/common/async-queue.mdx +1 -1
  154. package/docs/reference/typescript-api/common/bootstrap.mdx +2 -2
  155. package/docs/reference/typescript-api/common/injectable-strategy.mdx +2 -2
  156. package/docs/reference/typescript-api/common/injector.mdx +2 -2
  157. package/docs/reference/typescript-api/configurable-operation-def/config-args.mdx +1 -1
  158. package/docs/reference/typescript-api/configurable-operation-def/default-form-config-hash.mdx +11 -11
  159. package/docs/reference/typescript-api/configurable-operation-def/index.mdx +2 -2
  160. package/docs/reference/typescript-api/configuration/api-options.mdx +2 -2
  161. package/docs/reference/typescript-api/configuration/collection-filter.mdx +3 -3
  162. package/docs/reference/typescript-api/configuration/entity-duplicator.mdx +6 -6
  163. package/docs/reference/typescript-api/configuration/entity-id-strategy.mdx +4 -4
  164. package/docs/reference/typescript-api/configuration/entity-options.mdx +2 -2
  165. package/docs/reference/typescript-api/configuration/product-variant-price-selection-strategy.mdx +1 -1
  166. package/docs/reference/typescript-api/configuration/product-variant-price-update-strategy.mdx +3 -3
  167. package/docs/reference/typescript-api/configuration/runtime-vendure-config.mdx +15 -15
  168. package/docs/reference/typescript-api/configuration/slug-strategy.mdx +1 -1
  169. package/docs/reference/typescript-api/configuration/vendure-config.mdx +2 -2
  170. package/docs/reference/typescript-api/data-access/calculated-property-subscriber.mdx +1 -1
  171. package/docs/reference/typescript-api/data-access/calculated.mdx +1 -1
  172. package/docs/reference/typescript-api/data-access/entity-hydrator.mdx +1 -1
  173. package/docs/reference/typescript-api/data-access/get-entity-or-throw-options.mdx +1 -1
  174. package/docs/reference/typescript-api/data-access/hydrate-options.mdx +1 -1
  175. package/docs/reference/typescript-api/data-access/list-query-builder.mdx +4 -4
  176. package/docs/reference/typescript-api/data-access/transactional-connection.mdx +9 -9
  177. package/docs/reference/typescript-api/default-search-plugin/index.mdx +1 -1
  178. package/docs/reference/typescript-api/default-search-plugin/mysql-search-strategy.mdx +4 -4
  179. package/docs/reference/typescript-api/default-search-plugin/postgres-search-strategy.mdx +4 -4
  180. package/docs/reference/typescript-api/default-search-plugin/search-strategy.mdx +4 -4
  181. package/docs/reference/typescript-api/default-search-plugin/sqlite-search-strategy.mdx +4 -4
  182. package/docs/reference/typescript-api/entities/address.mdx +1 -1
  183. package/docs/reference/typescript-api/entities/administrator.mdx +1 -1
  184. package/docs/reference/typescript-api/entities/anonymous-session.mdx +1 -1
  185. package/docs/reference/typescript-api/entities/asset.mdx +1 -1
  186. package/docs/reference/typescript-api/entities/authenticated-session.mdx +1 -1
  187. package/docs/reference/typescript-api/entities/authentication-method.mdx +2 -2
  188. package/docs/reference/typescript-api/entities/channel.mdx +1 -1
  189. package/docs/reference/typescript-api/entities/collection.mdx +2 -2
  190. package/docs/reference/typescript-api/entities/country.mdx +1 -1
  191. package/docs/reference/typescript-api/entities/customer-group.mdx +1 -1
  192. package/docs/reference/typescript-api/entities/customer-history-entry.mdx +1 -1
  193. package/docs/reference/typescript-api/entities/customer.mdx +1 -1
  194. package/docs/reference/typescript-api/entities/facet-value.mdx +2 -2
  195. package/docs/reference/typescript-api/entities/facet.mdx +2 -2
  196. package/docs/reference/typescript-api/entities/fulfillment.mdx +1 -1
  197. package/docs/reference/typescript-api/entities/global-settings.mdx +1 -1
  198. package/docs/reference/typescript-api/entities/interfaces.mdx +1 -1
  199. package/docs/reference/typescript-api/entities/order-history-entry.mdx +1 -1
  200. package/docs/reference/typescript-api/entities/order-line-reference.mdx +3 -3
  201. package/docs/reference/typescript-api/entities/order-line.mdx +1 -1
  202. package/docs/reference/typescript-api/entities/order-modification.mdx +1 -1
  203. package/docs/reference/typescript-api/entities/order.mdx +1 -1
  204. package/docs/reference/typescript-api/entities/orderable-asset.mdx +1 -1
  205. package/docs/reference/typescript-api/entities/payment-method.mdx +2 -2
  206. package/docs/reference/typescript-api/entities/payment.mdx +1 -1
  207. package/docs/reference/typescript-api/entities/product-option-group.mdx +2 -2
  208. package/docs/reference/typescript-api/entities/product-option.mdx +2 -2
  209. package/docs/reference/typescript-api/entities/product-variant-price.mdx +1 -1
  210. package/docs/reference/typescript-api/entities/product-variant.mdx +2 -2
  211. package/docs/reference/typescript-api/entities/product.mdx +2 -2
  212. package/docs/reference/typescript-api/entities/promotion.mdx +4 -4
  213. package/docs/reference/typescript-api/entities/province.mdx +1 -1
  214. package/docs/reference/typescript-api/entities/refund.mdx +1 -1
  215. package/docs/reference/typescript-api/entities/region.mdx +1 -1
  216. package/docs/reference/typescript-api/entities/role.mdx +1 -1
  217. package/docs/reference/typescript-api/entities/seller.mdx +1 -1
  218. package/docs/reference/typescript-api/entities/settings-store-entry.mdx +1 -1
  219. package/docs/reference/typescript-api/entities/shipping-line.mdx +1 -1
  220. package/docs/reference/typescript-api/entities/shipping-method.mdx +4 -4
  221. package/docs/reference/typescript-api/entities/stock-level.mdx +1 -1
  222. package/docs/reference/typescript-api/entities/stock-location.mdx +1 -1
  223. package/docs/reference/typescript-api/entities/stock-movement.mdx +5 -5
  224. package/docs/reference/typescript-api/entities/surcharge.mdx +1 -1
  225. package/docs/reference/typescript-api/entities/tag.mdx +1 -1
  226. package/docs/reference/typescript-api/entities/tax-category.mdx +1 -1
  227. package/docs/reference/typescript-api/entities/tax-rate.mdx +1 -1
  228. package/docs/reference/typescript-api/entities/user.mdx +1 -1
  229. package/docs/reference/typescript-api/entities/vendure-entity.mdx +1 -1
  230. package/docs/reference/typescript-api/entities/zone.mdx +1 -1
  231. package/docs/reference/typescript-api/errors/error-handler-strategy.mdx +2 -2
  232. package/docs/reference/typescript-api/events/blocking-event-handler-options.mdx +2 -2
  233. package/docs/reference/typescript-api/events/event-bus.mdx +4 -4
  234. package/docs/reference/typescript-api/events/event-types.mdx +30 -30
  235. package/docs/reference/typescript-api/fulfillment/fulfillment-handler.mdx +5 -5
  236. package/docs/reference/typescript-api/fulfillment/fulfillment-process.mdx +4 -4
  237. package/docs/reference/typescript-api/import-export/asset-import-strategy.mdx +1 -1
  238. package/docs/reference/typescript-api/import-export/asset-importer.mdx +1 -1
  239. package/docs/reference/typescript-api/import-export/fast-importer-service.mdx +4 -4
  240. package/docs/reference/typescript-api/import-export/import-parser.mdx +5 -5
  241. package/docs/reference/typescript-api/import-export/importer.mdx +3 -3
  242. package/docs/reference/typescript-api/import-export/initial-data.mdx +3 -3
  243. package/docs/reference/typescript-api/import-export/populate.mdx +1 -1
  244. package/docs/reference/typescript-api/job-queue/default-job-queue-plugin.mdx +5 -5
  245. package/docs/reference/typescript-api/job-queue/in-memory-job-buffer-storage-strategy.mdx +3 -3
  246. package/docs/reference/typescript-api/job-queue/in-memory-job-queue-strategy.mdx +8 -8
  247. package/docs/reference/typescript-api/job-queue/index.mdx +2 -2
  248. package/docs/reference/typescript-api/job-queue/inspectable-job-queue-strategy.mdx +5 -5
  249. package/docs/reference/typescript-api/job-queue/job-buffer-storage-strategy.mdx +3 -3
  250. package/docs/reference/typescript-api/job-queue/job-buffer.mdx +2 -2
  251. package/docs/reference/typescript-api/job-queue/job-queue-service.mdx +6 -6
  252. package/docs/reference/typescript-api/job-queue/job-queue-strategy.mdx +3 -3
  253. package/docs/reference/typescript-api/job-queue/job.mdx +3 -3
  254. package/docs/reference/typescript-api/job-queue/polling-job-queue-strategy.mdx +8 -8
  255. package/docs/reference/typescript-api/job-queue/sql-job-queue-strategy.mdx +6 -6
  256. package/docs/reference/typescript-api/job-queue/subscribable-job.mdx +3 -3
  257. package/docs/reference/typescript-api/job-queue/types.mdx +1 -1
  258. package/docs/reference/typescript-api/migration/generate-migration.mdx +1 -1
  259. package/docs/reference/typescript-api/migration/revert-last-migration.mdx +1 -1
  260. package/docs/reference/typescript-api/migration/run-migrations.mdx +1 -1
  261. package/docs/reference/typescript-api/orders/active-order-service.mdx +6 -6
  262. package/docs/reference/typescript-api/orders/active-order-strategy.mdx +3 -3
  263. package/docs/reference/typescript-api/orders/changed-price-handling-strategy.mdx +1 -1
  264. package/docs/reference/typescript-api/orders/default-guest-checkout-strategy.mdx +1 -1
  265. package/docs/reference/typescript-api/orders/default-order-item-price-calculation-strategy.mdx +1 -1
  266. package/docs/reference/typescript-api/orders/default-stock-allocation-strategy.mdx +1 -1
  267. package/docs/reference/typescript-api/orders/guest-checkout-strategy.mdx +1 -1
  268. package/docs/reference/typescript-api/orders/order-by-code-access-strategy.mdx +1 -1
  269. package/docs/reference/typescript-api/orders/order-code-strategy.mdx +1 -1
  270. package/docs/reference/typescript-api/orders/order-interceptor.mdx +3 -3
  271. package/docs/reference/typescript-api/orders/order-item-price-calculation-strategy.mdx +1 -1
  272. package/docs/reference/typescript-api/orders/order-options.mdx +2 -2
  273. package/docs/reference/typescript-api/orders/order-placed-strategy.mdx +1 -1
  274. package/docs/reference/typescript-api/orders/order-process.mdx +4 -4
  275. package/docs/reference/typescript-api/orders/order-seller-strategy.mdx +3 -3
  276. package/docs/reference/typescript-api/orders/stock-allocation-strategy.mdx +1 -1
  277. package/docs/reference/typescript-api/payment/payment-method-config-options.mdx +6 -6
  278. package/docs/reference/typescript-api/payment/payment-method-eligibility-checker.mdx +4 -4
  279. package/docs/reference/typescript-api/payment/payment-method-handler.mdx +2 -2
  280. package/docs/reference/typescript-api/payment/payment-method-types.mdx +3 -3
  281. package/docs/reference/typescript-api/payment/payment-options.mdx +3 -3
  282. package/docs/reference/typescript-api/payment/payment-process.mdx +4 -4
  283. package/docs/reference/typescript-api/payment/refund-process.mdx +4 -4
  284. package/docs/reference/typescript-api/plugin/vendure-plugin-metadata.mdx +4 -4
  285. package/docs/reference/typescript-api/products-stock/catalog-options.mdx +1 -1
  286. package/docs/reference/typescript-api/products-stock/default-product-variant-price-calculation-strategy.mdx +1 -1
  287. package/docs/reference/typescript-api/products-stock/default-stock-location-strategy.mdx +1 -1
  288. package/docs/reference/typescript-api/products-stock/multi-channel-stock-location-strategy.mdx +2 -2
  289. package/docs/reference/typescript-api/products-stock/product-variant-price-calculation-strategy.mdx +1 -1
  290. package/docs/reference/typescript-api/products-stock/stock-display-strategy.mdx +1 -1
  291. package/docs/reference/typescript-api/products-stock/stock-location-strategy.mdx +5 -5
  292. package/docs/reference/typescript-api/promotions/facet-value-checker.mdx +1 -1
  293. package/docs/reference/typescript-api/promotions/promotion-action.mdx +22 -22
  294. package/docs/reference/typescript-api/promotions/promotion-condition.mdx +5 -5
  295. package/docs/reference/typescript-api/promotions/promotion-options.mdx +2 -2
  296. package/docs/reference/typescript-api/request/request-context-service.mdx +2 -2
  297. package/docs/reference/typescript-api/scheduled-tasks/default-scheduler-strategy.mdx +4 -4
  298. package/docs/reference/typescript-api/scheduled-tasks/scheduled-task.mdx +4 -4
  299. package/docs/reference/typescript-api/scheduled-tasks/scheduler-service.mdx +3 -3
  300. package/docs/reference/typescript-api/scheduled-tasks/scheduler-strategy.mdx +5 -5
  301. package/docs/reference/typescript-api/service-helpers/entity-duplicator-service.mdx +1 -1
  302. package/docs/reference/typescript-api/service-helpers/order-calculator.mdx +1 -1
  303. package/docs/reference/typescript-api/service-helpers/order-modifier.mdx +3 -3
  304. package/docs/reference/typescript-api/service-helpers/product-price-applicator.mdx +1 -1
  305. package/docs/reference/typescript-api/service-helpers/slug-validator.mdx +2 -2
  306. package/docs/reference/typescript-api/service-helpers/translatable-saver.mdx +2 -2
  307. package/docs/reference/typescript-api/service-helpers/translator-service.mdx +1 -1
  308. package/docs/reference/typescript-api/services/administrator-service.mdx +6 -6
  309. package/docs/reference/typescript-api/services/asset-service.mdx +13 -13
  310. package/docs/reference/typescript-api/services/auth-service.mdx +4 -4
  311. package/docs/reference/typescript-api/services/channel-service.mdx +12 -12
  312. package/docs/reference/typescript-api/services/collection-service.mdx +20 -20
  313. package/docs/reference/typescript-api/services/country-service.mdx +7 -7
  314. package/docs/reference/typescript-api/services/customer-group-service.mdx +8 -8
  315. package/docs/reference/typescript-api/services/customer-service.mdx +24 -24
  316. package/docs/reference/typescript-api/services/entity-slug-service.mdx +1 -1
  317. package/docs/reference/typescript-api/services/facet-service.mdx +11 -11
  318. package/docs/reference/typescript-api/services/facet-value-service.mdx +12 -12
  319. package/docs/reference/typescript-api/services/fulfillment-service.mdx +4 -4
  320. package/docs/reference/typescript-api/services/global-settings-service.mdx +2 -2
  321. package/docs/reference/typescript-api/services/history-service.mdx +8 -8
  322. package/docs/reference/typescript-api/services/order-service.mdx +52 -52
  323. package/docs/reference/typescript-api/services/order-testing-service.mdx +2 -2
  324. package/docs/reference/typescript-api/services/payment-method-service.mdx +10 -10
  325. package/docs/reference/typescript-api/services/payment-service.mdx +7 -7
  326. package/docs/reference/typescript-api/services/product-option-group-service.mdx +5 -5
  327. package/docs/reference/typescript-api/services/product-option-service.mdx +5 -5
  328. package/docs/reference/typescript-api/services/product-service.mdx +13 -13
  329. package/docs/reference/typescript-api/services/product-variant-service.mdx +22 -22
  330. package/docs/reference/typescript-api/services/promotion-service.mdx +9 -9
  331. package/docs/reference/typescript-api/services/province-service.mdx +5 -5
  332. package/docs/reference/typescript-api/services/role-service.mdx +11 -11
  333. package/docs/reference/typescript-api/services/search-service.mdx +2 -2
  334. package/docs/reference/typescript-api/services/seller-service.mdx +3 -3
  335. package/docs/reference/typescript-api/services/session-service.mdx +8 -8
  336. package/docs/reference/typescript-api/services/settings-store-service.mdx +15 -15
  337. package/docs/reference/typescript-api/services/shipping-method-service.mdx +8 -8
  338. package/docs/reference/typescript-api/services/slug-service.mdx +1 -1
  339. package/docs/reference/typescript-api/services/stock-level-service.mdx +3 -3
  340. package/docs/reference/typescript-api/services/stock-location-service.mdx +7 -7
  341. package/docs/reference/typescript-api/services/stock-movement-service.mdx +7 -7
  342. package/docs/reference/typescript-api/services/tag-service.mdx +5 -5
  343. package/docs/reference/typescript-api/services/tax-category-service.mdx +5 -5
  344. package/docs/reference/typescript-api/services/tax-rate-service.mdx +6 -6
  345. package/docs/reference/typescript-api/services/user-service.mdx +12 -12
  346. package/docs/reference/typescript-api/services/zone-service.mdx +8 -8
  347. package/docs/reference/typescript-api/settings-store/settings-store-field-config.mdx +2 -2
  348. package/docs/reference/typescript-api/shipping/default-shipping-line-assignment-strategy.mdx +1 -1
  349. package/docs/reference/typescript-api/shipping/shipping-calculator.mdx +3 -3
  350. package/docs/reference/typescript-api/shipping/shipping-eligibility-checker-config.mdx +3 -3
  351. package/docs/reference/typescript-api/shipping/shipping-eligibility-checker.mdx +2 -2
  352. package/docs/reference/typescript-api/shipping/shipping-line-assignment-strategy.mdx +1 -1
  353. package/docs/reference/typescript-api/shipping/shipping-options.mdx +5 -5
  354. package/docs/reference/typescript-api/state-machine/fsm.mdx +2 -2
  355. package/docs/reference/typescript-api/state-machine/state-machine-config.mdx +4 -4
  356. package/docs/reference/typescript-api/tax/tax-line-calculation-strategy.mdx +1 -1
  357. package/docs/reference/typescript-api/tax/tax-zone-strategy.mdx +1 -1
  358. package/docs/reference/typescript-api/telemetry/wrapped-method-args.mdx +2 -2
  359. package/docs/reference/typescript-api/testing/create-error-result-guard.mdx +1 -1
  360. package/docs/reference/typescript-api/testing/create-test-environment.mdx +1 -1
  361. package/docs/reference/typescript-api/testing/error-result-guard.mdx +1 -1
  362. package/docs/reference/typescript-api/testing/register-initializer.mdx +1 -1
  363. package/docs/reference/typescript-api/testing/simple-graph-qlclient.mdx +5 -5
  364. package/docs/reference/typescript-api/testing/test-db-initializer.mdx +3 -3
  365. package/docs/reference/typescript-api/testing/test-server.mdx +2 -2
  366. package/docs/reference/typescript-api/testing/testing-logger.mdx +1 -1
  367. package/docs/reference/typescript-api/worker/bootstrap-worker.mdx +2 -2
  368. package/docs/reference/typescript-api/worker/vendure-worker.mdx +2 -2
  369. package/package.json +1 -1
  370. package/docs/reference/admin-ui-api/index.mdx +0 -4
  371. package/docs/reference/dashboard/index.mdx +0 -4
  372. package/docs/reference/graphql-api/admin/_index.mdx +0 -4
  373. package/docs/reference/graphql-api/shop/_index.mdx +0 -4
  374. package/docs/reference/typescript-api/_index.mdx +0 -4
@@ -44,27 +44,27 @@ class RoleService {
44
44
 
45
45
  ### findAll
46
46
 
47
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, options?: ListQueryOptions&#60;<a href='/reference/typescript-api/entities/role#role'>Role</a>&#62;, relations?: RelationPaths&#60;<a href='/reference/typescript-api/entities/role#role'>Role</a>&#62;) => Promise&#60;<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a>&#60;<a href='/reference/typescript-api/entities/role#role'>Role</a>&#62;&#62;`} />
47
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, options?: ListQueryOptions<<a href='/reference/typescript-api/entities/role#role'>Role</a>>, relations?: RelationPaths<<a href='/reference/typescript-api/entities/role#role'>Role</a>>) => Promise<<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a><<a href='/reference/typescript-api/entities/role#role'>Role</a>>>`} />
48
48
 
49
49
 
50
50
  ### findOne
51
51
 
52
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, roleId: <a href='/reference/typescript-api/common/id#id'>ID</a>, relations?: RelationPaths&#60;<a href='/reference/typescript-api/entities/role#role'>Role</a>&#62;) => Promise&#60;<a href='/reference/typescript-api/entities/role#role'>Role</a> | undefined&#62;`} />
52
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, roleId: <a href='/reference/typescript-api/common/id#id'>ID</a>, relations?: RelationPaths<<a href='/reference/typescript-api/entities/role#role'>Role</a>>) => Promise<<a href='/reference/typescript-api/entities/role#role'>Role</a> | undefined>`} />
53
53
 
54
54
 
55
55
  ### getChannelsForRole
56
56
 
57
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, roleId: <a href='/reference/typescript-api/common/id#id'>ID</a>) => Promise&#60;<a href='/reference/typescript-api/entities/channel#channel'>Channel</a>[]&#62;`} />
57
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, roleId: <a href='/reference/typescript-api/common/id#id'>ID</a>) => Promise<<a href='/reference/typescript-api/entities/channel#channel'>Channel</a>[]>`} />
58
58
 
59
59
 
60
60
  ### getSuperAdminRole
61
61
 
62
- <MemberInfo kind="method" type={`(ctx?: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => Promise&#60;<a href='/reference/typescript-api/entities/role#role'>Role</a>&#62;`} />
62
+ <MemberInfo kind="method" type={`(ctx?: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => Promise<<a href='/reference/typescript-api/entities/role#role'>Role</a>>`} />
63
63
 
64
64
  Returns the special SuperAdmin Role, which always exists in Vendure.
65
65
  ### getCustomerRole
66
66
 
67
- <MemberInfo kind="method" type={`(ctx?: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => Promise&#60;<a href='/reference/typescript-api/entities/role#role'>Role</a>&#62;`} />
67
+ <MemberInfo kind="method" type={`(ctx?: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => Promise<<a href='/reference/typescript-api/entities/role#role'>Role</a>>`} />
68
68
 
69
69
  Returns the special Customer Role, which always exists in Vendure.
70
70
  ### getAllPermissions
@@ -74,32 +74,32 @@ Returns the special Customer Role, which always exists in Vendure.
74
74
  Returns all the valid Permission values
75
75
  ### userHasPermissionOnChannel
76
76
 
77
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, channelId: <a href='/reference/typescript-api/common/id#id'>ID</a>, permission: <a href='/reference/typescript-api/common/permission#permission'>Permission</a>) => Promise&#60;boolean&#62;`} />
77
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, channelId: <a href='/reference/typescript-api/common/id#id'>ID</a>, permission: <a href='/reference/typescript-api/common/permission#permission'>Permission</a>) => Promise<boolean>`} />
78
78
 
79
79
  Returns true if the User has the specified permission on that Channel
80
80
  ### userHasAnyPermissionsOnChannel
81
81
 
82
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, channelId: <a href='/reference/typescript-api/common/id#id'>ID</a>, permissions: <a href='/reference/typescript-api/common/permission#permission'>Permission</a>[]) => Promise&#60;boolean&#62;`} />
82
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, channelId: <a href='/reference/typescript-api/common/id#id'>ID</a>, permissions: <a href='/reference/typescript-api/common/permission#permission'>Permission</a>[]) => Promise<boolean>`} />
83
83
 
84
84
  Returns true if the User has any of the specified permissions on that Channel
85
85
  ### userHasAllPermissionsOnChannel
86
86
 
87
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, channelId: <a href='/reference/typescript-api/common/id#id'>ID</a>, permissions: <a href='/reference/typescript-api/common/permission#permission'>Permission</a>[]) => Promise&#60;boolean&#62;`} />
87
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, channelId: <a href='/reference/typescript-api/common/id#id'>ID</a>, permissions: <a href='/reference/typescript-api/common/permission#permission'>Permission</a>[]) => Promise<boolean>`} />
88
88
 
89
89
  Returns true if the User has all the specified permissions on that Channel
90
90
  ### create
91
91
 
92
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: CreateRoleInput) => Promise&#60;<a href='/reference/typescript-api/entities/role#role'>Role</a>&#62;`} />
92
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: CreateRoleInput) => Promise<<a href='/reference/typescript-api/entities/role#role'>Role</a>>`} />
93
93
 
94
94
 
95
95
  ### update
96
96
 
97
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: UpdateRoleInput) => Promise&#60;<a href='/reference/typescript-api/entities/role#role'>Role</a>&#62;`} />
97
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: UpdateRoleInput) => Promise<<a href='/reference/typescript-api/entities/role#role'>Role</a>>`} />
98
98
 
99
99
 
100
100
  ### delete
101
101
 
102
- <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&#60;DeletionResponse&#62;`} />
102
+ <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>`} />
103
103
 
104
104
 
105
105
  ### assignRoleToChannel
@@ -22,13 +22,13 @@ class SearchService {
22
22
 
23
23
  ### adopt
24
24
 
25
- <MemberInfo kind="method" type={`(override: Pick&#60;<a href='/reference/typescript-api/services/search-service#searchservice'>SearchService</a>, 'reindex'&#62;) => `} />
25
+ <MemberInfo kind="method" type={`(override: Pick<<a href='/reference/typescript-api/services/search-service#searchservice'>SearchService</a>, 'reindex'>) => `} />
26
26
 
27
27
  Adopt a concrete search service implementation to pass through the
28
28
  calls to.
29
29
  ### reindex
30
30
 
31
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => Promise&#60;<a href='/reference/typescript-api/job-queue/job#job'>Job</a>&#62;`} />
31
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => Promise<<a href='/reference/typescript-api/job-queue/job#job'>Job</a>>`} />
32
32
 
33
33
 
34
34
 
@@ -36,12 +36,12 @@ class SellerService {
36
36
 
37
37
  ### findAll
38
38
 
39
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, options?: ListQueryOptions&#60;<a href='/reference/typescript-api/entities/seller#seller'>Seller</a>&#62;) => Promise&#60;<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a>&#60;<a href='/reference/typescript-api/entities/seller#seller'>Seller</a>&#62;&#62;`} />
39
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, options?: ListQueryOptions<<a href='/reference/typescript-api/entities/seller#seller'>Seller</a>>) => Promise<<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a><<a href='/reference/typescript-api/entities/seller#seller'>Seller</a>>>`} />
40
40
 
41
41
 
42
42
  ### findOne
43
43
 
44
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, sellerId: <a href='/reference/typescript-api/common/id#id'>ID</a>) => Promise&#60;<a href='/reference/typescript-api/entities/seller#seller'>Seller</a> | undefined&#62;`} />
44
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, sellerId: <a href='/reference/typescript-api/common/id#id'>ID</a>) => Promise<<a href='/reference/typescript-api/entities/seller#seller'>Seller</a> | undefined>`} />
45
45
 
46
46
 
47
47
  ### create
@@ -56,7 +56,7 @@ class SellerService {
56
56
 
57
57
  ### delete
58
58
 
59
- <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&#60;DeletionResponse&#62;`} />
59
+ <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>`} />
60
60
 
61
61
 
62
62
 
@@ -45,18 +45,18 @@ class SessionService implements EntitySubscriberInterface, OnApplicationBootstra
45
45
 
46
46
  ### createNewAuthenticatedSession
47
47
 
48
- <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&#60;<a href='/reference/typescript-api/entities/authenticated-session#authenticatedsession'>AuthenticatedSession</a>&#62;`} />
48
+ <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>>`} />
49
49
 
50
50
  Creates a new <a href='/reference/typescript-api/entities/authenticated-session#authenticatedsession'>AuthenticatedSession</a>. To be used after successful authentication.
51
51
  ### createAnonymousSession
52
52
 
53
- <MemberInfo kind="method" type={`() => Promise&#60;<a href='/reference/typescript-api/auth/session-cache-strategy#cachedsession'>CachedSession</a>&#62;`} />
53
+ <MemberInfo kind="method" type={`() => Promise<<a href='/reference/typescript-api/auth/session-cache-strategy#cachedsession'>CachedSession</a>>`} />
54
54
 
55
55
  Create an <a href='/reference/typescript-api/entities/anonymous-session#anonymoussession'>AnonymousSession</a> and caches it using the configured <a href='/reference/typescript-api/auth/session-cache-strategy#sessioncachestrategy'>SessionCacheStrategy</a>,
56
56
  and returns the cached session object.
57
57
  ### getSessionFromToken
58
58
 
59
- <MemberInfo kind="method" type={`(sessionToken: string) => Promise&#60;<a href='/reference/typescript-api/auth/session-cache-strategy#cachedsession'>CachedSession</a> | undefined&#62;`} />
59
+ <MemberInfo kind="method" type={`(sessionToken: string) => Promise<<a href='/reference/typescript-api/auth/session-cache-strategy#cachedsession'>CachedSession</a> | undefined>`} />
60
60
 
61
61
  Returns the cached session object matching the given session token.
62
62
  ### serializeSession
@@ -66,27 +66,27 @@ Returns the cached session object matching the given session token.
66
66
  Serializes a <a href='/reference/typescript-api/entities/session#session'>Session</a> instance into a simplified plain object suitable for caching.
67
67
  ### setActiveOrder
68
68
 
69
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, serializedSession: <a href='/reference/typescript-api/auth/session-cache-strategy#cachedsession'>CachedSession</a>, order: <a href='/reference/typescript-api/entities/order#order'>Order</a>) => Promise&#60;<a href='/reference/typescript-api/auth/session-cache-strategy#cachedsession'>CachedSession</a>&#62;`} />
69
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, serializedSession: <a href='/reference/typescript-api/auth/session-cache-strategy#cachedsession'>CachedSession</a>, order: <a href='/reference/typescript-api/entities/order#order'>Order</a>) => Promise<<a href='/reference/typescript-api/auth/session-cache-strategy#cachedsession'>CachedSession</a>>`} />
70
70
 
71
71
  Sets the `activeOrder` on the given cached session object and updates the cache.
72
72
  ### unsetActiveOrder
73
73
 
74
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, serializedSession: <a href='/reference/typescript-api/auth/session-cache-strategy#cachedsession'>CachedSession</a>) => Promise&#60;<a href='/reference/typescript-api/auth/session-cache-strategy#cachedsession'>CachedSession</a>&#62;`} />
74
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, serializedSession: <a href='/reference/typescript-api/auth/session-cache-strategy#cachedsession'>CachedSession</a>) => Promise<<a href='/reference/typescript-api/auth/session-cache-strategy#cachedsession'>CachedSession</a>>`} />
75
75
 
76
76
  Clears the `activeOrder` on the given cached session object and updates the cache.
77
77
  ### setActiveChannel
78
78
 
79
- <MemberInfo kind="method" type={`(serializedSession: <a href='/reference/typescript-api/auth/session-cache-strategy#cachedsession'>CachedSession</a>, channel: <a href='/reference/typescript-api/entities/channel#channel'>Channel</a>) => Promise&#60;<a href='/reference/typescript-api/auth/session-cache-strategy#cachedsession'>CachedSession</a>&#62;`} />
79
+ <MemberInfo kind="method" type={`(serializedSession: <a href='/reference/typescript-api/auth/session-cache-strategy#cachedsession'>CachedSession</a>, channel: <a href='/reference/typescript-api/entities/channel#channel'>Channel</a>) => Promise<<a href='/reference/typescript-api/auth/session-cache-strategy#cachedsession'>CachedSession</a>>`} />
80
80
 
81
81
  Sets the `activeChannel` on the given cached session object and updates the cache.
82
82
  ### deleteSessionsByUser
83
83
 
84
- <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>) => Promise&#60;void&#62;`} />
84
+ <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>) => Promise<void>`} />
85
85
 
86
86
  Deletes all existing sessions for the given user.
87
87
  ### deleteSessionsByActiveOrderId
88
88
 
89
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, activeOrderId: <a href='/reference/typescript-api/common/id#id'>ID</a>) => Promise&#60;void&#62;`} />
89
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, activeOrderId: <a href='/reference/typescript-api/common/id#id'>ID</a>) => Promise<void>`} />
90
90
 
91
91
  Deletes all existing sessions with the given activeOrder.
92
92
  ### triggerCleanSessionsJob
@@ -81,68 +81,68 @@ Register settings store fields. This is typically called during application
81
81
  bootstrap when processing the VendureConfig.
82
82
  ### get
83
83
 
84
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, key: string) => Promise&#60;T | undefined&#62;`} />
84
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, key: string) => Promise<T | undefined>`} />
85
85
 
86
86
  Get a value for the specified key. The value is automatically scoped
87
87
  according to the field's scope configuration.
88
88
  ### get
89
89
 
90
- <MemberInfo kind="method" type={`(key: string, ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => Promise&#60;T | undefined&#62;`} />
90
+ <MemberInfo kind="method" type={`(key: string, ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => Promise<T | undefined>`} />
91
91
 
92
92
 
93
93
  ### get
94
94
 
95
- <MemberInfo kind="method" type={`(keyOrCtx: string | <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, ctxOrKey: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a> | string) => Promise&#60;T | undefined&#62;`} />
95
+ <MemberInfo kind="method" type={`(keyOrCtx: string | <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, ctxOrKey: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a> | string) => Promise<T | undefined>`} />
96
96
 
97
97
 
98
98
  ### getMany
99
99
 
100
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, keys: string[]) => Promise&#60;Record&#60;string, <a href='/reference/typescript-api/common/json-compatible#jsoncompatible'>JsonCompatible</a>&#60;any&#62;&#62;&#62;`} />
100
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, keys: string[]) => Promise<Record<string, <a href='/reference/typescript-api/common/json-compatible#jsoncompatible'>JsonCompatible</a><any>>>`} />
101
101
 
102
102
  Get multiple values efficiently. Each key is scoped according to
103
103
  its individual field configuration.
104
104
  ### getMany
105
105
 
106
- <MemberInfo kind="method" type={`(keys: string[], ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => Promise&#60;Record&#60;string, <a href='/reference/typescript-api/common/json-compatible#jsoncompatible'>JsonCompatible</a>&#60;any&#62;&#62;&#62;`} />
106
+ <MemberInfo kind="method" type={`(keys: string[], ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => Promise<Record<string, <a href='/reference/typescript-api/common/json-compatible#jsoncompatible'>JsonCompatible</a><any>>>`} />
107
107
 
108
108
 
109
109
  ### getMany
110
110
 
111
- <MemberInfo kind="method" type={`(keysOrCtx: string[] | <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, ctxOrKeys: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a> | string[]) => Promise&#60;Record&#60;string, <a href='/reference/typescript-api/common/json-compatible#jsoncompatible'>JsonCompatible</a>&#60;any&#62;&#62;&#62;`} />
111
+ <MemberInfo kind="method" type={`(keysOrCtx: string[] | <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, ctxOrKeys: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a> | string[]) => Promise<Record<string, <a href='/reference/typescript-api/common/json-compatible#jsoncompatible'>JsonCompatible</a><any>>>`} />
112
112
 
113
113
 
114
114
  ### set
115
115
 
116
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, key: string, value: T) => Promise&#60;<a href='/reference/typescript-api/settings-store/set-settings-store-value-result#setsettingsstorevalueresult'>SetSettingsStoreValueResult</a>&#62;`} />
116
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, key: string, value: T) => Promise<<a href='/reference/typescript-api/settings-store/set-settings-store-value-result#setsettingsstorevalueresult'>SetSettingsStoreValueResult</a>>`} />
117
117
 
118
118
  Set a value for the specified key with structured result feedback.
119
119
  This version returns detailed information about the success or failure
120
120
  of the operation instead of throwing errors.
121
121
  ### set
122
122
 
123
- <MemberInfo kind="method" type={`(key: string, value: T, ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => Promise&#60;<a href='/reference/typescript-api/settings-store/set-settings-store-value-result#setsettingsstorevalueresult'>SetSettingsStoreValueResult</a>&#62;`} />
123
+ <MemberInfo kind="method" type={`(key: string, value: T, ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => Promise<<a href='/reference/typescript-api/settings-store/set-settings-store-value-result#setsettingsstorevalueresult'>SetSettingsStoreValueResult</a>>`} />
124
124
 
125
125
 
126
126
  ### set
127
127
 
128
- <MemberInfo kind="method" type={`(keyOrCtx: string | <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, keyOrValue: string | T, ctxOrValue: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a> | T) => Promise&#60;<a href='/reference/typescript-api/settings-store/set-settings-store-value-result#setsettingsstorevalueresult'>SetSettingsStoreValueResult</a>&#62;`} />
128
+ <MemberInfo kind="method" type={`(keyOrCtx: string | <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, keyOrValue: string | T, ctxOrValue: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a> | T) => Promise<<a href='/reference/typescript-api/settings-store/set-settings-store-value-result#setsettingsstorevalueresult'>SetSettingsStoreValueResult</a>>`} />
129
129
 
130
130
 
131
131
  ### setMany
132
132
 
133
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, values: Record&#60;string, <a href='/reference/typescript-api/common/json-compatible#jsoncompatible'>JsonCompatible</a>&#60;any&#62;&#62;) => Promise&#60;<a href='/reference/typescript-api/settings-store/set-settings-store-value-result#setsettingsstorevalueresult'>SetSettingsStoreValueResult</a>[]&#62;`} />
133
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, values: Record<string, <a href='/reference/typescript-api/common/json-compatible#jsoncompatible'>JsonCompatible</a><any>>) => Promise<<a href='/reference/typescript-api/settings-store/set-settings-store-value-result#setsettingsstorevalueresult'>SetSettingsStoreValueResult</a>[]>`} />
134
134
 
135
135
  Set multiple values with structured result feedback for each operation.
136
136
  This method will not throw errors but will return
137
137
  detailed results for each key-value pair.
138
138
  ### setMany
139
139
 
140
- <MemberInfo kind="method" type={`(values: Record&#60;string, <a href='/reference/typescript-api/common/json-compatible#jsoncompatible'>JsonCompatible</a>&#60;any&#62;&#62;, ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => Promise&#60;<a href='/reference/typescript-api/settings-store/set-settings-store-value-result#setsettingsstorevalueresult'>SetSettingsStoreValueResult</a>[]&#62;`} />
140
+ <MemberInfo kind="method" type={`(values: Record<string, <a href='/reference/typescript-api/common/json-compatible#jsoncompatible'>JsonCompatible</a><any>>, ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => Promise<<a href='/reference/typescript-api/settings-store/set-settings-store-value-result#setsettingsstorevalueresult'>SetSettingsStoreValueResult</a>[]>`} />
141
141
 
142
142
 
143
143
  ### setMany
144
144
 
145
- <MemberInfo kind="method" type={`(valuesOrCtx: Record&#60;string, <a href='/reference/typescript-api/common/json-compatible#jsoncompatible'>JsonCompatible</a>&#60;any&#62;&#62; | <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, ctxOrValues: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a> | Record&#60;string, <a href='/reference/typescript-api/common/json-compatible#jsoncompatible'>JsonCompatible</a>&#60;any&#62;&#62;) => Promise&#60;<a href='/reference/typescript-api/settings-store/set-settings-store-value-result#setsettingsstorevalueresult'>SetSettingsStoreValueResult</a>[]&#62;`} />
145
+ <MemberInfo kind="method" type={`(valuesOrCtx: Record<string, <a href='/reference/typescript-api/common/json-compatible#jsoncompatible'>JsonCompatible</a><any>> | <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, ctxOrValues: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a> | Record<string, <a href='/reference/typescript-api/common/json-compatible#jsoncompatible'>JsonCompatible</a><any>>) => Promise<<a href='/reference/typescript-api/settings-store/set-settings-store-value-result#setsettingsstorevalueresult'>SetSettingsStoreValueResult</a>[]>`} />
146
146
 
147
147
 
148
148
  ### getFieldDefinition
@@ -152,17 +152,17 @@ detailed results for each key-value pair.
152
152
  Get the field configuration for a key.
153
153
  ### validateValue
154
154
 
155
- <MemberInfo kind="method" type={`(key: string, value: any, ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => Promise&#60;string | void&#62;`} />
155
+ <MemberInfo kind="method" type={`(key: string, value: any, ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => Promise<string | void>`} />
156
156
 
157
157
  Validate a value against its field definition.
158
158
  ### findOrphanedEntries
159
159
 
160
- <MemberInfo kind="method" type={`(options: <a href='/reference/typescript-api/settings-store/cleanup-orphaned-settings-store-entries-options#cleanuporphanedsettingsstoreentriesoptions'>CleanupOrphanedSettingsStoreEntriesOptions</a> = {}) => Promise&#60;<a href='/reference/typescript-api/settings-store/orphaned-settings-store-entry#orphanedsettingsstoreentry'>OrphanedSettingsStoreEntry</a>[]&#62;`} />
160
+ <MemberInfo kind="method" type={`(options: <a href='/reference/typescript-api/settings-store/cleanup-orphaned-settings-store-entries-options#cleanuporphanedsettingsstoreentriesoptions'>CleanupOrphanedSettingsStoreEntriesOptions</a> = {}) => Promise<<a href='/reference/typescript-api/settings-store/orphaned-settings-store-entry#orphanedsettingsstoreentry'>OrphanedSettingsStoreEntry</a>[]>`} />
161
161
 
162
162
  Find orphaned settings store entries that no longer have corresponding field definitions.
163
163
  ### cleanupOrphanedEntries
164
164
 
165
- <MemberInfo kind="method" type={`(options: <a href='/reference/typescript-api/settings-store/cleanup-orphaned-settings-store-entries-options#cleanuporphanedsettingsstoreentriesoptions'>CleanupOrphanedSettingsStoreEntriesOptions</a> = {}) => Promise&#60;<a href='/reference/typescript-api/settings-store/cleanup-orphaned-settings-store-entries-result#cleanuporphanedsettingsstoreentriesresult'>CleanupOrphanedSettingsStoreEntriesResult</a>&#62;`} />
165
+ <MemberInfo kind="method" type={`(options: <a href='/reference/typescript-api/settings-store/cleanup-orphaned-settings-store-entries-options#cleanuporphanedsettingsstoreentriesoptions'>CleanupOrphanedSettingsStoreEntriesOptions</a> = {}) => Promise<<a href='/reference/typescript-api/settings-store/cleanup-orphaned-settings-store-entries-result#cleanuporphanedsettingsstoreentriesresult'>CleanupOrphanedSettingsStoreEntriesResult</a>>`} />
166
166
 
167
167
  Clean up orphaned settings store entries from the database.
168
168
  ### hasPermission
@@ -36,37 +36,37 @@ class ShippingMethodService {
36
36
 
37
37
  ### findAll
38
38
 
39
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, options?: ListQueryOptions&#60;<a href='/reference/typescript-api/entities/shipping-method#shippingmethod'>ShippingMethod</a>&#62;, relations: RelationPaths&#60;<a href='/reference/typescript-api/entities/shipping-method#shippingmethod'>ShippingMethod</a>&#62; = []) => Promise&#60;<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a>&#60;Translated&#60;<a href='/reference/typescript-api/entities/shipping-method#shippingmethod'>ShippingMethod</a>&#62;&#62;&#62;`} />
39
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, options?: ListQueryOptions<<a href='/reference/typescript-api/entities/shipping-method#shippingmethod'>ShippingMethod</a>>, relations: RelationPaths<<a href='/reference/typescript-api/entities/shipping-method#shippingmethod'>ShippingMethod</a>> = []) => Promise<<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a><Translated<<a href='/reference/typescript-api/entities/shipping-method#shippingmethod'>ShippingMethod</a>>>>`} />
40
40
 
41
41
 
42
42
  ### findOne
43
43
 
44
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, shippingMethodId: <a href='/reference/typescript-api/common/id#id'>ID</a>, includeDeleted: = false, relations: RelationPaths&#60;<a href='/reference/typescript-api/entities/shipping-method#shippingmethod'>ShippingMethod</a>&#62; = []) => Promise&#60;Translated&#60;<a href='/reference/typescript-api/entities/shipping-method#shippingmethod'>ShippingMethod</a>&#62; | undefined&#62;`} />
44
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, shippingMethodId: <a href='/reference/typescript-api/common/id#id'>ID</a>, includeDeleted: = false, relations: RelationPaths<<a href='/reference/typescript-api/entities/shipping-method#shippingmethod'>ShippingMethod</a>> = []) => Promise<Translated<<a href='/reference/typescript-api/entities/shipping-method#shippingmethod'>ShippingMethod</a>> | undefined>`} />
45
45
 
46
46
 
47
47
  ### create
48
48
 
49
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: CreateShippingMethodInput) => Promise&#60;Translated&#60;<a href='/reference/typescript-api/entities/shipping-method#shippingmethod'>ShippingMethod</a>&#62;&#62;`} />
49
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: CreateShippingMethodInput) => Promise<Translated<<a href='/reference/typescript-api/entities/shipping-method#shippingmethod'>ShippingMethod</a>>>`} />
50
50
 
51
51
 
52
52
  ### update
53
53
 
54
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: UpdateShippingMethodInput) => Promise&#60;Translated&#60;<a href='/reference/typescript-api/entities/shipping-method#shippingmethod'>ShippingMethod</a>&#62;&#62;`} />
54
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: UpdateShippingMethodInput) => Promise<Translated<<a href='/reference/typescript-api/entities/shipping-method#shippingmethod'>ShippingMethod</a>>>`} />
55
55
 
56
56
 
57
57
  ### softDelete
58
58
 
59
- <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&#60;DeletionResponse&#62;`} />
59
+ <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>`} />
60
60
 
61
61
 
62
62
  ### assignShippingMethodsToChannel
63
63
 
64
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: AssignShippingMethodsToChannelInput) => Promise&#60;Array&#60;Translated&#60;<a href='/reference/typescript-api/entities/shipping-method#shippingmethod'>ShippingMethod</a>&#62;&#62;&#62;`} />
64
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: AssignShippingMethodsToChannelInput) => Promise<Array<Translated<<a href='/reference/typescript-api/entities/shipping-method#shippingmethod'>ShippingMethod</a>>>>`} />
65
65
 
66
66
 
67
67
  ### removeShippingMethodsFromChannel
68
68
 
69
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: RemoveShippingMethodsFromChannelInput) => Promise&#60;Array&#60;Translated&#60;<a href='/reference/typescript-api/entities/shipping-method#shippingmethod'>ShippingMethod</a>&#62;&#62;&#62;`} />
69
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: RemoveShippingMethodsFromChannelInput) => Promise<Array<Translated<<a href='/reference/typescript-api/entities/shipping-method#shippingmethod'>ShippingMethod</a>>>>`} />
70
70
 
71
71
 
72
72
  ### getShippingEligibilityCheckers
@@ -86,7 +86,7 @@ class ShippingMethodService {
86
86
 
87
87
  ### getActiveShippingMethods
88
88
 
89
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => Promise&#60;<a href='/reference/typescript-api/entities/shipping-method#shippingmethod'>ShippingMethod</a>[]&#62;`} />
89
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => Promise<<a href='/reference/typescript-api/entities/shipping-method#shippingmethod'>ShippingMethod</a>[]>`} />
90
90
 
91
91
 
92
92
 
@@ -26,7 +26,7 @@ class SlugService {
26
26
 
27
27
  ### generate
28
28
 
29
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, params: SlugGenerateParams) => Promise&#60;string&#62;`} />
29
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, params: SlugGenerateParams) => Promise<string>`} />
30
30
 
31
31
  Generates a slug from the input string using the configured SlugStrategy.
32
32
 
@@ -32,17 +32,17 @@ class StockLevelService {
32
32
 
33
33
  ### getStockLevel
34
34
 
35
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, productVariantId: <a href='/reference/typescript-api/common/id#id'>ID</a>, stockLocationId: <a href='/reference/typescript-api/common/id#id'>ID</a>) => Promise&#60;<a href='/reference/typescript-api/entities/stock-level#stocklevel'>StockLevel</a>&#62;`} />
35
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, productVariantId: <a href='/reference/typescript-api/common/id#id'>ID</a>, stockLocationId: <a href='/reference/typescript-api/common/id#id'>ID</a>) => Promise<<a href='/reference/typescript-api/entities/stock-level#stocklevel'>StockLevel</a>>`} />
36
36
 
37
37
  Returns the StockLevel for the given <a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a> and <a href='/reference/typescript-api/entities/stock-location#stocklocation'>StockLocation</a>.
38
38
  ### getStockLevelsForVariant
39
39
 
40
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, productVariantId: <a href='/reference/typescript-api/common/id#id'>ID</a>) => Promise&#60;<a href='/reference/typescript-api/entities/stock-level#stocklevel'>StockLevel</a>[]&#62;`} />
40
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, productVariantId: <a href='/reference/typescript-api/common/id#id'>ID</a>) => Promise<<a href='/reference/typescript-api/entities/stock-level#stocklevel'>StockLevel</a>[]>`} />
41
41
 
42
42
 
43
43
  ### getAvailableStock
44
44
 
45
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, productVariantId: <a href='/reference/typescript-api/common/id#id'>ID</a>) => Promise&#60;<a href='/reference/typescript-api/products-stock/stock-location-strategy#availablestock'>AvailableStock</a>&#62;`} />
45
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, productVariantId: <a href='/reference/typescript-api/common/id#id'>ID</a>) => Promise<<a href='/reference/typescript-api/products-stock/stock-location-strategy#availablestock'>AvailableStock</a>>`} />
46
46
 
47
47
  Returns the available stock (on hand and allocated) for the given <a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>. This is determined
48
48
  by the configured <a href='/reference/typescript-api/products-stock/stock-location-strategy#stocklocationstrategy'>StockLocationStrategy</a>.
@@ -43,40 +43,40 @@ class StockLocationService {
43
43
 
44
44
  ### findOne
45
45
 
46
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, stockLocationId: <a href='/reference/typescript-api/common/id#id'>ID</a>) => Promise&#60;<a href='/reference/typescript-api/entities/stock-location#stocklocation'>StockLocation</a> | undefined&#62;`} />
46
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, stockLocationId: <a href='/reference/typescript-api/common/id#id'>ID</a>) => Promise<<a href='/reference/typescript-api/entities/stock-location#stocklocation'>StockLocation</a> | undefined>`} />
47
47
 
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&#60;<a href='/reference/typescript-api/entities/stock-location#stocklocation'>StockLocation</a>&#62;, relations?: RelationPaths&#60;<a href='/reference/typescript-api/entities/stock-location#stocklocation'>StockLocation</a>&#62;) => Promise&#60;<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a>&#60;<a href='/reference/typescript-api/entities/stock-location#stocklocation'>StockLocation</a>&#62;&#62;`} />
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/stock-location#stocklocation'>StockLocation</a>>, relations?: RelationPaths<<a href='/reference/typescript-api/entities/stock-location#stocklocation'>StockLocation</a>>) => Promise<<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a><<a href='/reference/typescript-api/entities/stock-location#stocklocation'>StockLocation</a>>>`} />
52
52
 
53
53
 
54
54
  ### create
55
55
 
56
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: CreateStockLocationInput) => Promise&#60;<a href='/reference/typescript-api/entities/stock-location#stocklocation'>StockLocation</a>&#62;`} />
56
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: CreateStockLocationInput) => Promise<<a href='/reference/typescript-api/entities/stock-location#stocklocation'>StockLocation</a>>`} />
57
57
 
58
58
 
59
59
  ### update
60
60
 
61
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: UpdateStockLocationInput) => Promise&#60;<a href='/reference/typescript-api/entities/stock-location#stocklocation'>StockLocation</a>&#62;`} />
61
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: UpdateStockLocationInput) => Promise<<a href='/reference/typescript-api/entities/stock-location#stocklocation'>StockLocation</a>>`} />
62
62
 
63
63
 
64
64
  ### delete
65
65
 
66
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: DeleteStockLocationInput) => Promise&#60;DeletionResponse&#62;`} />
66
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: DeleteStockLocationInput) => Promise<DeletionResponse>`} />
67
67
 
68
68
  Deletes a StockLocation. If `transferToLocationId` is specified in the input, all stock levels
69
69
  from the deleted location will be transferred to the target location. The last StockLocation
70
70
  cannot be deleted.
71
71
  ### assignStockLocationsToChannel
72
72
 
73
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: AssignStockLocationsToChannelInput) => Promise&#60;<a href='/reference/typescript-api/entities/stock-location#stocklocation'>StockLocation</a>[]&#62;`} />
73
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: AssignStockLocationsToChannelInput) => Promise<<a href='/reference/typescript-api/entities/stock-location#stocklocation'>StockLocation</a>[]>`} />
74
74
 
75
75
  Assigns multiple StockLocations to the specified Channel. Requires the `UpdateStockLocation`
76
76
  permission on the target channel.
77
77
  ### removeStockLocationsFromChannel
78
78
 
79
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: RemoveStockLocationsFromChannelInput) => Promise&#60;<a href='/reference/typescript-api/entities/stock-location#stocklocation'>StockLocation</a>[]&#62;`} />
79
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: RemoveStockLocationsFromChannelInput) => Promise<<a href='/reference/typescript-api/entities/stock-location#stocklocation'>StockLocation</a>[]>`} />
80
80
 
81
81
  Removes multiple StockLocations from the specified Channel. Requires the `DeleteStockLocation`
82
82
  permission on the target channel. StockLocations cannot be removed from the default channel.
@@ -44,32 +44,32 @@ class StockMovementService {
44
44
 
45
45
  ### getStockMovementsByProductVariantId
46
46
 
47
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, productVariantId: <a href='/reference/typescript-api/common/id#id'>ID</a>, options?: StockMovementListOptions) => Promise&#60;<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a>&#60;<a href='/reference/typescript-api/entities/stock-movement#stockmovement'>StockMovement</a>&#62;&#62;`} />
47
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, productVariantId: <a href='/reference/typescript-api/common/id#id'>ID</a>, options?: StockMovementListOptions) => Promise<<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a><<a href='/reference/typescript-api/entities/stock-movement#stockmovement'>StockMovement</a>>>`} />
48
48
 
49
49
  Returns a <a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a> of all StockMovements associated with the specified ProductVariant.
50
50
  ### adjustProductVariantStock
51
51
 
52
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, productVariantId: <a href='/reference/typescript-api/common/id#id'>ID</a>, stockOnHandNumberOrInput: number | StockLevelInput[]) => Promise&#60;<a href='/reference/typescript-api/entities/stock-movement#stockadjustment'>StockAdjustment</a>[]&#62;`} />
52
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, productVariantId: <a href='/reference/typescript-api/common/id#id'>ID</a>, stockOnHandNumberOrInput: number | StockLevelInput[]) => Promise<<a href='/reference/typescript-api/entities/stock-movement#stockadjustment'>StockAdjustment</a>[]>`} />
53
53
 
54
54
  Adjusts the stock level of the ProductVariant, creating a new <a href='/reference/typescript-api/entities/stock-movement#stockadjustment'>StockAdjustment</a> entity
55
55
  in the process.
56
56
  ### createAllocationsForOrder
57
57
 
58
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, order: <a href='/reference/typescript-api/entities/order#order'>Order</a>) => Promise&#60;<a href='/reference/typescript-api/entities/stock-movement#allocation'>Allocation</a>[]&#62;`} />
58
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, order: <a href='/reference/typescript-api/entities/order#order'>Order</a>) => Promise<<a href='/reference/typescript-api/entities/stock-movement#allocation'>Allocation</a>[]>`} />
59
59
 
60
60
  Creates a new <a href='/reference/typescript-api/entities/stock-movement#allocation'>Allocation</a> for each OrderLine in the Order. For ProductVariants
61
61
  which are configured to track stock levels, the `ProductVariant.stockAllocated` value is
62
62
  increased, indicating that this quantity of stock is allocated and cannot be sold.
63
63
  ### createAllocationsForOrderLines
64
64
 
65
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, lines: OrderLineInput[]) => Promise&#60;<a href='/reference/typescript-api/entities/stock-movement#allocation'>Allocation</a>[]&#62;`} />
65
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, lines: OrderLineInput[]) => Promise<<a href='/reference/typescript-api/entities/stock-movement#allocation'>Allocation</a>[]>`} />
66
66
 
67
67
  Creates a new <a href='/reference/typescript-api/entities/stock-movement#allocation'>Allocation</a> for each of the given OrderLines. For ProductVariants
68
68
  which are configured to track stock levels, the `ProductVariant.stockAllocated` value is
69
69
  increased, indicating that this quantity of stock is allocated and cannot be sold.
70
70
  ### createSalesForOrder
71
71
 
72
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, lines: OrderLineInput[]) => Promise&#60;<a href='/reference/typescript-api/entities/stock-movement#sale'>Sale</a>[]&#62;`} />
72
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, lines: OrderLineInput[]) => Promise<<a href='/reference/typescript-api/entities/stock-movement#sale'>Sale</a>[]>`} />
73
73
 
74
74
  Creates <a href='/reference/typescript-api/entities/stock-movement#sale'>Sale</a>s for each OrderLine in the Order. For ProductVariants
75
75
  which are configured to track stock levels, the `ProductVariant.stockAllocated` value is
@@ -77,14 +77,14 @@ reduced and the `stockOnHand` value is also reduced by the OrderLine quantity, i
77
77
  that the stock is no longer allocated, but is actually sold and no longer available.
78
78
  ### createCancellationsForOrderLines
79
79
 
80
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, lineInputs: OrderLineInput[]) => Promise&#60;<a href='/reference/typescript-api/entities/stock-movement#cancellation'>Cancellation</a>[]&#62;`} />
80
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, lineInputs: OrderLineInput[]) => Promise<<a href='/reference/typescript-api/entities/stock-movement#cancellation'>Cancellation</a>[]>`} />
81
81
 
82
82
  Creates a <a href='/reference/typescript-api/entities/stock-movement#cancellation'>Cancellation</a> for each of the specified OrderItems. For ProductVariants
83
83
  which are configured to track stock levels, the `ProductVariant.stockOnHand` value is
84
84
  increased for each Cancellation, allowing that stock to be sold again.
85
85
  ### createReleasesForOrderLines
86
86
 
87
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, lineInputs: OrderLineInput[]) => Promise&#60;<a href='/reference/typescript-api/entities/stock-movement#release'>Release</a>[]&#62;`} />
87
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, lineInputs: OrderLineInput[]) => Promise<<a href='/reference/typescript-api/entities/stock-movement#release'>Release</a>[]>`} />
88
88
 
89
89
  Creates a <a href='/reference/typescript-api/entities/stock-movement#release'>Release</a> for each of the specified OrderItems. For ProductVariants
90
90
  which are configured to track stock levels, the `ProductVariant.stockAllocated` value is
@@ -32,12 +32,12 @@ class TagService {
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&#60;<a href='/reference/typescript-api/entities/tag#tag'>Tag</a>&#62;) => Promise&#60;<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a>&#60;<a href='/reference/typescript-api/entities/tag#tag'>Tag</a>&#62;&#62;`} />
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/tag#tag'>Tag</a>>) => Promise<<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a><<a href='/reference/typescript-api/entities/tag#tag'>Tag</a>>>`} />
36
36
 
37
37
 
38
38
  ### findOne
39
39
 
40
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, tagId: <a href='/reference/typescript-api/common/id#id'>ID</a>) => Promise&#60;<a href='/reference/typescript-api/entities/tag#tag'>Tag</a> | undefined&#62;`} />
40
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, tagId: <a href='/reference/typescript-api/common/id#id'>ID</a>) => Promise<<a href='/reference/typescript-api/entities/tag#tag'>Tag</a> | undefined>`} />
41
41
 
42
42
 
43
43
  ### create
@@ -52,17 +52,17 @@ class TagService {
52
52
 
53
53
  ### delete
54
54
 
55
- <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&#60;DeletionResponse&#62;`} />
55
+ <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>`} />
56
56
 
57
57
 
58
58
  ### valuesToTags
59
59
 
60
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, values: string[]) => Promise&#60;<a href='/reference/typescript-api/entities/tag#tag'>Tag</a>[]&#62;`} />
60
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, values: string[]) => Promise<<a href='/reference/typescript-api/entities/tag#tag'>Tag</a>[]>`} />
61
61
 
62
62
 
63
63
  ### getTagsForEntity
64
64
 
65
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, entity: Type&#60;<a href='/reference/typescript-api/entities/vendure-entity#vendureentity'>VendureEntity</a> &#38; <a href='/reference/typescript-api/entities/interfaces#taggable'>Taggable</a>&#62;, id: <a href='/reference/typescript-api/common/id#id'>ID</a>) => Promise&#60;<a href='/reference/typescript-api/entities/tag#tag'>Tag</a>[]&#62;`} />
65
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, entity: Type<<a href='/reference/typescript-api/entities/vendure-entity#vendureentity'>VendureEntity</a> &#38; <a href='/reference/typescript-api/entities/interfaces#taggable'>Taggable</a>>, id: <a href='/reference/typescript-api/common/id#id'>ID</a>) => Promise<<a href='/reference/typescript-api/entities/tag#tag'>Tag</a>[]>`} />
66
66
 
67
67
 
68
68