@vendure/docs 0.0.0-202601211552 → 0.0.0-202601211609

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (358) 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 +5 -5
  6. package/docs/reference/admin-ui-api/components/asset-picker-dialog-component.mdx +3 -3
  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 +1 -1
  26. package/docs/reference/admin-ui-api/directives/if-permissions-directive.mdx +1 -1
  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 +2 -2
  32. package/docs/reference/admin-ui-api/list-detail-views/typed-base-list-component.mdx +6 -6
  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-hooks/use-injector.mdx +1 -1
  44. package/docs/reference/admin-ui-api/react-hooks/use-lazy-query.mdx +1 -1
  45. package/docs/reference/admin-ui-api/react-hooks/use-mutation.mdx +1 -1
  46. package/docs/reference/admin-ui-api/react-hooks/use-query.mdx +1 -1
  47. package/docs/reference/admin-ui-api/services/data-service.mdx +9 -9
  48. package/docs/reference/admin-ui-api/services/modal-service.mdx +5 -5
  49. package/docs/reference/admin-ui-api/tabs/page-tab-config.mdx +1 -1
  50. package/docs/reference/admin-ui-api/ui-devkit/admin-ui-extension.mdx +1 -1
  51. package/docs/reference/core-plugins/admin-ui-plugin/admin-ui-plugin-options.mdx +1 -1
  52. package/docs/reference/core-plugins/admin-ui-plugin/index.mdx +1 -1
  53. package/docs/reference/core-plugins/asset-server-plugin/asset-server-options.mdx +2 -2
  54. package/docs/reference/core-plugins/asset-server-plugin/image-transform-strategy.mdx +1 -1
  55. package/docs/reference/core-plugins/asset-server-plugin/index.mdx +1 -1
  56. package/docs/reference/core-plugins/asset-server-plugin/local-asset-storage-strategy.mdx +8 -8
  57. package/docs/reference/core-plugins/asset-server-plugin/preset-only-strategy.mdx +1 -1
  58. package/docs/reference/core-plugins/asset-server-plugin/s3asset-storage-strategy.mdx +2 -2
  59. package/docs/reference/core-plugins/asset-server-plugin/sharp-asset-preview-strategy.mdx +1 -1
  60. package/docs/reference/core-plugins/dashboard-plugin/index.mdx +1 -1
  61. package/docs/reference/core-plugins/elasticsearch-plugin/elasticsearch-options.mdx +8 -8
  62. package/docs/reference/core-plugins/elasticsearch-plugin/index.mdx +1 -1
  63. package/docs/reference/core-plugins/email-plugin/email-event-handler-with-async-data.mdx +1 -1
  64. package/docs/reference/core-plugins/email-plugin/email-event-handler.mdx +6 -6
  65. package/docs/reference/core-plugins/email-plugin/email-event-listener.mdx +1 -1
  66. package/docs/reference/core-plugins/email-plugin/email-generator.mdx +2 -2
  67. package/docs/reference/core-plugins/email-plugin/email-plugin-options.mdx +2 -2
  68. package/docs/reference/core-plugins/email-plugin/email-plugin-types.mdx +1 -1
  69. package/docs/reference/core-plugins/email-plugin/email-sender.mdx +1 -1
  70. package/docs/reference/core-plugins/email-plugin/index.mdx +1 -1
  71. package/docs/reference/core-plugins/email-plugin/template-loader.mdx +4 -4
  72. package/docs/reference/core-plugins/email-plugin/transport-options.mdx +1 -1
  73. package/docs/reference/core-plugins/graphiql-plugin/index.mdx +2 -2
  74. package/docs/reference/core-plugins/harden-plugin/harden-plugin-options.mdx +1 -1
  75. package/docs/reference/core-plugins/job-queue-plugin/bull-mqjob-queue-strategy.mdx +9 -9
  76. package/docs/reference/core-plugins/job-queue-plugin/bull-mqplugin-options.mdx +5 -5
  77. package/docs/reference/core-plugins/job-queue-plugin/pub-sub-job-queue-strategy.mdx +3 -3
  78. package/docs/reference/core-plugins/job-queue-plugin/pub-sub-plugin.mdx +1 -1
  79. package/docs/reference/core-plugins/payments-plugin/braintree-plugin.mdx +2 -2
  80. package/docs/reference/core-plugins/payments-plugin/mollie-plugin.mdx +1 -1
  81. package/docs/reference/core-plugins/payments-plugin/stripe-plugin.mdx +5 -5
  82. package/docs/reference/core-plugins/stellate-plugin/purge-rule.mdx +3 -3
  83. package/docs/reference/core-plugins/stellate-plugin/stellate-service.mdx +1 -1
  84. package/docs/reference/core-plugins/telemetry-plugin/get-sdk-configuration.mdx +1 -1
  85. package/docs/reference/core-plugins/telemetry-plugin/register-method-hooks.mdx +2 -2
  86. package/docs/reference/core-plugins/telemetry-plugin/telemetry-plugin-options.mdx +1 -1
  87. package/docs/reference/dashboard/components/asset-gallery.mdx +3 -3
  88. package/docs/reference/dashboard/components/asset-picker-dialog.mdx +2 -2
  89. package/docs/reference/dashboard/components/channel-chip.mdx +1 -1
  90. package/docs/reference/dashboard/components/detail-page-button.mdx +1 -1
  91. package/docs/reference/dashboard/components/facet-value-selector.mdx +1 -1
  92. package/docs/reference/dashboard/components/permission-guard.mdx +1 -1
  93. package/docs/reference/dashboard/components/vendure-image.mdx +1 -1
  94. package/docs/reference/dashboard/detail-views/detail-page.mdx +2 -2
  95. package/docs/reference/dashboard/detail-views/use-detail-page.mdx +10 -10
  96. package/docs/reference/dashboard/detail-views/use-generated-form.mdx +2 -2
  97. package/docs/reference/dashboard/extensions-api/action-bar.mdx +1 -1
  98. package/docs/reference/dashboard/extensions-api/alerts.mdx +6 -6
  99. package/docs/reference/dashboard/extensions-api/data-tables.mdx +1 -1
  100. package/docs/reference/dashboard/extensions-api/detail-forms.mdx +1 -1
  101. package/docs/reference/dashboard/extensions-api/history-entries.mdx +2 -2
  102. package/docs/reference/dashboard/extensions-api/page-blocks.mdx +2 -2
  103. package/docs/reference/dashboard/extensions-api/routes.mdx +4 -4
  104. package/docs/reference/dashboard/extensions-api/widgets.mdx +1 -1
  105. package/docs/reference/dashboard/form-components/affixed-input.mdx +1 -1
  106. package/docs/reference/dashboard/form-components/boolean-input.mdx +1 -1
  107. package/docs/reference/dashboard/form-components/checkbox-input.mdx +1 -1
  108. package/docs/reference/dashboard/form-components/date-time-input.mdx +1 -1
  109. package/docs/reference/dashboard/form-components/money-input.mdx +1 -1
  110. package/docs/reference/dashboard/form-components/number-input.mdx +1 -1
  111. package/docs/reference/dashboard/form-components/password-input.mdx +1 -1
  112. package/docs/reference/dashboard/form-components/rich-text-input.mdx +1 -1
  113. package/docs/reference/dashboard/form-components/textarea-input.mdx +1 -1
  114. package/docs/reference/dashboard/hooks/use-alerts.mdx +1 -1
  115. package/docs/reference/dashboard/hooks/use-auth.mdx +5 -5
  116. package/docs/reference/dashboard/hooks/use-channel.mdx +2 -2
  117. package/docs/reference/dashboard/hooks/use-drag-and-drop.mdx +1 -1
  118. package/docs/reference/dashboard/list-views/bulk-actions.mdx +3 -3
  119. package/docs/reference/dashboard/list-views/data-table.mdx +10 -10
  120. package/docs/reference/dashboard/list-views/list-page.mdx +13 -13
  121. package/docs/reference/dashboard/list-views/paginated-list-data-table.mdx +17 -17
  122. package/docs/reference/dashboard/page-layout/index.mdx +1 -1
  123. package/docs/reference/dashboard/page-layout/page-action-bar.mdx +3 -3
  124. package/docs/reference/dashboard/page-layout/page-block.mdx +3 -3
  125. package/docs/reference/dashboard/page-layout/page-title.mdx +1 -1
  126. package/docs/reference/dashboard/page-layout/page.mdx +2 -2
  127. package/docs/reference/typescript-api/assets/asset-preview-strategy.mdx +1 -1
  128. package/docs/reference/typescript-api/assets/asset-storage-strategy.mdx +6 -6
  129. package/docs/reference/typescript-api/auth/auth-options.mdx +1 -1
  130. package/docs/reference/typescript-api/auth/authentication-strategy.mdx +2 -2
  131. package/docs/reference/typescript-api/auth/bcrypt-password-hashing-strategy.mdx +2 -2
  132. package/docs/reference/typescript-api/auth/default-session-cache-strategy.mdx +4 -4
  133. package/docs/reference/typescript-api/auth/external-authentication-service.mdx +5 -5
  134. package/docs/reference/typescript-api/auth/native-authentication-strategy.mdx +2 -2
  135. package/docs/reference/typescript-api/auth/password-hashing-strategy.mdx +2 -2
  136. package/docs/reference/typescript-api/auth/password-validation-strategy.mdx +1 -1
  137. package/docs/reference/typescript-api/auth/permission-definition.mdx +2 -2
  138. package/docs/reference/typescript-api/auth/session-cache-strategy.mdx +4 -4
  139. package/docs/reference/typescript-api/auth/verification-token-strategy.mdx +2 -2
  140. package/docs/reference/typescript-api/cache/cache-config.mdx +1 -1
  141. package/docs/reference/typescript-api/cache/cache-service.mdx +4 -4
  142. package/docs/reference/typescript-api/cache/cache-strategy.mdx +4 -4
  143. package/docs/reference/typescript-api/cache/index.mdx +3 -3
  144. package/docs/reference/typescript-api/cache/redis-cache-strategy.mdx +4 -4
  145. package/docs/reference/typescript-api/cache/request-context-cache-service.mdx +2 -2
  146. package/docs/reference/typescript-api/cache/self-refreshing-cache.mdx +5 -5
  147. package/docs/reference/typescript-api/cache/sql-cache-strategy.mdx +1 -1
  148. package/docs/reference/typescript-api/common/admin-ui/admin-ui-app-config.mdx +1 -1
  149. package/docs/reference/typescript-api/common/admin-ui/admin-ui-app-dev-mode-config.mdx +1 -1
  150. package/docs/reference/typescript-api/common/async-queue.mdx +1 -1
  151. package/docs/reference/typescript-api/common/bootstrap.mdx +2 -2
  152. package/docs/reference/typescript-api/common/injectable-strategy.mdx +2 -2
  153. package/docs/reference/typescript-api/common/injector.mdx +2 -2
  154. package/docs/reference/typescript-api/configurable-operation-def/config-args.mdx +1 -1
  155. package/docs/reference/typescript-api/configurable-operation-def/default-form-config-hash.mdx +11 -11
  156. package/docs/reference/typescript-api/configurable-operation-def/index.mdx +1 -1
  157. package/docs/reference/typescript-api/configuration/api-options.mdx +2 -2
  158. package/docs/reference/typescript-api/configuration/collection-filter.mdx +2 -2
  159. package/docs/reference/typescript-api/configuration/entity-duplicator.mdx +2 -2
  160. package/docs/reference/typescript-api/configuration/entity-id-strategy.mdx +2 -2
  161. package/docs/reference/typescript-api/configuration/entity-options.mdx +1 -1
  162. package/docs/reference/typescript-api/configuration/product-variant-price-selection-strategy.mdx +1 -1
  163. package/docs/reference/typescript-api/configuration/product-variant-price-update-strategy.mdx +3 -3
  164. package/docs/reference/typescript-api/configuration/runtime-vendure-config.mdx +14 -14
  165. package/docs/reference/typescript-api/configuration/slug-strategy.mdx +1 -1
  166. package/docs/reference/typescript-api/configuration/vendure-config.mdx +1 -1
  167. package/docs/reference/typescript-api/data-access/calculated-property-subscriber.mdx +1 -1
  168. package/docs/reference/typescript-api/data-access/calculated.mdx +1 -1
  169. package/docs/reference/typescript-api/data-access/entity-hydrator.mdx +1 -1
  170. package/docs/reference/typescript-api/data-access/hydrate-options.mdx +1 -1
  171. package/docs/reference/typescript-api/data-access/list-query-builder.mdx +4 -4
  172. package/docs/reference/typescript-api/data-access/transactional-connection.mdx +9 -9
  173. package/docs/reference/typescript-api/default-search-plugin/index.mdx +1 -1
  174. package/docs/reference/typescript-api/default-search-plugin/mysql-search-strategy.mdx +4 -4
  175. package/docs/reference/typescript-api/default-search-plugin/postgres-search-strategy.mdx +4 -4
  176. package/docs/reference/typescript-api/default-search-plugin/search-strategy.mdx +4 -4
  177. package/docs/reference/typescript-api/default-search-plugin/sqlite-search-strategy.mdx +4 -4
  178. package/docs/reference/typescript-api/entities/address.mdx +1 -1
  179. package/docs/reference/typescript-api/entities/administrator.mdx +1 -1
  180. package/docs/reference/typescript-api/entities/anonymous-session.mdx +1 -1
  181. package/docs/reference/typescript-api/entities/asset.mdx +1 -1
  182. package/docs/reference/typescript-api/entities/authenticated-session.mdx +1 -1
  183. package/docs/reference/typescript-api/entities/authentication-method.mdx +2 -2
  184. package/docs/reference/typescript-api/entities/channel.mdx +1 -1
  185. package/docs/reference/typescript-api/entities/collection.mdx +2 -2
  186. package/docs/reference/typescript-api/entities/country.mdx +1 -1
  187. package/docs/reference/typescript-api/entities/customer-group.mdx +1 -1
  188. package/docs/reference/typescript-api/entities/customer-history-entry.mdx +1 -1
  189. package/docs/reference/typescript-api/entities/customer.mdx +1 -1
  190. package/docs/reference/typescript-api/entities/facet-value.mdx +2 -2
  191. package/docs/reference/typescript-api/entities/facet.mdx +2 -2
  192. package/docs/reference/typescript-api/entities/fulfillment.mdx +1 -1
  193. package/docs/reference/typescript-api/entities/global-settings.mdx +1 -1
  194. package/docs/reference/typescript-api/entities/interfaces.mdx +1 -1
  195. package/docs/reference/typescript-api/entities/order-history-entry.mdx +1 -1
  196. package/docs/reference/typescript-api/entities/order-line-reference.mdx +3 -3
  197. package/docs/reference/typescript-api/entities/order-line.mdx +1 -1
  198. package/docs/reference/typescript-api/entities/order-modification.mdx +1 -1
  199. package/docs/reference/typescript-api/entities/order.mdx +1 -1
  200. package/docs/reference/typescript-api/entities/orderable-asset.mdx +1 -1
  201. package/docs/reference/typescript-api/entities/payment-method.mdx +2 -2
  202. package/docs/reference/typescript-api/entities/payment.mdx +1 -1
  203. package/docs/reference/typescript-api/entities/product-option-group.mdx +2 -2
  204. package/docs/reference/typescript-api/entities/product-option.mdx +2 -2
  205. package/docs/reference/typescript-api/entities/product-variant-price.mdx +1 -1
  206. package/docs/reference/typescript-api/entities/product-variant.mdx +2 -2
  207. package/docs/reference/typescript-api/entities/product.mdx +2 -2
  208. package/docs/reference/typescript-api/entities/promotion.mdx +4 -4
  209. package/docs/reference/typescript-api/entities/province.mdx +1 -1
  210. package/docs/reference/typescript-api/entities/refund.mdx +1 -1
  211. package/docs/reference/typescript-api/entities/region.mdx +1 -1
  212. package/docs/reference/typescript-api/entities/role.mdx +1 -1
  213. package/docs/reference/typescript-api/entities/seller.mdx +1 -1
  214. package/docs/reference/typescript-api/entities/settings-store-entry.mdx +1 -1
  215. package/docs/reference/typescript-api/entities/shipping-line.mdx +1 -1
  216. package/docs/reference/typescript-api/entities/shipping-method.mdx +4 -4
  217. package/docs/reference/typescript-api/entities/stock-level.mdx +1 -1
  218. package/docs/reference/typescript-api/entities/stock-location.mdx +1 -1
  219. package/docs/reference/typescript-api/entities/stock-movement.mdx +5 -5
  220. package/docs/reference/typescript-api/entities/surcharge.mdx +1 -1
  221. package/docs/reference/typescript-api/entities/tag.mdx +1 -1
  222. package/docs/reference/typescript-api/entities/tax-category.mdx +1 -1
  223. package/docs/reference/typescript-api/entities/tax-rate.mdx +1 -1
  224. package/docs/reference/typescript-api/entities/user.mdx +1 -1
  225. package/docs/reference/typescript-api/entities/vendure-entity.mdx +1 -1
  226. package/docs/reference/typescript-api/entities/zone.mdx +1 -1
  227. package/docs/reference/typescript-api/errors/error-handler-strategy.mdx +2 -2
  228. package/docs/reference/typescript-api/events/blocking-event-handler-options.mdx +2 -2
  229. package/docs/reference/typescript-api/events/event-bus.mdx +3 -3
  230. package/docs/reference/typescript-api/events/event-types.mdx +1 -1
  231. package/docs/reference/typescript-api/fulfillment/fulfillment-handler.mdx +1 -1
  232. package/docs/reference/typescript-api/fulfillment/fulfillment-process.mdx +4 -4
  233. package/docs/reference/typescript-api/import-export/asset-import-strategy.mdx +1 -1
  234. package/docs/reference/typescript-api/import-export/asset-importer.mdx +1 -1
  235. package/docs/reference/typescript-api/import-export/fast-importer-service.mdx +4 -4
  236. package/docs/reference/typescript-api/import-export/import-parser.mdx +5 -5
  237. package/docs/reference/typescript-api/import-export/importer.mdx +3 -3
  238. package/docs/reference/typescript-api/import-export/initial-data.mdx +3 -3
  239. package/docs/reference/typescript-api/import-export/populate.mdx +1 -1
  240. package/docs/reference/typescript-api/job-queue/default-job-queue-plugin.mdx +5 -5
  241. package/docs/reference/typescript-api/job-queue/in-memory-job-buffer-storage-strategy.mdx +3 -3
  242. package/docs/reference/typescript-api/job-queue/in-memory-job-queue-strategy.mdx +8 -8
  243. package/docs/reference/typescript-api/job-queue/index.mdx +1 -1
  244. package/docs/reference/typescript-api/job-queue/inspectable-job-queue-strategy.mdx +5 -5
  245. package/docs/reference/typescript-api/job-queue/job-buffer-storage-strategy.mdx +3 -3
  246. package/docs/reference/typescript-api/job-queue/job-buffer.mdx +2 -2
  247. package/docs/reference/typescript-api/job-queue/job-queue-service.mdx +4 -4
  248. package/docs/reference/typescript-api/job-queue/job-queue-strategy.mdx +3 -3
  249. package/docs/reference/typescript-api/job-queue/polling-job-queue-strategy.mdx +8 -8
  250. package/docs/reference/typescript-api/job-queue/sql-job-queue-strategy.mdx +6 -6
  251. package/docs/reference/typescript-api/job-queue/subscribable-job.mdx +1 -1
  252. package/docs/reference/typescript-api/job-queue/types.mdx +1 -1
  253. package/docs/reference/typescript-api/migration/generate-migration.mdx +1 -1
  254. package/docs/reference/typescript-api/migration/revert-last-migration.mdx +1 -1
  255. package/docs/reference/typescript-api/migration/run-migrations.mdx +1 -1
  256. package/docs/reference/typescript-api/orders/active-order-service.mdx +6 -6
  257. package/docs/reference/typescript-api/orders/active-order-strategy.mdx +3 -3
  258. package/docs/reference/typescript-api/orders/changed-price-handling-strategy.mdx +1 -1
  259. package/docs/reference/typescript-api/orders/default-guest-checkout-strategy.mdx +1 -1
  260. package/docs/reference/typescript-api/orders/default-order-item-price-calculation-strategy.mdx +1 -1
  261. package/docs/reference/typescript-api/orders/default-stock-allocation-strategy.mdx +1 -1
  262. package/docs/reference/typescript-api/orders/guest-checkout-strategy.mdx +1 -1
  263. package/docs/reference/typescript-api/orders/order-by-code-access-strategy.mdx +1 -1
  264. package/docs/reference/typescript-api/orders/order-code-strategy.mdx +1 -1
  265. package/docs/reference/typescript-api/orders/order-interceptor.mdx +3 -3
  266. package/docs/reference/typescript-api/orders/order-item-price-calculation-strategy.mdx +1 -1
  267. package/docs/reference/typescript-api/orders/order-options.mdx +2 -2
  268. package/docs/reference/typescript-api/orders/order-placed-strategy.mdx +1 -1
  269. package/docs/reference/typescript-api/orders/order-process.mdx +4 -4
  270. package/docs/reference/typescript-api/orders/order-seller-strategy.mdx +3 -3
  271. package/docs/reference/typescript-api/orders/stock-allocation-strategy.mdx +1 -1
  272. package/docs/reference/typescript-api/payment/payment-method-config-options.mdx +1 -1
  273. package/docs/reference/typescript-api/payment/payment-method-types.mdx +3 -3
  274. package/docs/reference/typescript-api/payment/payment-options.mdx +3 -3
  275. package/docs/reference/typescript-api/payment/payment-process.mdx +4 -4
  276. package/docs/reference/typescript-api/payment/refund-process.mdx +4 -4
  277. package/docs/reference/typescript-api/plugin/vendure-plugin-metadata.mdx +4 -4
  278. package/docs/reference/typescript-api/products-stock/catalog-options.mdx +1 -1
  279. package/docs/reference/typescript-api/products-stock/default-product-variant-price-calculation-strategy.mdx +1 -1
  280. package/docs/reference/typescript-api/products-stock/default-stock-location-strategy.mdx +1 -1
  281. package/docs/reference/typescript-api/products-stock/multi-channel-stock-location-strategy.mdx +2 -2
  282. package/docs/reference/typescript-api/products-stock/product-variant-price-calculation-strategy.mdx +1 -1
  283. package/docs/reference/typescript-api/products-stock/stock-display-strategy.mdx +1 -1
  284. package/docs/reference/typescript-api/products-stock/stock-location-strategy.mdx +5 -5
  285. package/docs/reference/typescript-api/promotions/facet-value-checker.mdx +1 -1
  286. package/docs/reference/typescript-api/promotions/promotion-action.mdx +1 -1
  287. package/docs/reference/typescript-api/promotions/promotion-condition.mdx +1 -1
  288. package/docs/reference/typescript-api/promotions/promotion-options.mdx +2 -2
  289. package/docs/reference/typescript-api/request/request-context-service.mdx +2 -2
  290. package/docs/reference/typescript-api/scheduled-tasks/default-scheduler-strategy.mdx +4 -4
  291. package/docs/reference/typescript-api/scheduled-tasks/scheduled-task.mdx +3 -3
  292. package/docs/reference/typescript-api/scheduled-tasks/scheduler-service.mdx +3 -3
  293. package/docs/reference/typescript-api/scheduled-tasks/scheduler-strategy.mdx +5 -5
  294. package/docs/reference/typescript-api/service-helpers/entity-duplicator-service.mdx +1 -1
  295. package/docs/reference/typescript-api/service-helpers/order-calculator.mdx +1 -1
  296. package/docs/reference/typescript-api/service-helpers/order-modifier.mdx +3 -3
  297. package/docs/reference/typescript-api/service-helpers/product-price-applicator.mdx +1 -1
  298. package/docs/reference/typescript-api/service-helpers/slug-validator.mdx +2 -2
  299. package/docs/reference/typescript-api/service-helpers/translatable-saver.mdx +2 -2
  300. package/docs/reference/typescript-api/service-helpers/translator-service.mdx +1 -1
  301. package/docs/reference/typescript-api/services/administrator-service.mdx +6 -6
  302. package/docs/reference/typescript-api/services/asset-service.mdx +13 -13
  303. package/docs/reference/typescript-api/services/auth-service.mdx +4 -4
  304. package/docs/reference/typescript-api/services/channel-service.mdx +12 -12
  305. package/docs/reference/typescript-api/services/collection-service.mdx +20 -20
  306. package/docs/reference/typescript-api/services/country-service.mdx +7 -7
  307. package/docs/reference/typescript-api/services/customer-group-service.mdx +8 -8
  308. package/docs/reference/typescript-api/services/customer-service.mdx +24 -24
  309. package/docs/reference/typescript-api/services/entity-slug-service.mdx +1 -1
  310. package/docs/reference/typescript-api/services/facet-service.mdx +11 -11
  311. package/docs/reference/typescript-api/services/facet-value-service.mdx +12 -12
  312. package/docs/reference/typescript-api/services/fulfillment-service.mdx +4 -4
  313. package/docs/reference/typescript-api/services/global-settings-service.mdx +2 -2
  314. package/docs/reference/typescript-api/services/history-service.mdx +8 -8
  315. package/docs/reference/typescript-api/services/order-service.mdx +52 -52
  316. package/docs/reference/typescript-api/services/order-testing-service.mdx +2 -2
  317. package/docs/reference/typescript-api/services/payment-method-service.mdx +10 -10
  318. package/docs/reference/typescript-api/services/payment-service.mdx +7 -7
  319. package/docs/reference/typescript-api/services/product-option-group-service.mdx +5 -5
  320. package/docs/reference/typescript-api/services/product-option-service.mdx +5 -5
  321. package/docs/reference/typescript-api/services/product-service.mdx +13 -13
  322. package/docs/reference/typescript-api/services/product-variant-service.mdx +22 -22
  323. package/docs/reference/typescript-api/services/promotion-service.mdx +9 -9
  324. package/docs/reference/typescript-api/services/province-service.mdx +5 -5
  325. package/docs/reference/typescript-api/services/role-service.mdx +11 -11
  326. package/docs/reference/typescript-api/services/search-service.mdx +2 -2
  327. package/docs/reference/typescript-api/services/seller-service.mdx +3 -3
  328. package/docs/reference/typescript-api/services/session-service.mdx +8 -8
  329. package/docs/reference/typescript-api/services/settings-store-service.mdx +15 -15
  330. package/docs/reference/typescript-api/services/shipping-method-service.mdx +8 -8
  331. package/docs/reference/typescript-api/services/slug-service.mdx +1 -1
  332. package/docs/reference/typescript-api/services/stock-level-service.mdx +3 -3
  333. package/docs/reference/typescript-api/services/stock-location-service.mdx +7 -7
  334. package/docs/reference/typescript-api/services/stock-movement-service.mdx +7 -7
  335. package/docs/reference/typescript-api/services/tag-service.mdx +5 -5
  336. package/docs/reference/typescript-api/services/tax-category-service.mdx +5 -5
  337. package/docs/reference/typescript-api/services/tax-rate-service.mdx +6 -6
  338. package/docs/reference/typescript-api/services/user-service.mdx +12 -12
  339. package/docs/reference/typescript-api/services/zone-service.mdx +8 -8
  340. package/docs/reference/typescript-api/settings-store/settings-store-field-config.mdx +2 -2
  341. package/docs/reference/typescript-api/shipping/default-shipping-line-assignment-strategy.mdx +1 -1
  342. package/docs/reference/typescript-api/shipping/shipping-calculator.mdx +2 -2
  343. package/docs/reference/typescript-api/shipping/shipping-line-assignment-strategy.mdx +1 -1
  344. package/docs/reference/typescript-api/shipping/shipping-options.mdx +5 -5
  345. package/docs/reference/typescript-api/state-machine/fsm.mdx +1 -1
  346. package/docs/reference/typescript-api/tax/tax-line-calculation-strategy.mdx +1 -1
  347. package/docs/reference/typescript-api/tax/tax-zone-strategy.mdx +1 -1
  348. package/docs/reference/typescript-api/telemetry/wrapped-method-args.mdx +2 -2
  349. package/docs/reference/typescript-api/testing/create-error-result-guard.mdx +1 -1
  350. package/docs/reference/typescript-api/testing/create-test-environment.mdx +1 -1
  351. package/docs/reference/typescript-api/testing/error-result-guard.mdx +1 -1
  352. package/docs/reference/typescript-api/testing/simple-graph-qlclient.mdx +5 -5
  353. package/docs/reference/typescript-api/testing/test-db-initializer.mdx +3 -3
  354. package/docs/reference/typescript-api/testing/test-server.mdx +2 -2
  355. package/docs/reference/typescript-api/testing/testing-logger.mdx +1 -1
  356. package/docs/reference/typescript-api/worker/bootstrap-worker.mdx +2 -2
  357. package/docs/reference/typescript-api/worker/vendure-worker.mdx +2 -2
  358. package/package.json +1 -1
@@ -25,7 +25,7 @@ class DefaultProductVariantPriceCalculationStrategy implements ProductVariantPri
25
25
 
26
26
  ### calculate
27
27
 
28
- <MemberInfo kind="method" type={`(args: <a href='/reference/typescript-api/products-stock/product-variant-price-calculation-strategy#productvariantpricecalculationargs'>ProductVariantPriceCalculationArgs</a>) => Promise<<a href='/reference/typescript-api/common/price-calculation-result#pricecalculationresult'>PriceCalculationResult</a>>`} />
28
+ <MemberInfo kind="method" type={`(args: <a href='/reference/typescript-api/products-stock/product-variant-price-calculation-strategy#productvariantpricecalculationargs'>ProductVariantPriceCalculationArgs</a>) => `Promise<`<a href='/reference/typescript-api/common/price-calculation-result#pricecalculationresult'>PriceCalculationResult</a>`>``} />
29
29
 
30
30
 
31
31
 
@@ -34,7 +34,7 @@ class DefaultStockLocationStrategy extends BaseStockLocationStrategy {
34
34
 
35
35
  ### forAllocation
36
36
 
37
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, stockLocations: <a href='/reference/typescript-api/entities/stock-location#stocklocation'>StockLocation</a>[], orderLine: <a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a>, quantity: number) => <a href='/reference/typescript-api/products-stock/stock-location-strategy#locationwithquantity'>LocationWithQuantity</a>[] | Promise<<a href='/reference/typescript-api/products-stock/stock-location-strategy#locationwithquantity'>LocationWithQuantity</a>[]>`} />
37
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, stockLocations: <a href='/reference/typescript-api/entities/stock-location#stocklocation'>StockLocation</a>[], orderLine: <a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a>, quantity: number) => <a href='/reference/typescript-api/products-stock/stock-location-strategy#locationwithquantity'>LocationWithQuantity</a>`[] | Promise<`<a href='/reference/typescript-api/products-stock/stock-location-strategy#locationwithquantity'>LocationWithQuantity</a>`[]>``} />
38
38
 
39
39
 
40
40
 
@@ -26,12 +26,12 @@ class MultiChannelStockLocationStrategy extends BaseStockLocationStrategy {
26
26
 
27
27
  ### getAvailableStock
28
28
 
29
- <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>, stockLevels: <a href='/reference/typescript-api/entities/stock-level#stocklevel'>StockLevel</a>[]) => Promise<<a href='/reference/typescript-api/products-stock/stock-location-strategy#availablestock'>AvailableStock</a>>`} />
29
+ <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>, stockLevels: <a href='/reference/typescript-api/entities/stock-level#stocklevel'>StockLevel</a>[]) => `Promise<`<a href='/reference/typescript-api/products-stock/stock-location-strategy#availablestock'>AvailableStock</a>`>``} />
30
30
 
31
31
  Returns the available stock for the given ProductVariant, taking into account the active Channel.
32
32
  ### forAllocation
33
33
 
34
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, stockLocations: <a href='/reference/typescript-api/entities/stock-location#stocklocation'>StockLocation</a>[], orderLine: <a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a>, quantity: number) => Promise<<a href='/reference/typescript-api/products-stock/stock-location-strategy#locationwithquantity'>LocationWithQuantity</a>[]>`} />
34
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, stockLocations: <a href='/reference/typescript-api/entities/stock-location#stocklocation'>StockLocation</a>[], orderLine: <a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a>, quantity: number) => `Promise<`<a href='/reference/typescript-api/products-stock/stock-location-strategy#locationwithquantity'>LocationWithQuantity</a>`[]>``} />
35
35
 
36
36
  This method takes into account whether the stock location is applicable to the active channel.
37
37
  It furthermore respects the `trackInventory` and `outOfStockThreshold` settings of the ProductVariant,
@@ -26,7 +26,7 @@ interface ProductVariantPriceCalculationStrategy extends InjectableStrategy {
26
26
 
27
27
  ### calculate
28
28
 
29
- <MemberInfo kind="method" type={`(args: <a href='/reference/typescript-api/products-stock/product-variant-price-calculation-strategy#productvariantpricecalculationargs'>ProductVariantPriceCalculationArgs</a>) => Promise<<a href='/reference/typescript-api/common/price-calculation-result#pricecalculationresult'>PriceCalculationResult</a>>`} />
29
+ <MemberInfo kind="method" type={`(args: <a href='/reference/typescript-api/products-stock/product-variant-price-calculation-strategy#productvariantpricecalculationargs'>ProductVariantPriceCalculationArgs</a>) => `Promise<`<a href='/reference/typescript-api/common/price-calculation-result#pricecalculationresult'>PriceCalculationResult</a>`>``} />
30
30
 
31
31
 
32
32
 
@@ -33,7 +33,7 @@ interface StockDisplayStrategy extends InjectableStrategy {
33
33
 
34
34
  ### getStockLevel
35
35
 
36
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, productVariant: <a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>, saleableStockLevel: number) => string | Promise<string>`} />
36
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, productVariant: <a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>, saleableStockLevel: number) => `string | Promise<string>``} />
37
37
 
38
38
  Returns a string representing the stock level, which will be used directly
39
39
  in the GraphQL `ProductVariant.stockLevel` field.
@@ -57,31 +57,31 @@ interface StockLocationStrategy extends InjectableStrategy {
57
57
 
58
58
  ### getAvailableStock
59
59
 
60
- <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>, stockLevels: <a href='/reference/typescript-api/entities/stock-level#stocklevel'>StockLevel</a>[]) => <a href='/reference/typescript-api/products-stock/stock-location-strategy#availablestock'>AvailableStock</a> | Promise<<a href='/reference/typescript-api/products-stock/stock-location-strategy#availablestock'>AvailableStock</a>>`} />
60
+ <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>, stockLevels: <a href='/reference/typescript-api/entities/stock-level#stocklevel'>StockLevel</a>[]) => <a href='/reference/typescript-api/products-stock/stock-location-strategy#availablestock'>AvailableStock</a>` | Promise<`<a href='/reference/typescript-api/products-stock/stock-location-strategy#availablestock'>AvailableStock</a>`>``} />
61
61
 
62
62
  Returns the available stock for the given ProductVariant, taking into account
63
63
  the stock levels at each StockLocation.
64
64
  ### forAllocation
65
65
 
66
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, stockLocations: <a href='/reference/typescript-api/entities/stock-location#stocklocation'>StockLocation</a>[], orderLine: <a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a>, quantity: number) => <a href='/reference/typescript-api/products-stock/stock-location-strategy#locationwithquantity'>LocationWithQuantity</a>[] | Promise<<a href='/reference/typescript-api/products-stock/stock-location-strategy#locationwithquantity'>LocationWithQuantity</a>[]>`} />
66
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, stockLocations: <a href='/reference/typescript-api/entities/stock-location#stocklocation'>StockLocation</a>[], orderLine: <a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a>, quantity: number) => <a href='/reference/typescript-api/products-stock/stock-location-strategy#locationwithquantity'>LocationWithQuantity</a>`[] | Promise<`<a href='/reference/typescript-api/products-stock/stock-location-strategy#locationwithquantity'>LocationWithQuantity</a>`[]>``} />
67
67
 
68
68
  Determines which StockLocations should be used to when allocating stock when
69
69
  and Order is placed.
70
70
  ### forRelease
71
71
 
72
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, stockLocations: <a href='/reference/typescript-api/entities/stock-location#stocklocation'>StockLocation</a>[], orderLine: <a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a>, quantity: number) => <a href='/reference/typescript-api/products-stock/stock-location-strategy#locationwithquantity'>LocationWithQuantity</a>[] | Promise<<a href='/reference/typescript-api/products-stock/stock-location-strategy#locationwithquantity'>LocationWithQuantity</a>[]>`} />
72
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, stockLocations: <a href='/reference/typescript-api/entities/stock-location#stocklocation'>StockLocation</a>[], orderLine: <a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a>, quantity: number) => <a href='/reference/typescript-api/products-stock/stock-location-strategy#locationwithquantity'>LocationWithQuantity</a>`[] | Promise<`<a href='/reference/typescript-api/products-stock/stock-location-strategy#locationwithquantity'>LocationWithQuantity</a>`[]>``} />
73
73
 
74
74
  Determines which StockLocations should be used to when releasing allocated
75
75
  stock when an OrderLine is cancelled before being fulfilled.
76
76
  ### forSale
77
77
 
78
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, stockLocations: <a href='/reference/typescript-api/entities/stock-location#stocklocation'>StockLocation</a>[], orderLine: <a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a>, quantity: number) => <a href='/reference/typescript-api/products-stock/stock-location-strategy#locationwithquantity'>LocationWithQuantity</a>[] | Promise<<a href='/reference/typescript-api/products-stock/stock-location-strategy#locationwithquantity'>LocationWithQuantity</a>[]>`} />
78
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, stockLocations: <a href='/reference/typescript-api/entities/stock-location#stocklocation'>StockLocation</a>[], orderLine: <a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a>, quantity: number) => <a href='/reference/typescript-api/products-stock/stock-location-strategy#locationwithquantity'>LocationWithQuantity</a>`[] | Promise<`<a href='/reference/typescript-api/products-stock/stock-location-strategy#locationwithquantity'>LocationWithQuantity</a>`[]>``} />
79
79
 
80
80
  Determines which StockLocations should be used to when creating a Sale
81
81
  and reducing the stockOnHand upon fulfillment.
82
82
  ### forCancellation
83
83
 
84
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, stockLocations: <a href='/reference/typescript-api/entities/stock-location#stocklocation'>StockLocation</a>[], orderLine: <a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a>, quantity: number) => <a href='/reference/typescript-api/products-stock/stock-location-strategy#locationwithquantity'>LocationWithQuantity</a>[] | Promise<<a href='/reference/typescript-api/products-stock/stock-location-strategy#locationwithquantity'>LocationWithQuantity</a>[]>`} />
84
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, stockLocations: <a href='/reference/typescript-api/entities/stock-location#stocklocation'>StockLocation</a>[], orderLine: <a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a>, quantity: number) => <a href='/reference/typescript-api/products-stock/stock-location-strategy#locationwithquantity'>LocationWithQuantity</a>`[] | Promise<`<a href='/reference/typescript-api/products-stock/stock-location-strategy#locationwithquantity'>LocationWithQuantity</a>`[]>``} />
85
85
 
86
86
  Determines which StockLocations should be used to when creating a Cancellation
87
87
  of an OrderLine which has already been fulfilled.
@@ -63,7 +63,7 @@ class FacetValueChecker implements OnModuleInit {
63
63
 
64
64
  ### hasFacetValues
65
65
 
66
- <MemberInfo kind="method" type={`(orderLine: <a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a>, facetValueIds: <a href='/reference/typescript-api/common/id#id'>ID</a>[], ctx?: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => Promise<boolean>`} />
66
+ <MemberInfo kind="method" type={`(orderLine: <a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a>, facetValueIds: <a href='/reference/typescript-api/common/id#id'>ID</a>[], ctx?: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => `Promise<boolean>``} />
67
67
 
68
68
  Checks a given <DocsLink href="/reference/typescript-api/entities/order-line#orderline">OrderLine</DocsLink> against the facetValueIds and returns
69
69
  `true` if the associated <DocsLink href="/reference/typescript-api/entities/product-variant#productvariant">ProductVariant</DocsLink> & <DocsLink href="/reference/typescript-api/entities/product#product">Product</DocsLink> together
@@ -227,7 +227,7 @@ on the same Order. See the <DocsLink href="/reference/typescript-api/entities/pr
227
227
  more information.
228
228
  ### conditions
229
229
 
230
- <MemberInfo kind="property" type={`U extends undefined ? undefined : ConditionTuple<Exclude<U, undefined>>`} />
230
+ <MemberInfo kind="property" type={``U extends undefined ? undefined : ConditionTuple<Exclude<U, undefined>>``} />
231
231
 
232
232
  Allows PromotionActions to define one or more PromotionConditions as dependencies. Having a PromotionCondition
233
233
  as a dependency has the following consequences:
@@ -41,7 +41,7 @@ more information.
41
41
 
42
42
  ### check
43
43
 
44
- <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>, args: ConfigArg[], promotion: <a href='/reference/typescript-api/entities/promotion#promotion'>Promotion</a>) => Promise<R>`} />
44
+ <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>, args: ConfigArg[], promotion: <a href='/reference/typescript-api/entities/promotion#promotion'>Promotion</a>) => `Promise<R>``} />
45
45
 
46
46
  This is the function which contains the conditional logic to decide whether
47
47
  a Promotion should apply to an Order. See <DocsLink href="/reference/typescript-api/promotions/promotion-condition#checkpromotionconditionfn">CheckPromotionConditionFn</DocsLink>.
@@ -17,12 +17,12 @@ interface PromotionOptions {
17
17
 
18
18
  ### promotionConditions
19
19
 
20
- <MemberInfo kind="property" type={`Array<<a href='/reference/typescript-api/promotions/promotion-condition#promotioncondition'>PromotionCondition</a>`<any>`>`} />
20
+ <MemberInfo kind="property" type={``Array<`<a href='/reference/typescript-api/promotions/promotion-condition#promotioncondition'>PromotionCondition</a>`<any>>``} />
21
21
 
22
22
  An array of conditions which can be used to construct Promotions
23
23
  ### promotionActions
24
24
 
25
- <MemberInfo kind="property" type={`Array<<a href='/reference/typescript-api/promotions/promotion-action#promotionaction'>PromotionAction</a>`<any>`>`} />
25
+ <MemberInfo kind="property" type={``Array<`<a href='/reference/typescript-api/promotions/promotion-action#promotionaction'>PromotionAction</a>`<any>>``} />
26
26
 
27
27
  An array of actions which can be used to construct Promotions
28
28
 
@@ -25,14 +25,14 @@ class RequestContextService {
25
25
 
26
26
  ### create
27
27
 
28
- <MemberInfo kind="method" type={`(config: { req?: Request; apiType: <a href='/reference/typescript-api/request/api-type#apitype'>ApiType</a>; channelOrToken?: <a href='/reference/typescript-api/entities/channel#channel'>Channel</a> | string; languageCode?: <a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>; currencyCode?: <a href='/reference/typescript-api/common/currency-code#currencycode'>CurrencyCode</a>; user?: <a href='/reference/typescript-api/entities/user#user'>User</a>; activeOrderId?: <a href='/reference/typescript-api/common/id#id'>ID</a>; }) => Promise<<a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>>`} since="1.5.0" />
28
+ <MemberInfo kind="method" type={`(config: { req?: Request; apiType: <a href='/reference/typescript-api/request/api-type#apitype'>ApiType</a>; channelOrToken?: <a href='/reference/typescript-api/entities/channel#channel'>Channel</a> | string; languageCode?: <a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>; currencyCode?: <a href='/reference/typescript-api/common/currency-code#currencycode'>CurrencyCode</a>; user?: <a href='/reference/typescript-api/entities/user#user'>User</a>; activeOrderId?: <a href='/reference/typescript-api/common/id#id'>ID</a>; }) => `Promise<`<a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>`>``} since="1.5.0" />
29
29
 
30
30
  Creates a RequestContext based on the config provided. This can be useful when interacting
31
31
  with services outside the request-response cycle, for example in stand-alone scripts or in
32
32
  worker jobs.
33
33
  ### fromRequest
34
34
 
35
- <MemberInfo kind="method" type={`(req: Request, info?: GraphQLResolveInfo, requiredPermissions?: <a href='/reference/typescript-api/common/permission#permission'>Permission</a>[], session?: <a href='/reference/typescript-api/auth/session-cache-strategy#cachedsession'>CachedSession</a>) => Promise<<a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>>`} />
35
+ <MemberInfo kind="method" type={`(req: Request, info?: GraphQLResolveInfo, requiredPermissions?: <a href='/reference/typescript-api/common/permission#permission'>Permission</a>[], session?: <a href='/reference/typescript-api/auth/session-cache-strategy#cachedsession'>CachedSession</a>) => `Promise<`<a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>`>``} />
36
36
 
37
37
  Creates a new RequestContext based on an Express request object. This is used internally
38
38
  in the API layer by the AuthGuard, and creates the RequestContext which is then passed
@@ -48,22 +48,22 @@ class DefaultSchedulerStrategy implements SchedulerStrategy {
48
48
 
49
49
  ### getTasks
50
50
 
51
- <MemberInfo kind="method" type={`() => Promise<<a href='/reference/typescript-api/scheduled-tasks/scheduler-strategy#taskreport'>TaskReport</a>[]>`} />
51
+ <MemberInfo kind="method" type={`() => `Promise<`<a href='/reference/typescript-api/scheduled-tasks/scheduler-strategy#taskreport'>TaskReport</a>`[]>``} />
52
52
 
53
53
 
54
54
  ### getTask
55
55
 
56
- <MemberInfo kind="method" type={`(id: string) => Promise<<a href='/reference/typescript-api/scheduled-tasks/scheduler-strategy#taskreport'>TaskReport</a> | undefined>`} />
56
+ <MemberInfo kind="method" type={`(id: string) => `Promise<`<a href='/reference/typescript-api/scheduled-tasks/scheduler-strategy#taskreport'>TaskReport</a>` | undefined>``} />
57
57
 
58
58
 
59
59
  ### updateTask
60
60
 
61
- <MemberInfo kind="method" type={`(input: UpdateScheduledTaskInput) => Promise<<a href='/reference/typescript-api/scheduled-tasks/scheduler-strategy#taskreport'>TaskReport</a>>`} />
61
+ <MemberInfo kind="method" type={`(input: UpdateScheduledTaskInput) => `Promise<`<a href='/reference/typescript-api/scheduled-tasks/scheduler-strategy#taskreport'>TaskReport</a>`>``} />
62
62
 
63
63
 
64
64
  ### triggerTask
65
65
 
66
- <MemberInfo kind="method" type={`(task: <a href='/reference/typescript-api/scheduled-tasks/scheduled-task#scheduledtask'>ScheduledTask</a>) => Promise<void>`} />
66
+ <MemberInfo kind="method" type={`(task: <a href='/reference/typescript-api/scheduled-tasks/scheduled-task#scheduledtask'>ScheduledTask</a>) => `Promise<void>``} />
67
67
 
68
68
 
69
69
 
@@ -54,7 +54,7 @@ class ScheduledTask<C extends Record<string, any> = Record<string, any>> {
54
54
 
55
55
  ### configure
56
56
 
57
- <MemberInfo kind="method" type={`(additionalConfig: Partial<Pick<<a href='/reference/typescript-api/scheduled-tasks/scheduled-task#scheduledtaskconfig'>ScheduledTaskConfig</a>`<C>`, 'schedule' | 'timeout' | 'params'>>) => `} />
57
+ <MemberInfo kind="method" type={`(additionalConfig: `Partial<Pick<`<a href='/reference/typescript-api/scheduled-tasks/scheduled-task#scheduledtaskconfig'>ScheduledTaskConfig</a>`<C>, 'schedule' | 'timeout' | 'params'>>`) => `} />
58
58
 
59
59
  This method allows you to further configure existing scheduled tasks. For example, you may
60
60
  wish to change the schedule or timeout of a task, without having to define a new task.
@@ -145,7 +145,7 @@ The description for the scheduled task.
145
145
  Optional parameters that will be passed to the `execute` function.
146
146
  ### schedule
147
147
 
148
- <MemberInfo kind="property" type={`string | ((cronTime: typeof CronTime) => string)`} />
148
+ <MemberInfo kind="property" type={``string | ((cronTime: typeof CronTime) => string)``} />
149
149
 
150
150
  The cron schedule for the scheduled task. This can be a standard cron expression or
151
151
  a function that returns a [cron-time-generator](https://www.npmjs.com/package/cron-time-generator)
@@ -175,7 +175,7 @@ will be considered to have failed with a timeout error.
175
175
  Whether the scheduled task should be prevented from running if it is already running.
176
176
  ### execute
177
177
 
178
- <MemberInfo kind="method" type={`(args: <a href='/reference/typescript-api/scheduled-tasks/scheduled-task#scheduledtaskexecutionargs'>ScheduledTaskExecutionArgs</a>`<C>`) => Promise<any>`} />
178
+ <MemberInfo kind="method" type={`(args: <a href='/reference/typescript-api/scheduled-tasks/scheduled-task#scheduledtaskexecutionargs'>ScheduledTaskExecutionArgs</a>`<C>`) => `Promise<any>``} />
179
179
 
180
180
  The function that will be executed when the scheduled task is run.
181
181
 
@@ -39,17 +39,17 @@ class SchedulerService implements OnApplicationBootstrap, OnApplicationShutdown
39
39
 
40
40
  ### getTaskList
41
41
 
42
- <MemberInfo kind="method" type={`() => Promise<TaskInfo[]>`} />
42
+ <MemberInfo kind="method" type={`() => `Promise<TaskInfo[]>``} />
43
43
 
44
44
  Returns a list of all the scheduled tasks and their current status.
45
45
  ### updateTask
46
46
 
47
- <MemberInfo kind="method" type={`(input: UpdateScheduledTaskInput) => Promise<TaskInfo>`} />
47
+ <MemberInfo kind="method" type={`(input: UpdateScheduledTaskInput) => `Promise<TaskInfo>``} />
48
48
 
49
49
 
50
50
  ### runTask
51
51
 
52
- <MemberInfo kind="method" type={`(taskId: string) => Promise<Success>`} />
52
+ <MemberInfo kind="method" type={`(taskId: string) => `Promise<Success>``} />
53
53
 
54
54
 
55
55
 
@@ -40,7 +40,7 @@ tasks ahead of time. This can be useful for keeping an internal reference of
40
40
  all the tasks to aid in the specific strategy implemetation.
41
41
  ### executeTask
42
42
 
43
- <MemberInfo kind="method" type={`(task: <a href='/reference/typescript-api/scheduled-tasks/scheduled-task#scheduledtask'>ScheduledTask</a>) => (job?: Cron) => Promise<any> | any`} />
43
+ <MemberInfo kind="method" type={`(task: <a href='/reference/typescript-api/scheduled-tasks/scheduled-task#scheduledtask'>ScheduledTask</a>) => `(job?: Cron) => Promise<any> | any``} />
44
44
 
45
45
  Execute a scheduled task. This method must also take care of
46
46
  ensuring that the task is executed exactly once at the scheduled time,
@@ -57,17 +57,17 @@ The function returned is then called in order to execture the task. The
57
57
  the task has been manually triggered, in which case it will be undefined.
58
58
  ### getTasks
59
59
 
60
- <MemberInfo kind="method" type={`() => Promise<<a href='/reference/typescript-api/scheduled-tasks/scheduler-strategy#taskreport'>TaskReport</a>[]>`} />
60
+ <MemberInfo kind="method" type={`() => `Promise<`<a href='/reference/typescript-api/scheduled-tasks/scheduler-strategy#taskreport'>TaskReport</a>`[]>``} />
61
61
 
62
62
  Get all scheduled tasks.
63
63
  ### getTask
64
64
 
65
- <MemberInfo kind="method" type={`(id: string) => Promise<<a href='/reference/typescript-api/scheduled-tasks/scheduler-strategy#taskreport'>TaskReport</a> | undefined>`} />
65
+ <MemberInfo kind="method" type={`(id: string) => `Promise<`<a href='/reference/typescript-api/scheduled-tasks/scheduler-strategy#taskreport'>TaskReport</a>` | undefined>``} />
66
66
 
67
67
  Get a single scheduled task by its id.
68
68
  ### triggerTask
69
69
 
70
- <MemberInfo kind="method" type={`(task: <a href='/reference/typescript-api/scheduled-tasks/scheduled-task#scheduledtask'>ScheduledTask</a>) => Promise<void>`} />
70
+ <MemberInfo kind="method" type={`(task: <a href='/reference/typescript-api/scheduled-tasks/scheduled-task#scheduledtask'>ScheduledTask</a>) => `Promise<void>``} />
71
71
 
72
72
  Manually trigger a given task. This method is not used to actually invoke the
73
73
  task function itself, since that would cause the task to run on the server
@@ -80,7 +80,7 @@ a flag in the database table which is checked periodically and causes those task
80
80
  to get immediately invoked.
81
81
  ### updateTask
82
82
 
83
- <MemberInfo kind="method" type={`(input: UpdateScheduledTaskInput) => Promise<<a href='/reference/typescript-api/scheduled-tasks/scheduler-strategy#taskreport'>TaskReport</a>>`} />
83
+ <MemberInfo kind="method" type={`(input: UpdateScheduledTaskInput) => `Promise<`<a href='/reference/typescript-api/scheduled-tasks/scheduler-strategy#taskreport'>TaskReport</a>`>``} />
84
84
 
85
85
  Update a scheduled task.
86
86
 
@@ -29,7 +29,7 @@ class EntityDuplicatorService {
29
29
  Returns all configured <DocsLink href="/reference/typescript-api/configuration/entity-duplicator#entityduplicator">EntityDuplicator</DocsLink> definitions.
30
30
  ### duplicateEntity
31
31
 
32
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: DuplicateEntityInput) => Promise<DuplicateEntityResult>`} />
32
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: DuplicateEntityInput) => `Promise<DuplicateEntityResult>``} />
33
33
 
34
34
  Duplicates an entity using the specified <DocsLink href="/reference/typescript-api/configuration/entity-duplicator#entityduplicator">EntityDuplicator</DocsLink>. The duplication is performed
35
35
  within a transaction, so if an error occurs, the transaction will be rolled back.
@@ -28,7 +28,7 @@ class OrderCalculator {
28
28
 
29
29
  ### applyPriceAdjustments
30
30
 
31
- <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>, promotions: <a href='/reference/typescript-api/entities/promotion#promotion'>Promotion</a>[], updatedOrderLines: <a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a>[] = [], options?: { recalculateShipping?: boolean }) => Promise<<a href='/reference/typescript-api/entities/order#order'>Order</a>>`} />
31
+ <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>, promotions: <a href='/reference/typescript-api/entities/promotion#promotion'>Promotion</a>[], updatedOrderLines: <a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a>[] = [], options?: { recalculateShipping?: boolean }) => `Promise<`<a href='/reference/typescript-api/entities/order#order'>Order</a>`>``} />
32
32
 
33
33
  Applies taxes and promotions to an Order. Mutates the order object.
34
34
  Returns an array of any OrderItems which had new adjustments
@@ -49,7 +49,7 @@ OrderLines into account when constraining the quantity. See https://github.com/v
49
49
  for more on this.
50
50
  ### getExistingOrderLine
51
51
 
52
- <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>, productVariantId: <a href='/reference/typescript-api/common/id#id'>ID</a>, customFields?: { [key: string]: any }) => Promise<<a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a> | undefined>`} />
52
+ <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>, productVariantId: <a href='/reference/typescript-api/common/id#id'>ID</a>, customFields?: { [key: string]: any }) => `Promise<`<a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a>` | undefined>``} />
53
53
 
54
54
  Given a ProductVariant ID and optional custom fields, this method will return an existing OrderLine that
55
55
  matches, or `undefined` if no match is found.
@@ -61,7 +61,7 @@ Returns the OrderLine containing the given <DocsLink href="/reference/typescript
61
61
  OrderLine is found, a new OrderLine will be created.
62
62
  ### updateOrderLineQuantity
63
63
 
64
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, orderLine: <a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a>, quantity: number, order: <a href='/reference/typescript-api/entities/order#order'>Order</a>) => Promise<<a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a>>`} />
64
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, orderLine: <a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a>, quantity: number, order: <a href='/reference/typescript-api/entities/order#order'>Order</a>) => `Promise<`<a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a>`>``} />
65
65
 
66
66
  Updates the quantity of an OrderLine, taking into account the available saleable stock level.
67
67
  Returns the actual quantity that the OrderLine was updated to (which may be less than the
@@ -73,7 +73,7 @@ Returns the actual quantity that the OrderLine was updated to (which may be less
73
73
 
74
74
  ### modifyOrder
75
75
 
76
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: ModifyOrderInput, order: <a href='/reference/typescript-api/entities/order#order'>Order</a>) => Promise<JustErrorResults<ModifyOrderResult> | { order: <a href='/reference/typescript-api/entities/order#order'>Order</a>; modification: <a href='/reference/typescript-api/entities/order-modification#ordermodification'>OrderModification</a> }>`} />
76
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: ModifyOrderInput, order: <a href='/reference/typescript-api/entities/order#order'>Order</a>) => `Promise<JustErrorResults<ModifyOrderResult> | { order: `<a href='/reference/typescript-api/entities/order#order'>Order</a>; modification: <a href='/reference/typescript-api/entities/order-modification#ordermodification'>OrderModification</a>` }>``} />
77
77
 
78
78
 
79
79
  ### setShippingMethods
@@ -45,7 +45,7 @@ class ProductPriceApplicator {
45
45
 
46
46
  ### applyChannelPriceAndTax
47
47
 
48
- <MemberInfo kind="method" type={`(variant: <a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>, ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, order?: <a href='/reference/typescript-api/entities/order#order'>Order</a>, throwIfNoPriceFound: = false) => Promise<<a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>>`} />
48
+ <MemberInfo kind="method" type={`(variant: <a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>, ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, order?: <a href='/reference/typescript-api/entities/order#order'>Order</a>, throwIfNoPriceFound: = false) => `Promise<`<a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>`>``} />
49
49
 
50
50
  Populates the `price` field with the price for the specified channel. Make sure that
51
51
  the ProductVariant being passed in has its `taxCategory` relation joined.
@@ -23,7 +23,7 @@ class SlugValidator {
23
23
 
24
24
  ### validateSlugs
25
25
 
26
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: T, translationEntity: Type<E>) => Promise<T>`} />
26
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: T, translationEntity: `Type<E>`) => `Promise<T>``} />
27
27
 
28
28
 
29
29
 
@@ -53,7 +53,7 @@ type InputWithSlug = {
53
53
 
54
54
  ### translations
55
55
 
56
- <MemberInfo kind="property" type={`Array<{ id?: <a href='/reference/typescript-api/common/id#id'>ID</a> | null; languageCode: <a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>; slug?: string | null; }> | null`} />
56
+ <MemberInfo kind="property" type={``Array<{ id?: `<a href='/reference/typescript-api/common/id#id'>ID</a> | null; languageCode: <a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>`; slug?: string | null; }> | null``} />
57
57
 
58
58
 
59
59
 
@@ -46,13 +46,13 @@ class TranslatableSaver {
46
46
 
47
47
  ### create
48
48
 
49
- <MemberInfo kind="method" type={`(options: CreateTranslatableOptions<T>) => Promise<T>`} />
49
+ <MemberInfo kind="method" type={`(options: `CreateTranslatableOptions<T>`) => `Promise<T>``} />
50
50
 
51
51
  Create a translatable entity, including creating any translation entities according
52
52
  to the `translations` array.
53
53
  ### update
54
54
 
55
- <MemberInfo kind="method" type={`(options: UpdateTranslatableOptions<T>) => Promise<T>`} />
55
+ <MemberInfo kind="method" type={`(options: `UpdateTranslatableOptions<T>`) => `Promise<T>``} />
56
56
 
57
57
  Update a translatable entity. Performs a diff of the `translations` array in order to
58
58
  perform the correct operation on the translations.
@@ -50,7 +50,7 @@ class TranslatorService {
50
50
 
51
51
  ### translate
52
52
 
53
- <MemberInfo kind="method" type={`(translatable: T, ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, translatableRelations: DeepTranslatableRelations<T> = []) => `} />
53
+ <MemberInfo kind="method" type={`(translatable: T, ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, translatableRelations: `DeepTranslatableRelations<T>` = []) => `} />
54
54
 
55
55
 
56
56
 
@@ -28,32 +28,32 @@ class AdministratorService {
28
28
 
29
29
  ### findAll
30
30
 
31
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, options?: ListQueryOptions<<a href='/reference/typescript-api/entities/administrator#administrator'>Administrator</a>>, relations?: RelationPaths<<a href='/reference/typescript-api/entities/administrator#administrator'>Administrator</a>>) => Promise<<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a>`<<a href='/reference/typescript-api/entities/administrator#administrator'>`Administrator</a>>>`} />
31
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, options?: `ListQueryOptions<`<a href='/reference/typescript-api/entities/administrator#administrator'>Administrator</a>`>`, relations?: `RelationPaths<`<a href='/reference/typescript-api/entities/administrator#administrator'>Administrator</a>`>`) => `Promise<`<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a>`<`<a href='/reference/typescript-api/entities/administrator#administrator'>Administrator</a>`>>``} />
32
32
 
33
33
  Get a paginated list of Administrators.
34
34
  ### findOne
35
35
 
36
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, administratorId: <a href='/reference/typescript-api/common/id#id'>ID</a>, relations?: RelationPaths<<a href='/reference/typescript-api/entities/administrator#administrator'>Administrator</a>>) => Promise<<a href='/reference/typescript-api/entities/administrator#administrator'>Administrator</a> | undefined>`} />
36
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, administratorId: <a href='/reference/typescript-api/common/id#id'>ID</a>, relations?: `RelationPaths<`<a href='/reference/typescript-api/entities/administrator#administrator'>Administrator</a>`>`) => `Promise<`<a href='/reference/typescript-api/entities/administrator#administrator'>Administrator</a>` | undefined>``} />
37
37
 
38
38
  Get an Administrator by id.
39
39
  ### findOneByUserId
40
40
 
41
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, userId: <a href='/reference/typescript-api/common/id#id'>ID</a>, relations?: RelationPaths<<a href='/reference/typescript-api/entities/administrator#administrator'>Administrator</a>>) => Promise<<a href='/reference/typescript-api/entities/administrator#administrator'>Administrator</a> | undefined>`} />
41
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, userId: <a href='/reference/typescript-api/common/id#id'>ID</a>, relations?: `RelationPaths<`<a href='/reference/typescript-api/entities/administrator#administrator'>Administrator</a>`>`) => `Promise<`<a href='/reference/typescript-api/entities/administrator#administrator'>Administrator</a>` | undefined>``} />
42
42
 
43
43
  Get an Administrator based on the User id.
44
44
  ### create
45
45
 
46
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: CreateAdministratorInput) => Promise<<a href='/reference/typescript-api/entities/administrator#administrator'>Administrator</a>>`} />
46
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: CreateAdministratorInput) => `Promise<`<a href='/reference/typescript-api/entities/administrator#administrator'>Administrator</a>`>``} />
47
47
 
48
48
  Create a new Administrator.
49
49
  ### update
50
50
 
51
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: UpdateAdministratorInput) => Promise<<a href='/reference/typescript-api/entities/administrator#administrator'>Administrator</a>>`} />
51
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: UpdateAdministratorInput) => `Promise<`<a href='/reference/typescript-api/entities/administrator#administrator'>Administrator</a>`>``} />
52
52
 
53
53
  Update an existing Administrator.
54
54
  ### assignRole
55
55
 
56
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, administratorId: <a href='/reference/typescript-api/common/id#id'>ID</a>, roleId: <a href='/reference/typescript-api/common/id#id'>ID</a>) => Promise<<a href='/reference/typescript-api/entities/administrator#administrator'>Administrator</a>>`} />
56
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, administratorId: <a href='/reference/typescript-api/common/id#id'>ID</a>, roleId: <a href='/reference/typescript-api/common/id#id'>ID</a>) => `Promise<`<a href='/reference/typescript-api/entities/administrator#administrator'>Administrator</a>`>``} />
57
57
 
58
58
  Assigns a Role to the Administrator's User entity.
59
59
  ### softDelete
@@ -34,38 +34,38 @@ class AssetService {
34
34
 
35
35
  ### findOne
36
36
 
37
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, id: <a href='/reference/typescript-api/common/id#id'>ID</a>, relations?: RelationPaths<<a href='/reference/typescript-api/entities/asset#asset'>Asset</a>>) => Promise<<a href='/reference/typescript-api/entities/asset#asset'>Asset</a> | undefined>`} />
37
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, id: <a href='/reference/typescript-api/common/id#id'>ID</a>, relations?: `RelationPaths<`<a href='/reference/typescript-api/entities/asset#asset'>Asset</a>`>`) => `Promise<`<a href='/reference/typescript-api/entities/asset#asset'>Asset</a>` | undefined>``} />
38
38
 
39
39
 
40
40
  ### findAll
41
41
 
42
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, options?: AssetListOptions, relations?: RelationPaths<<a href='/reference/typescript-api/entities/asset#asset'>Asset</a>>) => Promise<<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a>`<<a href='/reference/typescript-api/entities/asset#asset'>`Asset</a>>>`} />
42
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, options?: AssetListOptions, relations?: `RelationPaths<`<a href='/reference/typescript-api/entities/asset#asset'>Asset</a>`>`) => `Promise<`<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a>`<`<a href='/reference/typescript-api/entities/asset#asset'>Asset</a>`>>``} />
43
43
 
44
44
 
45
45
  ### getFeaturedAsset
46
46
 
47
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, entity: T) => Promise<<a href='/reference/typescript-api/entities/asset#asset'>Asset</a> | undefined>`} />
47
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, entity: T) => `Promise<`<a href='/reference/typescript-api/entities/asset#asset'>Asset</a>` | undefined>``} />
48
48
 
49
49
 
50
50
  ### getEntityAssets
51
51
 
52
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, entity: T) => Promise<<a href='/reference/typescript-api/entities/asset#asset'>Asset</a>[] | undefined>`} />
52
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, entity: T) => `Promise<`<a href='/reference/typescript-api/entities/asset#asset'>Asset</a>`[] | undefined>``} />
53
53
 
54
54
  Returns the Assets of an entity which has a well-ordered list of Assets, such as Product,
55
55
  ProductVariant or Collection.
56
56
  ### updateFeaturedAsset
57
57
 
58
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, entity: T, input: <a href='/reference/typescript-api/services/asset-service#entityassetinput'>EntityAssetInput</a>) => Promise<T>`} />
58
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, entity: T, input: <a href='/reference/typescript-api/services/asset-service#entityassetinput'>EntityAssetInput</a>) => `Promise<T>``} />
59
59
 
60
60
 
61
61
  ### updateEntityAssets
62
62
 
63
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, entity: T, input: <a href='/reference/typescript-api/services/asset-service#entityassetinput'>EntityAssetInput</a>) => Promise<T>`} />
63
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, entity: T, input: <a href='/reference/typescript-api/services/asset-service#entityassetinput'>EntityAssetInput</a>) => `Promise<T>``} />
64
64
 
65
65
  Updates the assets / featuredAsset of an entity, ensuring that only valid assetIds are used.
66
66
  ### create
67
67
 
68
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: CreateAssetInput) => Promise<CreateAssetResult>`} />
68
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: CreateAssetInput) => `Promise<CreateAssetResult>``} />
69
69
 
70
70
  Create an Asset based on a file uploaded via the GraphQL API. The file should be uploaded
71
71
  using the [GraphQL multipart request specification](https://github.com/jaydenseric/graphql-multipart-request-spec),
@@ -74,33 +74,33 @@ e.g. using the [apollo-upload-client](https://github.com/jaydenseric/apollo-uplo
74
74
  See the [Uploading Files docs](/guides/developer-guide/uploading-files) for an example of usage.
75
75
  ### update
76
76
 
77
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: UpdateAssetInput) => Promise<<a href='/reference/typescript-api/entities/asset#asset'>Asset</a>>`} />
77
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: UpdateAssetInput) => `Promise<`<a href='/reference/typescript-api/entities/asset#asset'>Asset</a>`>``} />
78
78
 
79
79
  Updates the name, focalPoint, tags & custom fields of an Asset.
80
80
  ### delete
81
81
 
82
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, ids: <a href='/reference/typescript-api/common/id#id'>ID</a>[], force: boolean = false, deleteFromAllChannels: boolean = false) => Promise<DeletionResponse>`} />
82
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, ids: <a href='/reference/typescript-api/common/id#id'>ID</a>[], force: boolean = false, deleteFromAllChannels: boolean = false) => `Promise<DeletionResponse>``} />
83
83
 
84
84
  Deletes an Asset after performing checks to ensure that the Asset is not currently in use
85
85
  by a Product, ProductVariant or Collection.
86
86
  ### assignToChannel
87
87
 
88
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: AssignAssetsToChannelInput) => Promise<<a href='/reference/typescript-api/entities/asset#asset'>Asset</a>[]>`} />
88
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: AssignAssetsToChannelInput) => `Promise<`<a href='/reference/typescript-api/entities/asset#asset'>Asset</a>`[]>``} />
89
89
 
90
90
 
91
91
  ### createFromFileStream
92
92
 
93
- <MemberInfo kind="method" type={`(stream: ReadStream, ctx?: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => Promise<CreateAssetResult>`} />
93
+ <MemberInfo kind="method" type={`(stream: ReadStream, ctx?: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => `Promise<CreateAssetResult>``} />
94
94
 
95
95
  Create an Asset from a file stream, for example to create an Asset during data import.
96
96
  ### createFromFileStream
97
97
 
98
- <MemberInfo kind="method" type={`(stream: Readable, filePath: string, ctx?: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => Promise<CreateAssetResult>`} />
98
+ <MemberInfo kind="method" type={`(stream: Readable, filePath: string, ctx?: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => `Promise<CreateAssetResult>``} />
99
99
 
100
100
 
101
101
  ### createFromFileStream
102
102
 
103
- <MemberInfo kind="method" type={`(stream: ReadStream | Readable, maybeFilePathOrCtx?: string | <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, maybeCtx?: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => Promise<CreateAssetResult>`} />
103
+ <MemberInfo kind="method" type={`(stream: ReadStream | Readable, maybeFilePathOrCtx?: string | <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, maybeCtx?: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => `Promise<CreateAssetResult>``} />
104
104
 
105
105
 
106
106