chore(docs): Generated References (automated) (#13206)
Generated the following references: - `api_key_models` - `auth_models` - `cart_models` - `core_flows` - `currency_models` - `customer_models` - `fulfillment_models` - `inventory_next_models` - `js_sdk` - `order` - `order_models` - `payment_models` - `pricing_models` - `product` - `product_models` - `promotion` - `promotion_models` - `region_models` - `sales_channel_models` - `stock_location_next_models` - `store_models` - `tax_models` - `user_models` Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
This commit is contained in:
1 parent
f0f3847f27
commit
623cf05fab
529 files changed
+199093
-198816
No files matched your search
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the Store data model. It belongs to the Store Module.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/394226b5c18d11072da826ed6a07d4e602e62f18/packages/modules/store/src/models/store.ts#L4" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/61a25dd07370282cad1dea30e13c3090ebea4f1b/packages/modules/store/src/models/store.ts#L4" />
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","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<[StoreCurrency](../store_models.StoreCurrency/page.mdx)>","description":"The associated supported\\_currencies.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","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<[Store](./page.mdx)>","description":"The store this currency belongs to.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","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<[StoreCurrency](../store_models.StoreCurrency/page.mdx)>","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"/>
|
||||
+1
-1
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the StoreCurrency data model. It belongs to the Store Module.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/394226b5c18d11072da826ed6a07d4e602e62f18/packages/modules/store/src/models/currency.ts#L4" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/61a25dd07370282cad1dea30e13c3090ebea4f1b/packages/modules/store/src/models/currency.ts#L4" />
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","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<[Store](../store_models.Store/page.mdx)>","description":"The store this currency belongs to.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","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<[StoreCurrency](./page.mdx)>","description":"The associated supported\\_currencies.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","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<[Store](../store_models.Store/page.mdx)>","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"/>
|
||||
Reference in new issue
Block a user