asyavee/medusa-store
1
0 Fork 0
Code Issues Pull Requests Actions 3 Packages Projects Releases Wiki Activity

docs: generate references manually for 2.1.1 (#10534)

Browse Source 
* docs: generate references manually for 2.1.1

* re-generate for core-flows

* Revert "re-generate for core-flows"

This reverts commit ff785c80214dc6125e2da4c6e8a674a87b03e9dd.
This commit is contained in:
Shahed Nasser authored and GitHub committed 2024-12-10 18:49:30 +02:00
1 parent 482929f74d
commit ab1bfb966d
1109 files changed
+348717 -331421
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

www/apps/resources/references/store_models/classes/store_models.Store/page.mdx
-13
View File
@@ -1,13 +0,0 @@
---
displayed_sidebar: storeModelReference
slug: /references/store/models/Store
sidebar_label: Store
---
import { TypeList } from "docs-ui"
# Store - Store Module Data Models Reference
This documentation provides a reference to the Store . This belongs to the Store Module.
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"supported_currencies","type":"Collection&#60;[StoreCurrency](../store_models.StoreCurrency/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"store_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"store","type":"`null` \\| [Store](page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"supported_currencies","type":"Collection&#60;[StoreCurrency](../store_models.StoreCurrency/page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"default_sales_channel_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"default_region_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"default_location_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"[OptionalProps]","type":"[SoftDeletableModelDateColumns](../../../types/DAL/types/types.DAL.SoftDeletableModelDateColumns/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"is_default","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"default_sales_channel_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"default_region_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"default_location_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"[OptionalProps]","type":"[SoftDeletableModelDateColumns](../../../types/DAL/types/types.DAL.SoftDeletableModelDateColumns/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="Store"/>
www/apps/resources/references/store_models/classes/store_models.StoreCurrency/page.mdx
-13
View File
@@ -1,13 +0,0 @@
---
displayed_sidebar: storeModelReference
slug: /references/store/models/StoreCurrency
sidebar_label: StoreCurrency
---
import { TypeList } from "docs-ui"
# StoreCurrency - Store Module Data Models Reference
This documentation provides a reference to the StoreCurrency . This belongs to the Store Module.
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"store_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"store","type":"`null` \\| [Store](../store_models.Store/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"supported_currencies","type":"Collection&#60;[StoreCurrency](page.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"store_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"store","type":"`null` \\| [Store](../store_models.Store/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"is_default","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"default_sales_channel_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"default_region_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"default_location_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"[OptionalProps]","type":"[SoftDeletableModelDateColumns](../../../types/DAL/types/types.DAL.SoftDeletableModelDateColumns/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"is_default","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="StoreCurrency"/>
www/apps/resources/references/store_models/variables/store_models.Store/page.mdx
+13
View File
@@ -0,0 +1,13 @@
---
displayed_sidebar: storeModelReference
slug: /references/store/models/Store
sidebar_label: Store
---
import { TypeList } from "docs-ui"
# Store - Store Module Data Models Reference
This documentation provides a reference to the Store data model. It belongs to the Store Module.
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the store.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the store","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"supported_currencies","type":"HasMany&#60;[StoreCurrency](../store_models.StoreCurrency/page.mdx)&#62;","description":"The associated supported\\_currencies.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The ISO 3 currency code. For example, `usd`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default","type":"`BooleanProperty`","description":"Whether the currency is the default in the store.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"store","type":"BelongsTo&#60;[Store](page.mdx)&#62;","description":"The store this currency belongs to.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the store.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the store","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"supported_currencies","type":"HasMany&#60;[StoreCurrency](../store_models.StoreCurrency/page.mdx)&#62;","description":"The associated supported\\_currencies.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"default_sales_channel_id","type":"`TextProperty`","description":"The ID of the store's default sales channel.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"default_region_id","type":"`TextProperty`","description":"The ID of the store's default region.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"default_location_id","type":"`TextProperty`","description":"The ID of the store's default stock location.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"default_sales_channel_id","type":"`TextProperty`","description":"The ID of the store's default sales channel.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"default_region_id","type":"`TextProperty`","description":"The ID of the store's default region.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"default_location_id","type":"`TextProperty`","description":"The ID of the store's default stock location.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="Store"/>
www/apps/resources/references/store_models/variables/store_models.StoreCurrency/page.mdx
+13
View File
@@ -0,0 +1,13 @@
---
displayed_sidebar: storeModelReference
slug: /references/store/models/StoreCurrency
sidebar_label: StoreCurrency
---
import { TypeList } from "docs-ui"
# StoreCurrency - Store Module Data Models Reference
This documentation provides a reference to the StoreCurrency data model. It belongs to the Store Module.
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The ISO 3 currency code. For example, `usd`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default","type":"`BooleanProperty`","description":"Whether the currency is the default in the store.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"store","type":"BelongsTo&#60;[Store](../store_models.Store/page.mdx)&#62;","description":"The store this currency belongs to.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the store.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the store","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"supported_currencies","type":"HasMany&#60;[StoreCurrency](page.mdx)&#62;","description":"The associated supported\\_currencies.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The ISO 3 currency code. For example, `usd`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default","type":"`BooleanProperty`","description":"Whether the currency is the default in the store.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"store","type":"BelongsTo&#60;[Store](../store_models.Store/page.mdx)&#62;","description":"The store this currency belongs to.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"default_sales_channel_id","type":"`TextProperty`","description":"The ID of the store's default sales channel.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"default_region_id","type":"`TextProperty`","description":"The ID of the store's default region.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"default_location_id","type":"`TextProperty`","description":"The ID of the store's default stock location.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="StoreCurrency"/>