chore(docs): Generated References (automated) (#10508)
Co-authored-by: shahednasser <shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]andshahednasser authored and 
GitHub committed
1 parent
866cabf384
commit
9534751b5c
5544 files changed
+275678
-228477
No files matched your search
+1
-1
@@ -10,4 +10,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the Country data model. It belongs to the Region Module.
|
||||
|
||||
<TypeList types={[{"name":"iso_2","type":"PrimaryKeyModifier<TextProperty>","description":"The ISO 2-character code of the country","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"iso_3","type":"`TextProperty`","description":"The ISO 3-character code of the country","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"num_code","type":"`TextProperty`","description":"The ISO numeric code of the country","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the country","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_name","type":"`TextProperty`","description":"The display name of the country","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region","type":"RelationNullableModifier<() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)<{ id: PrimaryKeyModifier<IdProperty> ; name: TextProperty ; currency_code: TextProperty ; automatic_taxes: BooleanProperty ; countries: HasMany<() => DmlEntity<{ iso_2: PrimaryKeyModifier<string, TextProperty>; iso_3: TextProperty; num_code: TextProperty; name: TextProperty; display_name: TextProperty; region: RelationNullableModifier<...>; metadata: NullableModifier<...>; } & { ...; } & {} & DMLSchemaDefaults, { ...; }>> ; metadata?: JSONProperty } & { id: PrimaryKeyModifier<IdProperty> ; name: TextProperty ; currency_code: TextProperty ; automatic_taxes: BooleanProperty ; countries: HasMany<() => DmlEntity<{ iso_2: PrimaryKeyModifier<string, TextProperty>; iso_3: TextProperty; num_code: TextProperty; name: TextProperty; display_name: TextProperty; region: RelationNullableModifier<...>; metadata: NullableModifier<...>; } & { ...; } & {} & DMLSchemaDefaults, { ...; }>> ; metadata?: JSONProperty } & {} & DMLSchemaDefaults, \"region\">, BelongsTo<() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)<{ id: PrimaryKeyModifier<IdProperty> ; name: TextProperty ; currency_code: TextProperty ; automatic_taxes: BooleanProperty ; countries: HasMany<() => ...> ; metadata?: JSONProperty } & { id: PrimaryKeyModifier<IdProperty> ; name: TextProperty ; currency_code: TextProperty ; automatic_taxes: BooleanProperty ; countries: HasMany<() => ...> ; metadata?: JSONProperty } & {} & DMLSchemaDefaults, \"region\">>>","description":"The region it belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="Country"/>
|
||||
<TypeList types={[{"name":"iso_2","type":"PrimaryKeyModifier<TextProperty>","description":"The ISO 2-character code of the country","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"iso_3","type":"`TextProperty`","description":"The ISO 3-character code of the country","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"num_code","type":"`TextProperty`","description":"The ISO numeric code of the country","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the country","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_name","type":"`TextProperty`","description":"The display name of the country","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region","type":"RelationNullableModifier<() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)<{ id: PrimaryKeyModifier<IdProperty> ; name: TextProperty ; currency_code: TextProperty ; automatic_taxes: BooleanProperty ; countries: HasMany<() => DmlEntity<{ iso_2: PrimaryKeyModifier<string, TextProperty>; iso_3: TextProperty; num_code: TextProperty; name: TextProperty; display_name: TextProperty; region: RelationNullableModifier<...>; metadata: NullableModifier<...>; } & { ...; } & {} & DMLSchemaDefaults, { ...; }>> ; metadata?: JSONProperty } & { id: PrimaryKeyModifier<IdProperty> ; name: TextProperty ; currency_code: TextProperty ; automatic_taxes: BooleanProperty ; countries: HasMany<() => DmlEntity<{ iso_2: PrimaryKeyModifier<string, TextProperty>; iso_3: TextProperty; num_code: TextProperty; name: TextProperty; display_name: TextProperty; region: RelationNullableModifier<...>; metadata: NullableModifier<...>; } & { ...; } & {} & DMLSchemaDefaults, { ...; }>> ; metadata?: JSONProperty } & {} & DMLSchemaDefaults, \"region\">, BelongsTo<() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)<{ id: PrimaryKeyModifier<IdProperty> ; name: TextProperty ; currency_code: TextProperty ; automatic_taxes: BooleanProperty ; countries: HasMany<() => ...> ; metadata?: JSONProperty } & { id: PrimaryKeyModifier<IdProperty> ; name: TextProperty ; currency_code: TextProperty ; automatic_taxes: BooleanProperty ; countries: HasMany<() => ...> ; metadata?: JSONProperty } & {} & DMLSchemaDefaults, \"region\">>>","description":"The region it belongs to.","optional":false,"defaultValue":"","expandable":true,"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="Country"/>
|
||||
@@ -10,4 +10,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the Region data model. It belongs to the Region Module.
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the region","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The ISO 3-character currency code of the region","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"automatic_taxes","type":"`BooleanProperty`","description":"Whether taxes are calculated automatically during checkout in the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"countries","type":"HasMany<[Country](../region_models.Country/page.mdx)>","description":"The countries that belong to the region.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"iso_2","type":"PrimaryKeyModifier<TextProperty>","description":"The ISO 2-character code of the country","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"iso_3","type":"`TextProperty`","description":"The ISO 3-character code of the country","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"num_code","type":"`TextProperty`","description":"The ISO numeric code of the country","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the country","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_name","type":"`TextProperty`","description":"The display name of the country","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region","type":"RelationNullableModifier<() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)<{ id: PrimaryKeyModifier<IdProperty> ; name: TextProperty ; currency_code: TextProperty ; automatic_taxes: BooleanProperty ; countries: HasMany<() => DmlEntity<{ iso_2: PrimaryKeyModifier<string, TextProperty>; iso_3: TextProperty; num_code: TextProperty; name: TextProperty; display_name: TextProperty; region: RelationNullableModifier<...>; metadata: NullableModifier<...>; } & { ...; } & {} & DMLSchemaDefaults, { ...; }>> ; metadata?: JSONProperty } & { id: PrimaryKeyModifier<IdProperty> ; name: TextProperty ; currency_code: TextProperty ; automatic_taxes: BooleanProperty ; countries: HasMany<() => DmlEntity<{ iso_2: PrimaryKeyModifier<string, TextProperty>; iso_3: TextProperty; num_code: TextProperty; name: TextProperty; display_name: TextProperty; region: RelationNullableModifier<...>; metadata: NullableModifier<...>; } & { ...; } & {} & DMLSchemaDefaults, { ...; }>> ; metadata?: JSONProperty } & {} & DMLSchemaDefaults, \"region\">, BelongsTo<() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)<{ id: PrimaryKeyModifier<IdProperty> ; name: TextProperty ; currency_code: TextProperty ; automatic_taxes: BooleanProperty ; countries: HasMany<() => ...> ; metadata?: JSONProperty } & { id: PrimaryKeyModifier<IdProperty> ; name: TextProperty ; currency_code: TextProperty ; automatic_taxes: BooleanProperty ; countries: HasMany<() => ...> ; metadata?: JSONProperty } & {} & DMLSchemaDefaults, \"region\">>>","description":"The region it belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","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/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="Region"/>
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the region","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The ISO 3-character currency code of the region","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"automatic_taxes","type":"`BooleanProperty`","description":"Whether taxes are calculated automatically during checkout in the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"countries","type":"HasMany<[Country](../region_models.Country/page.mdx)>","description":"The countries that belong to the region.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"iso_2","type":"PrimaryKeyModifier<TextProperty>","description":"The ISO 2-character code of the country","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"iso_3","type":"`TextProperty`","description":"The ISO 3-character code of the country","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"num_code","type":"`TextProperty`","description":"The ISO numeric code of the country","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the country","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_name","type":"`TextProperty`","description":"The display name of the country","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region","type":"RelationNullableModifier<() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)<{ id: PrimaryKeyModifier<IdProperty> ; name: TextProperty ; currency_code: TextProperty ; automatic_taxes: BooleanProperty ; countries: HasMany<() => DmlEntity<{ iso_2: PrimaryKeyModifier<string, TextProperty>; iso_3: TextProperty; num_code: TextProperty; name: TextProperty; display_name: TextProperty; region: RelationNullableModifier<...>; metadata: NullableModifier<...>; } & { ...; } & {} & DMLSchemaDefaults, { ...; }>> ; metadata?: JSONProperty } & { id: PrimaryKeyModifier<IdProperty> ; name: TextProperty ; currency_code: TextProperty ; automatic_taxes: BooleanProperty ; countries: HasMany<() => DmlEntity<{ iso_2: PrimaryKeyModifier<string, TextProperty>; iso_3: TextProperty; num_code: TextProperty; name: TextProperty; display_name: TextProperty; region: RelationNullableModifier<...>; metadata: NullableModifier<...>; } & { ...; } & {} & DMLSchemaDefaults, { ...; }>> ; metadata?: JSONProperty } & {} & DMLSchemaDefaults, \"region\">, BelongsTo<() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)<{ id: PrimaryKeyModifier<IdProperty> ; name: TextProperty ; currency_code: TextProperty ; automatic_taxes: BooleanProperty ; countries: HasMany<() => ...> ; metadata?: JSONProperty } & { id: PrimaryKeyModifier<IdProperty> ; name: TextProperty ; currency_code: TextProperty ; automatic_taxes: BooleanProperty ; countries: HasMany<() => ...> ; metadata?: JSONProperty } & {} & DMLSchemaDefaults, \"region\">>>","description":"The region it belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","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="Region"/>
|
||||
Reference in new issue
Block a user