docs: generate references for 2.10.1 (#13344)

This commit is contained in:
Shahed Nasser authored and GitHub committed 2025-08-29 12:51:43 +03:00
1 parent cf4da02e39
commit 899ac2f052
1325 files changed
+470691 -426567

No files matched your search

@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the TaxProvider data model. It belongs to the Tax Module.
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/61a25dd07370282cad1dea30e13c3090ebea4f1b/packages/modules/tax/src/models/tax-provider.ts#L4" />
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/9069e9279ee230384cf09c553f60ab6caa0e7012/packages/modules/tax/src/models/tax-provider.ts#L4" />
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the tax provider.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_enabled","type":"`BooleanProperty`","description":"Whether the tax provider is enabled.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"regions","type":"HasMany&#60;[TaxRegion](../tax_models.TaxRegion/page.mdx)&#62;","description":"The regions that use this provider to calculate taxes.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`TextProperty`","description":"The country code of the tax region.\n\n@example us","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"children","type":"HasMany&#60;[TaxRegion](../tax_models.TaxRegion/page.mdx)&#62;","description":"The tax region's children..","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`TextProperty`","description":"The country code of the tax region.\n\n@example us","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"children","type":"HasMany&#60;[TaxRegion](../tax_models.TaxRegion/page.mdx)&#62;","description":"The tax region's children..","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_rates","type":"HasMany&#60;[TaxRate](../tax_models.TaxRate/page.mdx)&#62;","description":"The associated tax rates.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"province_code","type":"`TextProperty`","description":"The province code of the tax region","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":"created_by","type":"`TextProperty`","description":"The ID of the user that created the tax region","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider","type":"BelongsTo&#60;[TaxProvider](./page.mdx)&#62;","description":"The provider that calculates taxes in this region.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"parent","type":"BelongsTo&#60;[TaxRegion](../tax_models.TaxRegion/page.mdx)&#62;","description":"The tax region's parent.","optional":true,"defaultValue":"","expandable":true,"children":[]}]},{"name":"tax_rates","type":"HasMany&#60;[TaxRate](../tax_models.TaxRate/page.mdx)&#62;","description":"The associated tax rates.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code the tax rate is identified by.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the tax rate","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default","type":"`BooleanProperty`","description":"Whether this tax rate is the default in the tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_combinable","type":"`BooleanProperty`","description":"Whether the tax rate should be combined with parent rates. Learn more in [this documentation](https://docs.medusajs.com/v2/resources/commerce-modules/tax/tax-rates-and-rules#combinable-tax-rates).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_region","type":"BelongsTo&#60;[TaxRegion](../tax_models.TaxRegion/page.mdx)&#62;","description":"The associated tax region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"rules","type":"HasMany&#60;[TaxRateRule](../tax_models.TaxRateRule/page.mdx)&#62;","description":"The associated rules.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"rate","type":"`FloatProperty`","description":"The rate to charge.\n\n@example 10","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":"created_by","type":"`TextProperty`","description":"The ID of the user that created the tax rate","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"province_code","type":"`TextProperty`","description":"The province codLine truncated
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the TaxRate data model. It belongs to the Tax Module.
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/61a25dd07370282cad1dea30e13c3090ebea4f1b/packages/modules/tax/src/models/tax-rate.ts#L5" />
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/9069e9279ee230384cf09c553f60ab6caa0e7012/packages/modules/tax/src/models/tax-rate.ts#L5" />
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code the tax rate is identified by.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the tax rate","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default","type":"`BooleanProperty`","description":"Whether this tax rate is the default in the tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_combinable","type":"`BooleanProperty`","description":"Whether the tax rate should be combined with parent rates. Learn more in [this documentation](https://docs.medusajs.com/v2/resources/commerce-modules/tax/tax-rates-and-rules#combinable-tax-rates).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_region","type":"BelongsTo&#60;[TaxRegion](../tax_models.TaxRegion/page.mdx)&#62;","description":"The associated tax region.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`TextProperty`","description":"The country code of the tax region.\n\n@example us","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"children","type":"HasMany&#60;[TaxRegion](../tax_models.TaxRegion/page.mdx)&#62;","description":"The tax region's children..","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`TextProperty`","description":"The country code of the tax region.\n\n@example us","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"children","type":"HasMany&#60;[TaxRegion](../tax_models.TaxRegion/page.mdx)&#62;","description":"The tax region's children..","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_rates","type":"HasMany&#60;[TaxRate](./page.mdx)&#62;","description":"The associated tax rates.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"province_code","type":"`TextProperty`","description":"The province code of the tax region","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":"created_by","type":"`TextProperty`","description":"The ID of the user that created the tax region","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider","type":"BelongsTo&#60;[TaxProvider](../tax_models.TaxProvider/page.mdx)&#62;","description":"The provider that calculates taxes in this region.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"parent","type":"BelongsTo&#60;[TaxRegion](../tax_models.TaxRegion/page.mdx)&#62;","description":"The tax region's parent.","optional":true,"defaultValue":"","expandable":true,"children":[]}]},{"name":"tax_rates","type":"HasMany&#60;[TaxRate](./page.mdx)&#62;","description":"The associated tax rates.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code the tax rate is identified by.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the tax rate","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default","type":"`BooleanProperty`","description":"Whether this tax rate is the default in the tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_combinable","type":"`BooleanProperty`","description":"Whether the tax rate should be combined with parent rates. Learn more in [this documentation](https://docs.medusajs.com/v2/resources/commerce-modules/tax/tax-rates-and-rules#combinable-tax-rates).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_region","type":"BelongsTo&#60;[TaxRegion](../tax_models.TaxRegion/page.mdx)&#62;","description":"The associated tax region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"rules","type":"HasMany&#60;[TaxRateRule](../tax_models.TaxRateRule/page.mdx)&#62;","description":"The associated rules.","optional":false,"defaultLine truncated
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the TaxRateRule data model. It belongs to the Tax Module.
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/61a25dd07370282cad1dea30e13c3090ebea4f1b/packages/modules/tax/src/models/tax-rate-rule.ts#L4" />
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/9069e9279ee230384cf09c553f60ab6caa0e7012/packages/modules/tax/src/models/tax-rate-rule.ts#L4" />
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the tax rate rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate","type":"BelongsTo&#60;[TaxRate](../tax_models.TaxRate/page.mdx)&#62;","description":"The associated tax rate.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code the tax rate is identified by.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the tax rate","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default","type":"`BooleanProperty`","description":"Whether this tax rate is the default in the tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_combinable","type":"`BooleanProperty`","description":"Whether the tax rate should be combined with parent rates. Learn more in [this documentation](https://docs.medusajs.com/v2/resources/commerce-modules/tax/tax-rates-and-rules#combinable-tax-rates).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_region","type":"BelongsTo&#60;[TaxRegion](../tax_models.TaxRegion/page.mdx)&#62;","description":"The associated tax region.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`TextProperty`","description":"The country code of the tax region.\n\n@example us","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"children","type":"HasMany&#60;[TaxRegion](../tax_models.TaxRegion/page.mdx)&#62;","description":"The tax region's children..","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_rates","type":"HasMany&#60;[TaxRate](../tax_models.TaxRate/page.mdx)&#62;","description":"The associated tax rates.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"province_code","type":"`TextProperty`","description":"The province code of the tax region","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":"created_by","type":"`TextProperty`","description":"The ID of the user that created the tax region","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider","type":"BelongsTo&#60;[TaxProvider](../tax_models.TaxProvider/page.mdx)&#62;","description":"The provider that calculates taxes in this region.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"parent","type":"BelongsTo&#60;[TaxRegion](../tax_models.TaxRegion/page.mdx)&#62;","description":"The tax region's parent.","optional":true,"defaultValue":"","expandable":true,"children":[]}]},{"name":"rules","type":"HasMany&#60;[TaxRateRule](./page.mdx)&#62;","description":"The associated rules.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the tax rate rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate","type":"BelongsTo&#60;[TaxRate](../tax_models.TaxRate/page.mdx)&#62;","description":"The associated tax rate.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"reference","type":"`TextProperty`","description":"The name of the table this rule references.\n\n@example product\\_type","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`TextProperty`","description":"The id of a record in the table that this rule references.\n\n@example ptyp\\_1","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`TextProperty`","description":"The ID of the user that created the tax rate rule","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"rate","type":"`FloatProperty`","description":"The rate to charge.\n\n@example 10","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":"created_by","type":"`TextProperty`","description":"The ID of the user tLine truncated
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"
This documentation provides a reference to the TaxRegion data model. It belongs to the Tax Module.
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/61a25dd07370282cad1dea30e13c3090ebea4f1b/packages/modules/tax/src/models/tax-region.ts#L10" />
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/9069e9279ee230384cf09c553f60ab6caa0e7012/packages/modules/tax/src/models/tax-region.ts#L10" />
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`TextProperty`","description":"The country code of the tax region.\n\n@example us","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"children","type":"HasMany&#60;[TaxRegion](./page.mdx)&#62;","description":"The tax region's children..","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`TextProperty`","description":"The country code of the tax region.\n\n@example us","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"children","type":"HasMany&#60;[TaxRegion](./page.mdx)&#62;","description":"The tax region's children..","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`TextProperty`","description":"The country code of the tax region.\n\n@example us","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"children","type":"HasMany&#60;[TaxRegion](./page.mdx)&#62;","description":"The tax region's children..","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_rates","type":"HasMany&#60;[TaxRate](../tax_models.TaxRate/page.mdx)&#62;","description":"The associated tax rates.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"province_code","type":"`TextProperty`","description":"The province code of the tax region","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":"created_by","type":"`TextProperty`","description":"The ID of the user that created the tax region","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider","type":"BelongsTo&#60;[TaxProvider](../tax_models.TaxProvider/page.mdx)&#62;","description":"The provider that calculates taxes in this region.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"parent","type":"BelongsTo&#60;[TaxRegion](./page.mdx)&#62;","description":"The tax region's parent.","optional":true,"defaultValue":"","expandable":true,"children":[]}]},{"name":"tax_rates","type":"HasMany&#60;[TaxRate](../tax_models.TaxRate/page.mdx)&#62;","description":"The associated tax rates.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code the tax rate is identified by.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the tax rate","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default","type":"`BooleanProperty`","description":"Whether this tax rate is the default in the tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_combinable","type":"`BooleanProperty`","description":"Whether the tax rate should be combined with parent rates. Learn more in [this documentation](https://docs.medusajs.com/v2/resources/commerce-modules/tax/tax-rates-and-rules#combinable-tax-rates).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_region","type":"BelongsTo&#60;[TaxRegion](./page.mdx)&#62;","description":"The associated tax region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"rules","type":"HasMany&#60;[TaxRateRule](../tax_models.TaxRateRule/page.mdx)&#62;","description":"The associated rules.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"rate","type":"`FloatProperty`","description":"The rate to charge.\n\n@example 10","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":"created_by","type":"`TextProperty`","description":"The ID of the user that created the tax rate","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"province_code","type":"`TextProperty`","description":"The province code of the tax region","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metLine truncated