chore(docs): generate references following latest workflows reference changes (#10943)
This commit is contained in:
1 parent
1758bfb8d0
commit
d9ea65dfc4
1148 files changed
+314257
-167753
No files matched your search
+1
-1
@@ -46,7 +46,7 @@ const [stores, count] = await storeModuleService.listAndCountStores(
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx)","description":"The filters to apply on the retrieved stores.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx) \\| [BaseFilterable](../../../interfaces/store.BaseFilterable/page.mdx)<[FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/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":"([FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx) \\| [BaseFilterable](../../../interfaces/store.BaseFilterable/page.mdx)<[FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/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":"([FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx) \\| [BaseFilterable](../../../interfaces/store.BaseFilterable/page.mdx)<[FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/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 stores by name through this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the stores by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[]","description":"Filter stores by their names.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"default_sales_channel_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/store.OperatorMap/page.mdx)<string \\| string[]>","description":"Filter stores by their associated default sales channel's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/store.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/store.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":"([FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx) \\| [BaseFilterable](../../../interfaces/store.BaseFilterable/page.mdx)<[FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/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":"([FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx) \\| [BaseFilterable](../../../interfaces/store.BaseFilterable/page.mdx)<[FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/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":"([FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx) \\| [BaseFilterable](../../../interfaces/store.BaseFilterable/page.mdx)<[FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/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 stores by name through this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the stores by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[]","description":"Filter stores by their names.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"default_sales_channel_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../..Line truncated
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx)","description":"The filters to apply on the retrieved stores.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx) \\| [BaseFilterable](../../../interfaces/store.BaseFilterable/page.mdx)<[FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/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":"([FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx) \\| [BaseFilterable](../../../interfaces/store.BaseFilterable/page.mdx)<[FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/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":"([FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx) \\| [BaseFilterable](../../../interfaces/store.BaseFilterable/page.mdx)<[FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/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 stores by name through this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the stores by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[]","description":"Filter stores by their names.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"default_sales_channel_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/store.OperatorMap/page.mdx)<string \\| string[]>","description":"Filter stores by their associated default sales channel's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/store.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/store.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":"([FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx) \\| [BaseFilterable](../../../interfaces/store.BaseFilterable/page.mdx)<[FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/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":"([FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx) \\| [BaseFilterable](../../../interfaces/store.BaseFilterable/page.mdx)<[FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/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":"([FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx) \\| [BaseFilterable](../../../interfaces/store.BaseFilterable/page.mdx)<[FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/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 stores by name through this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the stores by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[]","description":"Filter stores by their names.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"default_sales_channel_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../..Line truncated
|
||||
|
||||
## Returns
|
||||
|
||||
|
||||
+1
-1
@@ -44,7 +44,7 @@ const stores = await storeModuleService.listStores(
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx)","description":"The filters to apply on the retrieved stores.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx) \\| [BaseFilterable](../../../interfaces/store.BaseFilterable/page.mdx)<[FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/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":"([FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx) \\| [BaseFilterable](../../../interfaces/store.BaseFilterable/page.mdx)<[FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/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":"([FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx) \\| [BaseFilterable](../../../interfaces/store.BaseFilterable/page.mdx)<[FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/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 stores by name through this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the stores by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[]","description":"Filter stores by their names.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"default_sales_channel_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/store.OperatorMap/page.mdx)<string \\| string[]>","description":"Filter stores by their associated default sales channel's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/store.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/store.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":"([FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx) \\| [BaseFilterable](../../../interfaces/store.BaseFilterable/page.mdx)<[FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/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":"([FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx) \\| [BaseFilterable](../../../interfaces/store.BaseFilterable/page.mdx)<[FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/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":"([FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx) \\| [BaseFilterable](../../../interfaces/store.BaseFilterable/page.mdx)<[FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/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 stores by name through this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the stores by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[]","description":"Filter stores by their names.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"default_sales_channel_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../..Line truncated
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx)","description":"The filters to apply on the retrieved stores.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx) \\| [BaseFilterable](../../../interfaces/store.BaseFilterable/page.mdx)<[FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/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":"([FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx) \\| [BaseFilterable](../../../interfaces/store.BaseFilterable/page.mdx)<[FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/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":"([FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx) \\| [BaseFilterable](../../../interfaces/store.BaseFilterable/page.mdx)<[FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/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 stores by name through this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the stores by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[]","description":"Filter stores by their names.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"default_sales_channel_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/store.OperatorMap/page.mdx)<string \\| string[]>","description":"Filter stores by their associated default sales channel's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/store.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/store.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":"([FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx) \\| [BaseFilterable](../../../interfaces/store.BaseFilterable/page.mdx)<[FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/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":"([FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx) \\| [BaseFilterable](../../../interfaces/store.BaseFilterable/page.mdx)<[FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/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":"([FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx) \\| [BaseFilterable](../../../interfaces/store.BaseFilterable/page.mdx)<[FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/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 stores by name through this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the stores by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[]","description":"Filter stores by their names.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"default_sales_channel_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../..Line truncated
|
||||
|
||||
## Returns
|
||||
|
||||
|
||||
+1
-1
@@ -54,7 +54,7 @@ const store = await storeModuleService.updateStores(
|
||||
|
||||
### Parameters
|
||||
|
||||
<TypeList types={[{"name":"selector","type":"[FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx)","description":"The filters specifying which stores to update.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx) \\| [BaseFilterable](../../../interfaces/store.BaseFilterable/page.mdx)<[FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/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":"([FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx) \\| [BaseFilterable](../../../interfaces/store.BaseFilterable/page.mdx)<[FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/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":"([FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx) \\| [BaseFilterable](../../../interfaces/store.BaseFilterable/page.mdx)<[FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/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 stores by name through this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the stores by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[]","description":"Filter stores by their names.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"default_sales_channel_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/store.OperatorMap/page.mdx)<string \\| string[]>","description":"Filter stores by their associated default sales channel's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/store.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/store.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":"([FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx) \\| [BaseFilterable](../../../interfaces/store.BaseFilterable/page.mdx)<[FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/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":"([FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx) \\| [BaseFilterable](../../../interfaces/store.BaseFilterable/page.mdx)<[FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/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":"([FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx) \\| [BaseFilterable](../../../interfaces/store.BaseFilterable/page.mdx)<[FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/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 stores by name through this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the stores by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[]","description":"Filter stores by their names.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"default_sales_channel_id","type":"`string` \\| `string`[] \\| [OperatorMap](../..Line truncated
|
||||
<TypeList types={[{"name":"selector","type":"[FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx)","description":"The filters specifying which stores to update.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx) \\| [BaseFilterable](../../../interfaces/store.BaseFilterable/page.mdx)<[FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/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":"([FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx) \\| [BaseFilterable](../../../interfaces/store.BaseFilterable/page.mdx)<[FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/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":"([FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx) \\| [BaseFilterable](../../../interfaces/store.BaseFilterable/page.mdx)<[FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/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 stores by name through this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the stores by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[]","description":"Filter stores by their names.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"default_sales_channel_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/store.OperatorMap/page.mdx)<string \\| string[]>","description":"Filter stores by their associated default sales channel's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/store.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/store.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":"([FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx) \\| [BaseFilterable](../../../interfaces/store.BaseFilterable/page.mdx)<[FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/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":"([FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx) \\| [BaseFilterable](../../../interfaces/store.BaseFilterable/page.mdx)<[FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/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":"([FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx) \\| [BaseFilterable](../../../interfaces/store.BaseFilterable/page.mdx)<[FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/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 stores by name through this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the stores by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[]","description":"Filter stores by their names.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"default_sales_channel_id","type":"`string` \\| `string`[] \\| [OperatorMap](../..Line truncated
|
||||
|
||||
### Returns
|
||||
|
||||
|
||||
@@ -8,4 +8,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
The filters to apply on the retrieved stores.
|
||||
|
||||
<TypeList types={[{"name":"$and","type":"([FilterableStoreProps](./page.mdx) \\| [BaseFilterable](../store.BaseFilterable/page.mdx)<[FilterableStoreProps](./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":"([FilterableStoreProps](./page.mdx) \\| [BaseFilterable](../store.BaseFilterable/page.mdx)<[FilterableStoreProps](./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":"([FilterableStoreProps](./page.mdx) \\| [BaseFilterable](../store.BaseFilterable/page.mdx)<[FilterableStoreProps](./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":"([FilterableStoreProps](./page.mdx) \\| [BaseFilterable](../store.BaseFilterable/page.mdx)<[FilterableStoreProps](./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 stores by name through this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the stores by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[]","description":"Filter stores by their names.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"default_sales_channel_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../types/store.OperatorMap/page.mdx)<string \\| string[]>","description":"Filter stores by their associated default sales channel's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../store.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](../store.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":"([FilterableStoreProps](./page.mdx) \\| [BaseFilterable](../store.BaseFilterable/page.mdx)<[FilterableStoreProps](./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":"([FilterableStoreProps](./page.mdx) \\| [BaseFilterable](../store.BaseFilterable/page.mdx)<[FilterableStoreProps](./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":"([FilterableStoreProps](./page.mdx) \\| [BaseFilterable](../store.BaseFilterable/page.mdx)<[FilterableStoreProps](./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 stores by name through this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the stores by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[]","description":"Filter stores by their names.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"default_sales_channel_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../types/store.OperatorMap/page.mdx)<string \\| string[]>","description":"Filter stores by their associated default sales channel's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../store.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](../store.BaseFilterablLine truncated
|
||||
<TypeList types={[{"name":"$and","type":"([FilterableStoreProps](./page.mdx) \\| [BaseFilterable](../store.BaseFilterable/page.mdx)<[FilterableStoreProps](./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":"([FilterableStoreProps](./page.mdx) \\| [BaseFilterable](../store.BaseFilterable/page.mdx)<[FilterableStoreProps](./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":"([FilterableStoreProps](./page.mdx) \\| [BaseFilterable](../store.BaseFilterable/page.mdx)<[FilterableStoreProps](./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":"([FilterableStoreProps](./page.mdx) \\| [BaseFilterable](../store.BaseFilterable/page.mdx)<[FilterableStoreProps](./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 stores by name through this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the stores by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[]","description":"Filter stores by their names.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"default_sales_channel_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../types/store.OperatorMap/page.mdx)<string \\| string[]>","description":"Filter stores by their associated default sales channel's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../store.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](../store.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":"([FilterableStoreProps](./page.mdx) \\| [BaseFilterable](../store.BaseFilterable/page.mdx)<[FilterableStoreProps](./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":"([FilterableStoreProps](./page.mdx) \\| [BaseFilterable](../store.BaseFilterable/page.mdx)<[FilterableStoreProps](./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":"([FilterableStoreProps](./page.mdx) \\| [BaseFilterable](../store.BaseFilterable/page.mdx)<[FilterableStoreProps](./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 stores by name through this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the stores by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[]","description":"Filter stores by their names.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"default_sales_channel_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../types/store.OperatorMap/page.mdx)<string \\| string[]>","description":"Filter stores by their associated default sales channel's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../store.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](../store.BaseFilterablLine truncated
|
||||
@@ -8,4 +8,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
**OperatorMap**: `Object`
|
||||
|
||||
<TypeList types={[{"name":"$and","type":"[Query](../store.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"[Query](../store.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"[ExpandScalar](../store.ExpandScalar/page.mdx)<T> \\| [ExpandScalar](../store.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"[ExpandScalar](../store.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"[ExpandScalar](../store.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"[ExpandScalar](../store.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$not","type":"[Query](../store.Query/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gt","type":"[ExpandScalar](../store.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gte","type":"[ExpandScalar](../store.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lt","type":"[ExpandScalar](../store.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lte","type":"[ExpandScalar](../store.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$like","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$re","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ilike","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$fulltext","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$overlap","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contains","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contained","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$exists","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="OperatorMap"/>
|
||||
<TypeList types={[{"name":"$and","type":"[Query](../store.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"[Query](../store.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"[ExpandScalar](../store.ExpandScalar/page.mdx)<T> \\| [ExpandScalar](../store.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"[ExpandScalar](../store.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"[ExpandScalar](../store.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"[ExpandScalar](../store.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$not","type":"[Query](../store.Query/page.mdx)<T>","description":"API wrapper around the remoteQuery","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gt","type":"[ExpandScalar](../store.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gte","type":"[ExpandScalar](../store.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lt","type":"[ExpandScalar](../store.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lte","type":"[ExpandScalar](../store.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$like","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$re","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ilike","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$fulltext","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$overlap","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contains","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contained","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$exists","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="OperatorMap"/>
|
||||
Reference in new issue
Block a user