chore(docs): Generated References (#9026)

Generated the following references:
- `modules`
- `product`
- `promotion`
- `types`
This commit is contained in:
github-actions[bot] authored and GitHub committed 2024-09-06 08:53:22 +00:00
1 parent abe7b66999
commit a5748c6e1f
47 files changed
+1720800 -1718144

No files matched your search

@@ -0,0 +1,9 @@
---
displayed_sidebar: productReference
---
import { TypeList } from "docs-ui"
# CreateProductOptionValueDTO
<TypeList types={[{"name":"value","type":"`string`","description":"The value of the product option value.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../types/product.MetadataType/page.mdx)","description":"The metadata of the product option value.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="CreateProductOptionValueDTO"/>
@@ -0,0 +1,11 @@
---
displayed_sidebar: productReference
---
import { TypeList } from "docs-ui"
# FilterableProductOptionValueProps
The filters to apply on retrieved product option values.
<TypeList types={[{"name":"$and","type":"([FilterableProductOptionValueProps](page.mdx) \\| [BaseFilterable](../product.BaseFilterable/page.mdx)&#60;[FilterableProductOptionValueProps](page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableProductOptionValueProps](page.mdx) \\| [BaseFilterable](../product.BaseFilterable/page.mdx)&#60;[FilterableProductOptionValueProps](page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableProductOptionValueProps](page.mdx) \\| [BaseFilterable](../product.BaseFilterable/page.mdx)&#60;[FilterableProductOptionValueProps](page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableProductOptionValueProps](page.mdx) \\| [BaseFilterable](../product.BaseFilterable/page.mdx)&#60;[FilterableProductOptionValueProps](page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Search through the option values' values.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter product options by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string` \\| `string`[]","description":"The values to filter product options by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../product.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../product.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableProductOptionValueProps](page.mdx) \\| [BaseFilterable](../product.BaseFilterable/page.mdx)&#60;[FilterableProductOptionValueProps](page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableProductOptionValueProps](page.mdx) \\| [BaseFilterable](../product.BaseFilterable/page.mdx)&#60;[FilterableProductOptionValueProps](page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableProductOptionValueProps](page.mdx) \\| [BaseFilterable](../product.BaseFilterable/page.mdx)&#60;[FilterableProductOptionValueProps](page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Search through the option values' values.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter product options by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string` \\| `string`[]","description":"The values to filter product options by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../product.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../product.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"q","type":"`string`","description":"Search through the option values' values.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","tyLine truncated
@@ -49,6 +49,13 @@ The main service interface for the Product Module.
- [deleteProductOptions](../../IProductModuleService/methods/product.IProductModuleService.deleteProductOptions/page.mdx)
- [softDeleteProductOptions](../../IProductModuleService/methods/product.IProductModuleService.softDeleteProductOptions/page.mdx)
- [restoreProductOptions](../../IProductModuleService/methods/product.IProductModuleService.restoreProductOptions/page.mdx)
- [listProductOptionValues](../../IProductModuleService/methods/product.IProductModuleService.listProductOptionValues/page.mdx)
- [listAndCountProductOptionValues](../../IProductModuleService/methods/product.IProductModuleService.listAndCountProductOptionValues/page.mdx)
- [createProductOptionValues](../../IProductModuleService/methods/product.IProductModuleService.createProductOptionValues/page.mdx)
- [updateProductOptionValues](../../IProductModuleService/methods/product.IProductModuleService.updateProductOptionValues/page.mdx)
- [deleteProductOptionValues](../../IProductModuleService/methods/product.IProductModuleService.deleteProductOptionValues/page.mdx)
- [softDeleteProductOptionValues](../../IProductModuleService/methods/product.IProductModuleService.softDeleteProductOptionValues/page.mdx)
- [restoreProductOptionValues](../../IProductModuleService/methods/product.IProductModuleService.restoreProductOptionValues/page.mdx)
- [retrieveProductVariant](../../IProductModuleService/methods/product.IProductModuleService.retrieveProductVariant/page.mdx)
- [listProductVariants](../../IProductModuleService/methods/product.IProductModuleService.listProductVariants/page.mdx)
- [listAndCountProductVariants](../../IProductModuleService/methods/product.IProductModuleService.listAndCountProductVariants/page.mdx)
@@ -0,0 +1,9 @@
---
displayed_sidebar: productReference
---
import { TypeList } from "docs-ui"
# UpdateProductOptionValueDTO
<TypeList types={[{"name":"value","type":"`string`","description":"The value of the product option value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../types/product.MetadataType/page.mdx)","description":"The metadata of the product option value.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="UpdateProductOptionValueDTO"/>