chore(docs): Generated References (#8461)
Generated the following references: - `medusa` - `modules` - `types`
This commit is contained in:
github-actions[bot] authored and 
GitHub committed
1 parent
caf1bfd23b
commit
413e29837c
19 files changed
+20264
-20088
No files matched your search
+37
@@ -0,0 +1,37 @@
|
||||
---
|
||||
slug: /references/helper-steps/emitEventStep
|
||||
sidebar_label: emitEventStep
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# emitEventStep - Helper Steps API Reference
|
||||
|
||||
This documentation provides a reference to the `emitEventStep` step. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
## Example
|
||||
|
||||
```ts
|
||||
import {
|
||||
createWorkflow
|
||||
} from "@medusajs/workflows-sdk"
|
||||
import {
|
||||
emitEventStep
|
||||
} from "@medusajs/core-flows"
|
||||
|
||||
const helloWorldWorkflow = createWorkflow(
|
||||
"hello-world",
|
||||
() => {
|
||||
emitEventStep({
|
||||
eventName: "custom.created",
|
||||
data: {
|
||||
id: "123"
|
||||
}
|
||||
})
|
||||
}
|
||||
)
|
||||
```
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"Input","type":"`Input`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} sectionTitle="emitEventStep"/>
|
||||
+1
-1
@@ -8,4 +8,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"validatedBody","type":"Body","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"validatedQuery","type":"[RequestQueryFields](../medusa.RequestQueryFields/page.mdx) & `Record<string, unknown>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"expand","type":"`string`","description":"Comma-separated relations that should be expanded in the returned data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fields","type":"`string`","description":"Comma-separated fields that should be included in the returned data.\nif a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.\nwithout prefix it will replace the entire default fields.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip when retrieving a list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"Limit the number of items returned in the list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`string`","description":"The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"allowedProperties","type":"`string`[]","description":"TODO: shouldn't this correspond to returnable fields instead of allowed fields? also it is used by the cleanResponseData util","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"listConfig","type":"[FindConfig](../medusa.FindConfig-1/page.mdx)<unknown>","description":"An object containing the select, relation, skip, take and order to be used with medusa internal services","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"select","type":"keyof Entity[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"skip","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relations","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"retrieveConfig","type":"[FindConfig](../medusa.FindConfig-1/page.mdx)<unknown>","description":"An object containing the select, relation to be used with medusa internal services","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"select","type":"keyof Entity[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"skip","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relations","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"remoteQueryConfig","type":"`object`","description":"An object containing fields and variables to be used with the remoteQuery","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"pagination","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"filterableFields","type":"`Record<string, unknown>`","description":"An object containing the fields that are filterable e.g `{ id: Any<String> }`","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"errors","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"scope","type":"[MedusaContainer](../../types/medusa.MedusaContainer/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"auth_context","type":"[AuthContext](../medusa.AuthContext/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"actor_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"actor_type","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"auth_identity_id","type":"`string`","description":"","optional":false,"defaultValue":"Line truncated
|
||||
<TypeList types={[{"name":"validatedBody","type":"Body","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"validatedQuery","type":"[RequestQueryFields](../medusa.RequestQueryFields/page.mdx) & `Record<string, unknown>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"expand","type":"`string`","description":"Comma-separated relations that should be expanded in the returned data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fields","type":"`string`","description":"Comma-separated fields that should be included in the returned data.\nif a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.\nwithout prefix it will replace the entire default fields.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip when retrieving a list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"Limit the number of items returned in the list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`string`","description":"The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"allowedProperties","type":"`string`[]","description":"TODO: shouldn't this correspond to returnable fields instead of allowed fields? also it is used by the cleanResponseData util","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"listConfig","type":"[FindConfig](../medusa.FindConfig-1/page.mdx)<unknown>","description":"An object containing the select, relation, skip, take and order to be used with medusa internal services","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"select","type":"keyof Entity[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"skip","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relations","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"retrieveConfig","type":"[FindConfig](../medusa.FindConfig-1/page.mdx)<unknown>","description":"An object containing the select, relation to be used with medusa internal services","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"select","type":"keyof Entity[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"skip","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relations","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"remoteQueryConfig","type":"`object`","description":"An object containing fields and variables to be used with the remoteQuery","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"pagination","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"filterableFields","type":"`Record<string, unknown>`","description":"An object containing the fields that are filterable e.g `{ id: Any<String> }`","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"errors","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"scope","type":"[MedusaContainer](../../types/medusa.MedusaContainer/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"auth_context","type":"[AuthContext](../medusa.AuthContext/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"actor_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"actor_type","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"auth_identity_id","type":"`string`","description":"","optional":false,"defaultValue":"Line truncated
|
||||
@@ -8,4 +8,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"validatedBody","type":"Body","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"validatedQuery","type":"[RequestQueryFields](../medusa.RequestQueryFields/page.mdx) & `Record<string, unknown>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"expand","type":"`string`","description":"Comma-separated relations that should be expanded in the returned data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fields","type":"`string`","description":"Comma-separated fields that should be included in the returned data.\nif a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.\nwithout prefix it will replace the entire default fields.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip when retrieving a list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"Limit the number of items returned in the list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`string`","description":"The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"allowedProperties","type":"`string`[]","description":"TODO: shouldn't this correspond to returnable fields instead of allowed fields? also it is used by the cleanResponseData util","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"listConfig","type":"[FindConfig](../medusa.FindConfig-1/page.mdx)<unknown>","description":"An object containing the select, relation, skip, take and order to be used with medusa internal services","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"select","type":"keyof Entity[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"skip","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relations","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"retrieveConfig","type":"[FindConfig](../medusa.FindConfig-1/page.mdx)<unknown>","description":"An object containing the select, relation to be used with medusa internal services","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"select","type":"keyof Entity[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"skip","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relations","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"remoteQueryConfig","type":"`object`","description":"An object containing fields and variables to be used with the remoteQuery","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"pagination","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"filterableFields","type":"`Record<string, unknown>`","description":"An object containing the fields that are filterable e.g `{ id: Any<String> }`","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"errors","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"scope","type":"[MedusaContainer](../../types/medusa.MedusaContainer/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"user","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"customer_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"userId","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"includes","type":"`Record<string, boolean>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"nLine truncated
|
||||
<TypeList types={[{"name":"validatedBody","type":"Body","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"validatedQuery","type":"[RequestQueryFields](../medusa.RequestQueryFields/page.mdx) & `Record<string, unknown>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"expand","type":"`string`","description":"Comma-separated relations that should be expanded in the returned data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fields","type":"`string`","description":"Comma-separated fields that should be included in the returned data.\nif a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.\nwithout prefix it will replace the entire default fields.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip when retrieving a list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"Limit the number of items returned in the list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`string`","description":"The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"allowedProperties","type":"`string`[]","description":"TODO: shouldn't this correspond to returnable fields instead of allowed fields? also it is used by the cleanResponseData util","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"listConfig","type":"[FindConfig](../medusa.FindConfig-1/page.mdx)<unknown>","description":"An object containing the select, relation, skip, take and order to be used with medusa internal services","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"select","type":"keyof Entity[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"skip","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relations","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"retrieveConfig","type":"[FindConfig](../medusa.FindConfig-1/page.mdx)<unknown>","description":"An object containing the select, relation to be used with medusa internal services","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"select","type":"keyof Entity[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"skip","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relations","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"remoteQueryConfig","type":"`object`","description":"An object containing fields and variables to be used with the remoteQuery","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"pagination","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"filterableFields","type":"`Record<string, unknown>`","description":"An object containing the fields that are filterable e.g `{ id: Any<String> }`","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"errors","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"scope","type":"[MedusaContainer](../../types/medusa.MedusaContainer/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"user","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"customer_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"userId","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"includes","type":"`Record<string, boolean>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"nLine truncated
|
||||
@@ -8,4 +8,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"validatedBody","type":"Body","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"validatedQuery","type":"[RequestQueryFields](../medusa.RequestQueryFields/page.mdx) & `Record<string, unknown>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"expand","type":"`string`","description":"Comma-separated relations that should be expanded in the returned data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fields","type":"`string`","description":"Comma-separated fields that should be included in the returned data.\nif a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.\nwithout prefix it will replace the entire default fields.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip when retrieving a list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"Limit the number of items returned in the list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`string`","description":"The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"allowedProperties","type":"`string`[]","description":"TODO: shouldn't this correspond to returnable fields instead of allowed fields? also it is used by the cleanResponseData util","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"listConfig","type":"[FindConfig](../medusa.FindConfig/page.mdx)<unknown>","description":"An object containing the select, relation, skip, take and order to be used with medusa internal services","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"select","type":"keyof Entity[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"skip","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relations","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"retrieveConfig","type":"[FindConfig](../medusa.FindConfig/page.mdx)<unknown>","description":"An object containing the select, relation to be used with medusa internal services","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"select","type":"keyof Entity[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"skip","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relations","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"remoteQueryConfig","type":"`object`","description":"An object containing fields and variables to be used with the remoteQuery","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"pagination","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"filterableFields","type":"`Record<string, unknown>`","description":"An object containing the fields that are filterable e.g `{ id: Any<String> }`","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"errors","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"scope","type":"[MedusaContainer](../../types/medusa.MedusaContainer-1/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes","type":"`Record<string, boolean>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"allowedFields","type":"`string`[]","description":"An array of fields and relations that are allowed to be queried, this can be set by the\nconsumer as part of a middleware and it will take precedence over the defaultAllowedFields","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"allowed","type":"`string`[]","description":"An arrLine truncated
|
||||
<TypeList types={[{"name":"validatedBody","type":"Body","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"validatedQuery","type":"[RequestQueryFields](../medusa.RequestQueryFields/page.mdx) & `Record<string, unknown>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"expand","type":"`string`","description":"Comma-separated relations that should be expanded in the returned data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fields","type":"`string`","description":"Comma-separated fields that should be included in the returned data.\nif a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.\nwithout prefix it will replace the entire default fields.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip when retrieving a list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"Limit the number of items returned in the list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`string`","description":"The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"allowedProperties","type":"`string`[]","description":"TODO: shouldn't this correspond to returnable fields instead of allowed fields? also it is used by the cleanResponseData util","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"listConfig","type":"[FindConfig](../medusa.FindConfig/page.mdx)<unknown>","description":"An object containing the select, relation, skip, take and order to be used with medusa internal services","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"select","type":"keyof Entity[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"skip","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relations","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"retrieveConfig","type":"[FindConfig](../medusa.FindConfig/page.mdx)<unknown>","description":"An object containing the select, relation to be used with medusa internal services","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"select","type":"keyof Entity[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"skip","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relations","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"remoteQueryConfig","type":"`object`","description":"An object containing fields and variables to be used with the remoteQuery","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"pagination","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"filterableFields","type":"`Record<string, unknown>`","description":"An object containing the fields that are filterable e.g `{ id: Any<String> }`","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"errors","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"scope","type":"[MedusaContainer](../../types/medusa.MedusaContainer-1/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes","type":"`Record<string, boolean>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"allowedFields","type":"`string`[]","description":"An array of fields and relations that are allowed to be queried, this can be set by the\nconsumer as part of a middleware and it will take precedence over the defaultAllowedFields","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"allowed","type":"`string`[]","description":"An arrLine truncated
|
||||
+1
-1
@@ -8,7 +8,7 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
### Parameters
|
||||
|
||||
<TypeList types={[{"name":"error","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"req","type":"[MedusaRequest](../../interfaces/medusa.MedusaRequest/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"validatedBody","type":"Body","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"validatedQuery","type":"[RequestQueryFields](../../interfaces/medusa.RequestQueryFields/page.mdx) & `Record<string, unknown>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"allowedProperties","type":"`string`[]","description":"TODO: shouldn't this correspond to returnable fields instead of allowed fields? also it is used by the cleanResponseData util","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"listConfig","type":"[FindConfig](../../interfaces/medusa.FindConfig/page.mdx)<unknown>","description":"An object containing the select, relation, skip, take and order to be used with medusa internal services","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"retrieveConfig","type":"[FindConfig](../../interfaces/medusa.FindConfig/page.mdx)<unknown>","description":"An object containing the select, relation to be used with medusa internal services","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"remoteQueryConfig","type":"`object`","description":"An object containing fields and variables to be used with the remoteQuery","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"filterableFields","type":"`Record<string, unknown>`","description":"An object containing the fields that are filterable e.g `{ id: Any<String> }`","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"errors","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"scope","type":"[MedusaContainer](../medusa.MedusaContainer-1/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes","type":"`Record<string, boolean>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"allowedFields","type":"`string`[]","description":"An array of fields and relations that are allowed to be queried, this can be set by the\nconsumer as part of a middleware and it will take precedence over the defaultAllowedFields","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"allowed","type":"`string`[]","description":"An array of fields and relations that are allowed to be queried, this can be set by the\nconsumer as part of a middleware and it will take precedence over the defaultAllowedFields set\nby the api","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"session","type":"`any`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rawBody","type":"`any`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"pricingContext","type":"[MedusaPricingContext](../medusa.MedusaPricingContext/page.mdx)","description":"An object that carries the context that is used to calculate prices for variants","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"`Record<string, any>`","description":"A generic context object that can be used across the request lifecycle","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"extendedValidators","type":"`object`","description":"Custom validators for the request body and query params that will be\nmerged with the original validator of the route.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"user","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"res","type":"[MedusaResponse](../medusa.MedusaResponse/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"next","type":"[MedusaNextFunction](../medusa.MedusaNextFunction/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records" sectionTitle="__type"/>
|
||||
<TypeList types={[{"name":"error","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"req","type":"[MedusaRequest](../../interfaces/medusa.MedusaRequest/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"validatedBody","type":"Body","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"validatedQuery","type":"[RequestQueryFields](../../interfaces/medusa.RequestQueryFields/page.mdx) & `Record<string, unknown>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"allowedProperties","type":"`string`[]","description":"TODO: shouldn't this correspond to returnable fields instead of allowed fields? also it is used by the cleanResponseData util","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"listConfig","type":"[FindConfig](../../interfaces/medusa.FindConfig/page.mdx)<unknown>","description":"An object containing the select, relation, skip, take and order to be used with medusa internal services","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"retrieveConfig","type":"[FindConfig](../../interfaces/medusa.FindConfig/page.mdx)<unknown>","description":"An object containing the select, relation to be used with medusa internal services","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"remoteQueryConfig","type":"`object`","description":"An object containing fields and variables to be used with the remoteQuery","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"filterableFields","type":"`Record<string, unknown>`","description":"An object containing the fields that are filterable e.g `{ id: Any<String> }`","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"errors","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"scope","type":"[MedusaContainer](../medusa.MedusaContainer-1/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes","type":"`Record<string, boolean>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"allowedFields","type":"`string`[]","description":"An array of fields and relations that are allowed to be queried, this can be set by the\nconsumer as part of a middleware and it will take precedence over the defaultAllowedFields","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"allowed","type":"`string`[]","description":"An array of fields and relations that are allowed to be queried, this can be set by the\nconsumer as part of a middleware and it will take precedence over the defaultAllowedFields set\nby the api","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"session","type":"`any`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rawBody","type":"`any`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"pricingContext","type":"[MedusaPricingContext](../medusa.MedusaPricingContext/page.mdx)","description":"An object that carries the context that is used to calculate prices for variants","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"`Record<string, any>`","description":"A generic context object that can be used across the request lifecycle","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"additionalDataValidator","type":"ZodObject<any, any, ZodTypeAny, object, object>","description":"Custom validator to validate the `additional_data` property in\nrequests that allows for additional\\_data","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"user","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"res","type":"[MedusaResponse](../medusa.MedusaResponse/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"next","type":"[MedusaNextFunction](../medusa.MedusaNextFunction/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records" sectionTitle="__type"/>
|
||||
|
||||
### Returns
|
||||
|
||||
|
||||
@@ -12,7 +12,7 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
### Parameters
|
||||
|
||||
<TypeList types={[{"name":"req","type":"[MedusaRequest](../../interfaces/medusa.MedusaRequest-1/page.mdx)<Body>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"validatedBody","type":"Body","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"validatedQuery","type":"[RequestQueryFields](../../interfaces/medusa.RequestQueryFields/page.mdx) & `Record<string, unknown>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"allowedProperties","type":"`string`[]","description":"TODO: shouldn't this correspond to returnable fields instead of allowed fields? also it is used by the cleanResponseData util","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"listConfig","type":"[FindConfig](../../interfaces/medusa.FindConfig-1/page.mdx)<unknown>","description":"An object containing the select, relation, skip, take and order to be used with medusa internal services","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"retrieveConfig","type":"[FindConfig](../../interfaces/medusa.FindConfig-1/page.mdx)<unknown>","description":"An object containing the select, relation to be used with medusa internal services","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"remoteQueryConfig","type":"`object`","description":"An object containing fields and variables to be used with the remoteQuery","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"filterableFields","type":"`Record<string, unknown>`","description":"An object containing the fields that are filterable e.g `{ id: Any<String> }`","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"errors","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"scope","type":"[MedusaContainer](../medusa.MedusaContainer/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"user","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"includes","type":"`Record<string, boolean>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"allowedFields","type":"`string`[]","description":"An array of fields and relations that are allowed to be queried, this can be set by the\nconsumer as part of a middleware and it will take precedence over the defaultAllowedFields","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"allowed","type":"`string`[]","description":"An array of fields and relations that are allowed to be queried, this can be set by the\nconsumer as part of a middleware and it will take precedence over the defaultAllowedFields set\nby the api","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"session","type":"`any`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rawBody","type":"`any`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"pricingContext","type":"[MedusaPricingContext](../medusa.MedusaPricingContext/page.mdx)","description":"An object that carries the context that is used to calculate prices for variants","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"`Record<string, any>`","description":"A generic context object that can be used across the request lifecycle","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"extendedValidators","type":"`object`","description":"Custom validators for the request body and query params that will be\nmerged with the original validator of the route.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"res","type":"[MedusaResponse](../medusa.MedusaResponse-1/page.mdx)<Res>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"next","type":"[MedusaNextFunction](../medusa.MedusaNextFunction-1/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records" sectionTitle="__type"/>
|
||||
<TypeList types={[{"name":"req","type":"[MedusaRequest](../../interfaces/medusa.MedusaRequest-1/page.mdx)<Body>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"validatedBody","type":"Body","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"validatedQuery","type":"[RequestQueryFields](../../interfaces/medusa.RequestQueryFields/page.mdx) & `Record<string, unknown>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"allowedProperties","type":"`string`[]","description":"TODO: shouldn't this correspond to returnable fields instead of allowed fields? also it is used by the cleanResponseData util","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"listConfig","type":"[FindConfig](../../interfaces/medusa.FindConfig-1/page.mdx)<unknown>","description":"An object containing the select, relation, skip, take and order to be used with medusa internal services","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"retrieveConfig","type":"[FindConfig](../../interfaces/medusa.FindConfig-1/page.mdx)<unknown>","description":"An object containing the select, relation to be used with medusa internal services","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"remoteQueryConfig","type":"`object`","description":"An object containing fields and variables to be used with the remoteQuery","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"filterableFields","type":"`Record<string, unknown>`","description":"An object containing the fields that are filterable e.g `{ id: Any<String> }`","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"errors","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"scope","type":"[MedusaContainer](../medusa.MedusaContainer/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"user","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"includes","type":"`Record<string, boolean>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"allowedFields","type":"`string`[]","description":"An array of fields and relations that are allowed to be queried, this can be set by the\nconsumer as part of a middleware and it will take precedence over the defaultAllowedFields","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"allowed","type":"`string`[]","description":"An array of fields and relations that are allowed to be queried, this can be set by the\nconsumer as part of a middleware and it will take precedence over the defaultAllowedFields set\nby the api","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"session","type":"`any`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rawBody","type":"`any`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"pricingContext","type":"[MedusaPricingContext](../medusa.MedusaPricingContext/page.mdx)","description":"An object that carries the context that is used to calculate prices for variants","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"`Record<string, any>`","description":"A generic context object that can be used across the request lifecycle","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"additionalDataValidator","type":"ZodObject<any, any, ZodTypeAny, object, object>","description":"Custom validator to validate the `additional_data` property in\nrequests that allows for additional\\_data","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"res","type":"[MedusaResponse](../medusa.MedusaResponse-1/page.mdx)<Res>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"next","type":"[MedusaNextFunction](../medusa.MedusaNextFunction-1/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records" sectionTitle="__type"/>
|
||||
|
||||
### Returns
|
||||
|
||||
|
||||
@@ -12,7 +12,7 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
### Parameters
|
||||
|
||||
<TypeList types={[{"name":"req","type":"[MedusaRequest](../../interfaces/medusa.MedusaRequest/page.mdx)<Body>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"validatedBody","type":"Body","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"validatedQuery","type":"[RequestQueryFields](../../interfaces/medusa.RequestQueryFields/page.mdx) & `Record<string, unknown>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"allowedProperties","type":"`string`[]","description":"TODO: shouldn't this correspond to returnable fields instead of allowed fields? also it is used by the cleanResponseData util","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"listConfig","type":"[FindConfig](../../interfaces/medusa.FindConfig/page.mdx)<unknown>","description":"An object containing the select, relation, skip, take and order to be used with medusa internal services","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"retrieveConfig","type":"[FindConfig](../../interfaces/medusa.FindConfig/page.mdx)<unknown>","description":"An object containing the select, relation to be used with medusa internal services","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"remoteQueryConfig","type":"`object`","description":"An object containing fields and variables to be used with the remoteQuery","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"filterableFields","type":"`Record<string, unknown>`","description":"An object containing the fields that are filterable e.g `{ id: Any<String> }`","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"errors","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"scope","type":"[MedusaContainer](../medusa.MedusaContainer-1/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes","type":"`Record<string, boolean>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"allowedFields","type":"`string`[]","description":"An array of fields and relations that are allowed to be queried, this can be set by the\nconsumer as part of a middleware and it will take precedence over the defaultAllowedFields","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"allowed","type":"`string`[]","description":"An array of fields and relations that are allowed to be queried, this can be set by the\nconsumer as part of a middleware and it will take precedence over the defaultAllowedFields set\nby the api","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"session","type":"`any`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rawBody","type":"`any`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"pricingContext","type":"[MedusaPricingContext](../medusa.MedusaPricingContext/page.mdx)","description":"An object that carries the context that is used to calculate prices for variants","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"`Record<string, any>`","description":"A generic context object that can be used across the request lifecycle","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"extendedValidators","type":"`object`","description":"Custom validators for the request body and query params that will be\nmerged with the original validator of the route.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"user","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"res","type":"[MedusaResponse](../medusa.MedusaResponse/page.mdx)<Res>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"next","type":"[MedusaNextFunction](../medusa.MedusaNextFunction/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records" sectionTitle="__type"/>
|
||||
<TypeList types={[{"name":"req","type":"[MedusaRequest](../../interfaces/medusa.MedusaRequest/page.mdx)<Body>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"validatedBody","type":"Body","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"validatedQuery","type":"[RequestQueryFields](../../interfaces/medusa.RequestQueryFields/page.mdx) & `Record<string, unknown>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"allowedProperties","type":"`string`[]","description":"TODO: shouldn't this correspond to returnable fields instead of allowed fields? also it is used by the cleanResponseData util","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"listConfig","type":"[FindConfig](../../interfaces/medusa.FindConfig/page.mdx)<unknown>","description":"An object containing the select, relation, skip, take and order to be used with medusa internal services","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"retrieveConfig","type":"[FindConfig](../../interfaces/medusa.FindConfig/page.mdx)<unknown>","description":"An object containing the select, relation to be used with medusa internal services","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"remoteQueryConfig","type":"`object`","description":"An object containing fields and variables to be used with the remoteQuery","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"filterableFields","type":"`Record<string, unknown>`","description":"An object containing the fields that are filterable e.g `{ id: Any<String> }`","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"errors","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"scope","type":"[MedusaContainer](../medusa.MedusaContainer-1/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes","type":"`Record<string, boolean>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"allowedFields","type":"`string`[]","description":"An array of fields and relations that are allowed to be queried, this can be set by the\nconsumer as part of a middleware and it will take precedence over the defaultAllowedFields","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"allowed","type":"`string`[]","description":"An array of fields and relations that are allowed to be queried, this can be set by the\nconsumer as part of a middleware and it will take precedence over the defaultAllowedFields set\nby the api","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"session","type":"`any`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rawBody","type":"`any`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"pricingContext","type":"[MedusaPricingContext](../medusa.MedusaPricingContext/page.mdx)","description":"An object that carries the context that is used to calculate prices for variants","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"`Record<string, any>`","description":"A generic context object that can be used across the request lifecycle","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"additionalDataValidator","type":"ZodObject<any, any, ZodTypeAny, object, object>","description":"Custom validator to validate the `additional_data` property in\nrequests that allows for additional\\_data","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"user","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"res","type":"[MedusaResponse](../medusa.MedusaResponse/page.mdx)<Res>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"next","type":"[MedusaNextFunction](../medusa.MedusaNextFunction/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records" sectionTitle="__type"/>
|
||||
|
||||
### Returns
|
||||
|
||||
|
||||
@@ -12,5 +12,6 @@ This section of the documentation provides a reference to utility steps that you
|
||||
|
||||
- [createRemoteLinkStep](../../helper_steps/functions/helper_steps.createRemoteLinkStep/page.mdx)
|
||||
- [dismissRemoteLinkStep](../../helper_steps/functions/helper_steps.dismissRemoteLinkStep/page.mdx)
|
||||
- [emitEventStep](../../helper_steps/functions/helper_steps.emitEventStep/page.mdx)
|
||||
- [removeRemoteLinkStep](../../helper_steps/functions/helper_steps.removeRemoteLinkStep/page.mdx)
|
||||
- [useRemoteQueryStep](../../helper_steps/functions/helper_steps.useRemoteQueryStep/page.mdx)
|
||||
+12
@@ -0,0 +1,12 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# AdditionalData
|
||||
|
||||
**AdditionalData**: `Object`
|
||||
|
||||
Represents the additional\_data property accepted in HTTP
|
||||
requests to allow arbitrary values
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"additional_data","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="AdditionalData"/>
|
||||
@@ -185,6 +185,7 @@ import { TypeList } from "docs-ui"
|
||||
## Type Aliases
|
||||
|
||||
- [AdminCampaignListResponse](../HttpTypes/types/types.HttpTypes.AdminCampaignListResponse/page.mdx)
|
||||
- [AdditionalData](../HttpTypes/types/types.HttpTypes.AdditionalData/page.mdx)
|
||||
- [DeleteResponse](../HttpTypes/types/types.HttpTypes.DeleteResponse/page.mdx)
|
||||
- [PaginatedResponse](../HttpTypes/types/types.HttpTypes.PaginatedResponse/page.mdx)
|
||||
- [AdminUploadFile](../HttpTypes/types/types.HttpTypes.AdminUploadFile/page.mdx)
|
||||
|
||||
Reference in new issue
Block a user