docs: add additional data description in generated references (#10944)
This commit is contained in:
Shahed Nasser authored and 
GitHub committed
1 parent
1b86c17b72
commit
2a2b387bc3
917 files changed
+15807
-15158
No files matched your search
+1
-1
@@ -8,7 +8,7 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"messageData","type":"[RawMessageFormat](../../../types/tax.RawMessageFormat/page.mdx)<T> \\| [RawMessageFormat](../../../types/tax.RawMessageFormat/page.mdx)<T>[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"eventName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"TData","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"source","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"eventName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"TData","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"source","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"action","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"Pick<[Context](../../../interfaces/tax.Context/page.mdx), \"eventGroupId\">","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"eventGroupId","type":"`string`","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"`Record<string, any>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"action","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"Pick<[Context](../../../interfaces/tax.Context/page.mdx), \"eventGroupId\">","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"eventGroupId","type":"`string`","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"`Record<string, any>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="saveRawMessageData"/>
|
||||
<TypeList types={[{"name":"messageData","type":"[RawMessageFormat](../../../types/tax.RawMessageFormat/page.mdx)<T> \\| [RawMessageFormat](../../../types/tax.RawMessageFormat/page.mdx)<T>[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"eventName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"TData","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"source","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"action","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"Pick<[Context](../../../interfaces/tax.Context/page.mdx), \"eventGroupId\">","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"eventGroupId","type":"`string`","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"`Record<string, any>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="saveRawMessageData"/>
|
||||
|
||||
## Returns
|
||||
|
||||
|
||||
+1
-1
@@ -8,4 +8,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
## Returns
|
||||
|
||||
<TypeList types={[{"name":"alias","type":"[JoinerServiceConfigAlias](../../../interfaces/tax.JoinerServiceConfigAlias/page.mdx) \\| [JoinerServiceConfigAlias](../../../interfaces/tax.JoinerServiceConfigAlias/page.mdx)[]","description":"Property name to use as entrypoint to the service","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"name","type":"`string` \\| `string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"entity","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"args","type":"`Record<string, any>`","description":"Extra arguments to pass to the remoteFetchData callback","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"entity","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"args","type":"`Record<string, any>`","description":"Extra arguments to pass to the remoteFetchData callback","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"fieldAlias","type":"`Record<string, string \\| object>`","description":"alias for deeper nested relationships (e.g. { 'price': 'prices.calculated\\_price\\_set.amount' })","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"path","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"forwardArgumentsOnPath","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"args","type":"`Record<string, any>`","description":"Extra arguments to pass to the remoteFetchData callback","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"schema","type":"`string`","description":"GraphQL schema for the all module's available entities and fields","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relationships","type":"[ModuleJoinerRelationship](../../../types/tax.ModuleJoinerRelationship/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"alias","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"foreignKey","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"primaryKey","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"serviceName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"entity","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"inverse","type":"`boolean`","description":"In an inverted relationship the foreign key is on the other service and the primary key is on the current service","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isList","type":"`boolean`","description":"Force the relationship to return a list","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"args","type":"`Record<string, any>`","description":"Extra arguments to pass to the remoteFetchData callback","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleteCascade","type":"`boolean`","description":"If true, the link joiner will cascade deleting the relationship","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"extends","type":"`object`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"serviceName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"relationship","type":"[ModuleJoinerRelationship](../../../types/tax.ModuleJoinerRelationship/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"alias","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"foreignKey","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"primaryKey","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"serviceName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"entity","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"inverse","type":"`boolean`","description":"In an inverted relationship the foreign key is on the other service and the primary key is on the current service","optional":true,"defaultValue":"","expandable":false,"children":[Line truncated
|
||||
<TypeList types={[{"name":"alias","type":"[JoinerServiceConfigAlias](../../../interfaces/tax.JoinerServiceConfigAlias/page.mdx) \\| [JoinerServiceConfigAlias](../../../interfaces/tax.JoinerServiceConfigAlias/page.mdx)[]","description":"Property name to use as entrypoint to the service","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"name","type":"`string` \\| `string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"entity","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"args","type":"`Record<string, any>`","description":"Extra arguments to pass to the remoteFetchData callback","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"fieldAlias","type":"`Record<string, string \\| object>`","description":"alias for deeper nested relationships (e.g. { 'price': 'prices.calculated\\_price\\_set.amount' })","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"path","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"forwardArgumentsOnPath","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"args","type":"`Record<string, any>`","description":"Extra arguments to pass to the remoteFetchData callback","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"schema","type":"`string`","description":"GraphQL schema for the all module's available entities and fields","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relationships","type":"[ModuleJoinerRelationship](../../../types/tax.ModuleJoinerRelationship/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"alias","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"foreignKey","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"primaryKey","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"serviceName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"entity","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"inverse","type":"`boolean`","description":"In an inverted relationship the foreign key is on the other service and the primary key is on the current service","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isList","type":"`boolean`","description":"Force the relationship to return a list","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"args","type":"`Record<string, any>`","description":"Extra arguments to pass to the remoteFetchData callback","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleteCascade","type":"`boolean`","description":"If true, the link joiner will cascade deleting the relationship","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"extends","type":"`object`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"serviceName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"relationship","type":"[ModuleJoinerRelationship](../../../types/tax.ModuleJoinerRelationship/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"alias","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"foreignKey","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"primaryKey","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"serviceName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"entity","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"inverse","type":"`boolean`","description":"In an inverted relationship the foreign key is on the other service and the primary key is on the current service","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isList","type":"`boolean`","description":"Force the relationship to return a list","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"args","type":"`Record<string, any>`","description":"Extra arguments to pass to the remoteFetchData callback","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleteCascade","type":"`boolean`","description":"If true, the link joiner will casLine truncated
|
||||
+1
-1
@@ -47,7 +47,7 @@ const taxLines = await taxModuleService.getTaxLines(
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"items","type":"([TaxableItemDTO](../../../interfaces/tax.TaxableItemDTO/page.mdx) \\| [TaxableShippingDTO](../../../interfaces/tax.TaxableShippingDTO/page.mdx))[]","description":"The items and shipping methods to retrieve their tax lines.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the taxable item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`string`","description":"The associated product's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The ID of the taxable shipping.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_id","type":"`string`","description":"The associated shipping option's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_type_id","type":"`string`","description":"The ID of the type of the item's product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"[BigNumberInput](../../../types/tax.BigNumberInput/page.mdx)","description":"The quantity of the taxable item.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../types/tax.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"unit_price","type":"[BigNumberInput](../../../types/tax.BigNumberInput/page.mdx)","description":"The unit price of the taxable item.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../types/tax.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"currency_code","type":"`string`","description":"The ISO 3 character currency code of the taxable item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"unit_price","type":"[BigNumberInput](../../../types/tax.BigNumberInput/page.mdx)","description":"The unit price of the taxable shipping.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../types/tax.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"currency_code","type":"`string`","description":"The ISO 3 character currency code of the taxable shipping.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"calculationContext","type":"[TaxCalculationContext](../../../interfaces/tax.TaxCalculationContext/page.mdx)","description":"The context to pass to the underlying tax provider. It provides more\ndetails that are useful to provide accurate tax lines.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"address","type":"`object`","description":"The customer's address","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"country_code","type":"`string`","description":"The ISO 2 character currency code.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"province_code","type":"`null` \\| `string`","description":"The province code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`string`","description":"The first line of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`null` \\| `string`","description":"The second line of the address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`string`","description":"The city.","optional":true,"defaultValue":"","expandable":false,"chiLine truncated
|
||||
<TypeList types={[{"name":"items","type":"([TaxableItemDTO](../../../interfaces/tax.TaxableItemDTO/page.mdx) \\| [TaxableShippingDTO](../../../interfaces/tax.TaxableShippingDTO/page.mdx))[]","description":"The items and shipping methods to retrieve their tax lines.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the taxable item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`string`","description":"The associated product's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_id","type":"`string`","description":"The associated shipping option's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_type_id","type":"`string`","description":"The ID of the type of the item's product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"[BigNumberInput](../../../types/tax.BigNumberInput/page.mdx)","description":"The quantity of the taxable item.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../types/tax.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"unit_price","type":"[BigNumberInput](../../../types/tax.BigNumberInput/page.mdx)","description":"The unit price of the taxable item.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../types/tax.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"currency_code","type":"`string`","description":"The ISO 3 character currency code of the taxable item.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"calculationContext","type":"[TaxCalculationContext](../../../interfaces/tax.TaxCalculationContext/page.mdx)","description":"The context to pass to the underlying tax provider. It provides more\ndetails that are useful to provide accurate tax lines.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"address","type":"`object`","description":"The customer's address","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"country_code","type":"`string`","description":"The ISO 2 character currency code.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"province_code","type":"`null` \\| `string`","description":"The province code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`string`","description":"The first line of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`null` \\| `string`","description":"The second line of the address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`string`","description":"The city.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`string`","description":"The postal code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Address metadata.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customer","type":"`object`","description":"The customer's details.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`string`","description":"The email of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_groups","type":"`string`[]","description":"The groups that the customer belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Customer metadata.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"is_Line truncated
|
||||
|
||||
## Returns
|
||||
|
||||
|
||||
+1
-1
@@ -60,7 +60,7 @@ const [taxRates, count] = await taxModuleService.listAndCountTaxRates(
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableTaxRateProps](../../../interfaces/tax.FilterableTaxRateProps/page.mdx)","description":"The filters to apply on the retrieved tax rates.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableTaxRateProps](../../../interfaces/tax.FilterableTaxRateProps/page.mdx) \\| [BaseFilterable](../../../interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](../../../interfaces/tax.FilterableTaxRateProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableTaxRateProps](../../../interfaces/tax.FilterableTaxRateProps/page.mdx) \\| [BaseFilterable](../../../interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](../../../interfaces/tax.FilterableTaxRateProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableTaxRateProps](../../../interfaces/tax.FilterableTaxRateProps/page.mdx) \\| [BaseFilterable](../../../interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](../../../interfaces/tax.FilterableTaxRateProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Find tax rates based on name and code properties through this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the tax rates by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_region_id","type":"`string` \\| `string`[]","description":"Filter the tax rates by their associated tax regions.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`number` \\| [OperatorMap](../../../types/tax.OperatorMap/page.mdx)<number> \\| `number`[]","description":"Filter the tax rates by their rate.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by their code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by their name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[OperatorMap](../../../types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by their creation date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"[OperatorMap](../../../types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by their update date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by who created it.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/tax.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/tax.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableTaxRateProps](../../../interfaces/tax.FilterableTaxRateProps/page.mdx) \\| [BaseFilterable](../../../interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](../../../interfaces/tax.FilterableTaxRateProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableTaxRateProps](../../../interfaces/tax.FilterableTaxRateProps/page.mdx) \\| [BaseFilterable](../../../interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](../../../interfaces/tax.FilterableTaxRateProps/page.mdx)>)[]","description":"An arrLine truncated
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableTaxRateProps](../../../interfaces/tax.FilterableTaxRateProps/page.mdx)","description":"The filters to apply on the retrieved tax rates.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableTaxRateProps](../../../interfaces/tax.FilterableTaxRateProps/page.mdx) \\| [BaseFilterable](../../../interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](../../../interfaces/tax.FilterableTaxRateProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableTaxRateProps](../../../interfaces/tax.FilterableTaxRateProps/page.mdx) \\| [BaseFilterable](../../../interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](../../../interfaces/tax.FilterableTaxRateProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableTaxRateProps](../../../interfaces/tax.FilterableTaxRateProps/page.mdx) \\| [BaseFilterable](../../../interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](../../../interfaces/tax.FilterableTaxRateProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Find tax rates based on name and code properties through this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the tax rates by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_region_id","type":"`string` \\| `string`[]","description":"Filter the tax rates by their associated tax regions.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`number` \\| [OperatorMap](../../../types/tax.OperatorMap/page.mdx)<number> \\| `number`[]","description":"Filter the tax rates by their rate.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by their code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by their name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[OperatorMap](../../../types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by their creation date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"[OperatorMap](../../../types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by their update date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by who created it.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableTaxRateProps](../../../interfaces/tax.FilterableTaxRateProps/page.mdx) \\| [BaseFilterable](../../../interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](../../../interfaces/tax.FilterableTaxRateProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableTaxRateProps](../../../interfaces/tax.FilterableTaxRateProps/page.mdx) \\| [BaseFilterable](../../../interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](../../../interfaces/tax.FilterableTaxRateProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableTaxRateProps](../../../interfaces/tax.FilterableTaxRateProps/page.mdx) \\| [BaseFilterable](../../../interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](../../../interfaces/tax.FilterableTaxRateProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expanLine truncated
|
||||
|
||||
## Returns
|
||||
|
||||
|
||||
+1
-1
@@ -58,7 +58,7 @@ const taxRateRules = await taxModuleService.listTaxRateRules(
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableTaxRateRuleProps](../../../interfaces/tax.FilterableTaxRateRuleProps/page.mdx)","description":"The filters to apply on the retrieved tax rate rules.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableTaxRateRuleProps](../../../interfaces/tax.FilterableTaxRateRuleProps/page.mdx) \\| [BaseFilterable](../../../interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateRuleProps](../../../interfaces/tax.FilterableTaxRateRuleProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableTaxRateRuleProps](../../../interfaces/tax.FilterableTaxRateRuleProps/page.mdx) \\| [BaseFilterable](../../../interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateRuleProps](../../../interfaces/tax.FilterableTaxRateRuleProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableTaxRateRuleProps](../../../interfaces/tax.FilterableTaxRateRuleProps/page.mdx) \\| [BaseFilterable](../../../interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateRuleProps](../../../interfaces/tax.FilterableTaxRateRuleProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rate rule by what it references.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rate rule by the ID of the record it references.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rate rule by the ID of their associated tax rate.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate","type":"[FilterableTaxRateProps](../../../interfaces/tax.FilterableTaxRateProps/page.mdx)","description":"Filter the tax rate rule by their associated tax rate.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>` \\| [OperatorMap](../../../types/tax.OperatorMap/page.mdx)<Record<string, unknown>> \\| `Record<string, unknown>`[]","description":"Filter the tax rate rule by what its metadata.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[OperatorMap](../../../types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rate rule by its creation date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"[OperatorMap](../../../types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rate rule by its update date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rate rule by who created it.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/tax.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/tax.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableTaxRateRuleProps](../../../interfaces/tax.FilterableTaxRateRuleProps/page.mdx) \\| [BaseFilterable](../../../interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateRuleProps](../../../interfaces/tax.FilterableTaxRateRuleProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableTaxRateRuleProps](../../../interfaces/tax.FilterableTaxRateRulePropLine truncated
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableTaxRateRuleProps](../../../interfaces/tax.FilterableTaxRateRuleProps/page.mdx)","description":"The filters to apply on the retrieved tax rate rules.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableTaxRateRuleProps](../../../interfaces/tax.FilterableTaxRateRuleProps/page.mdx) \\| [BaseFilterable](../../../interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateRuleProps](../../../interfaces/tax.FilterableTaxRateRuleProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableTaxRateRuleProps](../../../interfaces/tax.FilterableTaxRateRuleProps/page.mdx) \\| [BaseFilterable](../../../interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateRuleProps](../../../interfaces/tax.FilterableTaxRateRuleProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableTaxRateRuleProps](../../../interfaces/tax.FilterableTaxRateRuleProps/page.mdx) \\| [BaseFilterable](../../../interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateRuleProps](../../../interfaces/tax.FilterableTaxRateRuleProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rate rule by what it references.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rate rule by the ID of the record it references.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rate rule by the ID of their associated tax rate.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate","type":"[FilterableTaxRateProps](../../../interfaces/tax.FilterableTaxRateProps/page.mdx)","description":"Filter the tax rate rule by their associated tax rate.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>` \\| [OperatorMap](../../../types/tax.OperatorMap/page.mdx)<Record<string, unknown>> \\| `Record<string, unknown>`[]","description":"Filter the tax rate rule by what its metadata.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[OperatorMap](../../../types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rate rule by its creation date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"[OperatorMap](../../../types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rate rule by its update date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rate rule by who created it.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableTaxRateRuleProps](../../../interfaces/tax.FilterableTaxRateRuleProps/page.mdx) \\| [BaseFilterable](../../../interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateRuleProps](../../../interfaces/tax.FilterableTaxRateRuleProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableTaxRateRuleProps](../../../interfaces/tax.FilterableTaxRateRuleProps/page.mdx) \\| [BaseFilterable](../../../interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateRuleProps](../../../interfaces/tax.FilterableTaxRateRuleProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableTaxRateRuleProps](../../../interfaces/tax.FilterableTaxRateRuleProps/page.mdx) \\| [BaseFilterable](../../../interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateRuleProps](../../../inteLine truncated
|
||||
|
||||
## Returns
|
||||
|
||||
|
||||
+1
-1
@@ -58,7 +58,7 @@ const taxRates = await taxModuleService.listTaxRates(
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableTaxRateProps](../../../interfaces/tax.FilterableTaxRateProps/page.mdx)","description":"The filters to apply on the retrieved tax rates.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableTaxRateProps](../../../interfaces/tax.FilterableTaxRateProps/page.mdx) \\| [BaseFilterable](../../../interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](../../../interfaces/tax.FilterableTaxRateProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableTaxRateProps](../../../interfaces/tax.FilterableTaxRateProps/page.mdx) \\| [BaseFilterable](../../../interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](../../../interfaces/tax.FilterableTaxRateProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableTaxRateProps](../../../interfaces/tax.FilterableTaxRateProps/page.mdx) \\| [BaseFilterable](../../../interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](../../../interfaces/tax.FilterableTaxRateProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Find tax rates based on name and code properties through this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the tax rates by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_region_id","type":"`string` \\| `string`[]","description":"Filter the tax rates by their associated tax regions.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`number` \\| [OperatorMap](../../../types/tax.OperatorMap/page.mdx)<number> \\| `number`[]","description":"Filter the tax rates by their rate.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by their code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by their name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[OperatorMap](../../../types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by their creation date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"[OperatorMap](../../../types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by their update date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by who created it.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/tax.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/tax.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableTaxRateProps](../../../interfaces/tax.FilterableTaxRateProps/page.mdx) \\| [BaseFilterable](../../../interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](../../../interfaces/tax.FilterableTaxRateProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableTaxRateProps](../../../interfaces/tax.FilterableTaxRateProps/page.mdx) \\| [BaseFilterable](../../../interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](../../../interfaces/tax.FilterableTaxRateProps/page.mdx)>)[]","description":"An arrLine truncated
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableTaxRateProps](../../../interfaces/tax.FilterableTaxRateProps/page.mdx)","description":"The filters to apply on the retrieved tax rates.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableTaxRateProps](../../../interfaces/tax.FilterableTaxRateProps/page.mdx) \\| [BaseFilterable](../../../interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](../../../interfaces/tax.FilterableTaxRateProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableTaxRateProps](../../../interfaces/tax.FilterableTaxRateProps/page.mdx) \\| [BaseFilterable](../../../interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](../../../interfaces/tax.FilterableTaxRateProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableTaxRateProps](../../../interfaces/tax.FilterableTaxRateProps/page.mdx) \\| [BaseFilterable](../../../interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](../../../interfaces/tax.FilterableTaxRateProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Find tax rates based on name and code properties through this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the tax rates by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_region_id","type":"`string` \\| `string`[]","description":"Filter the tax rates by their associated tax regions.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`number` \\| [OperatorMap](../../../types/tax.OperatorMap/page.mdx)<number> \\| `number`[]","description":"Filter the tax rates by their rate.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by their code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by their name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[OperatorMap](../../../types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by their creation date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"[OperatorMap](../../../types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by their update date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by who created it.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableTaxRateProps](../../../interfaces/tax.FilterableTaxRateProps/page.mdx) \\| [BaseFilterable](../../../interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](../../../interfaces/tax.FilterableTaxRateProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableTaxRateProps](../../../interfaces/tax.FilterableTaxRateProps/page.mdx) \\| [BaseFilterable](../../../interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](../../../interfaces/tax.FilterableTaxRateProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableTaxRateProps](../../../interfaces/tax.FilterableTaxRateProps/page.mdx) \\| [BaseFilterable](../../../interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](../../../interfaces/tax.FilterableTaxRateProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expanLine truncated
|
||||
|
||||
## Returns
|
||||
|
||||
|
||||
+1
-1
@@ -58,7 +58,7 @@ const taxRegions = await taxModuleService.listTaxRegions(
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableTaxRegionProps](../../../interfaces/tax.FilterableTaxRegionProps/page.mdx)","description":"The filters to apply on the retrieved tax regions.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableTaxRegionProps](../../../interfaces/tax.FilterableTaxRegionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRegionProps](../../../interfaces/tax.FilterableTaxRegionProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableTaxRegionProps](../../../interfaces/tax.FilterableTaxRegionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRegionProps](../../../interfaces/tax.FilterableTaxRegionProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableTaxRegionProps](../../../interfaces/tax.FilterableTaxRegionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRegionProps](../../../interfaces/tax.FilterableTaxRegionProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Find tax regions based on currency and province codes through this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the tax regions by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax regions by their country code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province_code","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax regions by their province code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax regions by the ID of their parent tax region.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>` \\| [OperatorMap](../../../types/tax.OperatorMap/page.mdx)<Record<string, unknown>> \\| `Record<string, unknown>`[]","description":"Filter the tax regions by their metadata.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[OperatorMap](../../../types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax regions by their creation date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"[OperatorMap](../../../types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax regions by their update date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax regions by who created it.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/tax.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/tax.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableTaxRegionProps](../../../interfaces/tax.FilterableTaxRegionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRegionProps](../../../interfaces/tax.FilterableTaxRegionProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableTaxRegionProps](../..Line truncated
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableTaxRegionProps](../../../interfaces/tax.FilterableTaxRegionProps/page.mdx)","description":"The filters to apply on the retrieved tax regions.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableTaxRegionProps](../../../interfaces/tax.FilterableTaxRegionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRegionProps](../../../interfaces/tax.FilterableTaxRegionProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableTaxRegionProps](../../../interfaces/tax.FilterableTaxRegionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRegionProps](../../../interfaces/tax.FilterableTaxRegionProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableTaxRegionProps](../../../interfaces/tax.FilterableTaxRegionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRegionProps](../../../interfaces/tax.FilterableTaxRegionProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Find tax regions based on currency and province codes through this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the tax regions by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax regions by their country code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province_code","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax regions by their province code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax regions by the ID of their parent tax region.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>` \\| [OperatorMap](../../../types/tax.OperatorMap/page.mdx)<Record<string, unknown>> \\| `Record<string, unknown>`[]","description":"Filter the tax regions by their metadata.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[OperatorMap](../../../types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax regions by their creation date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"[OperatorMap](../../../types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax regions by their update date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax regions by who created it.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableTaxRegionProps](../../../interfaces/tax.FilterableTaxRegionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRegionProps](../../../interfaces/tax.FilterableTaxRegionProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableTaxRegionProps](../../../interfaces/tax.FilterableTaxRegionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRegionProps](../../../interfaces/tax.FilterableTaxRegionProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableTaxRegionProps](../../../interfaces/tax.FilterableTaxRegionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/tax.BaseFilterable/page.mdx)<[FilteraLine truncated
|
||||
|
||||
## Returns
|
||||
|
||||
|
||||
+1
-1
@@ -78,7 +78,7 @@ const taxRates = await taxModuleService.updateTaxRates(
|
||||
|
||||
### Parameters
|
||||
|
||||
<TypeList types={[{"name":"selector","type":"[FilterableTaxRateProps](../../../interfaces/tax.FilterableTaxRateProps/page.mdx)","description":"The filters specifying which tax rates to update.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableTaxRateProps](../../../interfaces/tax.FilterableTaxRateProps/page.mdx) \\| [BaseFilterable](../../../interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](../../../interfaces/tax.FilterableTaxRateProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableTaxRateProps](../../../interfaces/tax.FilterableTaxRateProps/page.mdx) \\| [BaseFilterable](../../../interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](../../../interfaces/tax.FilterableTaxRateProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableTaxRateProps](../../../interfaces/tax.FilterableTaxRateProps/page.mdx) \\| [BaseFilterable](../../../interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](../../../interfaces/tax.FilterableTaxRateProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Find tax rates based on name and code properties through this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the tax rates by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_region_id","type":"`string` \\| `string`[]","description":"Filter the tax rates by their associated tax regions.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`number` \\| [OperatorMap](../../../types/tax.OperatorMap/page.mdx)<number> \\| `number`[]","description":"Filter the tax rates by their rate.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by their code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by their name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[OperatorMap](../../../types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by their creation date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"[OperatorMap](../../../types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by their update date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by who created it.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/tax.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/tax.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableTaxRateProps](../../../interfaces/tax.FilterableTaxRateProps/page.mdx) \\| [BaseFilterable](../../../interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](../../../interfaces/tax.FilterableTaxRateProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableTaxRateProps](../../../interfaces/tax.FilterableTaxRateProps/page.mdx) \\| [BaseFilterable](../../../interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](../../../interfaces/tax.FilterableTaxRateProps/page.mdx)>)[]","description":"An Line truncated
|
||||
<TypeList types={[{"name":"selector","type":"[FilterableTaxRateProps](../../../interfaces/tax.FilterableTaxRateProps/page.mdx)","description":"The filters specifying which tax rates to update.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableTaxRateProps](../../../interfaces/tax.FilterableTaxRateProps/page.mdx) \\| [BaseFilterable](../../../interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](../../../interfaces/tax.FilterableTaxRateProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableTaxRateProps](../../../interfaces/tax.FilterableTaxRateProps/page.mdx) \\| [BaseFilterable](../../../interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](../../../interfaces/tax.FilterableTaxRateProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableTaxRateProps](../../../interfaces/tax.FilterableTaxRateProps/page.mdx) \\| [BaseFilterable](../../../interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](../../../interfaces/tax.FilterableTaxRateProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Find tax rates based on name and code properties through this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the tax rates by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_region_id","type":"`string` \\| `string`[]","description":"Filter the tax rates by their associated tax regions.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`number` \\| [OperatorMap](../../../types/tax.OperatorMap/page.mdx)<number> \\| `number`[]","description":"Filter the tax rates by their rate.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by their code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by their name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[OperatorMap](../../../types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by their creation date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"[OperatorMap](../../../types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by their update date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by who created it.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableTaxRateProps](../../../interfaces/tax.FilterableTaxRateProps/page.mdx) \\| [BaseFilterable](../../../interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](../../../interfaces/tax.FilterableTaxRateProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableTaxRateProps](../../../interfaces/tax.FilterableTaxRateProps/page.mdx) \\| [BaseFilterable](../../../interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](../../../interfaces/tax.FilterableTaxRateProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableTaxRateProps](../../../interfaces/tax.FilterableTaxRateProps/page.mdx) \\| [BaseFilterable](../../../interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](../../../interfaces/tax.FilterableTaxRateProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","exLine truncated
|
||||
|
||||
### Returns
|
||||
|
||||
|
||||
@@ -8,4 +8,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
The filters to apply on the retrieved tax rates.
|
||||
|
||||
<TypeList types={[{"name":"$and","type":"([FilterableTaxRateProps](./page.mdx) \\| [BaseFilterable](../tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](./page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableTaxRateProps](./page.mdx) \\| [BaseFilterable](../tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](./page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableTaxRateProps](./page.mdx) \\| [BaseFilterable](../tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](./page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableTaxRateProps](./page.mdx) \\| [BaseFilterable](../tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](./page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Find tax rates based on name and code properties through this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the tax rates by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_region_id","type":"`string` \\| `string`[]","description":"Filter the tax rates by their associated tax regions.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`number` \\| [OperatorMap](../../types/tax.OperatorMap/page.mdx)<number> \\| `number`[]","description":"Filter the tax rates by their rate.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string` \\| `string`[] \\| [OperatorMap](../../types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by their code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[] \\| [OperatorMap](../../types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by their name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[OperatorMap](../../types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by their creation date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"[OperatorMap](../../types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by their update date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string` \\| `string`[] \\| [OperatorMap](../../types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by who created it.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../tax.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../tax.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableTaxRateProps](./page.mdx) \\| [BaseFilterable](../tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](./page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableTaxRateProps](./page.mdx) \\| [BaseFilterable](../tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](./page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableTaxRateProps](./page.mdx) \\| [BaseFilterable](../tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](./page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional"Line truncated
|
||||
<TypeList types={[{"name":"$and","type":"([FilterableTaxRateProps](./page.mdx) \\| [BaseFilterable](../tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](./page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableTaxRateProps](./page.mdx) \\| [BaseFilterable](../tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](./page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableTaxRateProps](./page.mdx) \\| [BaseFilterable](../tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](./page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableTaxRateProps](./page.mdx) \\| [BaseFilterable](../tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](./page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Find tax rates based on name and code properties through this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the tax rates by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_region_id","type":"`string` \\| `string`[]","description":"Filter the tax rates by their associated tax regions.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`number` \\| [OperatorMap](../../types/tax.OperatorMap/page.mdx)<number> \\| `number`[]","description":"Filter the tax rates by their rate.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string` \\| `string`[] \\| [OperatorMap](../../types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by their code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[] \\| [OperatorMap](../../types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by their name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[OperatorMap](../../types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by their creation date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"[OperatorMap](../../types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by their update date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string` \\| `string`[] \\| [OperatorMap](../../types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by who created it.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableTaxRateProps](./page.mdx) \\| [BaseFilterable](../tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](./page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableTaxRateProps](./page.mdx) \\| [BaseFilterable](../tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](./page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableTaxRateProps](./page.mdx) \\| [BaseFilterable](../tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](./page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Find tax rates based on name and code properties through this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the tax rates by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_region_id","type":"`string` \\| `string`[]","description":"Filter the tax rates by their associated tax regions.","optional":true,"defaultValue":"",Line truncated
|
||||
+1
-1
@@ -8,4 +8,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
The filters to apply on the retrieved tax rate rules.
|
||||
|
||||
<TypeList types={[{"name":"$and","type":"([FilterableTaxRateRuleProps](./page.mdx) \\| [BaseFilterable](../tax.BaseFilterable/page.mdx)<[FilterableTaxRateRuleProps](./page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableTaxRateRuleProps](./page.mdx) \\| [BaseFilterable](../tax.BaseFilterable/page.mdx)<[FilterableTaxRateRuleProps](./page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableTaxRateRuleProps](./page.mdx) \\| [BaseFilterable](../tax.BaseFilterable/page.mdx)<[FilterableTaxRateRuleProps](./page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableTaxRateRuleProps](./page.mdx) \\| [BaseFilterable](../tax.BaseFilterable/page.mdx)<[FilterableTaxRateRuleProps](./page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string` \\| `string`[] \\| [OperatorMap](../../types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rate rule by what it references.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rate rule by the ID of the record it references.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rate rule by the ID of their associated tax rate.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate","type":"[FilterableTaxRateProps](../tax.FilterableTaxRateProps/page.mdx)","description":"Filter the tax rate rule by their associated tax rate.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>` \\| [OperatorMap](../../types/tax.OperatorMap/page.mdx)<Record<string, unknown>> \\| `Record<string, unknown>`[]","description":"Filter the tax rate rule by what its metadata.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[OperatorMap](../../types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rate rule by its creation date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"[OperatorMap](../../types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rate rule by its update date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string` \\| `string`[] \\| [OperatorMap](../../types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rate rule by who created it.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../tax.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../tax.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableTaxRateRuleProps](./page.mdx) \\| [BaseFilterable](../tax.BaseFilterable/page.mdx)<[FilterableTaxRateRuleProps](./page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableTaxRateRuleProps](./page.mdx) \\| [BaseFilterable](../tax.BaseFilterable/page.mdx)<[FilterableTaxRateRuleProps](./page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableTaxRateRuleProps](./page.mdx) \\| [BaseFilterable](../tax.BaseFilterable/page.mdx)<[FilterableTaxRateRuleProps](./page.Line truncated
|
||||
<TypeList types={[{"name":"$and","type":"([FilterableTaxRateRuleProps](./page.mdx) \\| [BaseFilterable](../tax.BaseFilterable/page.mdx)<[FilterableTaxRateRuleProps](./page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableTaxRateRuleProps](./page.mdx) \\| [BaseFilterable](../tax.BaseFilterable/page.mdx)<[FilterableTaxRateRuleProps](./page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableTaxRateRuleProps](./page.mdx) \\| [BaseFilterable](../tax.BaseFilterable/page.mdx)<[FilterableTaxRateRuleProps](./page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableTaxRateRuleProps](./page.mdx) \\| [BaseFilterable](../tax.BaseFilterable/page.mdx)<[FilterableTaxRateRuleProps](./page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string` \\| `string`[] \\| [OperatorMap](../../types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rate rule by what it references.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rate rule by the ID of the record it references.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rate rule by the ID of their associated tax rate.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate","type":"[FilterableTaxRateProps](../tax.FilterableTaxRateProps/page.mdx)","description":"Filter the tax rate rule by their associated tax rate.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>` \\| [OperatorMap](../../types/tax.OperatorMap/page.mdx)<Record<string, unknown>> \\| `Record<string, unknown>`[]","description":"Filter the tax rate rule by what its metadata.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[OperatorMap](../../types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rate rule by its creation date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"[OperatorMap](../../types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rate rule by its update date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string` \\| `string`[] \\| [OperatorMap](../../types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rate rule by who created it.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableTaxRateRuleProps](./page.mdx) \\| [BaseFilterable](../tax.BaseFilterable/page.mdx)<[FilterableTaxRateRuleProps](./page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableTaxRateRuleProps](./page.mdx) \\| [BaseFilterable](../tax.BaseFilterable/page.mdx)<[FilterableTaxRateRuleProps](./page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableTaxRateRuleProps](./page.mdx) \\| [BaseFilterable](../tax.BaseFilterable/page.mdx)<[FilterableTaxRateRuleProps](./page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string` \\| `string`[] \\| [OperatorMap](../../types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rate rule by what it references.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../types/tax.OperatorMap/page.mdx)Line truncated
|
||||
@@ -8,4 +8,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
The filters to apply on the retrieved tax regions.
|
||||
|
||||
<TypeList types={[{"name":"$and","type":"([FilterableTaxRegionProps](./page.mdx) \\| [BaseFilterable](../tax.BaseFilterable/page.mdx)<[FilterableTaxRegionProps](./page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableTaxRegionProps](./page.mdx) \\| [BaseFilterable](../tax.BaseFilterable/page.mdx)<[FilterableTaxRegionProps](./page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableTaxRegionProps](./page.mdx) \\| [BaseFilterable](../tax.BaseFilterable/page.mdx)<[FilterableTaxRegionProps](./page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableTaxRegionProps](./page.mdx) \\| [BaseFilterable](../tax.BaseFilterable/page.mdx)<[FilterableTaxRegionProps](./page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Find tax regions based on currency and province codes through this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the tax regions by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string` \\| `string`[] \\| [OperatorMap](../../types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax regions by their country code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province_code","type":"`string` \\| `string`[] \\| [OperatorMap](../../types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax regions by their province code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax regions by the ID of their parent tax region.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>` \\| [OperatorMap](../../types/tax.OperatorMap/page.mdx)<Record<string, unknown>> \\| `Record<string, unknown>`[]","description":"Filter the tax regions by their metadata.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[OperatorMap](../../types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax regions by their creation date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"[OperatorMap](../../types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax regions by their update date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string` \\| `string`[] \\| [OperatorMap](../../types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax regions by who created it.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../tax.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../tax.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableTaxRegionProps](./page.mdx) \\| [BaseFilterable](../tax.BaseFilterable/page.mdx)<[FilterableTaxRegionProps](./page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableTaxRegionProps](./page.mdx) \\| [BaseFilterable](../tax.BaseFilterable/page.mdx)<[FilterableTaxRegionProps](./page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableTaxRegionProps](./page.mdx) \\| [BaseFilterabLine truncated
|
||||
<TypeList types={[{"name":"$and","type":"([FilterableTaxRegionProps](./page.mdx) \\| [BaseFilterable](../tax.BaseFilterable/page.mdx)<[FilterableTaxRegionProps](./page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableTaxRegionProps](./page.mdx) \\| [BaseFilterable](../tax.BaseFilterable/page.mdx)<[FilterableTaxRegionProps](./page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableTaxRegionProps](./page.mdx) \\| [BaseFilterable](../tax.BaseFilterable/page.mdx)<[FilterableTaxRegionProps](./page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableTaxRegionProps](./page.mdx) \\| [BaseFilterable](../tax.BaseFilterable/page.mdx)<[FilterableTaxRegionProps](./page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Find tax regions based on currency and province codes through this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the tax regions by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string` \\| `string`[] \\| [OperatorMap](../../types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax regions by their country code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province_code","type":"`string` \\| `string`[] \\| [OperatorMap](../../types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax regions by their province code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax regions by the ID of their parent tax region.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>` \\| [OperatorMap](../../types/tax.OperatorMap/page.mdx)<Record<string, unknown>> \\| `Record<string, unknown>`[]","description":"Filter the tax regions by their metadata.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[OperatorMap](../../types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax regions by their creation date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"[OperatorMap](../../types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax regions by their update date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string` \\| `string`[] \\| [OperatorMap](../../types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax regions by who created it.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableTaxRegionProps](./page.mdx) \\| [BaseFilterable](../tax.BaseFilterable/page.mdx)<[FilterableTaxRegionProps](./page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableTaxRegionProps](./page.mdx) \\| [BaseFilterable](../tax.BaseFilterable/page.mdx)<[FilterableTaxRegionProps](./page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableTaxRegionProps](./page.mdx) \\| [BaseFilterable](../tax.BaseFilterable/page.mdx)<[FilterableTaxRegionProps](./page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Find tax regions based on currency and province codes through this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the tax regions by."Line truncated
|
||||
@@ -6,4 +6,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
# JoinerServiceConfig
|
||||
|
||||
<TypeList types={[{"name":"serviceName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"primaryKeys","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"alias","type":"[JoinerServiceConfigAlias](../tax.JoinerServiceConfigAlias/page.mdx) \\| [JoinerServiceConfigAlias](../tax.JoinerServiceConfigAlias/page.mdx)[]","description":"Property name to use as entrypoint to the service","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"name","type":"`string` \\| `string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"entity","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"args","type":"`Record<string, any>`","description":"Extra arguments to pass to the remoteFetchData callback","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"entity","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"args","type":"`Record<string, any>`","description":"Extra arguments to pass to the remoteFetchData callback","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"fieldAlias","type":"`Record<string, string \\| object>`","description":"alias for deeper nested relationships (e.g. { 'price': 'prices.calculated\\_price\\_set.amount' })","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"path","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"forwardArgumentsOnPath","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"relationships","type":"[JoinerRelationship](../../types/tax.JoinerRelationship/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"alias","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"foreignKey","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"primaryKey","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"serviceName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"entity","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"inverse","type":"`boolean`","description":"In an inverted relationship the foreign key is on the other service and the primary key is on the current service","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isList","type":"`boolean`","description":"Force the relationship to return a list","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"args","type":"`Record<string, any>`","description":"Extra arguments to pass to the remoteFetchData callback","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"extends","type":"`object`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"serviceName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"relationship","type":"[JoinerRelationship](../../types/tax.JoinerRelationship/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"alias","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"foreignKey","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"primaryKey","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"serviceName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"entity","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"inverse","type":"`boolean`","description":"In an inverted relationship the foreign key is on the other service and the primary key is on the current service","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isList","type":"`boolean`","description":"Force the relationship to return a list","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"args","type":"`Record<string, any>`","description":"Extra arguments to pass to the remoteFetchData callback","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"entity","typLine truncated
|
||||
<TypeList types={[{"name":"serviceName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"primaryKeys","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"alias","type":"[JoinerServiceConfigAlias](../tax.JoinerServiceConfigAlias/page.mdx) \\| [JoinerServiceConfigAlias](../tax.JoinerServiceConfigAlias/page.mdx)[]","description":"Property name to use as entrypoint to the service","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"name","type":"`string` \\| `string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"entity","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"args","type":"`Record<string, any>`","description":"Extra arguments to pass to the remoteFetchData callback","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"fieldAlias","type":"`Record<string, string \\| object>`","description":"alias for deeper nested relationships (e.g. { 'price': 'prices.calculated\\_price\\_set.amount' })","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"path","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"forwardArgumentsOnPath","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"relationships","type":"[JoinerRelationship](../../types/tax.JoinerRelationship/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"alias","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"foreignKey","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"primaryKey","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"serviceName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"entity","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"inverse","type":"`boolean`","description":"In an inverted relationship the foreign key is on the other service and the primary key is on the current service","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isList","type":"`boolean`","description":"Force the relationship to return a list","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"args","type":"`Record<string, any>`","description":"Extra arguments to pass to the remoteFetchData callback","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"extends","type":"`object`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"serviceName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"relationship","type":"[JoinerRelationship](../../types/tax.JoinerRelationship/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"alias","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"foreignKey","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"primaryKey","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"serviceName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"entity","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"inverse","type":"`boolean`","description":"In an inverted relationship the foreign key is on the other service and the primary key is on the current service","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isList","type":"`boolean`","description":"Force the relationship to return a list","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"args","type":"`Record<string, any>`","description":"Extra arguments to pass to the remoteFetchData callback","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"entity","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"args","type":"`Record<string, any>`","description":"Extra arguments to pass to the remoteFetchData callback","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="JoinerServiceConfiLine truncated
|
||||
Reference in new issue
Block a user