docs: add additional data description in generated references (#10944)
This commit is contained in:
1 parent
1b86c17b72
commit
2a2b387bc3
917 files changed
+15807
-15158
No files matched your search
+1
-1
@@ -61,7 +61,7 @@ const [countries, count] =
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableRegionCountryProps](../../../interfaces/region.FilterableRegionCountryProps/page.mdx)","description":"The filters to apply on the retrieved countries.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableRegionCountryProps](../../../interfaces/region.FilterableRegionCountryProps/page.mdx) \\| [BaseFilterable](../../../interfaces/region.BaseFilterable/page.mdx)<[FilterableRegionCountryProps](../../../interfaces/region.FilterableRegionCountryProps/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":"([FilterableRegionCountryProps](../../../interfaces/region.FilterableRegionCountryProps/page.mdx) \\| [BaseFilterable](../../../interfaces/region.BaseFilterable/page.mdx)<[FilterableRegionCountryProps](../../../interfaces/region.FilterableRegionCountryProps/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":"([FilterableRegionCountryProps](../../../interfaces/region.FilterableRegionCountryProps/page.mdx) \\| [BaseFilterable](../../../interfaces/region.BaseFilterable/page.mdx)<[FilterableRegionCountryProps](../../../interfaces/region.FilterableRegionCountryProps/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":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the countries by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"iso_2","type":"`string` \\| `string`[]","description":"Filter countries by their ISO 2 code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"iso_3","type":"`string` \\| `string`[]","description":"Filter countries by their ISO 3 code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"num_code","type":"`string` \\| `string`[]","description":"Filter countries by their code number.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[]","description":"Filter countries by their name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"display_name","type":"`string` \\| `string`[]","description":"Filter countries by their display name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/region.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/region.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":"([FilterableRegionCountryProps](../../../interfaces/region.FilterableRegionCountryProps/page.mdx) \\| [BaseFilterable](../../../interfaces/region.BaseFilterable/page.mdx)<[FilterableRegionCountryProps](../../../interfaces/region.FilterableRegionCountryProps/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":"([FilterableRegionCountryProps](../../../interfaces/region.FilterableRegionCountryProps/page.mdx) \\| [BaseFilterable](../../../interfaces/region.BaseFilterable/page.mdx)<[FilterableRegionCountryProps](../../../interfaces/region.FilterableRegionCountryProps/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":"([FilterableRegionCountryProps](../../../interfaces/region.FilterableRegionCountryProps/page.mdx) \\| [BaseFilterable](../../../interfaces/region.BaseFilterable/page.mdx)<[FilterableRegionCountryProps](../../../interfaces/region.FilterableRegionCountryProps/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":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the countries by.","optional"Line truncated
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableRegionCountryProps](../../../interfaces/region.FilterableRegionCountryProps/page.mdx)","description":"The filters to apply on the retrieved countries.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableRegionCountryProps](../../../interfaces/region.FilterableRegionCountryProps/page.mdx) \\| [BaseFilterable](../../../interfaces/region.BaseFilterable/page.mdx)<[FilterableRegionCountryProps](../../../interfaces/region.FilterableRegionCountryProps/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":"([FilterableRegionCountryProps](../../../interfaces/region.FilterableRegionCountryProps/page.mdx) \\| [BaseFilterable](../../../interfaces/region.BaseFilterable/page.mdx)<[FilterableRegionCountryProps](../../../interfaces/region.FilterableRegionCountryProps/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":"([FilterableRegionCountryProps](../../../interfaces/region.FilterableRegionCountryProps/page.mdx) \\| [BaseFilterable](../../../interfaces/region.BaseFilterable/page.mdx)<[FilterableRegionCountryProps](../../../interfaces/region.FilterableRegionCountryProps/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":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the countries by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"iso_2","type":"`string` \\| `string`[]","description":"Filter countries by their ISO 2 code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"iso_3","type":"`string` \\| `string`[]","description":"Filter countries by their ISO 3 code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"num_code","type":"`string` \\| `string`[]","description":"Filter countries by their code number.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[]","description":"Filter countries by their name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"display_name","type":"`string` \\| `string`[]","description":"Filter countries by their display name.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableRegionCountryProps](../../../interfaces/region.FilterableRegionCountryProps/page.mdx) \\| [BaseFilterable](../../../interfaces/region.BaseFilterable/page.mdx)<[FilterableRegionCountryProps](../../../interfaces/region.FilterableRegionCountryProps/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":"([FilterableRegionCountryProps](../../../interfaces/region.FilterableRegionCountryProps/page.mdx) \\| [BaseFilterable](../../../interfaces/region.BaseFilterable/page.mdx)<[FilterableRegionCountryProps](../../../interfaces/region.FilterableRegionCountryProps/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":"([FilterableRegionCountryProps](../../../interfaces/region.FilterableRegionCountryProps/page.mdx) \\| [BaseFilterable](../../../interfaces/region.BaseFilterable/page.mdx)<[FilterableRegionCountryProps](../../../interfaces/region.FilterableRegionCountryProps/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":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the countries by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"iso_2","type":"`string` \\| `string`[]","description":"Filter countries by their ISO 2 code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"iso_3","type":"`string` \\| `string`[]","description":"Filter countries by their ISO 3 code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"num_code","type":"`string` \\| `string`[]","description":"Filter countries by their code number.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `stLine truncated
|
||||
|
||||
## Returns
|
||||
|
||||
|
||||
+1
-1
@@ -61,7 +61,7 @@ await regionModuleService.listAndCountRegions(
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableRegionProps](../../../interfaces/region.FilterableRegionProps/page.mdx)","description":"The filters to apply on the retrieved regions.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableRegionProps](../../../interfaces/region.FilterableRegionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/region.BaseFilterable/page.mdx)<[FilterableRegionProps](../../../interfaces/region.FilterableRegionProps/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":"([FilterableRegionProps](../../../interfaces/region.FilterableRegionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/region.BaseFilterable/page.mdx)<[FilterableRegionProps](../../../interfaces/region.FilterableRegionProps/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":"([FilterableRegionProps](../../../interfaces/region.FilterableRegionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/region.BaseFilterable/page.mdx)<[FilterableRegionProps](../../../interfaces/region.FilterableRegionProps/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 regions by name through this search term","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/region.OperatorMap/page.mdx)<string \\| string[]>","description":"The IDs to filter the regions by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| [OperatorMap](../../../types/region.OperatorMap/page.mdx)<string>","description":"Filter regions by their name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string` \\| [OperatorMap](../../../types/region.OperatorMap/page.mdx)<string>","description":"Filter regions by their currency code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>` \\| [OperatorMap](../../../types/region.OperatorMap/page.mdx)<Record<string, unknown>>","description":"Filter regions by their metadata.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[OperatorMap](../../../types/region.OperatorMap/page.mdx)<string>","description":"Filter regions by their creation date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"[OperatorMap](../../../types/region.OperatorMap/page.mdx)<string>","description":"Filter regions by their update date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/region.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/region.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":"([FilterableRegionProps](../../../interfaces/region.FilterableRegionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/region.BaseFilterable/page.mdx)<[FilterableRegionProps](../../../interfaces/region.FilterableRegionProps/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":"([FilterableRegionProps](../../../interfaces/region.FilterableRegionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/region.BaseFilterable/page.mdx)<[FilterableRegionProps](../../../interfaces/region.FilterableRegionProps/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":"([FilterableRegionProps](../../../interfaces/region.FilterableRegionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/region.BaseFilterable/page.mdxLine truncated
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableRegionProps](../../../interfaces/region.FilterableRegionProps/page.mdx)","description":"The filters to apply on the retrieved regions.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableRegionProps](../../../interfaces/region.FilterableRegionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/region.BaseFilterable/page.mdx)<[FilterableRegionProps](../../../interfaces/region.FilterableRegionProps/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":"([FilterableRegionProps](../../../interfaces/region.FilterableRegionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/region.BaseFilterable/page.mdx)<[FilterableRegionProps](../../../interfaces/region.FilterableRegionProps/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":"([FilterableRegionProps](../../../interfaces/region.FilterableRegionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/region.BaseFilterable/page.mdx)<[FilterableRegionProps](../../../interfaces/region.FilterableRegionProps/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 regions by name through this search term","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/region.OperatorMap/page.mdx)<string \\| string[]>","description":"The IDs to filter the regions by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| [OperatorMap](../../../types/region.OperatorMap/page.mdx)<string>","description":"Filter regions by their name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string` \\| [OperatorMap](../../../types/region.OperatorMap/page.mdx)<string>","description":"Filter regions by their currency code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>` \\| [OperatorMap](../../../types/region.OperatorMap/page.mdx)<Record<string, unknown>>","description":"Filter regions by their metadata.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[OperatorMap](../../../types/region.OperatorMap/page.mdx)<string>","description":"Filter regions by their creation date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"[OperatorMap](../../../types/region.OperatorMap/page.mdx)<string>","description":"Filter regions by their update date.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableRegionProps](../../../interfaces/region.FilterableRegionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/region.BaseFilterable/page.mdx)<[FilterableRegionProps](../../../interfaces/region.FilterableRegionProps/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":"([FilterableRegionProps](../../../interfaces/region.FilterableRegionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/region.BaseFilterable/page.mdx)<[FilterableRegionProps](../../../interfaces/region.FilterableRegionProps/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":"([FilterableRegionProps](../../../interfaces/region.FilterableRegionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/region.BaseFilterable/page.mdx)<[FilterableRegionProps](../../../interfaces/region.FilterableRegionProps/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 regions by name through this search term","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/region.OperatorMap/page.mdx)<string \\| string[]>","description":"The IDs to Line truncated
|
||||
|
||||
## Returns
|
||||
|
||||
|
||||
+1
-1
@@ -58,7 +58,7 @@ const countries = await regionModuleService.listCountries(
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableRegionCountryProps](../../../interfaces/region.FilterableRegionCountryProps/page.mdx)","description":"The filters to apply on the retrieved countries.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableRegionCountryProps](../../../interfaces/region.FilterableRegionCountryProps/page.mdx) \\| [BaseFilterable](../../../interfaces/region.BaseFilterable/page.mdx)<[FilterableRegionCountryProps](../../../interfaces/region.FilterableRegionCountryProps/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":"([FilterableRegionCountryProps](../../../interfaces/region.FilterableRegionCountryProps/page.mdx) \\| [BaseFilterable](../../../interfaces/region.BaseFilterable/page.mdx)<[FilterableRegionCountryProps](../../../interfaces/region.FilterableRegionCountryProps/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":"([FilterableRegionCountryProps](../../../interfaces/region.FilterableRegionCountryProps/page.mdx) \\| [BaseFilterable](../../../interfaces/region.BaseFilterable/page.mdx)<[FilterableRegionCountryProps](../../../interfaces/region.FilterableRegionCountryProps/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":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the countries by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"iso_2","type":"`string` \\| `string`[]","description":"Filter countries by their ISO 2 code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"iso_3","type":"`string` \\| `string`[]","description":"Filter countries by their ISO 3 code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"num_code","type":"`string` \\| `string`[]","description":"Filter countries by their code number.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[]","description":"Filter countries by their name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"display_name","type":"`string` \\| `string`[]","description":"Filter countries by their display name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/region.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/region.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":"([FilterableRegionCountryProps](../../../interfaces/region.FilterableRegionCountryProps/page.mdx) \\| [BaseFilterable](../../../interfaces/region.BaseFilterable/page.mdx)<[FilterableRegionCountryProps](../../../interfaces/region.FilterableRegionCountryProps/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":"([FilterableRegionCountryProps](../../../interfaces/region.FilterableRegionCountryProps/page.mdx) \\| [BaseFilterable](../../../interfaces/region.BaseFilterable/page.mdx)<[FilterableRegionCountryProps](../../../interfaces/region.FilterableRegionCountryProps/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":"([FilterableRegionCountryProps](../../../interfaces/region.FilterableRegionCountryProps/page.mdx) \\| [BaseFilterable](../../../interfaces/region.BaseFilterable/page.mdx)<[FilterableRegionCountryProps](../../../interfaces/region.FilterableRegionCountryProps/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":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the countries by.","optional"Line truncated
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableRegionCountryProps](../../../interfaces/region.FilterableRegionCountryProps/page.mdx)","description":"The filters to apply on the retrieved countries.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableRegionCountryProps](../../../interfaces/region.FilterableRegionCountryProps/page.mdx) \\| [BaseFilterable](../../../interfaces/region.BaseFilterable/page.mdx)<[FilterableRegionCountryProps](../../../interfaces/region.FilterableRegionCountryProps/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":"([FilterableRegionCountryProps](../../../interfaces/region.FilterableRegionCountryProps/page.mdx) \\| [BaseFilterable](../../../interfaces/region.BaseFilterable/page.mdx)<[FilterableRegionCountryProps](../../../interfaces/region.FilterableRegionCountryProps/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":"([FilterableRegionCountryProps](../../../interfaces/region.FilterableRegionCountryProps/page.mdx) \\| [BaseFilterable](../../../interfaces/region.BaseFilterable/page.mdx)<[FilterableRegionCountryProps](../../../interfaces/region.FilterableRegionCountryProps/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":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the countries by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"iso_2","type":"`string` \\| `string`[]","description":"Filter countries by their ISO 2 code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"iso_3","type":"`string` \\| `string`[]","description":"Filter countries by their ISO 3 code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"num_code","type":"`string` \\| `string`[]","description":"Filter countries by their code number.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[]","description":"Filter countries by their name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"display_name","type":"`string` \\| `string`[]","description":"Filter countries by their display name.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableRegionCountryProps](../../../interfaces/region.FilterableRegionCountryProps/page.mdx) \\| [BaseFilterable](../../../interfaces/region.BaseFilterable/page.mdx)<[FilterableRegionCountryProps](../../../interfaces/region.FilterableRegionCountryProps/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":"([FilterableRegionCountryProps](../../../interfaces/region.FilterableRegionCountryProps/page.mdx) \\| [BaseFilterable](../../../interfaces/region.BaseFilterable/page.mdx)<[FilterableRegionCountryProps](../../../interfaces/region.FilterableRegionCountryProps/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":"([FilterableRegionCountryProps](../../../interfaces/region.FilterableRegionCountryProps/page.mdx) \\| [BaseFilterable](../../../interfaces/region.BaseFilterable/page.mdx)<[FilterableRegionCountryProps](../../../interfaces/region.FilterableRegionCountryProps/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":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the countries by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"iso_2","type":"`string` \\| `string`[]","description":"Filter countries by their ISO 2 code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"iso_3","type":"`string` \\| `string`[]","description":"Filter countries by their ISO 3 code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"num_code","type":"`string` \\| `string`[]","description":"Filter countries by their code number.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `stLine truncated
|
||||
|
||||
## Returns
|
||||
|
||||
|
||||
+1
-1
@@ -58,7 +58,7 @@ const regions = await regionModuleService.listRegions(
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableRegionProps](../../../interfaces/region.FilterableRegionProps/page.mdx)","description":"The filters to apply on the retrieved regions.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableRegionProps](../../../interfaces/region.FilterableRegionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/region.BaseFilterable/page.mdx)<[FilterableRegionProps](../../../interfaces/region.FilterableRegionProps/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":"([FilterableRegionProps](../../../interfaces/region.FilterableRegionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/region.BaseFilterable/page.mdx)<[FilterableRegionProps](../../../interfaces/region.FilterableRegionProps/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":"([FilterableRegionProps](../../../interfaces/region.FilterableRegionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/region.BaseFilterable/page.mdx)<[FilterableRegionProps](../../../interfaces/region.FilterableRegionProps/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 regions by name through this search term","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/region.OperatorMap/page.mdx)<string \\| string[]>","description":"The IDs to filter the regions by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| [OperatorMap](../../../types/region.OperatorMap/page.mdx)<string>","description":"Filter regions by their name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string` \\| [OperatorMap](../../../types/region.OperatorMap/page.mdx)<string>","description":"Filter regions by their currency code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>` \\| [OperatorMap](../../../types/region.OperatorMap/page.mdx)<Record<string, unknown>>","description":"Filter regions by their metadata.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[OperatorMap](../../../types/region.OperatorMap/page.mdx)<string>","description":"Filter regions by their creation date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"[OperatorMap](../../../types/region.OperatorMap/page.mdx)<string>","description":"Filter regions by their update date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/region.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/region.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":"([FilterableRegionProps](../../../interfaces/region.FilterableRegionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/region.BaseFilterable/page.mdx)<[FilterableRegionProps](../../../interfaces/region.FilterableRegionProps/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":"([FilterableRegionProps](../../../interfaces/region.FilterableRegionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/region.BaseFilterable/page.mdx)<[FilterableRegionProps](../../../interfaces/region.FilterableRegionProps/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":"([FilterableRegionProps](../../../interfaces/region.FilterableRegionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/region.BaseFilterable/page.mdxLine truncated
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableRegionProps](../../../interfaces/region.FilterableRegionProps/page.mdx)","description":"The filters to apply on the retrieved regions.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableRegionProps](../../../interfaces/region.FilterableRegionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/region.BaseFilterable/page.mdx)<[FilterableRegionProps](../../../interfaces/region.FilterableRegionProps/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":"([FilterableRegionProps](../../../interfaces/region.FilterableRegionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/region.BaseFilterable/page.mdx)<[FilterableRegionProps](../../../interfaces/region.FilterableRegionProps/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":"([FilterableRegionProps](../../../interfaces/region.FilterableRegionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/region.BaseFilterable/page.mdx)<[FilterableRegionProps](../../../interfaces/region.FilterableRegionProps/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 regions by name through this search term","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/region.OperatorMap/page.mdx)<string \\| string[]>","description":"The IDs to filter the regions by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| [OperatorMap](../../../types/region.OperatorMap/page.mdx)<string>","description":"Filter regions by their name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string` \\| [OperatorMap](../../../types/region.OperatorMap/page.mdx)<string>","description":"Filter regions by their currency code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>` \\| [OperatorMap](../../../types/region.OperatorMap/page.mdx)<Record<string, unknown>>","description":"Filter regions by their metadata.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[OperatorMap](../../../types/region.OperatorMap/page.mdx)<string>","description":"Filter regions by their creation date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"[OperatorMap](../../../types/region.OperatorMap/page.mdx)<string>","description":"Filter regions by their update date.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableRegionProps](../../../interfaces/region.FilterableRegionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/region.BaseFilterable/page.mdx)<[FilterableRegionProps](../../../interfaces/region.FilterableRegionProps/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":"([FilterableRegionProps](../../../interfaces/region.FilterableRegionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/region.BaseFilterable/page.mdx)<[FilterableRegionProps](../../../interfaces/region.FilterableRegionProps/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":"([FilterableRegionProps](../../../interfaces/region.FilterableRegionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/region.BaseFilterable/page.mdx)<[FilterableRegionProps](../../../interfaces/region.FilterableRegionProps/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 regions by name through this search term","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/region.OperatorMap/page.mdx)<string \\| string[]>","description":"The IDs to Line truncated
|
||||
|
||||
## Returns
|
||||
|
||||
|
||||
+1
-1
@@ -55,7 +55,7 @@ const region = await regionModuleService.updateRegions(
|
||||
|
||||
### Parameters
|
||||
|
||||
<TypeList types={[{"name":"selector","type":"[FilterableRegionProps](../../../interfaces/region.FilterableRegionProps/page.mdx)","description":"The filters to apply on the retrieved regions.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableRegionProps](../../../interfaces/region.FilterableRegionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/region.BaseFilterable/page.mdx)<[FilterableRegionProps](../../../interfaces/region.FilterableRegionProps/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":"([FilterableRegionProps](../../../interfaces/region.FilterableRegionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/region.BaseFilterable/page.mdx)<[FilterableRegionProps](../../../interfaces/region.FilterableRegionProps/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":"([FilterableRegionProps](../../../interfaces/region.FilterableRegionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/region.BaseFilterable/page.mdx)<[FilterableRegionProps](../../../interfaces/region.FilterableRegionProps/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 regions by name through this search term","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/region.OperatorMap/page.mdx)<string \\| string[]>","description":"The IDs to filter the regions by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| [OperatorMap](../../../types/region.OperatorMap/page.mdx)<string>","description":"Filter regions by their name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string` \\| [OperatorMap](../../../types/region.OperatorMap/page.mdx)<string>","description":"Filter regions by their currency code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>` \\| [OperatorMap](../../../types/region.OperatorMap/page.mdx)<Record<string, unknown>>","description":"Filter regions by their metadata.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[OperatorMap](../../../types/region.OperatorMap/page.mdx)<string>","description":"Filter regions by their creation date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"[OperatorMap](../../../types/region.OperatorMap/page.mdx)<string>","description":"Filter regions by their update date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/region.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/region.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":"([FilterableRegionProps](../../../interfaces/region.FilterableRegionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/region.BaseFilterable/page.mdx)<[FilterableRegionProps](../../../interfaces/region.FilterableRegionProps/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":"([FilterableRegionProps](../../../interfaces/region.FilterableRegionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/region.BaseFilterable/page.mdx)<[FilterableRegionProps](../../../interfaces/region.FilterableRegionProps/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":"([FilterableRegionProps](../../../interfaces/region.FilterableRegionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/region.BaseFilterable/page.mLine truncated
|
||||
<TypeList types={[{"name":"selector","type":"[FilterableRegionProps](../../../interfaces/region.FilterableRegionProps/page.mdx)","description":"The filters to apply on the retrieved regions.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableRegionProps](../../../interfaces/region.FilterableRegionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/region.BaseFilterable/page.mdx)<[FilterableRegionProps](../../../interfaces/region.FilterableRegionProps/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":"([FilterableRegionProps](../../../interfaces/region.FilterableRegionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/region.BaseFilterable/page.mdx)<[FilterableRegionProps](../../../interfaces/region.FilterableRegionProps/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":"([FilterableRegionProps](../../../interfaces/region.FilterableRegionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/region.BaseFilterable/page.mdx)<[FilterableRegionProps](../../../interfaces/region.FilterableRegionProps/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 regions by name through this search term","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/region.OperatorMap/page.mdx)<string \\| string[]>","description":"The IDs to filter the regions by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| [OperatorMap](../../../types/region.OperatorMap/page.mdx)<string>","description":"Filter regions by their name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string` \\| [OperatorMap](../../../types/region.OperatorMap/page.mdx)<string>","description":"Filter regions by their currency code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>` \\| [OperatorMap](../../../types/region.OperatorMap/page.mdx)<Record<string, unknown>>","description":"Filter regions by their metadata.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[OperatorMap](../../../types/region.OperatorMap/page.mdx)<string>","description":"Filter regions by their creation date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"[OperatorMap](../../../types/region.OperatorMap/page.mdx)<string>","description":"Filter regions by their update date.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableRegionProps](../../../interfaces/region.FilterableRegionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/region.BaseFilterable/page.mdx)<[FilterableRegionProps](../../../interfaces/region.FilterableRegionProps/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":"([FilterableRegionProps](../../../interfaces/region.FilterableRegionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/region.BaseFilterable/page.mdx)<[FilterableRegionProps](../../../interfaces/region.FilterableRegionProps/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":"([FilterableRegionProps](../../../interfaces/region.FilterableRegionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/region.BaseFilterable/page.mdx)<[FilterableRegionProps](../../../interfaces/region.FilterableRegionProps/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 regions by name through this search term","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/region.OperatorMap/page.mdx)<string \\| string[]>","description":"The IDs tLine truncated
|
||||
|
||||
### Returns
|
||||
|
||||
|
||||
Reference in new issue
Block a user