chore(docs): Generated References (automated) (#10276)

Generated the following references:
- `api_key`
- `auth`
- `cart`
- `core_flows`
- `currency`
- `customer`
- `dml`
- `fulfillment`
- `helper_steps`
- `inventory_next`
- `js_sdk`
- `medusa`
- `medusa_config`
- `modules`
- `modules_sdk`
- `order`
- `payment`
- `payment_provider`
- `pricing`
- `product`
- `product_models`
- `promotion`
- `region`
- `sales_channel`
- `search`
- `stock_location_next`
- `store`
- `tax`
- `tax_provider`
- `types`
- `user`
- `utils`
- `workflows`

Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]andShahed Nasser authored and GitHub committed 2024-11-26 09:24:41 +00:00
1 parent 67e2e718e9
commit d5ee0070b4
928 files changed
+182409 -172163

No files matched your search

@@ -10,7 +10,7 @@ The following methods are used on a property to configure it.
## Methods
- [nullable](../Property_Configuration_Methods/methods/dml.Property_Configuration_Methods.nullable/page.mdx)
- [index](../Property_Configuration_Methods/methods/dml.Property_Configuration_Methods.index/page.mdx)
- [unique](../Property_Configuration_Methods/methods/dml.Property_Configuration_Methods.unique/page.mdx)
- [default](../Property_Configuration_Methods/methods/dml.Property_Configuration_Methods.default/page.mdx)
- [index](../Property_Configuration_Methods/methods/dml.Property_Configuration_Methods.index/page.mdx)
- [nullable](../Property_Configuration_Methods/methods/dml.Property_Configuration_Methods.nullable/page.mdx)
- [unique](../Property_Configuration_Methods/methods/dml.Property_Configuration_Methods.unique/page.mdx)
@@ -10,12 +10,12 @@ The following methods are used to define the type of a property in a data model.
## Methods
- [id](../Property_Types/methods/dml.Property_Types.id/page.mdx)
- [text](../Property_Types/methods/dml.Property_Types.text/page.mdx)
- [boolean](../Property_Types/methods/dml.Property_Types.boolean/page.mdx)
- [number](../Property_Types/methods/dml.Property_Types.number/page.mdx)
- [bigNumber](../Property_Types/methods/dml.Property_Types.bigNumber/page.mdx)
- [array](../Property_Types/methods/dml.Property_Types.array/page.mdx)
- [bigNumber](../Property_Types/methods/dml.Property_Types.bigNumber/page.mdx)
- [boolean](../Property_Types/methods/dml.Property_Types.boolean/page.mdx)
- [dateTime](../Property_Types/methods/dml.Property_Types.dateTime/page.mdx)
- [json](../Property_Types/methods/dml.Property_Types.json/page.mdx)
- [enum](../Property_Types/methods/dml.Property_Types.enum/page.mdx)
- [id](../Property_Types/methods/dml.Property_Types.id/page.mdx)
- [json](../Property_Types/methods/dml.Property_Types.json/page.mdx)
- [number](../Property_Types/methods/dml.Property_Types.number/page.mdx)
- [text](../Property_Types/methods/dml.Property_Types.text/page.mdx)
@@ -10,7 +10,7 @@ The following methods are used to define a relationship between two data models.
## Methods
- [hasOne](../Relationship_Methods/methods/dml.Relationship_Methods.hasOne/page.mdx)
- [belongsTo](../Relationship_Methods/methods/dml.Relationship_Methods.belongsTo/page.mdx)
- [hasMany](../Relationship_Methods/methods/dml.Relationship_Methods.hasMany/page.mdx)
- [hasOne](../Relationship_Methods/methods/dml.Relationship_Methods.hasOne/page.mdx)
- [manyToMany](../Relationship_Methods/methods/dml.Relationship_Methods.manyToMany/page.mdx)
@@ -13,19 +13,19 @@ name, its schema and relationships.
- [constructor](page.mdx#constructor)
## Methods
- [cascades](../../../Model_Methods/methods/dml.Model_Methods.cascades/page.mdx)
- [indexes](../../../Model_Methods/methods/dml.Model_Methods.indexes/page.mdx)
- [isDmlEntity](../../DmlEntity/methods/dml.entity.DmlEntity.isDmlEntity/page.mdx)
- [parse](../../DmlEntity/methods/dml.entity.DmlEntity.parse/page.mdx)
## Properties
- [[IsDmlEntity]](page.mdx#[isdmlentity])
- [name](page.mdx#name)
- [schema](page.mdx#schema)
## Methods
- [isDmlEntity](../../DmlEntity/methods/dml.entity.DmlEntity.isDmlEntity/page.mdx)
- [parse](../../DmlEntity/methods/dml.entity.DmlEntity.parse/page.mdx)
- [cascades](../../../Model_Methods/methods/dml.Model_Methods.cascades/page.mdx)
- [indexes](../../../Model_Methods/methods/dml.Model_Methods.indexes/page.mdx)
## constructor
### Type Parameters
@@ -11,19 +11,19 @@ schema using the shorthand methods.
## Methods
- [define](../../EntityBuilder/methods/dml.entity_builder.EntityBuilder.define/page.mdx)
- [id](../../../Property_Types/methods/dml.Property_Types.id/page.mdx)
- [text](../../../Property_Types/methods/dml.Property_Types.text/page.mdx)
- [boolean](../../../Property_Types/methods/dml.Property_Types.boolean/page.mdx)
- [number](../../../Property_Types/methods/dml.Property_Types.number/page.mdx)
- [bigNumber](../../../Property_Types/methods/dml.Property_Types.bigNumber/page.mdx)
- [array](../../../Property_Types/methods/dml.Property_Types.array/page.mdx)
- [dateTime](../../../Property_Types/methods/dml.Property_Types.dateTime/page.mdx)
- [json](../../../Property_Types/methods/dml.Property_Types.json/page.mdx)
- [enum](../../../Property_Types/methods/dml.Property_Types.enum/page.mdx)
- [hasOne](../../../Relationship_Methods/methods/dml.Relationship_Methods.hasOne/page.mdx)
- [belongsTo](../../../Relationship_Methods/methods/dml.Relationship_Methods.belongsTo/page.mdx)
- [bigNumber](../../../Property_Types/methods/dml.Property_Types.bigNumber/page.mdx)
- [boolean](../../../Property_Types/methods/dml.Property_Types.boolean/page.mdx)
- [dateTime](../../../Property_Types/methods/dml.Property_Types.dateTime/page.mdx)
- [define](../../EntityBuilder/methods/dml.entity_builder.EntityBuilder.define/page.mdx)
- [enum](../../../Property_Types/methods/dml.Property_Types.enum/page.mdx)
- [hasMany](../../../Relationship_Methods/methods/dml.Relationship_Methods.hasMany/page.mdx)
- [hasOne](../../../Relationship_Methods/methods/dml.Relationship_Methods.hasOne/page.mdx)
- [id](../../../Property_Types/methods/dml.Property_Types.id/page.mdx)
- [json](../../../Property_Types/methods/dml.Property_Types.json/page.mdx)
- [manyToMany](../../../Relationship_Methods/methods/dml.Relationship_Methods.manyToMany/page.mdx)
- [number](../../../Property_Types/methods/dml.Property_Types.number/page.mdx)
- [text](../../../Property_Types/methods/dml.Property_Types.text/page.mdx)
## constructor
@@ -13,18 +13,18 @@ property classes
- [constructor](page.mdx#constructor)
## Properties
- [dataType](page.mdx#datatype)
- [$dataType](page.mdx#$datatype)
## Methods
- [nullable](../../../Property_Configuration_Methods/methods/dml.Property_Configuration_Methods.nullable/page.mdx)
- [index](../../../Property_Configuration_Methods/methods/dml.Property_Configuration_Methods.index/page.mdx)
- [unique](../../../Property_Configuration_Methods/methods/dml.Property_Configuration_Methods.unique/page.mdx)
- [default](../../../Property_Configuration_Methods/methods/dml.Property_Configuration_Methods.default/page.mdx)
- [index](../../../Property_Configuration_Methods/methods/dml.Property_Configuration_Methods.index/page.mdx)
- [nullable](../../../Property_Configuration_Methods/methods/dml.Property_Configuration_Methods.nullable/page.mdx)
- [parse](../../BaseProperty/methods/dml.properties_base.BaseProperty.parse/page.mdx)
- [unique](../../../Property_Configuration_Methods/methods/dml.Property_Configuration_Methods.unique/page.mdx)
## Properties
- [$dataType](page.mdx#$datatype)
- [dataType](page.mdx#datatype)
## constructor
@@ -34,4 +34,4 @@ property classes
___
<TypeList types={[{"name":"dataType","type":"`object`","description":"The runtime dataType for the schema. It is not the same as\nthe \"$dataType\".","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"name","type":"[KnownDataTypes](../../../../types/DmlTypes/types/types.DmlTypes.KnownDataTypes/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record<string, any>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$dataType","type":"T","description":"A type-only property to infer the JavScript data-type\nof the schema property","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="BaseProperty"/>
<TypeList types={[{"name":"$dataType","type":"T","description":"A type-only property to infer the JavScript data-type\nof the schema property","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"dataType","type":"`object`","description":"The runtime dataType for the schema. It is not the same as\nthe \"$dataType\".","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"name","type":"[KnownDataTypes](../../../../types/DmlTypes/types/types.DmlTypes.KnownDataTypes/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record<string, any>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="BaseProperty"/>