@vendure/docs 0.0.0-202601161541

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 (968) hide show
  1. package/dist/index.d.ts +3 -0
  2. package/dist/index.d.ts.map +1 -0
  3. package/dist/index.js +2 -0
  4. package/dist/index.js.map +1 -0
  5. package/dist/manifest.d.ts +3 -0
  6. package/dist/manifest.d.ts.map +1 -0
  7. package/dist/manifest.js +857 -0
  8. package/dist/manifest.js.map +1 -0
  9. package/docs/guides/core-concepts/auth/admin-role.webp +0 -0
  10. package/docs/guides/core-concepts/auth/admin.webp +0 -0
  11. package/docs/guides/core-concepts/auth/customer.webp +0 -0
  12. package/docs/guides/core-concepts/auth/index.md +557 -0
  13. package/docs/guides/core-concepts/auth/roles.webp +0 -0
  14. package/docs/guides/core-concepts/channels/channel-token.webp +0 -0
  15. package/docs/guides/core-concepts/channels/channels.webp +0 -0
  16. package/docs/guides/core-concepts/channels/channels_currencies_diagram.png +0 -0
  17. package/docs/guides/core-concepts/channels/channels_diagram.png +0 -0
  18. package/docs/guides/core-concepts/channels/channels_prices_diagram.png +0 -0
  19. package/docs/guides/core-concepts/channels/default-currency.webp +0 -0
  20. package/docs/guides/core-concepts/channels/index.md +154 -0
  21. package/docs/guides/core-concepts/channels/variant-prices.webp +0 -0
  22. package/docs/guides/core-concepts/collections/collection-filters.webp +0 -0
  23. package/docs/guides/core-concepts/collections/collections.webp +0 -0
  24. package/docs/guides/core-concepts/collections/filter-inheritance.webp +0 -0
  25. package/docs/guides/core-concepts/collections/index.mdx +125 -0
  26. package/docs/guides/core-concepts/customers/customer.webp +0 -0
  27. package/docs/guides/core-concepts/customers/index.mdx +21 -0
  28. package/docs/guides/core-concepts/email/email-plugin-flow.webp +0 -0
  29. package/docs/guides/core-concepts/email/index.mdx +155 -0
  30. package/docs/guides/core-concepts/images-assets/asset-flow.webp +0 -0
  31. package/docs/guides/core-concepts/images-assets/asset-tags.webp +0 -0
  32. package/docs/guides/core-concepts/images-assets/index.mdx +42 -0
  33. package/docs/guides/core-concepts/money/index.mdx +246 -0
  34. package/docs/guides/core-concepts/orders/custom-order-ui.webp +0 -0
  35. package/docs/guides/core-concepts/orders/index.md +366 -0
  36. package/docs/guides/core-concepts/orders/order-process.webp +0 -0
  37. package/docs/guides/core-concepts/orders/order.webp +0 -0
  38. package/docs/guides/core-concepts/payment/index.md +410 -0
  39. package/docs/guides/core-concepts/payment/payment-method.webp +0 -0
  40. package/docs/guides/core-concepts/payment/payment_sequence_one_step.png +0 -0
  41. package/docs/guides/core-concepts/payment/payment_sequence_two_step.png +0 -0
  42. package/docs/guides/core-concepts/products/facets.webp +0 -0
  43. package/docs/guides/core-concepts/products/index.mdx +59 -0
  44. package/docs/guides/core-concepts/products/product-relations.webp +0 -0
  45. package/docs/guides/core-concepts/products/products-variants.webp +0 -0
  46. package/docs/guides/core-concepts/promotions/index.md +324 -0
  47. package/docs/guides/core-concepts/shipping/index.md +225 -0
  48. package/docs/guides/core-concepts/shipping/shipping-method.webp +0 -0
  49. package/docs/guides/core-concepts/stock-control/global-stock-control.webp +0 -0
  50. package/docs/guides/core-concepts/stock-control/index.md +233 -0
  51. package/docs/guides/core-concepts/stock-control/stock-levels.webp +0 -0
  52. package/docs/guides/core-concepts/taxes/index.mdx +76 -0
  53. package/docs/guides/deployment/deploy-to-digital-ocean-app-platform/01-create-space.webp +0 -0
  54. package/docs/guides/deployment/deploy-to-digital-ocean-app-platform/02-space-access-keys.webp +0 -0
  55. package/docs/guides/deployment/deploy-to-digital-ocean-app-platform/03-create-app.webp +0 -0
  56. package/docs/guides/deployment/deploy-to-digital-ocean-app-platform/04-configure-server.webp +0 -0
  57. package/docs/guides/deployment/deploy-to-digital-ocean-app-platform/05-open-server-settings.webp +0 -0
  58. package/docs/guides/deployment/deploy-to-digital-ocean-app-platform/06-admin-app-route.webp +0 -0
  59. package/docs/guides/deployment/deploy-to-digital-ocean-app-platform/07-open-app.webp +0 -0
  60. package/docs/guides/deployment/deploy-to-digital-ocean-app-platform/deploy-to-do-app-platform.webp +0 -0
  61. package/docs/guides/deployment/deploy-to-digital-ocean-app-platform/index.md +246 -0
  62. package/docs/guides/deployment/deploy-to-google-cloud-run/deploy-to-gcr.webp +0 -0
  63. package/docs/guides/deployment/deploy-to-google-cloud-run/index.md +53 -0
  64. package/docs/guides/deployment/deploy-to-northflank/01-create-template-screen.webp +0 -0
  65. package/docs/guides/deployment/deploy-to-northflank/02-paste-config.webp +0 -0
  66. package/docs/guides/deployment/deploy-to-northflank/03-run-template.webp +0 -0
  67. package/docs/guides/deployment/deploy-to-northflank/04-find-project.webp +0 -0
  68. package/docs/guides/deployment/deploy-to-northflank/05-server-service.webp +0 -0
  69. package/docs/guides/deployment/deploy-to-northflank/06-find-url.webp +0 -0
  70. package/docs/guides/deployment/deploy-to-northflank/deploy-to-northflank.webp +0 -0
  71. package/docs/guides/deployment/deploy-to-northflank/index.md +606 -0
  72. package/docs/guides/deployment/deploy-to-railway/01-new-service.webp +0 -0
  73. package/docs/guides/deployment/deploy-to-railway/02-env-vars.webp +0 -0
  74. package/docs/guides/deployment/deploy-to-railway/03-test-server.webp +0 -0
  75. package/docs/guides/deployment/deploy-to-railway/deploy-to-railway.webp +0 -0
  76. package/docs/guides/deployment/deploy-to-railway/index.md +202 -0
  77. package/docs/guides/deployment/deploy-to-render/01-create-db.webp +0 -0
  78. package/docs/guides/deployment/deploy-to-render/02-env-group.webp +0 -0
  79. package/docs/guides/deployment/deploy-to-render/03-db-connection.webp +0 -0
  80. package/docs/guides/deployment/deploy-to-render/04-link-env-group.webp +0 -0
  81. package/docs/guides/deployment/deploy-to-render/05-server-url.webp +0 -0
  82. package/docs/guides/deployment/deploy-to-render/deploy-to-render.webp +0 -0
  83. package/docs/guides/deployment/deploy-to-render/index.md +221 -0
  84. package/docs/guides/deployment/deploying-admin-ui.md +130 -0
  85. package/docs/guides/deployment/getting-data-into-production.md +50 -0
  86. package/docs/guides/deployment/horizontal-scaling.md +75 -0
  87. package/docs/guides/deployment/production-configuration/env-var-ui.webp +0 -0
  88. package/docs/guides/deployment/production-configuration/index.md +140 -0
  89. package/docs/guides/deployment/server-resource-requirements.md +29 -0
  90. package/docs/guides/deployment/using-docker.md +193 -0
  91. package/docs/guides/developer-guide/cache/cache-service.webp +0 -0
  92. package/docs/guides/developer-guide/cache/index.mdx +327 -0
  93. package/docs/guides/developer-guide/channel-aware/index.md +117 -0
  94. package/docs/guides/developer-guide/cli/add-command.webp +0 -0
  95. package/docs/guides/developer-guide/cli/index.md +418 -0
  96. package/docs/guides/developer-guide/cli/migrate-command.webp +0 -0
  97. package/docs/guides/developer-guide/cli/schema-command.webp +0 -0
  98. package/docs/guides/developer-guide/configuration/index.md +226 -0
  99. package/docs/guides/developer-guide/custom-fields/custom-fields-data-table.webp +0 -0
  100. package/docs/guides/developer-guide/custom-fields/custom-fields-ui.webp +0 -0
  101. package/docs/guides/developer-guide/custom-fields/index.md +1423 -0
  102. package/docs/guides/developer-guide/custom-permissions/index.md +186 -0
  103. package/docs/guides/developer-guide/custom-strategies-in-plugins/index.mdx +467 -0
  104. package/docs/guides/developer-guide/database-entity/index.md +136 -0
  105. package/docs/guides/developer-guide/dataloaders/index.md +137 -0
  106. package/docs/guides/developer-guide/db-subscribers/index.md +115 -0
  107. package/docs/guides/developer-guide/error-handling/index.mdx +324 -0
  108. package/docs/guides/developer-guide/events/index.mdx +406 -0
  109. package/docs/guides/developer-guide/extend-graphql-api/index.md +501 -0
  110. package/docs/guides/developer-guide/has-custom-fields/index.md +174 -0
  111. package/docs/guides/developer-guide/importing-data/index.md +488 -0
  112. package/docs/guides/developer-guide/importing-data/reindex.webp +0 -0
  113. package/docs/guides/developer-guide/logging/index.md +77 -0
  114. package/docs/guides/developer-guide/migrating-from-v1/breaking-api-changes.md +213 -0
  115. package/docs/guides/developer-guide/migrating-from-v1/database-migration.md +39 -0
  116. package/docs/guides/developer-guide/migrating-from-v1/index.md +41 -0
  117. package/docs/guides/developer-guide/migrating-from-v1/storefront-migration.md +30 -0
  118. package/docs/guides/developer-guide/migrations/index.md +197 -0
  119. package/docs/guides/developer-guide/migrations/migration.webp +0 -0
  120. package/docs/guides/developer-guide/nest-devtools/index.md +74 -0
  121. package/docs/guides/developer-guide/nest-devtools/nest-devtools-bootstrap-perf.webp +0 -0
  122. package/docs/guides/developer-guide/nest-devtools/nest-devtools-graph.webp +0 -0
  123. package/docs/guides/developer-guide/overview/Vendure_docs-architecture.webp +0 -0
  124. package/docs/guides/developer-guide/overview/index.md +40 -0
  125. package/docs/guides/developer-guide/plugins/index.mdx +806 -0
  126. package/docs/guides/developer-guide/rest-endpoint/index.md +99 -0
  127. package/docs/guides/developer-guide/scheduled-tasks/index.md +298 -0
  128. package/docs/guides/developer-guide/security/index.md +264 -0
  129. package/docs/guides/developer-guide/settings-store/index.mdx +553 -0
  130. package/docs/guides/developer-guide/stand-alone-scripts/index.md +119 -0
  131. package/docs/guides/developer-guide/strategies-configurable-operations/collection-filters-args.webp +0 -0
  132. package/docs/guides/developer-guide/strategies-configurable-operations/collection-filters.webp +0 -0
  133. package/docs/guides/developer-guide/strategies-configurable-operations/index.mdx +373 -0
  134. package/docs/guides/developer-guide/testing/index.md +254 -0
  135. package/docs/guides/developer-guide/the-api-layer/Vendure_docs-api_request.webp +0 -0
  136. package/docs/guides/developer-guide/the-api-layer/index.mdx +474 -0
  137. package/docs/guides/developer-guide/the-service-layer/index.mdx +311 -0
  138. package/docs/guides/developer-guide/translatable/index.md +224 -0
  139. package/docs/guides/developer-guide/translations/index.md +165 -0
  140. package/docs/guides/developer-guide/updating/index.md +79 -0
  141. package/docs/guides/developer-guide/uploading-files/index.md +220 -0
  142. package/docs/guides/developer-guide/worker-job-queue/Vendure_docs-job-queue-2.webp +0 -0
  143. package/docs/guides/developer-guide/worker-job-queue/Vendure_docs-job-queue-3.webp +0 -0
  144. package/docs/guides/developer-guide/worker-job-queue/Vendure_docs-job-queue.webp +0 -0
  145. package/docs/guides/developer-guide/worker-job-queue/index.mdx +522 -0
  146. package/docs/guides/developer-guide/worker-job-queue/worker-job-queue.webp +0 -0
  147. package/docs/guides/extending-the-admin-ui/add-actions-to-pages/index.md +233 -0
  148. package/docs/guides/extending-the-admin-ui/add-actions-to-pages/ui-extensions-actionbar-dropdown.webp +0 -0
  149. package/docs/guides/extending-the-admin-ui/add-actions-to-pages/ui-extensions-actionbar.webp +0 -0
  150. package/docs/guides/extending-the-admin-ui/adding-ui-translations/index.md +113 -0
  151. package/docs/guides/extending-the-admin-ui/adding-ui-translations/ui-translations-01.webp +0 -0
  152. package/docs/guides/extending-the-admin-ui/admin-ui-theming-branding/index.md +133 -0
  153. package/docs/guides/extending-the-admin-ui/alerts/alerts-01.webp +0 -0
  154. package/docs/guides/extending-the-admin-ui/alerts/index.md +56 -0
  155. package/docs/guides/extending-the-admin-ui/bulk-actions/bulk-actions-screenshot.webp +0 -0
  156. package/docs/guides/extending-the-admin-ui/bulk-actions/index.md +78 -0
  157. package/docs/guides/extending-the-admin-ui/creating-detail-views/index.md +332 -0
  158. package/docs/guides/extending-the-admin-ui/creating-list-views/index.md +331 -0
  159. package/docs/guides/extending-the-admin-ui/custom-data-table-components/custom-data-table-location.webp +0 -0
  160. package/docs/guides/extending-the-admin-ui/custom-data-table-components/custom-data-table.webp +0 -0
  161. package/docs/guides/extending-the-admin-ui/custom-data-table-components/index.md +111 -0
  162. package/docs/guides/extending-the-admin-ui/custom-detail-components/detail-component.webp +0 -0
  163. package/docs/guides/extending-the-admin-ui/custom-detail-components/index.md +198 -0
  164. package/docs/guides/extending-the-admin-ui/custom-form-inputs/index.md +285 -0
  165. package/docs/guides/extending-the-admin-ui/custom-form-inputs/ui-extensions-custom-field-default.webp +0 -0
  166. package/docs/guides/extending-the-admin-ui/custom-form-inputs/ui-extensions-custom-field-slider.webp +0 -0
  167. package/docs/guides/extending-the-admin-ui/custom-timeline-components/index.md +79 -0
  168. package/docs/guides/extending-the-admin-ui/custom-timeline-components/timeline-entry.webp +0 -0
  169. package/docs/guides/extending-the-admin-ui/dashboard-widgets/dashboard-widgets.webp +0 -0
  170. package/docs/guides/extending-the-admin-ui/dashboard-widgets/index.md +149 -0
  171. package/docs/guides/extending-the-admin-ui/defining-routes/index.md +777 -0
  172. package/docs/guides/extending-the-admin-ui/defining-routes/route-area.webp +0 -0
  173. package/docs/guides/extending-the-admin-ui/defining-routes/ui-extensions-greeter.webp +0 -0
  174. package/docs/guides/extending-the-admin-ui/getting-started/index.md +656 -0
  175. package/docs/guides/extending-the-admin-ui/getting-started/provider-extension-points.webp +0 -0
  176. package/docs/guides/extending-the-admin-ui/nav-menu/index.md +97 -0
  177. package/docs/guides/extending-the-admin-ui/nav-menu/nav-menu-id.webp +0 -0
  178. package/docs/guides/extending-the-admin-ui/nav-menu/ui-extensions-navbar.webp +0 -0
  179. package/docs/guides/extending-the-admin-ui/page-tabs/index.md +44 -0
  180. package/docs/guides/extending-the-admin-ui/page-tabs/ui-extensions-tabs.webp +0 -0
  181. package/docs/guides/extending-the-admin-ui/ui-library/buttons.webp +0 -0
  182. package/docs/guides/extending-the-admin-ui/ui-library/card.webp +0 -0
  183. package/docs/guides/extending-the-admin-ui/ui-library/form-inputs.webp +0 -0
  184. package/docs/guides/extending-the-admin-ui/ui-library/icons.webp +0 -0
  185. package/docs/guides/extending-the-admin-ui/ui-library/index.md +356 -0
  186. package/docs/guides/extending-the-admin-ui/ui-library/layout.webp +0 -0
  187. package/docs/guides/extending-the-admin-ui/using-other-frameworks/index.md +205 -0
  188. package/docs/guides/extending-the-admin-ui/using-other-frameworks/ui-extensions-cra.jpg +0 -0
  189. package/docs/guides/extending-the-dashboard/alerts/alert.webp +0 -0
  190. package/docs/guides/extending-the-dashboard/alerts/index.md +89 -0
  191. package/docs/guides/extending-the-dashboard/creating-pages/detail-pages.md +316 -0
  192. package/docs/guides/extending-the-dashboard/creating-pages/index.md +90 -0
  193. package/docs/guides/extending-the-dashboard/creating-pages/list-pages.md +206 -0
  194. package/docs/guides/extending-the-dashboard/creating-pages/tabbed-page-example.webp +0 -0
  195. package/docs/guides/extending-the-dashboard/creating-pages/tabbed-pages.md +144 -0
  196. package/docs/guides/extending-the-dashboard/custom-form-components/color-picker.webp +0 -0
  197. package/docs/guides/extending-the-dashboard/custom-form-components/dev-mode.webp +0 -0
  198. package/docs/guides/extending-the-dashboard/custom-form-components/example-currency-input.webp +0 -0
  199. package/docs/guides/extending-the-dashboard/custom-form-components/example-email-input.webp +0 -0
  200. package/docs/guides/extending-the-dashboard/custom-form-components/example-slug-input.webp +0 -0
  201. package/docs/guides/extending-the-dashboard/custom-form-components/example-tags-input.webp +0 -0
  202. package/docs/guides/extending-the-dashboard/custom-form-components/form-component-examples.mdx +445 -0
  203. package/docs/guides/extending-the-dashboard/custom-form-components/index.md +465 -0
  204. package/docs/guides/extending-the-dashboard/custom-form-components/locator.webp +0 -0
  205. package/docs/guides/extending-the-dashboard/custom-form-components/relation-selectors.md +687 -0
  206. package/docs/guides/extending-the-dashboard/customizing-pages/action-bar-button.webp +0 -0
  207. package/docs/guides/extending-the-dashboard/customizing-pages/action-bar-dropdown.webp +0 -0
  208. package/docs/guides/extending-the-dashboard/customizing-pages/action-bar-items.md +272 -0
  209. package/docs/guides/extending-the-dashboard/customizing-pages/custom-widget.webp +0 -0
  210. package/docs/guides/extending-the-dashboard/customizing-pages/customizing-detail-pages.md +129 -0
  211. package/docs/guides/extending-the-dashboard/customizing-pages/customizing-list-pages.md +93 -0
  212. package/docs/guides/extending-the-dashboard/customizing-pages/customizing-login-page.md +66 -0
  213. package/docs/guides/extending-the-dashboard/customizing-pages/history-entries.md +43 -0
  214. package/docs/guides/extending-the-dashboard/customizing-pages/history-entry.webp +0 -0
  215. package/docs/guides/extending-the-dashboard/customizing-pages/index.md +10 -0
  216. package/docs/guides/extending-the-dashboard/customizing-pages/insights-widgets.md +57 -0
  217. package/docs/guides/extending-the-dashboard/customizing-pages/login-page.webp +0 -0
  218. package/docs/guides/extending-the-dashboard/customizing-pages/page-blocks.md +244 -0
  219. package/docs/guides/extending-the-dashboard/data-fetching/index.md +126 -0
  220. package/docs/guides/extending-the-dashboard/data-fetching/type-inference.webp +0 -0
  221. package/docs/guides/extending-the-dashboard/deployment/index.md +200 -0
  222. package/docs/guides/extending-the-dashboard/extending-overview/dev-mode.webp +0 -0
  223. package/docs/guides/extending-the-dashboard/extending-overview/index.md +228 -0
  224. package/docs/guides/extending-the-dashboard/extending-overview/location-id.webp +0 -0
  225. package/docs/guides/extending-the-dashboard/getting-started/detail-view.webp +0 -0
  226. package/docs/guides/extending-the-dashboard/getting-started/index.md +194 -0
  227. package/docs/guides/extending-the-dashboard/getting-started/list-view-empty.webp +0 -0
  228. package/docs/guides/extending-the-dashboard/getting-started/list-view-full.webp +0 -0
  229. package/docs/guides/extending-the-dashboard/getting-started/page-block.webp +0 -0
  230. package/docs/guides/extending-the-dashboard/getting-started/test-page.webp +0 -0
  231. package/docs/guides/extending-the-dashboard/localization/index.md +94 -0
  232. package/docs/guides/extending-the-dashboard/migration/index.md +1902 -0
  233. package/docs/guides/extending-the-dashboard/navigation/dev-mode-nav.webp +0 -0
  234. package/docs/guides/extending-the-dashboard/navigation/index.md +322 -0
  235. package/docs/guides/extending-the-dashboard/navigation/unauthenticated-page.webp +0 -0
  236. package/docs/guides/extending-the-dashboard/tech-stack/index.md +395 -0
  237. package/docs/guides/extending-the-dashboard/theming/index.md +180 -0
  238. package/docs/guides/extending-the-dashboard/theming/show-colour-value-inspection.gif +0 -0
  239. package/docs/guides/getting-started/graphql-intro/index.mdx +572 -0
  240. package/docs/guides/getting-started/installation/app-screens.webp +0 -0
  241. package/docs/guides/getting-started/installation/index.md +234 -0
  242. package/docs/guides/getting-started/try-the-api/graphiql-docs.jpeg +0 -0
  243. package/docs/guides/getting-started/try-the-api/graphiql.jpeg +0 -0
  244. package/docs/guides/getting-started/try-the-api/index.mdx +238 -0
  245. package/docs/guides/how-to/cms-integration-plugin/index.mdx +2083 -0
  246. package/docs/guides/how-to/codegen/index.md +280 -0
  247. package/docs/guides/how-to/configurable-products/index.md +138 -0
  248. package/docs/guides/how-to/digital-products/index.mdx +485 -0
  249. package/docs/guides/how-to/digital-products/product-variant.webp +0 -0
  250. package/docs/guides/how-to/digital-products/shipping-method.webp +0 -0
  251. package/docs/guides/how-to/github-oauth-authentication/index.mdx +360 -0
  252. package/docs/guides/how-to/google-oauth-authentication/index.mdx +494 -0
  253. package/docs/guides/how-to/multi-vendor-marketplaces/aggregate-order.webp +0 -0
  254. package/docs/guides/how-to/multi-vendor-marketplaces/index.md +197 -0
  255. package/docs/guides/how-to/paginated-list/index.mdx +360 -0
  256. package/docs/guides/how-to/publish-plugin/index.mdx +402 -0
  257. package/docs/guides/how-to/s3-asset-storage/index.mdx +572 -0
  258. package/docs/guides/how-to/telemetry/grafana-logs.webp +0 -0
  259. package/docs/guides/how-to/telemetry/grafana-trace.webp +0 -0
  260. package/docs/guides/how-to/telemetry/index.md +260 -0
  261. package/docs/guides/how-to/telemetry/jaeger-trace.webp +0 -0
  262. package/docs/guides/storefront/active-order/index.mdx +201 -0
  263. package/docs/guides/storefront/checkout-flow/index.mdx +428 -0
  264. package/docs/guides/storefront/codegen/index.mdx +157 -0
  265. package/docs/guides/storefront/connect-api/index.mdx +677 -0
  266. package/docs/guides/storefront/customer-accounts/index.mdx +389 -0
  267. package/docs/guides/storefront/customer-accounts/pw-reset.webp +0 -0
  268. package/docs/guides/storefront/customer-accounts/verification.webp +0 -0
  269. package/docs/guides/storefront/listing-products/index.mdx +711 -0
  270. package/docs/guides/storefront/navigation-menu/index.mdx +157 -0
  271. package/docs/guides/storefront/order-workflow/index.md +231 -0
  272. package/docs/guides/storefront/order-workflow/order_class_diagram.png +0 -0
  273. package/docs/guides/storefront/order-workflow/order_state_diagram.png +0 -0
  274. package/docs/guides/storefront/product-detail/index.mdx +295 -0
  275. package/docs/guides/storefront/storefront-starters/angular-storefront.webp +0 -0
  276. package/docs/guides/storefront/storefront-starters/index.mdx +69 -0
  277. package/docs/guides/storefront/storefront-starters/next-storefront.webp +0 -0
  278. package/docs/guides/storefront/storefront-starters/qwik-storefront.webp +0 -0
  279. package/docs/guides/storefront/storefront-starters/remix-storefront.webp +0 -0
  280. package/docs/reference/admin-ui-api/action-bar/action-bar-context.md +82 -0
  281. package/docs/reference/admin-ui-api/action-bar/action-bar-dropdown-menu-item.md +93 -0
  282. package/docs/reference/admin-ui-api/action-bar/action-bar-item.md +106 -0
  283. package/docs/reference/admin-ui-api/action-bar/action-bar-location-id.md +17 -0
  284. package/docs/reference/admin-ui-api/action-bar/add-action-bar-dropdown-menu-item.md +38 -0
  285. package/docs/reference/admin-ui-api/action-bar/add-action-bar-item.md +36 -0
  286. package/docs/reference/admin-ui-api/action-bar/index.md +5 -0
  287. package/docs/reference/admin-ui-api/action-bar/page-location-id.md +61 -0
  288. package/docs/reference/admin-ui-api/action-bar/router-link-definition.md +16 -0
  289. package/docs/reference/admin-ui-api/alerts/alert-config.md +88 -0
  290. package/docs/reference/admin-ui-api/alerts/alert-context.md +52 -0
  291. package/docs/reference/admin-ui-api/alerts/index.md +5 -0
  292. package/docs/reference/admin-ui-api/alerts/register-alert.md +23 -0
  293. package/docs/reference/admin-ui-api/bulk-actions/bulk-action.md +229 -0
  294. package/docs/reference/admin-ui-api/bulk-actions/index.md +5 -0
  295. package/docs/reference/admin-ui-api/bulk-actions/register-bulk-action.md +63 -0
  296. package/docs/reference/admin-ui-api/components/asset-picker-dialog-component.md +160 -0
  297. package/docs/reference/admin-ui-api/components/chip-component.md +63 -0
  298. package/docs/reference/admin-ui-api/components/currency-input-component.md +174 -0
  299. package/docs/reference/admin-ui-api/components/data-table-component.md +238 -0
  300. package/docs/reference/admin-ui-api/components/data-table2component.md +354 -0
  301. package/docs/reference/admin-ui-api/components/datetime-picker-component.md +262 -0
  302. package/docs/reference/admin-ui-api/components/dropdown-component.md +86 -0
  303. package/docs/reference/admin-ui-api/components/facet-value-selector-component.md +155 -0
  304. package/docs/reference/admin-ui-api/components/index.md +5 -0
  305. package/docs/reference/admin-ui-api/components/object-tree-component.md +86 -0
  306. package/docs/reference/admin-ui-api/components/order-state-label-component.md +41 -0
  307. package/docs/reference/admin-ui-api/components/product-variant-selector-component.md +75 -0
  308. package/docs/reference/admin-ui-api/components/rich-text-editor-component.md +108 -0
  309. package/docs/reference/admin-ui-api/components/zone-selector-component.md +124 -0
  310. package/docs/reference/admin-ui-api/custom-detail-components/custom-detail-component-config.md +41 -0
  311. package/docs/reference/admin-ui-api/custom-detail-components/custom-detail-component-location-id.md +36 -0
  312. package/docs/reference/admin-ui-api/custom-detail-components/custom-detail-component.md +36 -0
  313. package/docs/reference/admin-ui-api/custom-detail-components/index.md +5 -0
  314. package/docs/reference/admin-ui-api/custom-detail-components/register-custom-detail-component.md +69 -0
  315. package/docs/reference/admin-ui-api/custom-history-entry-components/customer-history-entry-component.md +32 -0
  316. package/docs/reference/admin-ui-api/custom-history-entry-components/history-entry-component.md +57 -0
  317. package/docs/reference/admin-ui-api/custom-history-entry-components/history-entry-config.md +35 -0
  318. package/docs/reference/admin-ui-api/custom-history-entry-components/index.md +5 -0
  319. package/docs/reference/admin-ui-api/custom-history-entry-components/order-history-entry-component.md +32 -0
  320. package/docs/reference/admin-ui-api/custom-history-entry-components/register-history-entry-component.md +79 -0
  321. package/docs/reference/admin-ui-api/custom-input-components/default-inputs.md +1034 -0
  322. package/docs/reference/admin-ui-api/custom-input-components/form-input-component.md +56 -0
  323. package/docs/reference/admin-ui-api/custom-input-components/index.md +5 -0
  324. package/docs/reference/admin-ui-api/custom-input-components/register-form-input-component.md +71 -0
  325. package/docs/reference/admin-ui-api/custom-table-components/custom-column-component.md +32 -0
  326. package/docs/reference/admin-ui-api/custom-table-components/data-table-component-config.md +48 -0
  327. package/docs/reference/admin-ui-api/custom-table-components/index.md +5 -0
  328. package/docs/reference/admin-ui-api/custom-table-components/register-data-table-component.md +55 -0
  329. package/docs/reference/admin-ui-api/dashboard-widgets/dashboard-widget-config.md +60 -0
  330. package/docs/reference/admin-ui-api/dashboard-widgets/index.md +5 -0
  331. package/docs/reference/admin-ui-api/dashboard-widgets/register-dashboard-widget.md +27 -0
  332. package/docs/reference/admin-ui-api/dashboard-widgets/set-dashboard-widget-layout.md +22 -0
  333. package/docs/reference/admin-ui-api/dashboard-widgets/widget-layout-definition.md +16 -0
  334. package/docs/reference/admin-ui-api/directives/if-multichannel-directive.md +41 -0
  335. package/docs/reference/admin-ui-api/directives/if-permissions-directive.md +43 -0
  336. package/docs/reference/admin-ui-api/directives/index.md +5 -0
  337. package/docs/reference/admin-ui-api/index.md +13 -0
  338. package/docs/reference/admin-ui-api/list-detail-views/base-detail-component.md +168 -0
  339. package/docs/reference/admin-ui-api/list-detail-views/base-entity-resolver.md +54 -0
  340. package/docs/reference/admin-ui-api/list-detail-views/base-list-component.md +155 -0
  341. package/docs/reference/admin-ui-api/list-detail-views/detail-component-with-resolver.md +52 -0
  342. package/docs/reference/admin-ui-api/list-detail-views/index.md +5 -0
  343. package/docs/reference/admin-ui-api/list-detail-views/typed-base-detail-component.md +51 -0
  344. package/docs/reference/admin-ui-api/list-detail-views/typed-base-list-component.md +125 -0
  345. package/docs/reference/admin-ui-api/nav-menu/add-nav-menu-item.md +52 -0
  346. package/docs/reference/admin-ui-api/nav-menu/add-nav-menu-section.md +47 -0
  347. package/docs/reference/admin-ui-api/nav-menu/index.md +5 -0
  348. package/docs/reference/admin-ui-api/nav-menu/nav-menu-item.md +66 -0
  349. package/docs/reference/admin-ui-api/nav-menu/nav-menu-section.md +83 -0
  350. package/docs/reference/admin-ui-api/nav-menu/navigation-types.md +38 -0
  351. package/docs/reference/admin-ui-api/pipes/asset-preview-pipe.md +41 -0
  352. package/docs/reference/admin-ui-api/pipes/duration-pipe.md +45 -0
  353. package/docs/reference/admin-ui-api/pipes/file-size-pipe.md +38 -0
  354. package/docs/reference/admin-ui-api/pipes/has-permission-pipe.md +51 -0
  355. package/docs/reference/admin-ui-api/pipes/index.md +5 -0
  356. package/docs/reference/admin-ui-api/pipes/locale-currency-name-pipe.md +47 -0
  357. package/docs/reference/admin-ui-api/pipes/locale-currency-pipe.md +54 -0
  358. package/docs/reference/admin-ui-api/pipes/locale-date-pipe.md +48 -0
  359. package/docs/reference/admin-ui-api/pipes/locale-language-name-pipe.md +47 -0
  360. package/docs/reference/admin-ui-api/pipes/locale-region-name-pipe.md +47 -0
  361. package/docs/reference/admin-ui-api/pipes/time-ago-pipe.md +44 -0
  362. package/docs/reference/admin-ui-api/react-components/action-bar.md +36 -0
  363. package/docs/reference/admin-ui-api/react-components/card.md +36 -0
  364. package/docs/reference/admin-ui-api/react-components/cds-icon.md +34 -0
  365. package/docs/reference/admin-ui-api/react-components/form-field.md +42 -0
  366. package/docs/reference/admin-ui-api/react-components/index.md +5 -0
  367. package/docs/reference/admin-ui-api/react-components/link.md +34 -0
  368. package/docs/reference/admin-ui-api/react-components/page-block.md +36 -0
  369. package/docs/reference/admin-ui-api/react-components/page-detail-layout.md +36 -0
  370. package/docs/reference/admin-ui-api/react-components/rich-text-editor.md +42 -0
  371. package/docs/reference/admin-ui-api/react-extensions/index.md +5 -0
  372. package/docs/reference/admin-ui-api/react-extensions/react-custom-detail-component-config.md +41 -0
  373. package/docs/reference/admin-ui-api/react-extensions/react-data-table-component-config.md +48 -0
  374. package/docs/reference/admin-ui-api/react-extensions/register-react-custom-detail-component.md +23 -0
  375. package/docs/reference/admin-ui-api/react-extensions/register-react-data-table-component.md +55 -0
  376. package/docs/reference/admin-ui-api/react-extensions/register-react-form-input-component.md +26 -0
  377. package/docs/reference/admin-ui-api/react-extensions/register-react-route-component-options.md +18 -0
  378. package/docs/reference/admin-ui-api/react-extensions/register-react-route-component.md +22 -0
  379. package/docs/reference/admin-ui-api/react-hooks/index.md +5 -0
  380. package/docs/reference/admin-ui-api/react-hooks/use-detail-component-data.md +39 -0
  381. package/docs/reference/admin-ui-api/react-hooks/use-form-control.md +36 -0
  382. package/docs/reference/admin-ui-api/react-hooks/use-injector.md +39 -0
  383. package/docs/reference/admin-ui-api/react-hooks/use-lazy-query.md +74 -0
  384. package/docs/reference/admin-ui-api/react-hooks/use-mutation.md +62 -0
  385. package/docs/reference/admin-ui-api/react-hooks/use-page-metadata.md +36 -0
  386. package/docs/reference/admin-ui-api/react-hooks/use-query.md +59 -0
  387. package/docs/reference/admin-ui-api/react-hooks/use-rich-text-editor.md +30 -0
  388. package/docs/reference/admin-ui-api/react-hooks/use-route-params.md +29 -0
  389. package/docs/reference/admin-ui-api/routes/index.md +5 -0
  390. package/docs/reference/admin-ui-api/routes/register-route-component-options.md +28 -0
  391. package/docs/reference/admin-ui-api/routes/register-route-component.md +57 -0
  392. package/docs/reference/admin-ui-api/services/data-service.md +142 -0
  393. package/docs/reference/admin-ui-api/services/index.md +5 -0
  394. package/docs/reference/admin-ui-api/services/modal-service.md +199 -0
  395. package/docs/reference/admin-ui-api/services/notification-service.md +126 -0
  396. package/docs/reference/admin-ui-api/tabs/index.md +5 -0
  397. package/docs/reference/admin-ui-api/tabs/page-tab-config.md +70 -0
  398. package/docs/reference/admin-ui-api/tabs/register-page-tab.md +38 -0
  399. package/docs/reference/admin-ui-api/ui-devkit/admin-ui-extension.md +417 -0
  400. package/docs/reference/admin-ui-api/ui-devkit/compile-ui-extensions.md +22 -0
  401. package/docs/reference/admin-ui-api/ui-devkit/helpers.md +39 -0
  402. package/docs/reference/admin-ui-api/ui-devkit/index.md +5 -0
  403. package/docs/reference/admin-ui-api/ui-devkit/ui-devkit-client.md +160 -0
  404. package/docs/reference/admin-ui-api/ui-devkit/ui-extension-build-command.md +16 -0
  405. package/docs/reference/admin-ui-api/ui-devkit/ui-extension-compiler-options.md +118 -0
  406. package/docs/reference/admin-ui-api/ui-devkit/ui-extension-compiler-process-argument.md +16 -0
  407. package/docs/reference/core-plugins/admin-ui-plugin/admin-ui-plugin-options.md +67 -0
  408. package/docs/reference/core-plugins/admin-ui-plugin/index.md +94 -0
  409. package/docs/reference/core-plugins/asset-server-plugin/asset-server-options.md +106 -0
  410. package/docs/reference/core-plugins/asset-server-plugin/cache-config.md +36 -0
  411. package/docs/reference/core-plugins/asset-server-plugin/hashed-asset-naming-strategy.md +47 -0
  412. package/docs/reference/core-plugins/asset-server-plugin/image-transform-mode.md +21 -0
  413. package/docs/reference/core-plugins/asset-server-plugin/image-transform-preset.md +57 -0
  414. package/docs/reference/core-plugins/asset-server-plugin/image-transform-strategy.md +144 -0
  415. package/docs/reference/core-plugins/asset-server-plugin/index.md +189 -0
  416. package/docs/reference/core-plugins/asset-server-plugin/local-asset-storage-strategy.md +74 -0
  417. package/docs/reference/core-plugins/asset-server-plugin/preset-only-strategy.md +118 -0
  418. package/docs/reference/core-plugins/asset-server-plugin/s3asset-storage-strategy.md +225 -0
  419. package/docs/reference/core-plugins/asset-server-plugin/sharp-asset-preview-strategy.md +118 -0
  420. package/docs/reference/core-plugins/dashboard-plugin/dashboard-plugin-options.md +43 -0
  421. package/docs/reference/core-plugins/dashboard-plugin/index.md +106 -0
  422. package/docs/reference/core-plugins/elasticsearch-plugin/elasticsearch-options.md +695 -0
  423. package/docs/reference/core-plugins/elasticsearch-plugin/index.md +193 -0
  424. package/docs/reference/core-plugins/email-plugin/email-event-handler-with-async-data.md +33 -0
  425. package/docs/reference/core-plugins/email-plugin/email-event-handler.md +299 -0
  426. package/docs/reference/core-plugins/email-plugin/email-event-listener.md +42 -0
  427. package/docs/reference/core-plugins/email-plugin/email-generator.md +78 -0
  428. package/docs/reference/core-plugins/email-plugin/email-plugin-options.md +154 -0
  429. package/docs/reference/core-plugins/email-plugin/email-plugin-types.md +276 -0
  430. package/docs/reference/core-plugins/email-plugin/email-send-event.md +34 -0
  431. package/docs/reference/core-plugins/email-plugin/email-sender.md +92 -0
  432. package/docs/reference/core-plugins/email-plugin/email-utils.md +54 -0
  433. package/docs/reference/core-plugins/email-plugin/index.md +309 -0
  434. package/docs/reference/core-plugins/email-plugin/template-loader.md +96 -0
  435. package/docs/reference/core-plugins/email-plugin/transport-options.md +241 -0
  436. package/docs/reference/core-plugins/graphiql-plugin/index.md +89 -0
  437. package/docs/reference/core-plugins/harden-plugin/default-vendure-complexity-estimator.md +30 -0
  438. package/docs/reference/core-plugins/harden-plugin/harden-plugin-options.md +106 -0
  439. package/docs/reference/core-plugins/harden-plugin/index.md +169 -0
  440. package/docs/reference/core-plugins/index.md +5 -0
  441. package/docs/reference/core-plugins/job-queue-plugin/bull-mqjob-queue-plugin.md +211 -0
  442. package/docs/reference/core-plugins/job-queue-plugin/bull-mqjob-queue-strategy.md +93 -0
  443. package/docs/reference/core-plugins/job-queue-plugin/bull-mqplugin-options.md +142 -0
  444. package/docs/reference/core-plugins/job-queue-plugin/index.md +5 -0
  445. package/docs/reference/core-plugins/job-queue-plugin/pub-sub-job-queue-strategy.md +65 -0
  446. package/docs/reference/core-plugins/job-queue-plugin/pub-sub-plugin.md +36 -0
  447. package/docs/reference/core-plugins/payments-plugin/braintree-plugin.md +350 -0
  448. package/docs/reference/core-plugins/payments-plugin/index.md +5 -0
  449. package/docs/reference/core-plugins/payments-plugin/mollie-plugin.md +209 -0
  450. package/docs/reference/core-plugins/payments-plugin/stripe-plugin.md +355 -0
  451. package/docs/reference/core-plugins/sentry-plugin/index.md +158 -0
  452. package/docs/reference/core-plugins/sentry-plugin/sentry-plugin-options.md +32 -0
  453. package/docs/reference/core-plugins/sentry-plugin/sentry-service.md +47 -0
  454. package/docs/reference/core-plugins/stellate-plugin/index.md +277 -0
  455. package/docs/reference/core-plugins/stellate-plugin/purge-rule.md +91 -0
  456. package/docs/reference/core-plugins/stellate-plugin/stellate-plugin-options.md +65 -0
  457. package/docs/reference/core-plugins/stellate-plugin/stellate-service.md +71 -0
  458. package/docs/reference/core-plugins/telemetry-plugin/get-sdk-configuration.md +92 -0
  459. package/docs/reference/core-plugins/telemetry-plugin/index.md +131 -0
  460. package/docs/reference/core-plugins/telemetry-plugin/otel-logger.md +102 -0
  461. package/docs/reference/core-plugins/telemetry-plugin/register-method-hooks.md +46 -0
  462. package/docs/reference/core-plugins/telemetry-plugin/telemetry-plugin-options.md +77 -0
  463. package/docs/reference/dashboard/components/asset-gallery.md +127 -0
  464. package/docs/reference/dashboard/components/asset-picker-dialog.md +76 -0
  465. package/docs/reference/dashboard/components/channel-chip.md +22 -0
  466. package/docs/reference/dashboard/components/detail-page-button.md +49 -0
  467. package/docs/reference/dashboard/components/facet-value-chip.md +22 -0
  468. package/docs/reference/dashboard/components/facet-value-selector.md +85 -0
  469. package/docs/reference/dashboard/components/index.md +5 -0
  470. package/docs/reference/dashboard/components/permission-guard.md +63 -0
  471. package/docs/reference/dashboard/components/vendure-image.md +199 -0
  472. package/docs/reference/dashboard/detail-views/detail-page.md +91 -0
  473. package/docs/reference/dashboard/detail-views/index.md +5 -0
  474. package/docs/reference/dashboard/detail-views/use-detail-page.md +234 -0
  475. package/docs/reference/dashboard/detail-views/use-generated-form.md +105 -0
  476. package/docs/reference/dashboard/extensions-api/action-bar.md +66 -0
  477. package/docs/reference/dashboard/extensions-api/alerts.md +78 -0
  478. package/docs/reference/dashboard/extensions-api/data-tables.md +55 -0
  479. package/docs/reference/dashboard/extensions-api/define-dashboard-extension.md +142 -0
  480. package/docs/reference/dashboard/extensions-api/detail-forms.md +81 -0
  481. package/docs/reference/dashboard/extensions-api/form-components.md +188 -0
  482. package/docs/reference/dashboard/extensions-api/history-entries.md +246 -0
  483. package/docs/reference/dashboard/extensions-api/index.md +5 -0
  484. package/docs/reference/dashboard/extensions-api/login.md +113 -0
  485. package/docs/reference/dashboard/extensions-api/navigation.md +128 -0
  486. package/docs/reference/dashboard/extensions-api/page-blocks.md +143 -0
  487. package/docs/reference/dashboard/extensions-api/routes.md +69 -0
  488. package/docs/reference/dashboard/extensions-api/widgets.md +61 -0
  489. package/docs/reference/dashboard/form-components/affixed-input.md +34 -0
  490. package/docs/reference/dashboard/form-components/boolean-input.md +22 -0
  491. package/docs/reference/dashboard/form-components/checkbox-input.md +22 -0
  492. package/docs/reference/dashboard/form-components/date-time-input.md +22 -0
  493. package/docs/reference/dashboard/form-components/form-field-wrapper.md +80 -0
  494. package/docs/reference/dashboard/form-components/index.md +5 -0
  495. package/docs/reference/dashboard/form-components/money-input.md +23 -0
  496. package/docs/reference/dashboard/form-components/number-input.md +22 -0
  497. package/docs/reference/dashboard/form-components/password-input.md +22 -0
  498. package/docs/reference/dashboard/form-components/rich-text-input.md +22 -0
  499. package/docs/reference/dashboard/form-components/slug-input.md +57 -0
  500. package/docs/reference/dashboard/form-components/text-input.md +13 -0
  501. package/docs/reference/dashboard/form-components/textarea-input.md +22 -0
  502. package/docs/reference/dashboard/form-components/translatable-form-field-wrapper.md +70 -0
  503. package/docs/reference/dashboard/hooks/index.md +5 -0
  504. package/docs/reference/dashboard/hooks/use-alerts.md +65 -0
  505. package/docs/reference/dashboard/hooks/use-auth.md +84 -0
  506. package/docs/reference/dashboard/hooks/use-channel.md +72 -0
  507. package/docs/reference/dashboard/hooks/use-custom-field-config.md +24 -0
  508. package/docs/reference/dashboard/hooks/use-display-locale.md +32 -0
  509. package/docs/reference/dashboard/hooks/use-drag-and-drop.md +22 -0
  510. package/docs/reference/dashboard/hooks/use-local-format.md +30 -0
  511. package/docs/reference/dashboard/hooks/use-paginated-list.md +29 -0
  512. package/docs/reference/dashboard/hooks/use-permissions.md +25 -0
  513. package/docs/reference/dashboard/hooks/use-sorted-languages.md +30 -0
  514. package/docs/reference/dashboard/hooks/use-ui-language-loader.md +18 -0
  515. package/docs/reference/dashboard/hooks/use-widget-filters.md +16 -0
  516. package/docs/reference/dashboard/list-views/bulk-actions.md +199 -0
  517. package/docs/reference/dashboard/list-views/data-table-cell-component.md +45 -0
  518. package/docs/reference/dashboard/list-views/data-table.md +209 -0
  519. package/docs/reference/dashboard/list-views/index.md +5 -0
  520. package/docs/reference/dashboard/list-views/list-page.md +493 -0
  521. package/docs/reference/dashboard/list-views/paginated-list-data-table.md +303 -0
  522. package/docs/reference/dashboard/page-layout/index.md +54 -0
  523. package/docs/reference/dashboard/page-layout/page-action-bar.md +62 -0
  524. package/docs/reference/dashboard/page-layout/page-block.md +137 -0
  525. package/docs/reference/dashboard/page-layout/page-title.md +22 -0
  526. package/docs/reference/dashboard/page-layout/page.md +100 -0
  527. package/docs/reference/dashboard/page-layout/use-page-block.md +32 -0
  528. package/docs/reference/dashboard/vite-plugin/index.md +5 -0
  529. package/docs/reference/dashboard/vite-plugin/vendure-dashboard-plugin.md +356 -0
  530. package/docs/reference/graphql-api/_index.md +16 -0
  531. package/docs/reference/graphql-api/admin/_index.md +13 -0
  532. package/docs/reference/graphql-api/admin/enums.md +1142 -0
  533. package/docs/reference/graphql-api/admin/input-types.md +4631 -0
  534. package/docs/reference/graphql-api/admin/mutations.md +1985 -0
  535. package/docs/reference/graphql-api/admin/object-types.md +4515 -0
  536. package/docs/reference/graphql-api/admin/queries.md +760 -0
  537. package/docs/reference/graphql-api/shop/_index.md +13 -0
  538. package/docs/reference/graphql-api/shop/enums.md +1072 -0
  539. package/docs/reference/graphql-api/shop/input-types.md +1192 -0
  540. package/docs/reference/graphql-api/shop/mutations.md +431 -0
  541. package/docs/reference/graphql-api/shop/object-types.md +3406 -0
  542. package/docs/reference/graphql-api/shop/queries.md +247 -0
  543. package/docs/reference/index.mdx +38 -0
  544. package/docs/reference/links.webp +0 -0
  545. package/docs/reference/typescript-api/_index.md +13 -0
  546. package/docs/reference/typescript-api/assets/asset-naming-strategy.md +56 -0
  547. package/docs/reference/typescript-api/assets/asset-options.md +58 -0
  548. package/docs/reference/typescript-api/assets/asset-preview-strategy.md +45 -0
  549. package/docs/reference/typescript-api/assets/asset-storage-strategy.md +84 -0
  550. package/docs/reference/typescript-api/assets/default-asset-naming-strategy.md +39 -0
  551. package/docs/reference/typescript-api/assets/index.md +5 -0
  552. package/docs/reference/typescript-api/auth/auth-options.md +165 -0
  553. package/docs/reference/typescript-api/auth/authentication-strategy.md +97 -0
  554. package/docs/reference/typescript-api/auth/bcrypt-password-hashing-strategy.md +38 -0
  555. package/docs/reference/typescript-api/auth/cookie-options.md +108 -0
  556. package/docs/reference/typescript-api/auth/default-password-validation-strategy.md +44 -0
  557. package/docs/reference/typescript-api/auth/default-session-cache-strategy.md +73 -0
  558. package/docs/reference/typescript-api/auth/default-verification-token-strategy.md +47 -0
  559. package/docs/reference/typescript-api/auth/external-authentication-service.md +98 -0
  560. package/docs/reference/typescript-api/auth/in-memory-session-cache-strategy.md +63 -0
  561. package/docs/reference/typescript-api/auth/index.md +5 -0
  562. package/docs/reference/typescript-api/auth/native-authentication-strategy.md +58 -0
  563. package/docs/reference/typescript-api/auth/noop-session-cache-strategy.md +51 -0
  564. package/docs/reference/typescript-api/auth/password-hashing-strategy.md +45 -0
  565. package/docs/reference/typescript-api/auth/password-validation-strategy.md +43 -0
  566. package/docs/reference/typescript-api/auth/permission-definition.md +269 -0
  567. package/docs/reference/typescript-api/auth/session-cache-strategy.md +275 -0
  568. package/docs/reference/typescript-api/auth/superadmin-credentials.md +36 -0
  569. package/docs/reference/typescript-api/auth/verification-token-strategy.md +45 -0
  570. package/docs/reference/typescript-api/cache/cache-config.md +44 -0
  571. package/docs/reference/typescript-api/cache/cache-service.md +76 -0
  572. package/docs/reference/typescript-api/cache/cache-strategy.md +103 -0
  573. package/docs/reference/typescript-api/cache/default-cache-plugin.md +73 -0
  574. package/docs/reference/typescript-api/cache/index.md +79 -0
  575. package/docs/reference/typescript-api/cache/redis-cache-plugin.md +85 -0
  576. package/docs/reference/typescript-api/cache/redis-cache-strategy.md +75 -0
  577. package/docs/reference/typescript-api/cache/request-context-cache-service.md +54 -0
  578. package/docs/reference/typescript-api/cache/self-refreshing-cache.md +152 -0
  579. package/docs/reference/typescript-api/cache/sql-cache-strategy.md +87 -0
  580. package/docs/reference/typescript-api/common/admin-ui/admin-ui-app-config.md +43 -0
  581. package/docs/reference/typescript-api/common/admin-ui/admin-ui-app-dev-mode-config.md +47 -0
  582. package/docs/reference/typescript-api/common/admin-ui/admin-ui-config.md +139 -0
  583. package/docs/reference/typescript-api/common/admin-ui/index.md +5 -0
  584. package/docs/reference/typescript-api/common/async-queue.md +38 -0
  585. package/docs/reference/typescript-api/common/bootstrap.md +129 -0
  586. package/docs/reference/typescript-api/common/currency-code.md +174 -0
  587. package/docs/reference/typescript-api/common/entity-relation-paths.md +34 -0
  588. package/docs/reference/typescript-api/common/i18n-service.md +74 -0
  589. package/docs/reference/typescript-api/common/id.md +17 -0
  590. package/docs/reference/typescript-api/common/index.md +5 -0
  591. package/docs/reference/typescript-api/common/injectable-strategy.md +48 -0
  592. package/docs/reference/typescript-api/common/injector.md +47 -0
  593. package/docs/reference/typescript-api/common/job-state.md +23 -0
  594. package/docs/reference/typescript-api/common/json-compatible.md +23 -0
  595. package/docs/reference/typescript-api/common/language-code.md +177 -0
  596. package/docs/reference/typescript-api/common/middleware.md +72 -0
  597. package/docs/reference/typescript-api/common/paginated-list.md +36 -0
  598. package/docs/reference/typescript-api/common/permission.md +136 -0
  599. package/docs/reference/typescript-api/common/price-calculation-result.md +36 -0
  600. package/docs/reference/typescript-api/common/process-context.md +55 -0
  601. package/docs/reference/typescript-api/common/vendure_version.md +22 -0
  602. package/docs/reference/typescript-api/configurable-operation-def/config-arg-type.md +22 -0
  603. package/docs/reference/typescript-api/configurable-operation-def/config-args.md +89 -0
  604. package/docs/reference/typescript-api/configurable-operation-def/configurable-operation-def-options.md +57 -0
  605. package/docs/reference/typescript-api/configurable-operation-def/default-form-component-id.md +34 -0
  606. package/docs/reference/typescript-api/configurable-operation-def/default-form-config-hash.md +137 -0
  607. package/docs/reference/typescript-api/configurable-operation-def/index.md +149 -0
  608. package/docs/reference/typescript-api/configurable-operation-def/localized-string-array.md +28 -0
  609. package/docs/reference/typescript-api/configuration/api-options.md +159 -0
  610. package/docs/reference/typescript-api/configuration/collection-filter.md +76 -0
  611. package/docs/reference/typescript-api/configuration/default-config.md +13 -0
  612. package/docs/reference/typescript-api/configuration/default-slug-strategy.md +46 -0
  613. package/docs/reference/typescript-api/configuration/entity-duplicator.md +195 -0
  614. package/docs/reference/typescript-api/configuration/entity-id-decorator.md +24 -0
  615. package/docs/reference/typescript-api/configuration/entity-id-strategy.md +168 -0
  616. package/docs/reference/typescript-api/configuration/entity-options.md +153 -0
  617. package/docs/reference/typescript-api/configuration/index.md +5 -0
  618. package/docs/reference/typescript-api/configuration/merge-config.md +49 -0
  619. package/docs/reference/typescript-api/configuration/product-variant-price-selection-strategy.md +71 -0
  620. package/docs/reference/typescript-api/configuration/product-variant-price-update-strategy.md +185 -0
  621. package/docs/reference/typescript-api/configuration/runtime-vendure-config.md +111 -0
  622. package/docs/reference/typescript-api/configuration/settings-store-fields.md +29 -0
  623. package/docs/reference/typescript-api/configuration/slug-strategy.md +47 -0
  624. package/docs/reference/typescript-api/configuration/system-options.md +50 -0
  625. package/docs/reference/typescript-api/configuration/trust-proxy-options.md +19 -0
  626. package/docs/reference/typescript-api/configuration/vendure-config.md +168 -0
  627. package/docs/reference/typescript-api/custom-fields/custom-field-config.md +25 -0
  628. package/docs/reference/typescript-api/custom-fields/custom-field-type.md +42 -0
  629. package/docs/reference/typescript-api/custom-fields/index.md +70 -0
  630. package/docs/reference/typescript-api/custom-fields/struct-custom-field-config.md +21 -0
  631. package/docs/reference/typescript-api/custom-fields/struct-field-config.md +41 -0
  632. package/docs/reference/typescript-api/custom-fields/typed-custom-single-field-config.md +24 -0
  633. package/docs/reference/typescript-api/data-access/calculated-property-subscriber.md +38 -0
  634. package/docs/reference/typescript-api/data-access/calculated.md +62 -0
  635. package/docs/reference/typescript-api/data-access/entity-hydrator.md +103 -0
  636. package/docs/reference/typescript-api/data-access/get-entity-or-throw-options.md +53 -0
  637. package/docs/reference/typescript-api/data-access/hydrate-options.md +40 -0
  638. package/docs/reference/typescript-api/data-access/index.md +5 -0
  639. package/docs/reference/typescript-api/data-access/list-query-builder.md +239 -0
  640. package/docs/reference/typescript-api/data-access/transactional-connection.md +173 -0
  641. package/docs/reference/typescript-api/default-search-plugin/default-search-plugin-init-options.md +126 -0
  642. package/docs/reference/typescript-api/default-search-plugin/index.md +64 -0
  643. package/docs/reference/typescript-api/default-search-plugin/mysql-search-strategy.md +56 -0
  644. package/docs/reference/typescript-api/default-search-plugin/postgres-search-strategy.md +56 -0
  645. package/docs/reference/typescript-api/default-search-plugin/search-strategy.md +58 -0
  646. package/docs/reference/typescript-api/default-search-plugin/sqlite-search-strategy.md +57 -0
  647. package/docs/reference/typescript-api/entities/address.md +124 -0
  648. package/docs/reference/typescript-api/entities/administrator.md +78 -0
  649. package/docs/reference/typescript-api/entities/anonymous-session.md +34 -0
  650. package/docs/reference/typescript-api/entities/asset.md +135 -0
  651. package/docs/reference/typescript-api/entities/authenticated-session.md +48 -0
  652. package/docs/reference/typescript-api/entities/authentication-method.md +156 -0
  653. package/docs/reference/typescript-api/entities/channel.md +233 -0
  654. package/docs/reference/typescript-api/entities/collection.md +152 -0
  655. package/docs/reference/typescript-api/entities/country.md +40 -0
  656. package/docs/reference/typescript-api/entities/customer-group.md +63 -0
  657. package/docs/reference/typescript-api/entities/customer-history-entry.md +40 -0
  658. package/docs/reference/typescript-api/entities/customer.md +122 -0
  659. package/docs/reference/typescript-api/entities/facet-value.md +98 -0
  660. package/docs/reference/typescript-api/entities/facet.md +89 -0
  661. package/docs/reference/typescript-api/entities/fulfillment.md +84 -0
  662. package/docs/reference/typescript-api/entities/global-settings.md +66 -0
  663. package/docs/reference/typescript-api/entities/history-entry.md +66 -0
  664. package/docs/reference/typescript-api/entities/index.md +5 -0
  665. package/docs/reference/typescript-api/entities/interfaces.md +125 -0
  666. package/docs/reference/typescript-api/entities/order-history-entry.md +40 -0
  667. package/docs/reference/typescript-api/entities/order-line-reference.md +174 -0
  668. package/docs/reference/typescript-api/entities/order-line.md +344 -0
  669. package/docs/reference/typescript-api/entities/order-modification.md +103 -0
  670. package/docs/reference/typescript-api/entities/order.md +284 -0
  671. package/docs/reference/typescript-api/entities/orderable-asset.md +61 -0
  672. package/docs/reference/typescript-api/entities/payment-method.md +94 -0
  673. package/docs/reference/typescript-api/entities/payment.md +96 -0
  674. package/docs/reference/typescript-api/entities/product-option-group.md +84 -0
  675. package/docs/reference/typescript-api/entities/product-option.md +90 -0
  676. package/docs/reference/typescript-api/entities/product-variant-price.md +70 -0
  677. package/docs/reference/typescript-api/entities/product-variant.md +251 -0
  678. package/docs/reference/typescript-api/entities/product.md +134 -0
  679. package/docs/reference/typescript-api/entities/promotion.md +190 -0
  680. package/docs/reference/typescript-api/entities/province.md +39 -0
  681. package/docs/reference/typescript-api/entities/refund.md +120 -0
  682. package/docs/reference/typescript-api/entities/region.md +87 -0
  683. package/docs/reference/typescript-api/entities/role.md +62 -0
  684. package/docs/reference/typescript-api/entities/seller.md +63 -0
  685. package/docs/reference/typescript-api/entities/session.md +87 -0
  686. package/docs/reference/typescript-api/entities/settings-store-entry.md +57 -0
  687. package/docs/reference/typescript-api/entities/shipping-line.md +150 -0
  688. package/docs/reference/typescript-api/entities/shipping-method.md +123 -0
  689. package/docs/reference/typescript-api/entities/stock-level.md +87 -0
  690. package/docs/reference/typescript-api/entities/stock-location.md +76 -0
  691. package/docs/reference/typescript-api/entities/stock-movement.md +270 -0
  692. package/docs/reference/typescript-api/entities/surcharge.md +102 -0
  693. package/docs/reference/typescript-api/entities/tag.md +40 -0
  694. package/docs/reference/typescript-api/entities/tax-category.md +68 -0
  695. package/docs/reference/typescript-api/entities/tax-rate.md +138 -0
  696. package/docs/reference/typescript-api/entities/user.md +111 -0
  697. package/docs/reference/typescript-api/entities/vendure-entity.md +49 -0
  698. package/docs/reference/typescript-api/entities/zone.md +78 -0
  699. package/docs/reference/typescript-api/errors/error-handler-strategy.md +88 -0
  700. package/docs/reference/typescript-api/errors/error-result-union.md +30 -0
  701. package/docs/reference/typescript-api/errors/error-types.md +197 -0
  702. package/docs/reference/typescript-api/errors/i18n-error.md +39 -0
  703. package/docs/reference/typescript-api/errors/index.md +5 -0
  704. package/docs/reference/typescript-api/errors/is-graph-ql-error-result.md +40 -0
  705. package/docs/reference/typescript-api/events/blocking-event-handler-options.md +57 -0
  706. package/docs/reference/typescript-api/events/event-bus.md +136 -0
  707. package/docs/reference/typescript-api/events/event-types.md +1689 -0
  708. package/docs/reference/typescript-api/events/index.md +5 -0
  709. package/docs/reference/typescript-api/events/vendure-entity-event.md +57 -0
  710. package/docs/reference/typescript-api/events/vendure-event.md +35 -0
  711. package/docs/reference/typescript-api/fulfillment/fulfillment-handler.md +173 -0
  712. package/docs/reference/typescript-api/fulfillment/fulfillment-process.md +71 -0
  713. package/docs/reference/typescript-api/fulfillment/fulfillment-state.md +21 -0
  714. package/docs/reference/typescript-api/fulfillment/fulfillment-states.md +18 -0
  715. package/docs/reference/typescript-api/fulfillment/fulfillment-transition-data.md +41 -0
  716. package/docs/reference/typescript-api/fulfillment/index.md +5 -0
  717. package/docs/reference/typescript-api/health-check/health-check-registry-service.md +70 -0
  718. package/docs/reference/typescript-api/health-check/health-check-strategy.md +70 -0
  719. package/docs/reference/typescript-api/health-check/http-health-check-strategy.md +61 -0
  720. package/docs/reference/typescript-api/health-check/index.md +5 -0
  721. package/docs/reference/typescript-api/health-check/type-ormhealth-check-strategy.md +64 -0
  722. package/docs/reference/typescript-api/import-export/asset-import-strategy.md +46 -0
  723. package/docs/reference/typescript-api/import-export/asset-importer.md +32 -0
  724. package/docs/reference/typescript-api/import-export/default-asset-import-strategy.md +48 -0
  725. package/docs/reference/typescript-api/import-export/fast-importer-service.md +67 -0
  726. package/docs/reference/typescript-api/import-export/import-export-options.md +36 -0
  727. package/docs/reference/typescript-api/import-export/import-parser.md +280 -0
  728. package/docs/reference/typescript-api/import-export/importer.md +54 -0
  729. package/docs/reference/typescript-api/import-export/index.md +5 -0
  730. package/docs/reference/typescript-api/import-export/initial-data.md +71 -0
  731. package/docs/reference/typescript-api/import-export/populate.md +71 -0
  732. package/docs/reference/typescript-api/import-export/populator.md +38 -0
  733. package/docs/reference/typescript-api/job-queue/default-job-queue-plugin.md +245 -0
  734. package/docs/reference/typescript-api/job-queue/in-memory-job-buffer-storage-strategy.md +55 -0
  735. package/docs/reference/typescript-api/job-queue/in-memory-job-queue-strategy.md +110 -0
  736. package/docs/reference/typescript-api/job-queue/index.md +84 -0
  737. package/docs/reference/typescript-api/job-queue/inspectable-job-queue-strategy.md +60 -0
  738. package/docs/reference/typescript-api/job-queue/job-buffer-storage-strategy.md +78 -0
  739. package/docs/reference/typescript-api/job-queue/job-buffer.md +119 -0
  740. package/docs/reference/typescript-api/job-queue/job-queue-options.md +56 -0
  741. package/docs/reference/typescript-api/job-queue/job-queue-service.md +128 -0
  742. package/docs/reference/typescript-api/job-queue/job-queue-strategy.md +59 -0
  743. package/docs/reference/typescript-api/job-queue/job.md +195 -0
  744. package/docs/reference/typescript-api/job-queue/polling-job-queue-strategy.md +122 -0
  745. package/docs/reference/typescript-api/job-queue/sql-job-queue-strategy.md +84 -0
  746. package/docs/reference/typescript-api/job-queue/subscribable-job.md +44 -0
  747. package/docs/reference/typescript-api/job-queue/types.md +199 -0
  748. package/docs/reference/typescript-api/logger/default-logger.md +81 -0
  749. package/docs/reference/typescript-api/logger/index.md +120 -0
  750. package/docs/reference/typescript-api/logger/log-level.md +30 -0
  751. package/docs/reference/typescript-api/logger/vendure-logger.md +60 -0
  752. package/docs/reference/typescript-api/migration/generate-migration.md +28 -0
  753. package/docs/reference/typescript-api/migration/index.md +5 -0
  754. package/docs/reference/typescript-api/migration/migration-options.md +36 -0
  755. package/docs/reference/typescript-api/migration/revert-last-migration.md +23 -0
  756. package/docs/reference/typescript-api/migration/run-migrations.md +23 -0
  757. package/docs/reference/typescript-api/money/big-int-money-strategy.md +68 -0
  758. package/docs/reference/typescript-api/money/default-money-strategy.md +47 -0
  759. package/docs/reference/typescript-api/money/index.md +5 -0
  760. package/docs/reference/typescript-api/money/money-decorator.md +23 -0
  761. package/docs/reference/typescript-api/money/money-strategy.md +116 -0
  762. package/docs/reference/typescript-api/money/round-money.md +26 -0
  763. package/docs/reference/typescript-api/orders/active-order-service.md +69 -0
  764. package/docs/reference/typescript-api/orders/active-order-strategy.md +203 -0
  765. package/docs/reference/typescript-api/orders/changed-price-handling-strategy.md +51 -0
  766. package/docs/reference/typescript-api/orders/custom-order-states.md +18 -0
  767. package/docs/reference/typescript-api/orders/default-active-order-strategy.md +52 -0
  768. package/docs/reference/typescript-api/orders/default-guest-checkout-strategy.md +93 -0
  769. package/docs/reference/typescript-api/orders/default-order-item-price-calculation-strategy.md +33 -0
  770. package/docs/reference/typescript-api/orders/default-order-placed-strategy.md +33 -0
  771. package/docs/reference/typescript-api/orders/default-stock-allocation-strategy.md +33 -0
  772. package/docs/reference/typescript-api/orders/guest-checkout-strategy.md +56 -0
  773. package/docs/reference/typescript-api/orders/index.md +5 -0
  774. package/docs/reference/typescript-api/orders/merge-strategies.md +114 -0
  775. package/docs/reference/typescript-api/orders/order-by-code-access-strategy.md +91 -0
  776. package/docs/reference/typescript-api/orders/order-code-strategy.md +88 -0
  777. package/docs/reference/typescript-api/orders/order-interceptor.md +250 -0
  778. package/docs/reference/typescript-api/orders/order-item-price-calculation-strategy.md +91 -0
  779. package/docs/reference/typescript-api/orders/order-merge-strategy.md +80 -0
  780. package/docs/reference/typescript-api/orders/order-options.md +145 -0
  781. package/docs/reference/typescript-api/orders/order-placed-strategy.md +54 -0
  782. package/docs/reference/typescript-api/orders/order-process.md +271 -0
  783. package/docs/reference/typescript-api/orders/order-seller-strategy.md +124 -0
  784. package/docs/reference/typescript-api/orders/stock-allocation-strategy.md +46 -0
  785. package/docs/reference/typescript-api/payment/default-payment-process.md +13 -0
  786. package/docs/reference/typescript-api/payment/default-refund-process.md +13 -0
  787. package/docs/reference/typescript-api/payment/dummy-payment-handler.md +31 -0
  788. package/docs/reference/typescript-api/payment/index.md +5 -0
  789. package/docs/reference/typescript-api/payment/payment-method-config-options.md +69 -0
  790. package/docs/reference/typescript-api/payment/payment-method-eligibility-checker.md +95 -0
  791. package/docs/reference/typescript-api/payment/payment-method-handler.md +83 -0
  792. package/docs/reference/typescript-api/payment/payment-method-types.md +386 -0
  793. package/docs/reference/typescript-api/payment/payment-options.md +57 -0
  794. package/docs/reference/typescript-api/payment/payment-process.md +62 -0
  795. package/docs/reference/typescript-api/payment/payment-state.md +20 -0
  796. package/docs/reference/typescript-api/payment/payment-states.md +18 -0
  797. package/docs/reference/typescript-api/payment/payment-transition-data.md +42 -0
  798. package/docs/reference/typescript-api/payment/refund-process.md +55 -0
  799. package/docs/reference/typescript-api/payment/refund-state.md +16 -0
  800. package/docs/reference/typescript-api/payment/refund-states.md +18 -0
  801. package/docs/reference/typescript-api/payment/refund-transition-data.md +41 -0
  802. package/docs/reference/typescript-api/plugin/index.md +5 -0
  803. package/docs/reference/typescript-api/plugin/plugin-common-module.md +28 -0
  804. package/docs/reference/typescript-api/plugin/plugin-utilities.md +96 -0
  805. package/docs/reference/typescript-api/plugin/vendure-plugin-metadata.md +147 -0
  806. package/docs/reference/typescript-api/plugin/vendure-plugin.md +52 -0
  807. package/docs/reference/typescript-api/products-stock/catalog-options.md +70 -0
  808. package/docs/reference/typescript-api/products-stock/default-product-variant-price-calculation-strategy.md +38 -0
  809. package/docs/reference/typescript-api/products-stock/default-stock-display-strategy.md +40 -0
  810. package/docs/reference/typescript-api/products-stock/default-stock-location-strategy.md +47 -0
  811. package/docs/reference/typescript-api/products-stock/index.md +5 -0
  812. package/docs/reference/typescript-api/products-stock/multi-channel-stock-location-strategy.md +47 -0
  813. package/docs/reference/typescript-api/products-stock/product-variant-price-calculation-strategy.md +95 -0
  814. package/docs/reference/typescript-api/products-stock/stock-display-strategy.md +47 -0
  815. package/docs/reference/typescript-api/products-stock/stock-location-strategy.md +157 -0
  816. package/docs/reference/typescript-api/promotions/facet-value-checker.md +78 -0
  817. package/docs/reference/typescript-api/promotions/index.md +5 -0
  818. package/docs/reference/typescript-api/promotions/promotion-action.md +454 -0
  819. package/docs/reference/typescript-api/promotions/promotion-condition.md +117 -0
  820. package/docs/reference/typescript-api/promotions/promotion-options.md +35 -0
  821. package/docs/reference/typescript-api/request/allow-decorator.md +53 -0
  822. package/docs/reference/typescript-api/request/api-decorator.md +28 -0
  823. package/docs/reference/typescript-api/request/api-type.md +16 -0
  824. package/docs/reference/typescript-api/request/ctx-decorator.md +23 -0
  825. package/docs/reference/typescript-api/request/index.md +5 -0
  826. package/docs/reference/typescript-api/request/relations-decorator.md +116 -0
  827. package/docs/reference/typescript-api/request/request-context-service.md +47 -0
  828. package/docs/reference/typescript-api/request/request-context.md +205 -0
  829. package/docs/reference/typescript-api/request/transaction-decorator.md +82 -0
  830. package/docs/reference/typescript-api/scheduled-tasks/clean-sessions-task.md +40 -0
  831. package/docs/reference/typescript-api/scheduled-tasks/default-scheduler-plugin.md +86 -0
  832. package/docs/reference/typescript-api/scheduled-tasks/default-scheduler-strategy.md +76 -0
  833. package/docs/reference/typescript-api/scheduled-tasks/index.md +5 -0
  834. package/docs/reference/typescript-api/scheduled-tasks/scheduled-task.md +196 -0
  835. package/docs/reference/typescript-api/scheduled-tasks/scheduler-options.md +47 -0
  836. package/docs/reference/typescript-api/scheduled-tasks/scheduler-service.md +62 -0
  837. package/docs/reference/typescript-api/scheduled-tasks/scheduler-strategy.md +141 -0
  838. package/docs/reference/typescript-api/service-helpers/entity-duplicator-service.md +43 -0
  839. package/docs/reference/typescript-api/service-helpers/index.md +5 -0
  840. package/docs/reference/typescript-api/service-helpers/order-calculator.md +54 -0
  841. package/docs/reference/typescript-api/service-helpers/order-modifier.md +91 -0
  842. package/docs/reference/typescript-api/service-helpers/product-price-applicator.md +62 -0
  843. package/docs/reference/typescript-api/service-helpers/slug-validator.md +86 -0
  844. package/docs/reference/typescript-api/service-helpers/translatable-saver.md +66 -0
  845. package/docs/reference/typescript-api/service-helpers/translator-service.md +63 -0
  846. package/docs/reference/typescript-api/services/administrator-service.md +71 -0
  847. package/docs/reference/typescript-api/services/asset-service.md +177 -0
  848. package/docs/reference/typescript-api/services/auth-service.md +54 -0
  849. package/docs/reference/typescript-api/services/channel-service.md +111 -0
  850. package/docs/reference/typescript-api/services/collection-service.md +186 -0
  851. package/docs/reference/typescript-api/services/country-service.md +71 -0
  852. package/docs/reference/typescript-api/services/customer-group-service.md +77 -0
  853. package/docs/reference/typescript-api/services/customer-service.md +203 -0
  854. package/docs/reference/typescript-api/services/entity-slug-service.md +37 -0
  855. package/docs/reference/typescript-api/services/facet-service.md +95 -0
  856. package/docs/reference/typescript-api/services/facet-value-service.md +104 -0
  857. package/docs/reference/typescript-api/services/fulfillment-service.md +69 -0
  858. package/docs/reference/typescript-api/services/global-settings-service.md +41 -0
  859. package/docs/reference/typescript-api/services/history-service.md +172 -0
  860. package/docs/reference/typescript-api/services/index.md +5 -0
  861. package/docs/reference/typescript-api/services/initializer-service.md +36 -0
  862. package/docs/reference/typescript-api/services/order-service.md +440 -0
  863. package/docs/reference/typescript-api/services/order-testing-service.md +44 -0
  864. package/docs/reference/typescript-api/services/payment-method-service.md +105 -0
  865. package/docs/reference/typescript-api/services/payment-service.md +105 -0
  866. package/docs/reference/typescript-api/services/product-option-group-service.md +67 -0
  867. package/docs/reference/typescript-api/services/product-option-service.md +64 -0
  868. package/docs/reference/typescript-api/services/product-service.md +111 -0
  869. package/docs/reference/typescript-api/services/product-variant-service.md +179 -0
  870. package/docs/reference/typescript-api/services/promotion-service.md +127 -0
  871. package/docs/reference/typescript-api/services/province-service.md +59 -0
  872. package/docs/reference/typescript-api/services/role-service.md +113 -0
  873. package/docs/reference/typescript-api/services/search-service.md +37 -0
  874. package/docs/reference/typescript-api/services/seller-service.md +65 -0
  875. package/docs/reference/typescript-api/services/session-service.md +105 -0
  876. package/docs/reference/typescript-api/services/settings-store-service.md +194 -0
  877. package/docs/reference/typescript-api/services/shipping-method-service.md +95 -0
  878. package/docs/reference/typescript-api/services/slug-service.md +35 -0
  879. package/docs/reference/typescript-api/services/stock-level-service.md +62 -0
  880. package/docs/reference/typescript-api/services/stock-location-service.md +115 -0
  881. package/docs/reference/typescript-api/services/stock-movement-service.md +95 -0
  882. package/docs/reference/typescript-api/services/tag-service.md +71 -0
  883. package/docs/reference/typescript-api/services/tax-category-service.md +59 -0
  884. package/docs/reference/typescript-api/services/tax-rate-service.md +66 -0
  885. package/docs/reference/typescript-api/services/user-service.md +132 -0
  886. package/docs/reference/typescript-api/services/zone-service.md +77 -0
  887. package/docs/reference/typescript-api/settings-store/cleanup-orphaned-settings-store-entries-options.md +48 -0
  888. package/docs/reference/typescript-api/settings-store/cleanup-orphaned-settings-store-entries-result.md +41 -0
  889. package/docs/reference/typescript-api/settings-store/index.md +38 -0
  890. package/docs/reference/typescript-api/settings-store/orphaned-settings-store-entry.md +48 -0
  891. package/docs/reference/typescript-api/settings-store/set-settings-store-value-result.md +42 -0
  892. package/docs/reference/typescript-api/settings-store/settings-store-field-config.md +92 -0
  893. package/docs/reference/typescript-api/settings-store/settings-store-registration.md +36 -0
  894. package/docs/reference/typescript-api/settings-store/settings-store-scope-function.md +35 -0
  895. package/docs/reference/typescript-api/settings-store/settings-store-scopes.md +36 -0
  896. package/docs/reference/typescript-api/shipping/check-shipping-eligibility-checker-fn.md +27 -0
  897. package/docs/reference/typescript-api/shipping/default-shipping-line-assignment-strategy.md +33 -0
  898. package/docs/reference/typescript-api/shipping/index.md +5 -0
  899. package/docs/reference/typescript-api/shipping/shipping-calculator.md +121 -0
  900. package/docs/reference/typescript-api/shipping/shipping-eligibility-checker-config.md +39 -0
  901. package/docs/reference/typescript-api/shipping/shipping-eligibility-checker.md +60 -0
  902. package/docs/reference/typescript-api/shipping/shipping-line-assignment-strategy.md +75 -0
  903. package/docs/reference/typescript-api/shipping/shipping-options.md +63 -0
  904. package/docs/reference/typescript-api/shipping/should-run-check-fn.md +44 -0
  905. package/docs/reference/typescript-api/state-machine/fsm.md +66 -0
  906. package/docs/reference/typescript-api/state-machine/index.md +5 -0
  907. package/docs/reference/typescript-api/state-machine/state-machine-config.md +103 -0
  908. package/docs/reference/typescript-api/state-machine/transitions.md +43 -0
  909. package/docs/reference/typescript-api/tax/address-based-tax-zone-strategy.md +57 -0
  910. package/docs/reference/typescript-api/tax/default-tax-line-calculation-strategy.md +33 -0
  911. package/docs/reference/typescript-api/tax/default-tax-zone-strategy.md +35 -0
  912. package/docs/reference/typescript-api/tax/index.md +5 -0
  913. package/docs/reference/typescript-api/tax/tax-line-calculation-strategy.md +90 -0
  914. package/docs/reference/typescript-api/tax/tax-options.md +35 -0
  915. package/docs/reference/typescript-api/tax/tax-zone-strategy.md +54 -0
  916. package/docs/reference/typescript-api/telemetry/index.md +5 -0
  917. package/docs/reference/typescript-api/telemetry/instrument.md +47 -0
  918. package/docs/reference/typescript-api/telemetry/instrumentation-strategy.md +35 -0
  919. package/docs/reference/typescript-api/telemetry/wrapped-method-args.md +56 -0
  920. package/docs/reference/typescript-api/testing/create-error-result-guard.md +33 -0
  921. package/docs/reference/typescript-api/testing/create-test-environment.md +47 -0
  922. package/docs/reference/typescript-api/testing/error-result-guard.md +73 -0
  923. package/docs/reference/typescript-api/testing/get-superadmin-context.md +23 -0
  924. package/docs/reference/typescript-api/testing/index.md +5 -0
  925. package/docs/reference/typescript-api/testing/register-initializer.md +27 -0
  926. package/docs/reference/typescript-api/testing/simple-graph-qlclient.md +123 -0
  927. package/docs/reference/typescript-api/testing/test-config.md +30 -0
  928. package/docs/reference/typescript-api/testing/test-db-initializer.md +60 -0
  929. package/docs/reference/typescript-api/testing/test-environment.md +42 -0
  930. package/docs/reference/typescript-api/testing/test-server-options.md +47 -0
  931. package/docs/reference/typescript-api/testing/test-server.md +60 -0
  932. package/docs/reference/typescript-api/testing/testing-logger.md +140 -0
  933. package/docs/reference/typescript-api/worker/bootstrap-worker.md +76 -0
  934. package/docs/reference/typescript-api/worker/index.md +5 -0
  935. package/docs/reference/typescript-api/worker/vendure-worker.md +50 -0
  936. package/docs/reference/typescript-api/worker/worker-health-check-config.md +41 -0
  937. package/docs/user-guide/catalog/collections.md +27 -0
  938. package/docs/user-guide/catalog/facets.md +34 -0
  939. package/docs/user-guide/catalog/product-variants.png +0 -0
  940. package/docs/user-guide/catalog/products.md +35 -0
  941. package/docs/user-guide/catalog/screen-facet-add.webp +0 -0
  942. package/docs/user-guide/catalog/screen-facet-list.webp +0 -0
  943. package/docs/user-guide/catalog/screen-inventory.webp +0 -0
  944. package/docs/user-guide/customers/index.md +30 -0
  945. package/docs/user-guide/customers/screen-customer-group.webp +0 -0
  946. package/docs/user-guide/index.md +7 -0
  947. package/docs/user-guide/localization/index.md +42 -0
  948. package/docs/user-guide/localization/screen-ui-language.webp +0 -0
  949. package/docs/user-guide/orders/draft-orders.md +28 -0
  950. package/docs/user-guide/orders/order-state-diagram-for-admin.png +0 -0
  951. package/docs/user-guide/orders/orders.md +65 -0
  952. package/docs/user-guide/orders/screen-fulfillment-shipped.webp +0 -0
  953. package/docs/user-guide/orders/screen-fulfillment.webp +0 -0
  954. package/docs/user-guide/orders/screen-modification.webp +0 -0
  955. package/docs/user-guide/orders/screen-modify-button.webp +0 -0
  956. package/docs/user-guide/orders/screen-refund-button.webp +0 -0
  957. package/docs/user-guide/orders/screen-settle-payment.webp +0 -0
  958. package/docs/user-guide/promotions/index.md +44 -0
  959. package/docs/user-guide/settings/administrators-roles.md +34 -0
  960. package/docs/user-guide/settings/channels.md +18 -0
  961. package/docs/user-guide/settings/countries-zones.md +12 -0
  962. package/docs/user-guide/settings/global-settings.md +12 -0
  963. package/docs/user-guide/settings/payment-methods.md +32 -0
  964. package/docs/user-guide/settings/screen-shipping-test.webp +0 -0
  965. package/docs/user-guide/settings/screen-translations.webp +0 -0
  966. package/docs/user-guide/settings/shipping-methods.md +55 -0
  967. package/docs/user-guide/settings/taxes.md +32 -0
  968. package/package.json +32 -0
@@ -0,0 +1,1142 @@
1
+ ---
2
+ title: "Enums"
3
+ generated: true
4
+ ---
5
+ <!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
6
+
7
+
8
+
9
+ ## AdjustmentType
10
+
11
+ <div class="graphql-code-block">
12
+
13
+ <div class="graphql-code-line top-level">enum <span class="graphql-code-identifier">AdjustmentType</span> &#123;</div>
14
+ <div class="graphql-code-line ">PROMOTION</div>
15
+ <div class="graphql-code-line ">DISTRIBUTED_ORDER_PROMOTION</div>
16
+ <div class="graphql-code-line ">OTHER</div>
17
+ <div class="graphql-code-line top-level">&#125;</div>
18
+ </div>
19
+
20
+ ## AssetType
21
+
22
+ <div class="graphql-code-block">
23
+
24
+ <div class="graphql-code-line top-level">enum <span class="graphql-code-identifier">AssetType</span> &#123;</div>
25
+ <div class="graphql-code-line ">IMAGE</div>
26
+ <div class="graphql-code-line ">VIDEO</div>
27
+ <div class="graphql-code-line ">BINARY</div>
28
+ <div class="graphql-code-line top-level">&#125;</div>
29
+ </div>
30
+
31
+ ## CurrencyCode
32
+
33
+ <div class="graphql-code-block">
34
+ <div class="graphql-code-line comment">"""</div>
35
+ <div class="graphql-code-line comment">ISO 4217 currency code</div>
36
+
37
+ <div class="graphql-code-line comment"></div>
38
+
39
+ <div class="graphql-code-line comment"></div>
40
+ <div class="graphql-code-line comment">"""</div>
41
+
42
+ <div class="graphql-code-line top-level">enum <span class="graphql-code-identifier">CurrencyCode</span> &#123;</div>
43
+ <div class="graphql-code-line comment">"""United Arab Emirates dirham"""</div>
44
+ <div class="graphql-code-line ">AED</div>
45
+ <div class="graphql-code-line comment">"""Afghan afghani"""</div>
46
+ <div class="graphql-code-line ">AFN</div>
47
+ <div class="graphql-code-line comment">"""Albanian lek"""</div>
48
+ <div class="graphql-code-line ">ALL</div>
49
+ <div class="graphql-code-line comment">"""Armenian dram"""</div>
50
+ <div class="graphql-code-line ">AMD</div>
51
+ <div class="graphql-code-line comment">"""Netherlands Antillean guilder"""</div>
52
+ <div class="graphql-code-line ">ANG</div>
53
+ <div class="graphql-code-line comment">"""Angolan kwanza"""</div>
54
+ <div class="graphql-code-line ">AOA</div>
55
+ <div class="graphql-code-line comment">"""Argentine peso"""</div>
56
+ <div class="graphql-code-line ">ARS</div>
57
+ <div class="graphql-code-line comment">"""Australian dollar"""</div>
58
+ <div class="graphql-code-line ">AUD</div>
59
+ <div class="graphql-code-line comment">"""Aruban florin"""</div>
60
+ <div class="graphql-code-line ">AWG</div>
61
+ <div class="graphql-code-line comment">"""Azerbaijani manat"""</div>
62
+ <div class="graphql-code-line ">AZN</div>
63
+ <div class="graphql-code-line comment">"""Bosnia and Herzegovina convertible mark"""</div>
64
+ <div class="graphql-code-line ">BAM</div>
65
+ <div class="graphql-code-line comment">"""Barbados dollar"""</div>
66
+ <div class="graphql-code-line ">BBD</div>
67
+ <div class="graphql-code-line comment">"""Bangladeshi taka"""</div>
68
+ <div class="graphql-code-line ">BDT</div>
69
+ <div class="graphql-code-line comment">"""Bulgarian lev"""</div>
70
+ <div class="graphql-code-line ">BGN</div>
71
+ <div class="graphql-code-line comment">"""Bahraini dinar"""</div>
72
+ <div class="graphql-code-line ">BHD</div>
73
+ <div class="graphql-code-line comment">"""Burundian franc"""</div>
74
+ <div class="graphql-code-line ">BIF</div>
75
+ <div class="graphql-code-line comment">"""Bermudian dollar"""</div>
76
+ <div class="graphql-code-line ">BMD</div>
77
+ <div class="graphql-code-line comment">"""Brunei dollar"""</div>
78
+ <div class="graphql-code-line ">BND</div>
79
+ <div class="graphql-code-line comment">"""Boliviano"""</div>
80
+ <div class="graphql-code-line ">BOB</div>
81
+ <div class="graphql-code-line comment">"""Brazilian real"""</div>
82
+ <div class="graphql-code-line ">BRL</div>
83
+ <div class="graphql-code-line comment">"""Bahamian dollar"""</div>
84
+ <div class="graphql-code-line ">BSD</div>
85
+ <div class="graphql-code-line comment">"""Bhutanese ngultrum"""</div>
86
+ <div class="graphql-code-line ">BTN</div>
87
+ <div class="graphql-code-line comment">"""Botswana pula"""</div>
88
+ <div class="graphql-code-line ">BWP</div>
89
+ <div class="graphql-code-line comment">"""Belarusian ruble"""</div>
90
+ <div class="graphql-code-line ">BYN</div>
91
+ <div class="graphql-code-line comment">"""Belize dollar"""</div>
92
+ <div class="graphql-code-line ">BZD</div>
93
+ <div class="graphql-code-line comment">"""Canadian dollar"""</div>
94
+ <div class="graphql-code-line ">CAD</div>
95
+ <div class="graphql-code-line comment">"""Congolese franc"""</div>
96
+ <div class="graphql-code-line ">CDF</div>
97
+ <div class="graphql-code-line comment">"""Swiss franc"""</div>
98
+ <div class="graphql-code-line ">CHF</div>
99
+ <div class="graphql-code-line comment">"""Chilean peso"""</div>
100
+ <div class="graphql-code-line ">CLP</div>
101
+ <div class="graphql-code-line comment">"""Renminbi (Chinese) yuan"""</div>
102
+ <div class="graphql-code-line ">CNY</div>
103
+ <div class="graphql-code-line comment">"""Colombian peso"""</div>
104
+ <div class="graphql-code-line ">COP</div>
105
+ <div class="graphql-code-line comment">"""Costa Rican colon"""</div>
106
+ <div class="graphql-code-line ">CRC</div>
107
+ <div class="graphql-code-line comment">"""Cuban convertible peso"""</div>
108
+ <div class="graphql-code-line ">CUC</div>
109
+ <div class="graphql-code-line comment">"""Cuban peso"""</div>
110
+ <div class="graphql-code-line ">CUP</div>
111
+ <div class="graphql-code-line comment">"""Cape Verde escudo"""</div>
112
+ <div class="graphql-code-line ">CVE</div>
113
+ <div class="graphql-code-line comment">"""Czech koruna"""</div>
114
+ <div class="graphql-code-line ">CZK</div>
115
+ <div class="graphql-code-line comment">"""Djiboutian franc"""</div>
116
+ <div class="graphql-code-line ">DJF</div>
117
+ <div class="graphql-code-line comment">"""Danish krone"""</div>
118
+ <div class="graphql-code-line ">DKK</div>
119
+ <div class="graphql-code-line comment">"""Dominican peso"""</div>
120
+ <div class="graphql-code-line ">DOP</div>
121
+ <div class="graphql-code-line comment">"""Algerian dinar"""</div>
122
+ <div class="graphql-code-line ">DZD</div>
123
+ <div class="graphql-code-line comment">"""Egyptian pound"""</div>
124
+ <div class="graphql-code-line ">EGP</div>
125
+ <div class="graphql-code-line comment">"""Eritrean nakfa"""</div>
126
+ <div class="graphql-code-line ">ERN</div>
127
+ <div class="graphql-code-line comment">"""Ethiopian birr"""</div>
128
+ <div class="graphql-code-line ">ETB</div>
129
+ <div class="graphql-code-line comment">"""Euro"""</div>
130
+ <div class="graphql-code-line ">EUR</div>
131
+ <div class="graphql-code-line comment">"""Fiji dollar"""</div>
132
+ <div class="graphql-code-line ">FJD</div>
133
+ <div class="graphql-code-line comment">"""Falkland Islands pound"""</div>
134
+ <div class="graphql-code-line ">FKP</div>
135
+ <div class="graphql-code-line comment">"""Pound sterling"""</div>
136
+ <div class="graphql-code-line ">GBP</div>
137
+ <div class="graphql-code-line comment">"""Georgian lari"""</div>
138
+ <div class="graphql-code-line ">GEL</div>
139
+ <div class="graphql-code-line comment">"""Ghanaian cedi"""</div>
140
+ <div class="graphql-code-line ">GHS</div>
141
+ <div class="graphql-code-line comment">"""Gibraltar pound"""</div>
142
+ <div class="graphql-code-line ">GIP</div>
143
+ <div class="graphql-code-line comment">"""Gambian dalasi"""</div>
144
+ <div class="graphql-code-line ">GMD</div>
145
+ <div class="graphql-code-line comment">"""Guinean franc"""</div>
146
+ <div class="graphql-code-line ">GNF</div>
147
+ <div class="graphql-code-line comment">"""Guatemalan quetzal"""</div>
148
+ <div class="graphql-code-line ">GTQ</div>
149
+ <div class="graphql-code-line comment">"""Guyanese dollar"""</div>
150
+ <div class="graphql-code-line ">GYD</div>
151
+ <div class="graphql-code-line comment">"""Hong Kong dollar"""</div>
152
+ <div class="graphql-code-line ">HKD</div>
153
+ <div class="graphql-code-line comment">"""Honduran lempira"""</div>
154
+ <div class="graphql-code-line ">HNL</div>
155
+ <div class="graphql-code-line comment">"""Croatian kuna"""</div>
156
+ <div class="graphql-code-line ">HRK</div>
157
+ <div class="graphql-code-line comment">"""Haitian gourde"""</div>
158
+ <div class="graphql-code-line ">HTG</div>
159
+ <div class="graphql-code-line comment">"""Hungarian forint"""</div>
160
+ <div class="graphql-code-line ">HUF</div>
161
+ <div class="graphql-code-line comment">"""Indonesian rupiah"""</div>
162
+ <div class="graphql-code-line ">IDR</div>
163
+ <div class="graphql-code-line comment">"""Israeli new shekel"""</div>
164
+ <div class="graphql-code-line ">ILS</div>
165
+ <div class="graphql-code-line comment">"""Indian rupee"""</div>
166
+ <div class="graphql-code-line ">INR</div>
167
+ <div class="graphql-code-line comment">"""Iraqi dinar"""</div>
168
+ <div class="graphql-code-line ">IQD</div>
169
+ <div class="graphql-code-line comment">"""Iranian rial"""</div>
170
+ <div class="graphql-code-line ">IRR</div>
171
+ <div class="graphql-code-line comment">"""Icelandic króna"""</div>
172
+ <div class="graphql-code-line ">ISK</div>
173
+ <div class="graphql-code-line comment">"""Jamaican dollar"""</div>
174
+ <div class="graphql-code-line ">JMD</div>
175
+ <div class="graphql-code-line comment">"""Jordanian dinar"""</div>
176
+ <div class="graphql-code-line ">JOD</div>
177
+ <div class="graphql-code-line comment">"""Japanese yen"""</div>
178
+ <div class="graphql-code-line ">JPY</div>
179
+ <div class="graphql-code-line comment">"""Kenyan shilling"""</div>
180
+ <div class="graphql-code-line ">KES</div>
181
+ <div class="graphql-code-line comment">"""Kyrgyzstani som"""</div>
182
+ <div class="graphql-code-line ">KGS</div>
183
+ <div class="graphql-code-line comment">"""Cambodian riel"""</div>
184
+ <div class="graphql-code-line ">KHR</div>
185
+ <div class="graphql-code-line comment">"""Comoro franc"""</div>
186
+ <div class="graphql-code-line ">KMF</div>
187
+ <div class="graphql-code-line comment">"""North Korean won"""</div>
188
+ <div class="graphql-code-line ">KPW</div>
189
+ <div class="graphql-code-line comment">"""South Korean won"""</div>
190
+ <div class="graphql-code-line ">KRW</div>
191
+ <div class="graphql-code-line comment">"""Kuwaiti dinar"""</div>
192
+ <div class="graphql-code-line ">KWD</div>
193
+ <div class="graphql-code-line comment">"""Cayman Islands dollar"""</div>
194
+ <div class="graphql-code-line ">KYD</div>
195
+ <div class="graphql-code-line comment">"""Kazakhstani tenge"""</div>
196
+ <div class="graphql-code-line ">KZT</div>
197
+ <div class="graphql-code-line comment">"""Lao kip"""</div>
198
+ <div class="graphql-code-line ">LAK</div>
199
+ <div class="graphql-code-line comment">"""Lebanese pound"""</div>
200
+ <div class="graphql-code-line ">LBP</div>
201
+ <div class="graphql-code-line comment">"""Sri Lankan rupee"""</div>
202
+ <div class="graphql-code-line ">LKR</div>
203
+ <div class="graphql-code-line comment">"""Liberian dollar"""</div>
204
+ <div class="graphql-code-line ">LRD</div>
205
+ <div class="graphql-code-line comment">"""Lesotho loti"""</div>
206
+ <div class="graphql-code-line ">LSL</div>
207
+ <div class="graphql-code-line comment">"""Libyan dinar"""</div>
208
+ <div class="graphql-code-line ">LYD</div>
209
+ <div class="graphql-code-line comment">"""Moroccan dirham"""</div>
210
+ <div class="graphql-code-line ">MAD</div>
211
+ <div class="graphql-code-line comment">"""Moldovan leu"""</div>
212
+ <div class="graphql-code-line ">MDL</div>
213
+ <div class="graphql-code-line comment">"""Malagasy ariary"""</div>
214
+ <div class="graphql-code-line ">MGA</div>
215
+ <div class="graphql-code-line comment">"""Macedonian denar"""</div>
216
+ <div class="graphql-code-line ">MKD</div>
217
+ <div class="graphql-code-line comment">"""Myanmar kyat"""</div>
218
+ <div class="graphql-code-line ">MMK</div>
219
+ <div class="graphql-code-line comment">"""Mongolian tögrög"""</div>
220
+ <div class="graphql-code-line ">MNT</div>
221
+ <div class="graphql-code-line comment">"""Macanese pataca"""</div>
222
+ <div class="graphql-code-line ">MOP</div>
223
+ <div class="graphql-code-line comment">"""Mauritanian ouguiya"""</div>
224
+ <div class="graphql-code-line ">MRU</div>
225
+ <div class="graphql-code-line comment">"""Mauritian rupee"""</div>
226
+ <div class="graphql-code-line ">MUR</div>
227
+ <div class="graphql-code-line comment">"""Maldivian rufiyaa"""</div>
228
+ <div class="graphql-code-line ">MVR</div>
229
+ <div class="graphql-code-line comment">"""Malawian kwacha"""</div>
230
+ <div class="graphql-code-line ">MWK</div>
231
+ <div class="graphql-code-line comment">"""Mexican peso"""</div>
232
+ <div class="graphql-code-line ">MXN</div>
233
+ <div class="graphql-code-line comment">"""Malaysian ringgit"""</div>
234
+ <div class="graphql-code-line ">MYR</div>
235
+ <div class="graphql-code-line comment">"""Mozambican metical"""</div>
236
+ <div class="graphql-code-line ">MZN</div>
237
+ <div class="graphql-code-line comment">"""Namibian dollar"""</div>
238
+ <div class="graphql-code-line ">NAD</div>
239
+ <div class="graphql-code-line comment">"""Nigerian naira"""</div>
240
+ <div class="graphql-code-line ">NGN</div>
241
+ <div class="graphql-code-line comment">"""Nicaraguan córdoba"""</div>
242
+ <div class="graphql-code-line ">NIO</div>
243
+ <div class="graphql-code-line comment">"""Norwegian krone"""</div>
244
+ <div class="graphql-code-line ">NOK</div>
245
+ <div class="graphql-code-line comment">"""Nepalese rupee"""</div>
246
+ <div class="graphql-code-line ">NPR</div>
247
+ <div class="graphql-code-line comment">"""New Zealand dollar"""</div>
248
+ <div class="graphql-code-line ">NZD</div>
249
+ <div class="graphql-code-line comment">"""Omani rial"""</div>
250
+ <div class="graphql-code-line ">OMR</div>
251
+ <div class="graphql-code-line comment">"""Panamanian balboa"""</div>
252
+ <div class="graphql-code-line ">PAB</div>
253
+ <div class="graphql-code-line comment">"""Peruvian sol"""</div>
254
+ <div class="graphql-code-line ">PEN</div>
255
+ <div class="graphql-code-line comment">"""Papua New Guinean kina"""</div>
256
+ <div class="graphql-code-line ">PGK</div>
257
+ <div class="graphql-code-line comment">"""Philippine peso"""</div>
258
+ <div class="graphql-code-line ">PHP</div>
259
+ <div class="graphql-code-line comment">"""Pakistani rupee"""</div>
260
+ <div class="graphql-code-line ">PKR</div>
261
+ <div class="graphql-code-line comment">"""Polish złoty"""</div>
262
+ <div class="graphql-code-line ">PLN</div>
263
+ <div class="graphql-code-line comment">"""Paraguayan guaraní"""</div>
264
+ <div class="graphql-code-line ">PYG</div>
265
+ <div class="graphql-code-line comment">"""Qatari riyal"""</div>
266
+ <div class="graphql-code-line ">QAR</div>
267
+ <div class="graphql-code-line comment">"""Romanian leu"""</div>
268
+ <div class="graphql-code-line ">RON</div>
269
+ <div class="graphql-code-line comment">"""Serbian dinar"""</div>
270
+ <div class="graphql-code-line ">RSD</div>
271
+ <div class="graphql-code-line comment">"""Russian ruble"""</div>
272
+ <div class="graphql-code-line ">RUB</div>
273
+ <div class="graphql-code-line comment">"""Rwandan franc"""</div>
274
+ <div class="graphql-code-line ">RWF</div>
275
+ <div class="graphql-code-line comment">"""Saudi riyal"""</div>
276
+ <div class="graphql-code-line ">SAR</div>
277
+ <div class="graphql-code-line comment">"""Solomon Islands dollar"""</div>
278
+ <div class="graphql-code-line ">SBD</div>
279
+ <div class="graphql-code-line comment">"""Seychelles rupee"""</div>
280
+ <div class="graphql-code-line ">SCR</div>
281
+ <div class="graphql-code-line comment">"""Sudanese pound"""</div>
282
+ <div class="graphql-code-line ">SDG</div>
283
+ <div class="graphql-code-line comment">"""Swedish krona/kronor"""</div>
284
+ <div class="graphql-code-line ">SEK</div>
285
+ <div class="graphql-code-line comment">"""Singapore dollar"""</div>
286
+ <div class="graphql-code-line ">SGD</div>
287
+ <div class="graphql-code-line comment">"""Saint Helena pound"""</div>
288
+ <div class="graphql-code-line ">SHP</div>
289
+ <div class="graphql-code-line comment">"""Sierra Leonean leone"""</div>
290
+ <div class="graphql-code-line ">SLL</div>
291
+ <div class="graphql-code-line comment">"""Somali shilling"""</div>
292
+ <div class="graphql-code-line ">SOS</div>
293
+ <div class="graphql-code-line comment">"""Surinamese dollar"""</div>
294
+ <div class="graphql-code-line ">SRD</div>
295
+ <div class="graphql-code-line comment">"""South Sudanese pound"""</div>
296
+ <div class="graphql-code-line ">SSP</div>
297
+ <div class="graphql-code-line comment">"""São Tomé and Príncipe dobra"""</div>
298
+ <div class="graphql-code-line ">STN</div>
299
+ <div class="graphql-code-line comment">"""Salvadoran colón"""</div>
300
+ <div class="graphql-code-line ">SVC</div>
301
+ <div class="graphql-code-line comment">"""Syrian pound"""</div>
302
+ <div class="graphql-code-line ">SYP</div>
303
+ <div class="graphql-code-line comment">"""Swazi lilangeni"""</div>
304
+ <div class="graphql-code-line ">SZL</div>
305
+ <div class="graphql-code-line comment">"""Thai baht"""</div>
306
+ <div class="graphql-code-line ">THB</div>
307
+ <div class="graphql-code-line comment">"""Tajikistani somoni"""</div>
308
+ <div class="graphql-code-line ">TJS</div>
309
+ <div class="graphql-code-line comment">"""Turkmenistan manat"""</div>
310
+ <div class="graphql-code-line ">TMT</div>
311
+ <div class="graphql-code-line comment">"""Tunisian dinar"""</div>
312
+ <div class="graphql-code-line ">TND</div>
313
+ <div class="graphql-code-line comment">"""Tongan paʻanga"""</div>
314
+ <div class="graphql-code-line ">TOP</div>
315
+ <div class="graphql-code-line comment">"""Turkish lira"""</div>
316
+ <div class="graphql-code-line ">TRY</div>
317
+ <div class="graphql-code-line comment">"""Trinidad and Tobago dollar"""</div>
318
+ <div class="graphql-code-line ">TTD</div>
319
+ <div class="graphql-code-line comment">"""New Taiwan dollar"""</div>
320
+ <div class="graphql-code-line ">TWD</div>
321
+ <div class="graphql-code-line comment">"""Tanzanian shilling"""</div>
322
+ <div class="graphql-code-line ">TZS</div>
323
+ <div class="graphql-code-line comment">"""Ukrainian hryvnia"""</div>
324
+ <div class="graphql-code-line ">UAH</div>
325
+ <div class="graphql-code-line comment">"""Ugandan shilling"""</div>
326
+ <div class="graphql-code-line ">UGX</div>
327
+ <div class="graphql-code-line comment">"""United States dollar"""</div>
328
+ <div class="graphql-code-line ">USD</div>
329
+ <div class="graphql-code-line comment">"""Uruguayan peso"""</div>
330
+ <div class="graphql-code-line ">UYU</div>
331
+ <div class="graphql-code-line comment">"""Uzbekistan som"""</div>
332
+ <div class="graphql-code-line ">UZS</div>
333
+ <div class="graphql-code-line comment">"""Venezuelan bolívar soberano"""</div>
334
+ <div class="graphql-code-line ">VES</div>
335
+ <div class="graphql-code-line comment">"""Vietnamese đồng"""</div>
336
+ <div class="graphql-code-line ">VND</div>
337
+ <div class="graphql-code-line comment">"""Vanuatu vatu"""</div>
338
+ <div class="graphql-code-line ">VUV</div>
339
+ <div class="graphql-code-line comment">"""Samoan tala"""</div>
340
+ <div class="graphql-code-line ">WST</div>
341
+ <div class="graphql-code-line comment">"""CFA franc BEAC"""</div>
342
+ <div class="graphql-code-line ">XAF</div>
343
+ <div class="graphql-code-line comment">"""East Caribbean dollar"""</div>
344
+ <div class="graphql-code-line ">XCD</div>
345
+ <div class="graphql-code-line comment">"""CFA franc BCEAO"""</div>
346
+ <div class="graphql-code-line ">XOF</div>
347
+ <div class="graphql-code-line comment">"""CFP franc (franc Pacifique)"""</div>
348
+ <div class="graphql-code-line ">XPF</div>
349
+ <div class="graphql-code-line comment">"""Yemeni rial"""</div>
350
+ <div class="graphql-code-line ">YER</div>
351
+ <div class="graphql-code-line comment">"""South African rand"""</div>
352
+ <div class="graphql-code-line ">ZAR</div>
353
+ <div class="graphql-code-line comment">"""Zambian kwacha"""</div>
354
+ <div class="graphql-code-line ">ZMW</div>
355
+ <div class="graphql-code-line comment">"""Zimbabwean dollar"""</div>
356
+ <div class="graphql-code-line ">ZWL</div>
357
+ <div class="graphql-code-line top-level">&#125;</div>
358
+ </div>
359
+
360
+ ## DeletionResult
361
+
362
+ <div class="graphql-code-block">
363
+
364
+ <div class="graphql-code-line top-level">enum <span class="graphql-code-identifier">DeletionResult</span> &#123;</div>
365
+ <div class="graphql-code-line comment">"""The entity was successfully deleted"""</div>
366
+ <div class="graphql-code-line ">DELETED</div>
367
+ <div class="graphql-code-line comment">"""Deletion did not take place, reason given in message"""</div>
368
+ <div class="graphql-code-line ">NOT_DELETED</div>
369
+ <div class="graphql-code-line top-level">&#125;</div>
370
+ </div>
371
+
372
+ ## ErrorCode
373
+
374
+ <div class="graphql-code-block">
375
+
376
+ <div class="graphql-code-line top-level">enum <span class="graphql-code-identifier">ErrorCode</span> &#123;</div>
377
+ <div class="graphql-code-line ">UNKNOWN_ERROR</div>
378
+ <div class="graphql-code-line ">MIME_TYPE_ERROR</div>
379
+ <div class="graphql-code-line ">LANGUAGE_NOT_AVAILABLE_ERROR</div>
380
+ <div class="graphql-code-line ">DUPLICATE_ENTITY_ERROR</div>
381
+ <div class="graphql-code-line ">FACET_IN_USE_ERROR</div>
382
+ <div class="graphql-code-line ">CHANNEL_DEFAULT_LANGUAGE_ERROR</div>
383
+ <div class="graphql-code-line ">SETTLE_PAYMENT_ERROR</div>
384
+ <div class="graphql-code-line ">CANCEL_PAYMENT_ERROR</div>
385
+ <div class="graphql-code-line ">EMPTY_ORDER_LINE_SELECTION_ERROR</div>
386
+ <div class="graphql-code-line ">ITEMS_ALREADY_FULFILLED_ERROR</div>
387
+ <div class="graphql-code-line ">INVALID_FULFILLMENT_HANDLER_ERROR</div>
388
+ <div class="graphql-code-line ">CREATE_FULFILLMENT_ERROR</div>
389
+ <div class="graphql-code-line ">INSUFFICIENT_STOCK_ON_HAND_ERROR</div>
390
+ <div class="graphql-code-line ">MULTIPLE_ORDER_ERROR</div>
391
+ <div class="graphql-code-line ">CANCEL_ACTIVE_ORDER_ERROR</div>
392
+ <div class="graphql-code-line ">PAYMENT_ORDER_MISMATCH_ERROR</div>
393
+ <div class="graphql-code-line ">REFUND_ORDER_STATE_ERROR</div>
394
+ <div class="graphql-code-line ">NOTHING_TO_REFUND_ERROR</div>
395
+ <div class="graphql-code-line ">ALREADY_REFUNDED_ERROR</div>
396
+ <div class="graphql-code-line ">QUANTITY_TOO_GREAT_ERROR</div>
397
+ <div class="graphql-code-line ">REFUND_AMOUNT_ERROR</div>
398
+ <div class="graphql-code-line ">REFUND_STATE_TRANSITION_ERROR</div>
399
+ <div class="graphql-code-line ">PAYMENT_STATE_TRANSITION_ERROR</div>
400
+ <div class="graphql-code-line ">FULFILLMENT_STATE_TRANSITION_ERROR</div>
401
+ <div class="graphql-code-line ">ORDER_MODIFICATION_STATE_ERROR</div>
402
+ <div class="graphql-code-line ">NO_CHANGES_SPECIFIED_ERROR</div>
403
+ <div class="graphql-code-line ">PAYMENT_METHOD_MISSING_ERROR</div>
404
+ <div class="graphql-code-line ">REFUND_PAYMENT_ID_MISSING_ERROR</div>
405
+ <div class="graphql-code-line ">MANUAL_PAYMENT_STATE_ERROR</div>
406
+ <div class="graphql-code-line ">PRODUCT_OPTION_IN_USE_ERROR</div>
407
+ <div class="graphql-code-line ">MISSING_CONDITIONS_ERROR</div>
408
+ <div class="graphql-code-line ">NATIVE_AUTH_STRATEGY_ERROR</div>
409
+ <div class="graphql-code-line ">INVALID_CREDENTIALS_ERROR</div>
410
+ <div class="graphql-code-line ">ORDER_STATE_TRANSITION_ERROR</div>
411
+ <div class="graphql-code-line ">EMAIL_ADDRESS_CONFLICT_ERROR</div>
412
+ <div class="graphql-code-line ">GUEST_CHECKOUT_ERROR</div>
413
+ <div class="graphql-code-line ">ORDER_LIMIT_ERROR</div>
414
+ <div class="graphql-code-line ">NEGATIVE_QUANTITY_ERROR</div>
415
+ <div class="graphql-code-line ">INSUFFICIENT_STOCK_ERROR</div>
416
+ <div class="graphql-code-line ">COUPON_CODE_INVALID_ERROR</div>
417
+ <div class="graphql-code-line ">COUPON_CODE_EXPIRED_ERROR</div>
418
+ <div class="graphql-code-line ">COUPON_CODE_LIMIT_ERROR</div>
419
+ <div class="graphql-code-line ">ORDER_MODIFICATION_ERROR</div>
420
+ <div class="graphql-code-line ">INELIGIBLE_SHIPPING_METHOD_ERROR</div>
421
+ <div class="graphql-code-line ">NO_ACTIVE_ORDER_ERROR</div>
422
+ <div class="graphql-code-line ">ORDER_INTERCEPTOR_ERROR</div>
423
+ <div class="graphql-code-line top-level">&#125;</div>
424
+ </div>
425
+
426
+ ## GlobalFlag
427
+
428
+ <div class="graphql-code-block">
429
+
430
+ <div class="graphql-code-line top-level">enum <span class="graphql-code-identifier">GlobalFlag</span> &#123;</div>
431
+ <div class="graphql-code-line ">TRUE</div>
432
+ <div class="graphql-code-line ">FALSE</div>
433
+ <div class="graphql-code-line ">INHERIT</div>
434
+ <div class="graphql-code-line top-level">&#125;</div>
435
+ </div>
436
+
437
+ ## HistoryEntryType
438
+
439
+ <div class="graphql-code-block">
440
+
441
+ <div class="graphql-code-line top-level">enum <span class="graphql-code-identifier">HistoryEntryType</span> &#123;</div>
442
+ <div class="graphql-code-line ">CUSTOMER_REGISTERED</div>
443
+ <div class="graphql-code-line ">CUSTOMER_VERIFIED</div>
444
+ <div class="graphql-code-line ">CUSTOMER_DETAIL_UPDATED</div>
445
+ <div class="graphql-code-line ">CUSTOMER_ADDED_TO_GROUP</div>
446
+ <div class="graphql-code-line ">CUSTOMER_REMOVED_FROM_GROUP</div>
447
+ <div class="graphql-code-line ">CUSTOMER_ADDRESS_CREATED</div>
448
+ <div class="graphql-code-line ">CUSTOMER_ADDRESS_UPDATED</div>
449
+ <div class="graphql-code-line ">CUSTOMER_ADDRESS_DELETED</div>
450
+ <div class="graphql-code-line ">CUSTOMER_PASSWORD_UPDATED</div>
451
+ <div class="graphql-code-line ">CUSTOMER_PASSWORD_RESET_REQUESTED</div>
452
+ <div class="graphql-code-line ">CUSTOMER_PASSWORD_RESET_VERIFIED</div>
453
+ <div class="graphql-code-line ">CUSTOMER_EMAIL_UPDATE_REQUESTED</div>
454
+ <div class="graphql-code-line ">CUSTOMER_EMAIL_UPDATE_VERIFIED</div>
455
+ <div class="graphql-code-line ">CUSTOMER_NOTE</div>
456
+ <div class="graphql-code-line ">ORDER_STATE_TRANSITION</div>
457
+ <div class="graphql-code-line ">ORDER_PAYMENT_TRANSITION</div>
458
+ <div class="graphql-code-line ">ORDER_FULFILLMENT</div>
459
+ <div class="graphql-code-line ">ORDER_CANCELLATION</div>
460
+ <div class="graphql-code-line ">ORDER_REFUND_TRANSITION</div>
461
+ <div class="graphql-code-line ">ORDER_FULFILLMENT_TRANSITION</div>
462
+ <div class="graphql-code-line ">ORDER_NOTE</div>
463
+ <div class="graphql-code-line ">ORDER_COUPON_APPLIED</div>
464
+ <div class="graphql-code-line ">ORDER_COUPON_REMOVED</div>
465
+ <div class="graphql-code-line ">ORDER_MODIFIED</div>
466
+ <div class="graphql-code-line ">ORDER_CUSTOMER_UPDATED</div>
467
+ <div class="graphql-code-line top-level">&#125;</div>
468
+ </div>
469
+
470
+ ## JobState
471
+
472
+ <div class="graphql-code-block">
473
+ <div class="graphql-code-line comment">"""</div>
474
+ <div class="graphql-code-line comment">The state of a Job in the JobQueue</div>
475
+
476
+ <div class="graphql-code-line comment"></div>
477
+
478
+ <div class="graphql-code-line comment"></div>
479
+ <div class="graphql-code-line comment">"""</div>
480
+
481
+ <div class="graphql-code-line top-level">enum <span class="graphql-code-identifier">JobState</span> &#123;</div>
482
+ <div class="graphql-code-line ">PENDING</div>
483
+ <div class="graphql-code-line ">RUNNING</div>
484
+ <div class="graphql-code-line ">COMPLETED</div>
485
+ <div class="graphql-code-line ">RETRYING</div>
486
+ <div class="graphql-code-line ">FAILED</div>
487
+ <div class="graphql-code-line ">CANCELLED</div>
488
+ <div class="graphql-code-line top-level">&#125;</div>
489
+ </div>
490
+
491
+ ## LanguageCode
492
+
493
+ <div class="graphql-code-block">
494
+ <div class="graphql-code-line comment">"""</div>
495
+ <div class="graphql-code-line comment">Languages in the form of a ISO 639-1 language code with optional</div>
496
+
497
+ <div class="graphql-code-line comment">region or script modifier (e.g. de_AT). The selection available is based</div>
498
+
499
+ <div class="graphql-code-line comment">on the [Unicode CLDR summary list](https://unicode-org.github.io/cldr-staging/charts/37/summary/root.html)</div>
500
+
501
+ <div class="graphql-code-line comment">and includes the major spoken languages of the world and any widely-used variants.</div>
502
+
503
+ <div class="graphql-code-line comment"></div>
504
+
505
+ <div class="graphql-code-line comment"></div>
506
+ <div class="graphql-code-line comment">"""</div>
507
+
508
+ <div class="graphql-code-line top-level">enum <span class="graphql-code-identifier">LanguageCode</span> &#123;</div>
509
+ <div class="graphql-code-line comment">"""Afrikaans"""</div>
510
+ <div class="graphql-code-line ">af</div>
511
+ <div class="graphql-code-line comment">"""Akan"""</div>
512
+ <div class="graphql-code-line ">ak</div>
513
+ <div class="graphql-code-line comment">"""Albanian"""</div>
514
+ <div class="graphql-code-line ">sq</div>
515
+ <div class="graphql-code-line comment">"""Amharic"""</div>
516
+ <div class="graphql-code-line ">am</div>
517
+ <div class="graphql-code-line comment">"""Arabic"""</div>
518
+ <div class="graphql-code-line ">ar</div>
519
+ <div class="graphql-code-line comment">"""Armenian"""</div>
520
+ <div class="graphql-code-line ">hy</div>
521
+ <div class="graphql-code-line comment">"""Assamese"""</div>
522
+ <div class="graphql-code-line ">as</div>
523
+ <div class="graphql-code-line comment">"""Azerbaijani"""</div>
524
+ <div class="graphql-code-line ">az</div>
525
+ <div class="graphql-code-line comment">"""Bambara"""</div>
526
+ <div class="graphql-code-line ">bm</div>
527
+ <div class="graphql-code-line comment">"""Bangla"""</div>
528
+ <div class="graphql-code-line ">bn</div>
529
+ <div class="graphql-code-line comment">"""Basque"""</div>
530
+ <div class="graphql-code-line ">eu</div>
531
+ <div class="graphql-code-line comment">"""Belarusian"""</div>
532
+ <div class="graphql-code-line ">be</div>
533
+ <div class="graphql-code-line comment">"""Bosnian"""</div>
534
+ <div class="graphql-code-line ">bs</div>
535
+ <div class="graphql-code-line comment">"""Breton"""</div>
536
+ <div class="graphql-code-line ">br</div>
537
+ <div class="graphql-code-line comment">"""Bulgarian"""</div>
538
+ <div class="graphql-code-line ">bg</div>
539
+ <div class="graphql-code-line comment">"""Burmese"""</div>
540
+ <div class="graphql-code-line ">my</div>
541
+ <div class="graphql-code-line comment">"""Catalan"""</div>
542
+ <div class="graphql-code-line ">ca</div>
543
+ <div class="graphql-code-line comment">"""Chechen"""</div>
544
+ <div class="graphql-code-line ">ce</div>
545
+ <div class="graphql-code-line comment">"""Chinese"""</div>
546
+ <div class="graphql-code-line ">zh</div>
547
+ <div class="graphql-code-line comment">"""Simplified Chinese"""</div>
548
+ <div class="graphql-code-line ">zh_Hans</div>
549
+ <div class="graphql-code-line comment">"""Traditional Chinese"""</div>
550
+ <div class="graphql-code-line ">zh_Hant</div>
551
+ <div class="graphql-code-line comment">"""Church Slavic"""</div>
552
+ <div class="graphql-code-line ">cu</div>
553
+ <div class="graphql-code-line comment">"""Cornish"""</div>
554
+ <div class="graphql-code-line ">kw</div>
555
+ <div class="graphql-code-line comment">"""Corsican"""</div>
556
+ <div class="graphql-code-line ">co</div>
557
+ <div class="graphql-code-line comment">"""Croatian"""</div>
558
+ <div class="graphql-code-line ">hr</div>
559
+ <div class="graphql-code-line comment">"""Czech"""</div>
560
+ <div class="graphql-code-line ">cs</div>
561
+ <div class="graphql-code-line comment">"""Danish"""</div>
562
+ <div class="graphql-code-line ">da</div>
563
+ <div class="graphql-code-line comment">"""Dutch"""</div>
564
+ <div class="graphql-code-line ">nl</div>
565
+ <div class="graphql-code-line comment">"""Flemish"""</div>
566
+ <div class="graphql-code-line ">nl_BE</div>
567
+ <div class="graphql-code-line comment">"""Dzongkha"""</div>
568
+ <div class="graphql-code-line ">dz</div>
569
+ <div class="graphql-code-line comment">"""English"""</div>
570
+ <div class="graphql-code-line ">en</div>
571
+ <div class="graphql-code-line comment">"""Australian English"""</div>
572
+ <div class="graphql-code-line ">en_AU</div>
573
+ <div class="graphql-code-line comment">"""Canadian English"""</div>
574
+ <div class="graphql-code-line ">en_CA</div>
575
+ <div class="graphql-code-line comment">"""British English"""</div>
576
+ <div class="graphql-code-line ">en_GB</div>
577
+ <div class="graphql-code-line comment">"""American English"""</div>
578
+ <div class="graphql-code-line ">en_US</div>
579
+ <div class="graphql-code-line comment">"""Esperanto"""</div>
580
+ <div class="graphql-code-line ">eo</div>
581
+ <div class="graphql-code-line comment">"""Estonian"""</div>
582
+ <div class="graphql-code-line ">et</div>
583
+ <div class="graphql-code-line comment">"""Ewe"""</div>
584
+ <div class="graphql-code-line ">ee</div>
585
+ <div class="graphql-code-line comment">"""Faroese"""</div>
586
+ <div class="graphql-code-line ">fo</div>
587
+ <div class="graphql-code-line comment">"""Finnish"""</div>
588
+ <div class="graphql-code-line ">fi</div>
589
+ <div class="graphql-code-line comment">"""French"""</div>
590
+ <div class="graphql-code-line ">fr</div>
591
+ <div class="graphql-code-line comment">"""Canadian French"""</div>
592
+ <div class="graphql-code-line ">fr_CA</div>
593
+ <div class="graphql-code-line comment">"""Swiss French"""</div>
594
+ <div class="graphql-code-line ">fr_CH</div>
595
+ <div class="graphql-code-line comment">"""Fulah"""</div>
596
+ <div class="graphql-code-line ">ff</div>
597
+ <div class="graphql-code-line comment">"""Galician"""</div>
598
+ <div class="graphql-code-line ">gl</div>
599
+ <div class="graphql-code-line comment">"""Ganda"""</div>
600
+ <div class="graphql-code-line ">lg</div>
601
+ <div class="graphql-code-line comment">"""Georgian"""</div>
602
+ <div class="graphql-code-line ">ka</div>
603
+ <div class="graphql-code-line comment">"""German"""</div>
604
+ <div class="graphql-code-line ">de</div>
605
+ <div class="graphql-code-line comment">"""Austrian German"""</div>
606
+ <div class="graphql-code-line ">de_AT</div>
607
+ <div class="graphql-code-line comment">"""Swiss High German"""</div>
608
+ <div class="graphql-code-line ">de_CH</div>
609
+ <div class="graphql-code-line comment">"""Greek"""</div>
610
+ <div class="graphql-code-line ">el</div>
611
+ <div class="graphql-code-line comment">"""Gujarati"""</div>
612
+ <div class="graphql-code-line ">gu</div>
613
+ <div class="graphql-code-line comment">"""Haitian Creole"""</div>
614
+ <div class="graphql-code-line ">ht</div>
615
+ <div class="graphql-code-line comment">"""Hausa"""</div>
616
+ <div class="graphql-code-line ">ha</div>
617
+ <div class="graphql-code-line comment">"""Hebrew"""</div>
618
+ <div class="graphql-code-line ">he</div>
619
+ <div class="graphql-code-line comment">"""Hindi"""</div>
620
+ <div class="graphql-code-line ">hi</div>
621
+ <div class="graphql-code-line comment">"""Hungarian"""</div>
622
+ <div class="graphql-code-line ">hu</div>
623
+ <div class="graphql-code-line comment">"""Icelandic"""</div>
624
+ <div class="graphql-code-line ">is</div>
625
+ <div class="graphql-code-line comment">"""Igbo"""</div>
626
+ <div class="graphql-code-line ">ig</div>
627
+ <div class="graphql-code-line comment">"""Indonesian"""</div>
628
+ <div class="graphql-code-line ">id</div>
629
+ <div class="graphql-code-line comment">"""Interlingua"""</div>
630
+ <div class="graphql-code-line ">ia</div>
631
+ <div class="graphql-code-line comment">"""Irish"""</div>
632
+ <div class="graphql-code-line ">ga</div>
633
+ <div class="graphql-code-line comment">"""Italian"""</div>
634
+ <div class="graphql-code-line ">it</div>
635
+ <div class="graphql-code-line comment">"""Japanese"""</div>
636
+ <div class="graphql-code-line ">ja</div>
637
+ <div class="graphql-code-line comment">"""Javanese"""</div>
638
+ <div class="graphql-code-line ">jv</div>
639
+ <div class="graphql-code-line comment">"""Kalaallisut"""</div>
640
+ <div class="graphql-code-line ">kl</div>
641
+ <div class="graphql-code-line comment">"""Kannada"""</div>
642
+ <div class="graphql-code-line ">kn</div>
643
+ <div class="graphql-code-line comment">"""Kashmiri"""</div>
644
+ <div class="graphql-code-line ">ks</div>
645
+ <div class="graphql-code-line comment">"""Kazakh"""</div>
646
+ <div class="graphql-code-line ">kk</div>
647
+ <div class="graphql-code-line comment">"""Khmer"""</div>
648
+ <div class="graphql-code-line ">km</div>
649
+ <div class="graphql-code-line comment">"""Kikuyu"""</div>
650
+ <div class="graphql-code-line ">ki</div>
651
+ <div class="graphql-code-line comment">"""Kinyarwanda"""</div>
652
+ <div class="graphql-code-line ">rw</div>
653
+ <div class="graphql-code-line comment">"""Korean"""</div>
654
+ <div class="graphql-code-line ">ko</div>
655
+ <div class="graphql-code-line comment">"""Kurdish"""</div>
656
+ <div class="graphql-code-line ">ku</div>
657
+ <div class="graphql-code-line comment">"""Kyrgyz"""</div>
658
+ <div class="graphql-code-line ">ky</div>
659
+ <div class="graphql-code-line comment">"""Lao"""</div>
660
+ <div class="graphql-code-line ">lo</div>
661
+ <div class="graphql-code-line comment">"""Latin"""</div>
662
+ <div class="graphql-code-line ">la</div>
663
+ <div class="graphql-code-line comment">"""Latvian"""</div>
664
+ <div class="graphql-code-line ">lv</div>
665
+ <div class="graphql-code-line comment">"""Lingala"""</div>
666
+ <div class="graphql-code-line ">ln</div>
667
+ <div class="graphql-code-line comment">"""Lithuanian"""</div>
668
+ <div class="graphql-code-line ">lt</div>
669
+ <div class="graphql-code-line comment">"""Luba-Katanga"""</div>
670
+ <div class="graphql-code-line ">lu</div>
671
+ <div class="graphql-code-line comment">"""Luxembourgish"""</div>
672
+ <div class="graphql-code-line ">lb</div>
673
+ <div class="graphql-code-line comment">"""Macedonian"""</div>
674
+ <div class="graphql-code-line ">mk</div>
675
+ <div class="graphql-code-line comment">"""Malagasy"""</div>
676
+ <div class="graphql-code-line ">mg</div>
677
+ <div class="graphql-code-line comment">"""Malay"""</div>
678
+ <div class="graphql-code-line ">ms</div>
679
+ <div class="graphql-code-line comment">"""Malayalam"""</div>
680
+ <div class="graphql-code-line ">ml</div>
681
+ <div class="graphql-code-line comment">"""Maltese"""</div>
682
+ <div class="graphql-code-line ">mt</div>
683
+ <div class="graphql-code-line comment">"""Manx"""</div>
684
+ <div class="graphql-code-line ">gv</div>
685
+ <div class="graphql-code-line comment">"""Maori"""</div>
686
+ <div class="graphql-code-line ">mi</div>
687
+ <div class="graphql-code-line comment">"""Marathi"""</div>
688
+ <div class="graphql-code-line ">mr</div>
689
+ <div class="graphql-code-line comment">"""Mongolian"""</div>
690
+ <div class="graphql-code-line ">mn</div>
691
+ <div class="graphql-code-line comment">"""Nepali"""</div>
692
+ <div class="graphql-code-line ">ne</div>
693
+ <div class="graphql-code-line comment">"""North Ndebele"""</div>
694
+ <div class="graphql-code-line ">nd</div>
695
+ <div class="graphql-code-line comment">"""Northern Sami"""</div>
696
+ <div class="graphql-code-line ">se</div>
697
+ <div class="graphql-code-line comment">"""Norwegian Bokmål"""</div>
698
+ <div class="graphql-code-line ">nb</div>
699
+ <div class="graphql-code-line comment">"""Norwegian Nynorsk"""</div>
700
+ <div class="graphql-code-line ">nn</div>
701
+ <div class="graphql-code-line comment">"""Nyanja"""</div>
702
+ <div class="graphql-code-line ">ny</div>
703
+ <div class="graphql-code-line comment">"""Odia"""</div>
704
+ <div class="graphql-code-line ">or</div>
705
+ <div class="graphql-code-line comment">"""Oromo"""</div>
706
+ <div class="graphql-code-line ">om</div>
707
+ <div class="graphql-code-line comment">"""Ossetic"""</div>
708
+ <div class="graphql-code-line ">os</div>
709
+ <div class="graphql-code-line comment">"""Pashto"""</div>
710
+ <div class="graphql-code-line ">ps</div>
711
+ <div class="graphql-code-line comment">"""Persian"""</div>
712
+ <div class="graphql-code-line ">fa</div>
713
+ <div class="graphql-code-line comment">"""Dari"""</div>
714
+ <div class="graphql-code-line ">fa_AF</div>
715
+ <div class="graphql-code-line comment">"""Polish"""</div>
716
+ <div class="graphql-code-line ">pl</div>
717
+ <div class="graphql-code-line comment">"""Portuguese"""</div>
718
+ <div class="graphql-code-line ">pt</div>
719
+ <div class="graphql-code-line comment">"""Brazilian Portuguese"""</div>
720
+ <div class="graphql-code-line ">pt_BR</div>
721
+ <div class="graphql-code-line comment">"""European Portuguese"""</div>
722
+ <div class="graphql-code-line ">pt_PT</div>
723
+ <div class="graphql-code-line comment">"""Punjabi"""</div>
724
+ <div class="graphql-code-line ">pa</div>
725
+ <div class="graphql-code-line comment">"""Quechua"""</div>
726
+ <div class="graphql-code-line ">qu</div>
727
+ <div class="graphql-code-line comment">"""Romanian"""</div>
728
+ <div class="graphql-code-line ">ro</div>
729
+ <div class="graphql-code-line comment">"""Moldavian"""</div>
730
+ <div class="graphql-code-line ">ro_MD</div>
731
+ <div class="graphql-code-line comment">"""Romansh"""</div>
732
+ <div class="graphql-code-line ">rm</div>
733
+ <div class="graphql-code-line comment">"""Rundi"""</div>
734
+ <div class="graphql-code-line ">rn</div>
735
+ <div class="graphql-code-line comment">"""Russian"""</div>
736
+ <div class="graphql-code-line ">ru</div>
737
+ <div class="graphql-code-line comment">"""Samoan"""</div>
738
+ <div class="graphql-code-line ">sm</div>
739
+ <div class="graphql-code-line comment">"""Sango"""</div>
740
+ <div class="graphql-code-line ">sg</div>
741
+ <div class="graphql-code-line comment">"""Sanskrit"""</div>
742
+ <div class="graphql-code-line ">sa</div>
743
+ <div class="graphql-code-line comment">"""Scottish Gaelic"""</div>
744
+ <div class="graphql-code-line ">gd</div>
745
+ <div class="graphql-code-line comment">"""Serbian"""</div>
746
+ <div class="graphql-code-line ">sr</div>
747
+ <div class="graphql-code-line comment">"""Shona"""</div>
748
+ <div class="graphql-code-line ">sn</div>
749
+ <div class="graphql-code-line comment">"""Sichuan Yi"""</div>
750
+ <div class="graphql-code-line ">ii</div>
751
+ <div class="graphql-code-line comment">"""Sindhi"""</div>
752
+ <div class="graphql-code-line ">sd</div>
753
+ <div class="graphql-code-line comment">"""Sinhala"""</div>
754
+ <div class="graphql-code-line ">si</div>
755
+ <div class="graphql-code-line comment">"""Slovak"""</div>
756
+ <div class="graphql-code-line ">sk</div>
757
+ <div class="graphql-code-line comment">"""Slovenian"""</div>
758
+ <div class="graphql-code-line ">sl</div>
759
+ <div class="graphql-code-line comment">"""Somali"""</div>
760
+ <div class="graphql-code-line ">so</div>
761
+ <div class="graphql-code-line comment">"""Southern Sotho"""</div>
762
+ <div class="graphql-code-line ">st</div>
763
+ <div class="graphql-code-line comment">"""Spanish"""</div>
764
+ <div class="graphql-code-line ">es</div>
765
+ <div class="graphql-code-line comment">"""European Spanish"""</div>
766
+ <div class="graphql-code-line ">es_ES</div>
767
+ <div class="graphql-code-line comment">"""Mexican Spanish"""</div>
768
+ <div class="graphql-code-line ">es_MX</div>
769
+ <div class="graphql-code-line comment">"""Sundanese"""</div>
770
+ <div class="graphql-code-line ">su</div>
771
+ <div class="graphql-code-line comment">"""Swahili"""</div>
772
+ <div class="graphql-code-line ">sw</div>
773
+ <div class="graphql-code-line comment">"""Congo Swahili"""</div>
774
+ <div class="graphql-code-line ">sw_CD</div>
775
+ <div class="graphql-code-line comment">"""Swedish"""</div>
776
+ <div class="graphql-code-line ">sv</div>
777
+ <div class="graphql-code-line comment">"""Tajik"""</div>
778
+ <div class="graphql-code-line ">tg</div>
779
+ <div class="graphql-code-line comment">"""Tamil"""</div>
780
+ <div class="graphql-code-line ">ta</div>
781
+ <div class="graphql-code-line comment">"""Tatar"""</div>
782
+ <div class="graphql-code-line ">tt</div>
783
+ <div class="graphql-code-line comment">"""Telugu"""</div>
784
+ <div class="graphql-code-line ">te</div>
785
+ <div class="graphql-code-line comment">"""Thai"""</div>
786
+ <div class="graphql-code-line ">th</div>
787
+ <div class="graphql-code-line comment">"""Tibetan"""</div>
788
+ <div class="graphql-code-line ">bo</div>
789
+ <div class="graphql-code-line comment">"""Tigrinya"""</div>
790
+ <div class="graphql-code-line ">ti</div>
791
+ <div class="graphql-code-line comment">"""Tongan"""</div>
792
+ <div class="graphql-code-line ">to</div>
793
+ <div class="graphql-code-line comment">"""Turkish"""</div>
794
+ <div class="graphql-code-line ">tr</div>
795
+ <div class="graphql-code-line comment">"""Turkmen"""</div>
796
+ <div class="graphql-code-line ">tk</div>
797
+ <div class="graphql-code-line comment">"""Ukrainian"""</div>
798
+ <div class="graphql-code-line ">uk</div>
799
+ <div class="graphql-code-line comment">"""Urdu"""</div>
800
+ <div class="graphql-code-line ">ur</div>
801
+ <div class="graphql-code-line comment">"""Uyghur"""</div>
802
+ <div class="graphql-code-line ">ug</div>
803
+ <div class="graphql-code-line comment">"""Uzbek"""</div>
804
+ <div class="graphql-code-line ">uz</div>
805
+ <div class="graphql-code-line comment">"""Vietnamese"""</div>
806
+ <div class="graphql-code-line ">vi</div>
807
+ <div class="graphql-code-line comment">"""Volapük"""</div>
808
+ <div class="graphql-code-line ">vo</div>
809
+ <div class="graphql-code-line comment">"""Welsh"""</div>
810
+ <div class="graphql-code-line ">cy</div>
811
+ <div class="graphql-code-line comment">"""Western Frisian"""</div>
812
+ <div class="graphql-code-line ">fy</div>
813
+ <div class="graphql-code-line comment">"""Wolof"""</div>
814
+ <div class="graphql-code-line ">wo</div>
815
+ <div class="graphql-code-line comment">"""Xhosa"""</div>
816
+ <div class="graphql-code-line ">xh</div>
817
+ <div class="graphql-code-line comment">"""Yiddish"""</div>
818
+ <div class="graphql-code-line ">yi</div>
819
+ <div class="graphql-code-line comment">"""Yoruba"""</div>
820
+ <div class="graphql-code-line ">yo</div>
821
+ <div class="graphql-code-line comment">"""Zulu"""</div>
822
+ <div class="graphql-code-line ">zu</div>
823
+ <div class="graphql-code-line top-level">&#125;</div>
824
+ </div>
825
+
826
+ ## LogicalOperator
827
+
828
+ <div class="graphql-code-block">
829
+
830
+ <div class="graphql-code-line top-level">enum <span class="graphql-code-identifier">LogicalOperator</span> &#123;</div>
831
+ <div class="graphql-code-line ">AND</div>
832
+ <div class="graphql-code-line ">OR</div>
833
+ <div class="graphql-code-line top-level">&#125;</div>
834
+ </div>
835
+
836
+ ## MetricInterval
837
+
838
+ <div class="graphql-code-block">
839
+
840
+ <div class="graphql-code-line top-level">enum <span class="graphql-code-identifier">MetricInterval</span> &#123;</div>
841
+ <div class="graphql-code-line ">Daily</div>
842
+ <div class="graphql-code-line top-level">&#125;</div>
843
+ </div>
844
+
845
+ ## MetricType
846
+
847
+ <div class="graphql-code-block">
848
+
849
+ <div class="graphql-code-line top-level">enum <span class="graphql-code-identifier">MetricType</span> &#123;</div>
850
+ <div class="graphql-code-line ">OrderCount</div>
851
+ <div class="graphql-code-line ">OrderTotal</div>
852
+ <div class="graphql-code-line ">AverageOrderValue</div>
853
+ <div class="graphql-code-line top-level">&#125;</div>
854
+ </div>
855
+
856
+ ## OrderType
857
+
858
+ <div class="graphql-code-block">
859
+
860
+ <div class="graphql-code-line top-level">enum <span class="graphql-code-identifier">OrderType</span> &#123;</div>
861
+ <div class="graphql-code-line ">Regular</div>
862
+ <div class="graphql-code-line ">Seller</div>
863
+ <div class="graphql-code-line ">Aggregate</div>
864
+ <div class="graphql-code-line top-level">&#125;</div>
865
+ </div>
866
+
867
+ ## Permission
868
+
869
+ <div class="graphql-code-block">
870
+ <div class="graphql-code-line comment">"""</div>
871
+ <div class="graphql-code-line comment">Permissions for administrators and customers. Used to control access to</div>
872
+
873
+ <div class="graphql-code-line comment">GraphQL resolvers via the &#123;@link Allow&#125; decorator.</div>
874
+
875
+ <div class="graphql-code-line comment"></div>
876
+
877
+ <div class="graphql-code-line comment">## Understanding Permission.Owner</div>
878
+
879
+ <div class="graphql-code-line comment"></div>
880
+
881
+ <div class="graphql-code-line comment">`Permission.Owner` is a special permission which is used in some Vendure resolvers to indicate that that resolver should only</div>
882
+
883
+ <div class="graphql-code-line comment">be accessible to the "owner" of that resource.</div>
884
+
885
+ <div class="graphql-code-line comment"></div>
886
+
887
+ <div class="graphql-code-line comment">For example, the Shop API <code>activeCustomer</code> query resolver should only return the Customer object for the "owner" of that Customer, i.e.</div>
888
+
889
+ <div class="graphql-code-line comment">based on the activeUserId of the current session. As a result, the resolver code looks like this:</div>
890
+
891
+ <div class="graphql-code-line comment"></div>
892
+
893
+ <div class="graphql-code-line comment">@example</div>
894
+
895
+ <div class="graphql-code-line comment">```TypeScript</div>
896
+
897
+ <div class="graphql-code-line comment">\@Query()</div>
898
+
899
+ <div class="graphql-code-line comment">\@Allow(Permission.Owner)</div>
900
+
901
+ <div class="graphql-code-line comment">async activeCustomer(\@Ctx() ctx: RequestContext): Promise&lt;Customer | undefined&gt; &#123;</div>
902
+
903
+ <div class="graphql-code-line comment"> const userId = ctx.activeUserId;</div>
904
+
905
+ <div class="graphql-code-line comment"> if (userId) &#123;</div>
906
+
907
+ <div class="graphql-code-line comment"> return this.customerService.findOneByUserId(ctx, userId);</div>
908
+
909
+ <div class="graphql-code-line comment"> &#125;</div>
910
+
911
+ <div class="graphql-code-line comment">&#125;</div>
912
+
913
+ <div class="graphql-code-line comment">```</div>
914
+
915
+ <div class="graphql-code-line comment"></div>
916
+
917
+ <div class="graphql-code-line comment">Here we can see that the "ownership" must be enforced by custom logic inside the resolver. Since "ownership" cannot be defined generally</div>
918
+
919
+ <div class="graphql-code-line comment">nor statically encoded at build-time, any resolvers using <code>Permission.Owner</code> **must** include logic to enforce that only the owner</div>
920
+
921
+ <div class="graphql-code-line comment">of the resource has access. If not, then it is the equivalent of using `Permission.Public`.</div>
922
+
923
+ <div class="graphql-code-line comment"></div>
924
+
925
+ <div class="graphql-code-line comment"></div>
926
+
927
+ <div class="graphql-code-line comment"></div>
928
+ <div class="graphql-code-line comment">"""</div>
929
+
930
+ <div class="graphql-code-line top-level">enum <span class="graphql-code-identifier">Permission</span> &#123;</div>
931
+ <div class="graphql-code-line comment">"""Authenticated means simply that the user is logged in"""</div>
932
+ <div class="graphql-code-line ">Authenticated</div>
933
+ <div class="graphql-code-line comment">"""SuperAdmin has unrestricted access to all operations"""</div>
934
+ <div class="graphql-code-line ">SuperAdmin</div>
935
+ <div class="graphql-code-line comment">"""Owner means the user owns this entity, e.g. a Customer's own Order"""</div>
936
+ <div class="graphql-code-line ">Owner</div>
937
+ <div class="graphql-code-line comment">"""Public means any unauthenticated user may perform the operation"""</div>
938
+ <div class="graphql-code-line ">Public</div>
939
+ <div class="graphql-code-line comment">"""Grants permission to update GlobalSettings"""</div>
940
+ <div class="graphql-code-line ">UpdateGlobalSettings</div>
941
+ <div class="graphql-code-line comment">"""Grants permission to create Products, Facets, Assets, Collections"""</div>
942
+ <div class="graphql-code-line ">CreateCatalog</div>
943
+ <div class="graphql-code-line comment">"""Grants permission to read Products, Facets, Assets, Collections"""</div>
944
+ <div class="graphql-code-line ">ReadCatalog</div>
945
+ <div class="graphql-code-line comment">"""Grants permission to update Products, Facets, Assets, Collections"""</div>
946
+ <div class="graphql-code-line ">UpdateCatalog</div>
947
+ <div class="graphql-code-line comment">"""Grants permission to delete Products, Facets, Assets, Collections"""</div>
948
+ <div class="graphql-code-line ">DeleteCatalog</div>
949
+ <div class="graphql-code-line comment">"""Grants permission to create PaymentMethods, ShippingMethods, TaxCategories, TaxRates, Zones, Countries, System & GlobalSettings"""</div>
950
+ <div class="graphql-code-line ">CreateSettings</div>
951
+ <div class="graphql-code-line comment">"""Grants permission to read PaymentMethods, ShippingMethods, TaxCategories, TaxRates, Zones, Countries, System & GlobalSettings"""</div>
952
+ <div class="graphql-code-line ">ReadSettings</div>
953
+ <div class="graphql-code-line comment">"""Grants permission to update PaymentMethods, ShippingMethods, TaxCategories, TaxRates, Zones, Countries, System & GlobalSettings"""</div>
954
+ <div class="graphql-code-line ">UpdateSettings</div>
955
+ <div class="graphql-code-line comment">"""Grants permission to delete PaymentMethods, ShippingMethods, TaxCategories, TaxRates, Zones, Countries, System & GlobalSettings"""</div>
956
+ <div class="graphql-code-line ">DeleteSettings</div>
957
+ <div class="graphql-code-line comment">"""Grants permission to create Administrator"""</div>
958
+ <div class="graphql-code-line ">CreateAdministrator</div>
959
+ <div class="graphql-code-line comment">"""Grants permission to read Administrator"""</div>
960
+ <div class="graphql-code-line ">ReadAdministrator</div>
961
+ <div class="graphql-code-line comment">"""Grants permission to update Administrator"""</div>
962
+ <div class="graphql-code-line ">UpdateAdministrator</div>
963
+ <div class="graphql-code-line comment">"""Grants permission to delete Administrator"""</div>
964
+ <div class="graphql-code-line ">DeleteAdministrator</div>
965
+ <div class="graphql-code-line comment">"""Grants permission to create Asset"""</div>
966
+ <div class="graphql-code-line ">CreateAsset</div>
967
+ <div class="graphql-code-line comment">"""Grants permission to read Asset"""</div>
968
+ <div class="graphql-code-line ">ReadAsset</div>
969
+ <div class="graphql-code-line comment">"""Grants permission to update Asset"""</div>
970
+ <div class="graphql-code-line ">UpdateAsset</div>
971
+ <div class="graphql-code-line comment">"""Grants permission to delete Asset"""</div>
972
+ <div class="graphql-code-line ">DeleteAsset</div>
973
+ <div class="graphql-code-line comment">"""Grants permission to create Channel"""</div>
974
+ <div class="graphql-code-line ">CreateChannel</div>
975
+ <div class="graphql-code-line comment">"""Grants permission to read Channel"""</div>
976
+ <div class="graphql-code-line ">ReadChannel</div>
977
+ <div class="graphql-code-line comment">"""Grants permission to update Channel"""</div>
978
+ <div class="graphql-code-line ">UpdateChannel</div>
979
+ <div class="graphql-code-line comment">"""Grants permission to delete Channel"""</div>
980
+ <div class="graphql-code-line ">DeleteChannel</div>
981
+ <div class="graphql-code-line comment">"""Grants permission to create Collection"""</div>
982
+ <div class="graphql-code-line ">CreateCollection</div>
983
+ <div class="graphql-code-line comment">"""Grants permission to read Collection"""</div>
984
+ <div class="graphql-code-line ">ReadCollection</div>
985
+ <div class="graphql-code-line comment">"""Grants permission to update Collection"""</div>
986
+ <div class="graphql-code-line ">UpdateCollection</div>
987
+ <div class="graphql-code-line comment">"""Grants permission to delete Collection"""</div>
988
+ <div class="graphql-code-line ">DeleteCollection</div>
989
+ <div class="graphql-code-line comment">"""Grants permission to create Country"""</div>
990
+ <div class="graphql-code-line ">CreateCountry</div>
991
+ <div class="graphql-code-line comment">"""Grants permission to read Country"""</div>
992
+ <div class="graphql-code-line ">ReadCountry</div>
993
+ <div class="graphql-code-line comment">"""Grants permission to update Country"""</div>
994
+ <div class="graphql-code-line ">UpdateCountry</div>
995
+ <div class="graphql-code-line comment">"""Grants permission to delete Country"""</div>
996
+ <div class="graphql-code-line ">DeleteCountry</div>
997
+ <div class="graphql-code-line comment">"""Grants permission to create Customer"""</div>
998
+ <div class="graphql-code-line ">CreateCustomer</div>
999
+ <div class="graphql-code-line comment">"""Grants permission to read Customer"""</div>
1000
+ <div class="graphql-code-line ">ReadCustomer</div>
1001
+ <div class="graphql-code-line comment">"""Grants permission to update Customer"""</div>
1002
+ <div class="graphql-code-line ">UpdateCustomer</div>
1003
+ <div class="graphql-code-line comment">"""Grants permission to delete Customer"""</div>
1004
+ <div class="graphql-code-line ">DeleteCustomer</div>
1005
+ <div class="graphql-code-line comment">"""Grants permission to create CustomerGroup"""</div>
1006
+ <div class="graphql-code-line ">CreateCustomerGroup</div>
1007
+ <div class="graphql-code-line comment">"""Grants permission to read CustomerGroup"""</div>
1008
+ <div class="graphql-code-line ">ReadCustomerGroup</div>
1009
+ <div class="graphql-code-line comment">"""Grants permission to update CustomerGroup"""</div>
1010
+ <div class="graphql-code-line ">UpdateCustomerGroup</div>
1011
+ <div class="graphql-code-line comment">"""Grants permission to delete CustomerGroup"""</div>
1012
+ <div class="graphql-code-line ">DeleteCustomerGroup</div>
1013
+ <div class="graphql-code-line comment">"""Grants permission to create Facet"""</div>
1014
+ <div class="graphql-code-line ">CreateFacet</div>
1015
+ <div class="graphql-code-line comment">"""Grants permission to read Facet"""</div>
1016
+ <div class="graphql-code-line ">ReadFacet</div>
1017
+ <div class="graphql-code-line comment">"""Grants permission to update Facet"""</div>
1018
+ <div class="graphql-code-line ">UpdateFacet</div>
1019
+ <div class="graphql-code-line comment">"""Grants permission to delete Facet"""</div>
1020
+ <div class="graphql-code-line ">DeleteFacet</div>
1021
+ <div class="graphql-code-line comment">"""Grants permission to create Order"""</div>
1022
+ <div class="graphql-code-line ">CreateOrder</div>
1023
+ <div class="graphql-code-line comment">"""Grants permission to read Order"""</div>
1024
+ <div class="graphql-code-line ">ReadOrder</div>
1025
+ <div class="graphql-code-line comment">"""Grants permission to update Order"""</div>
1026
+ <div class="graphql-code-line ">UpdateOrder</div>
1027
+ <div class="graphql-code-line comment">"""Grants permission to delete Order"""</div>
1028
+ <div class="graphql-code-line ">DeleteOrder</div>
1029
+ <div class="graphql-code-line comment">"""Grants permission to create PaymentMethod"""</div>
1030
+ <div class="graphql-code-line ">CreatePaymentMethod</div>
1031
+ <div class="graphql-code-line comment">"""Grants permission to read PaymentMethod"""</div>
1032
+ <div class="graphql-code-line ">ReadPaymentMethod</div>
1033
+ <div class="graphql-code-line comment">"""Grants permission to update PaymentMethod"""</div>
1034
+ <div class="graphql-code-line ">UpdatePaymentMethod</div>
1035
+ <div class="graphql-code-line comment">"""Grants permission to delete PaymentMethod"""</div>
1036
+ <div class="graphql-code-line ">DeletePaymentMethod</div>
1037
+ <div class="graphql-code-line comment">"""Grants permission to create Product"""</div>
1038
+ <div class="graphql-code-line ">CreateProduct</div>
1039
+ <div class="graphql-code-line comment">"""Grants permission to read Product"""</div>
1040
+ <div class="graphql-code-line ">ReadProduct</div>
1041
+ <div class="graphql-code-line comment">"""Grants permission to update Product"""</div>
1042
+ <div class="graphql-code-line ">UpdateProduct</div>
1043
+ <div class="graphql-code-line comment">"""Grants permission to delete Product"""</div>
1044
+ <div class="graphql-code-line ">DeleteProduct</div>
1045
+ <div class="graphql-code-line comment">"""Grants permission to create Promotion"""</div>
1046
+ <div class="graphql-code-line ">CreatePromotion</div>
1047
+ <div class="graphql-code-line comment">"""Grants permission to read Promotion"""</div>
1048
+ <div class="graphql-code-line ">ReadPromotion</div>
1049
+ <div class="graphql-code-line comment">"""Grants permission to update Promotion"""</div>
1050
+ <div class="graphql-code-line ">UpdatePromotion</div>
1051
+ <div class="graphql-code-line comment">"""Grants permission to delete Promotion"""</div>
1052
+ <div class="graphql-code-line ">DeletePromotion</div>
1053
+ <div class="graphql-code-line comment">"""Grants permission to create ShippingMethod"""</div>
1054
+ <div class="graphql-code-line ">CreateShippingMethod</div>
1055
+ <div class="graphql-code-line comment">"""Grants permission to read ShippingMethod"""</div>
1056
+ <div class="graphql-code-line ">ReadShippingMethod</div>
1057
+ <div class="graphql-code-line comment">"""Grants permission to update ShippingMethod"""</div>
1058
+ <div class="graphql-code-line ">UpdateShippingMethod</div>
1059
+ <div class="graphql-code-line comment">"""Grants permission to delete ShippingMethod"""</div>
1060
+ <div class="graphql-code-line ">DeleteShippingMethod</div>
1061
+ <div class="graphql-code-line comment">"""Grants permission to create Tag"""</div>
1062
+ <div class="graphql-code-line ">CreateTag</div>
1063
+ <div class="graphql-code-line comment">"""Grants permission to read Tag"""</div>
1064
+ <div class="graphql-code-line ">ReadTag</div>
1065
+ <div class="graphql-code-line comment">"""Grants permission to update Tag"""</div>
1066
+ <div class="graphql-code-line ">UpdateTag</div>
1067
+ <div class="graphql-code-line comment">"""Grants permission to delete Tag"""</div>
1068
+ <div class="graphql-code-line ">DeleteTag</div>
1069
+ <div class="graphql-code-line comment">"""Grants permission to create TaxCategory"""</div>
1070
+ <div class="graphql-code-line ">CreateTaxCategory</div>
1071
+ <div class="graphql-code-line comment">"""Grants permission to read TaxCategory"""</div>
1072
+ <div class="graphql-code-line ">ReadTaxCategory</div>
1073
+ <div class="graphql-code-line comment">"""Grants permission to update TaxCategory"""</div>
1074
+ <div class="graphql-code-line ">UpdateTaxCategory</div>
1075
+ <div class="graphql-code-line comment">"""Grants permission to delete TaxCategory"""</div>
1076
+ <div class="graphql-code-line ">DeleteTaxCategory</div>
1077
+ <div class="graphql-code-line comment">"""Grants permission to create TaxRate"""</div>
1078
+ <div class="graphql-code-line ">CreateTaxRate</div>
1079
+ <div class="graphql-code-line comment">"""Grants permission to read TaxRate"""</div>
1080
+ <div class="graphql-code-line ">ReadTaxRate</div>
1081
+ <div class="graphql-code-line comment">"""Grants permission to update TaxRate"""</div>
1082
+ <div class="graphql-code-line ">UpdateTaxRate</div>
1083
+ <div class="graphql-code-line comment">"""Grants permission to delete TaxRate"""</div>
1084
+ <div class="graphql-code-line ">DeleteTaxRate</div>
1085
+ <div class="graphql-code-line comment">"""Grants permission to create Seller"""</div>
1086
+ <div class="graphql-code-line ">CreateSeller</div>
1087
+ <div class="graphql-code-line comment">"""Grants permission to read Seller"""</div>
1088
+ <div class="graphql-code-line ">ReadSeller</div>
1089
+ <div class="graphql-code-line comment">"""Grants permission to update Seller"""</div>
1090
+ <div class="graphql-code-line ">UpdateSeller</div>
1091
+ <div class="graphql-code-line comment">"""Grants permission to delete Seller"""</div>
1092
+ <div class="graphql-code-line ">DeleteSeller</div>
1093
+ <div class="graphql-code-line comment">"""Grants permission to create StockLocation"""</div>
1094
+ <div class="graphql-code-line ">CreateStockLocation</div>
1095
+ <div class="graphql-code-line comment">"""Grants permission to read StockLocation"""</div>
1096
+ <div class="graphql-code-line ">ReadStockLocation</div>
1097
+ <div class="graphql-code-line comment">"""Grants permission to update StockLocation"""</div>
1098
+ <div class="graphql-code-line ">UpdateStockLocation</div>
1099
+ <div class="graphql-code-line comment">"""Grants permission to delete StockLocation"""</div>
1100
+ <div class="graphql-code-line ">DeleteStockLocation</div>
1101
+ <div class="graphql-code-line comment">"""Grants permission to create System"""</div>
1102
+ <div class="graphql-code-line ">CreateSystem</div>
1103
+ <div class="graphql-code-line comment">"""Grants permission to read System"""</div>
1104
+ <div class="graphql-code-line ">ReadSystem</div>
1105
+ <div class="graphql-code-line comment">"""Grants permission to update System"""</div>
1106
+ <div class="graphql-code-line ">UpdateSystem</div>
1107
+ <div class="graphql-code-line comment">"""Grants permission to delete System"""</div>
1108
+ <div class="graphql-code-line ">DeleteSystem</div>
1109
+ <div class="graphql-code-line comment">"""Grants permission to create Zone"""</div>
1110
+ <div class="graphql-code-line ">CreateZone</div>
1111
+ <div class="graphql-code-line comment">"""Grants permission to read Zone"""</div>
1112
+ <div class="graphql-code-line ">ReadZone</div>
1113
+ <div class="graphql-code-line comment">"""Grants permission to update Zone"""</div>
1114
+ <div class="graphql-code-line ">UpdateZone</div>
1115
+ <div class="graphql-code-line comment">"""Grants permission to delete Zone"""</div>
1116
+ <div class="graphql-code-line ">DeleteZone</div>
1117
+ <div class="graphql-code-line top-level">&#125;</div>
1118
+ </div>
1119
+
1120
+ ## SortOrder
1121
+
1122
+ <div class="graphql-code-block">
1123
+
1124
+ <div class="graphql-code-line top-level">enum <span class="graphql-code-identifier">SortOrder</span> &#123;</div>
1125
+ <div class="graphql-code-line ">ASC</div>
1126
+ <div class="graphql-code-line ">DESC</div>
1127
+ <div class="graphql-code-line top-level">&#125;</div>
1128
+ </div>
1129
+
1130
+ ## StockMovementType
1131
+
1132
+ <div class="graphql-code-block">
1133
+
1134
+ <div class="graphql-code-line top-level">enum <span class="graphql-code-identifier">StockMovementType</span> &#123;</div>
1135
+ <div class="graphql-code-line ">ADJUSTMENT</div>
1136
+ <div class="graphql-code-line ">ALLOCATION</div>
1137
+ <div class="graphql-code-line ">RELEASE</div>
1138
+ <div class="graphql-code-line ">SALE</div>
1139
+ <div class="graphql-code-line ">CANCELLATION</div>
1140
+ <div class="graphql-code-line ">RETURN</div>
1141
+ <div class="graphql-code-line top-level">&#125;</div>
1142
+ </div>