chore(docs): Generated References (automated) (#12460)
Generated the following references: - `_index.mdx` - `api_key` - `api_key_models` - `auth` - `auth_models` - `auth_provider` - `cart` - `cart_models` - `core_flows` - `currency` - `currency_models` - `customer` - `customer_models` - `events` - `file` - `file_service` - `fulfillment` - `fulfillment_models` - `fulfillment_provider` - `inventory_next` - `inventory_next_models` - `js_sdk` - `locking` - `medusa` - `module_events` - `modules` - `modules_sdk` - `notification` - `notification_service` - `order` - `order_models` - `payment` - `payment_models` - `payment_provider` - `pricing` - `pricing_models` - `product` - `product_models` - `promotion` - `promotion_models` - `region` - `region_models` - `sales_channel` - `sales_channel_models` - `stock_location_next` - `stock_location_next_models` - `store` - `store_models` - `tax` - `tax_models` - `tax_provider` - `types` - `user` - `user_models` - `utils` - `workflows` Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com> Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
1978 files changed
+332243
-279592
No files matched your search
@@ -10,4 +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/e09fd61a8f649959a6c0819c1d867abf05ae0dc4/packages/modules/tax/src/models/tax-provider.ts#L4" />
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","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<[TaxRegion](../tax_models.TaxRegion/page.mdx)>","description":"The regions that use this provider to calculate taxes.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","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<[TaxRegion](../tax_models.TaxRegion/page.mdx)>","description":"The tax region's children..","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","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<[TaxRegion](../tax_models.TaxRegion/page.mdx)>","description":"The tax region's children..","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_rates","type":"HasMany<[TaxRate](../tax_models.TaxRate/page.mdx)>","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<[TaxProvider](./page.mdx)>","description":"The provider that calculates taxes in this region.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"parent","type":"BelongsTo<[TaxRegion](../tax_models.TaxRegion/page.mdx)>","description":"The tax region's parent.","optional":true,"defaultValue":"","expandable":true,"children":[]}]},{"name":"tax_rates","type":"HasMany<[TaxRate](../tax_models.TaxRate/page.mdx)>","description":"The associated tax rates.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","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<[TaxRegion](../tax_models.TaxRegion/page.mdx)>","description":"The associated tax region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"rules","type":"HasMany<[TaxRateRule](../tax_models.TaxRateRule/page.mdx)>","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,4 +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/e09fd61a8f649959a6c0819c1d867abf05ae0dc4/packages/modules/tax/src/models/tax-rate.ts#L5" />
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","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<[TaxRegion](../tax_models.TaxRegion/page.mdx)>","description":"The associated tax region.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","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<[TaxRegion](../tax_models.TaxRegion/page.mdx)>","description":"The tax region's children..","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","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<[TaxRegion](../tax_models.TaxRegion/page.mdx)>","description":"The tax region's children..","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_rates","type":"HasMany<[TaxRate](./page.mdx)>","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<[TaxProvider](../tax_models.TaxProvider/page.mdx)>","description":"The provider that calculates taxes in this region.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"parent","type":"BelongsTo<[TaxRegion](../tax_models.TaxRegion/page.mdx)>","description":"The tax region's parent.","optional":true,"defaultValue":"","expandable":true,"children":[]}]},{"name":"tax_rates","type":"HasMany<[TaxRate](./page.mdx)>","description":"The associated tax rates.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","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<[TaxRegion](../tax_models.TaxRegion/page.mdx)>","description":"The associated tax region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"rules","type":"HasMany<[TaxRateRule](../tax_models.TaxRateRule/page.mdx)>","description":"The associated rules.","optional":false,"defaultLine truncated
|
||||
@@ -10,4 +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/e09fd61a8f649959a6c0819c1d867abf05ae0dc4/packages/modules/tax/src/models/tax-rate-rule.ts#L4" />
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the tax rate rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate","type":"BelongsTo<[TaxRate](../tax_models.TaxRate/page.mdx)>","description":"The associated tax rate.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","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<[TaxRegion](../tax_models.TaxRegion/page.mdx)>","description":"The associated tax region.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","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<[TaxRegion](../tax_models.TaxRegion/page.mdx)>","description":"The tax region's children..","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_rates","type":"HasMany<[TaxRate](../tax_models.TaxRate/page.mdx)>","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<[TaxProvider](../tax_models.TaxProvider/page.mdx)>","description":"The provider that calculates taxes in this region.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"parent","type":"BelongsTo<[TaxRegion](../tax_models.TaxRegion/page.mdx)>","description":"The tax region's parent.","optional":true,"defaultValue":"","expandable":true,"children":[]}]},{"name":"rules","type":"HasMany<[TaxRateRule](./page.mdx)>","description":"The associated rules.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the tax rate rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate","type":"BelongsTo<[TaxRate](../tax_models.TaxRate/page.mdx)>","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,4 +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/e09fd61a8f649959a6c0819c1d867abf05ae0dc4/packages/modules/tax/src/models/tax-region.ts#L10" />
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","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<[TaxRegion](./page.mdx)>","description":"The tax region's children..","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","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<[TaxRegion](./page.mdx)>","description":"The tax region's children..","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","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<[TaxRegion](./page.mdx)>","description":"The tax region's children..","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_rates","type":"HasMany<[TaxRate](../tax_models.TaxRate/page.mdx)>","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<[TaxProvider](../tax_models.TaxProvider/page.mdx)>","description":"The provider that calculates taxes in this region.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"parent","type":"BelongsTo<[TaxRegion](./page.mdx)>","description":"The tax region's parent.","optional":true,"defaultValue":"","expandable":true,"children":[]}]},{"name":"tax_rates","type":"HasMany<[TaxRate](../tax_models.TaxRate/page.mdx)>","description":"The associated tax rates.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","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<[TaxRegion](./page.mdx)>","description":"The associated tax region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"rules","type":"HasMany<[TaxRateRule](../tax_models.TaxRateRule/page.mdx)>","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
|
||||
Reference in new issue
Block a user