@vendure/docs 0.0.0-202601211609 → 0.0.0-202601221206

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