chore(docs): Generated References (#8383)
Generated the following references: - `helper_steps` - `modules` - `types` - `workflows`
This commit is contained in:
github-actions[bot]
+21
@@ -9,6 +9,27 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `createRemoteLinkStep` step. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
## Example
|
||||
|
||||
```ts
|
||||
import { createWorkflow } from "@medusajs/workflows-sdk"
|
||||
import { createRemoteLinkStep } from "@medusajs/core-flows"
|
||||
import { Modules } from "@medusajs/utils"
|
||||
|
||||
const helloWorldWorkflow = createWorkflow("hello-world", () => {
|
||||
createRemoteLinkStep([
|
||||
{
|
||||
[Modules.PRODUCT]: {
|
||||
product_id: "prod_123",
|
||||
},
|
||||
helloModuleService: {
|
||||
my_custom_id: "mc_123",
|
||||
},
|
||||
},
|
||||
])
|
||||
})
|
||||
```
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"LinkDefinition[]","type":"[LinkDefinition](../../../modules_sdk/types/modules_sdk.LinkDefinition/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"LinkDefinition","type":"`object` & `object`","description":"A link for two records of linked data models.\n\nThe keys are the names of each module, and their value is an object that holds the ID of the linked data model's record.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="createRemoteLinkStep"/>
|
||||
|
||||
+28
@@ -9,6 +9,34 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `dismissRemoteLinkStep` step. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
## Example
|
||||
|
||||
```ts
|
||||
import {
|
||||
createWorkflow
|
||||
} from "@medusajs/workflows-sdk"
|
||||
import {
|
||||
dismissRemoteLinkStep
|
||||
} from "@medusajs/core-flows"
|
||||
import {
|
||||
Modules
|
||||
} from "@medusajs/utils"
|
||||
|
||||
const helloWorldWorkflow = createWorkflow(
|
||||
"hello-world",
|
||||
() => {
|
||||
dismissRemoteLinkStep([{
|
||||
[Modules.PRODUCT]: {
|
||||
product_id: "prod_123",
|
||||
},
|
||||
"helloModuleService": {
|
||||
my_custom_id: "mc_123",
|
||||
},
|
||||
}])
|
||||
}
|
||||
)
|
||||
```
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"DismissRemoteLinksStepInput","type":"[LinkDefinition](../../../modules_sdk/types/modules_sdk.LinkDefinition/page.mdx) \\| [LinkDefinition](../../../modules_sdk/types/modules_sdk.LinkDefinition/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="dismissRemoteLinkStep"/>
|
||||
|
||||
+25
@@ -9,6 +9,31 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `removeRemoteLinkStep` step. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
## Example
|
||||
|
||||
```ts
|
||||
import {
|
||||
createWorkflow
|
||||
} from "@medusajs/workflows-sdk"
|
||||
import {
|
||||
removeRemoteLinkStep
|
||||
} from "@medusajs/core-flows"
|
||||
import {
|
||||
Modules
|
||||
} from "@medusajs/utils"
|
||||
|
||||
const helloWorldWorkflow = createWorkflow(
|
||||
"hello-world",
|
||||
() => {
|
||||
removeRemoteLinkStep([{
|
||||
[Modules.PRODUCT]: {
|
||||
product_id: "prod_123",
|
||||
},
|
||||
}])
|
||||
}
|
||||
)
|
||||
```
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"RemoveRemoteLinksStepInput","type":"`RemoveRemoteLinksStepInput`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} sectionTitle="removeRemoteLinkStep"/>
|
||||
|
||||
+87
@@ -9,6 +9,93 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `useRemoteQueryStep` step. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
## Example
|
||||
|
||||
To retrieve a list of records of a data model:
|
||||
|
||||
```ts
|
||||
import {
|
||||
createWorkflow
|
||||
} from "@medusajs/workflows-sdk"
|
||||
import {
|
||||
useRemoteQueryStep
|
||||
} from "@medusajs/core-flows"
|
||||
|
||||
const helloWorldWorkflow = createWorkflow(
|
||||
"hello-world",
|
||||
() => {
|
||||
const products = useRemoteQueryStep({
|
||||
entry_point: "product",
|
||||
fields: [
|
||||
"*",
|
||||
"variants.*"
|
||||
]
|
||||
})
|
||||
}
|
||||
)
|
||||
```
|
||||
|
||||
To retrieve a single item instead of a an array:
|
||||
|
||||
```ts
|
||||
import {
|
||||
createWorkflow
|
||||
} from "@medusajs/workflows-sdk"
|
||||
import {
|
||||
useRemoteQueryStep
|
||||
} from "@medusajs/core-flows"
|
||||
|
||||
const helloWorldWorkflow = createWorkflow(
|
||||
"hello-world",
|
||||
() => {
|
||||
const product = useRemoteQueryStep({
|
||||
entry_point: "product",
|
||||
fields: [
|
||||
"*",
|
||||
"variants.*"
|
||||
],
|
||||
variables: {
|
||||
filters: {
|
||||
id: "123"
|
||||
}
|
||||
},
|
||||
list: false
|
||||
})
|
||||
}
|
||||
)
|
||||
```
|
||||
|
||||
To throw an error if a record isn't found matching the specified ID:
|
||||
|
||||
```ts
|
||||
import {
|
||||
createWorkflow
|
||||
} from "@medusajs/workflows-sdk"
|
||||
import {
|
||||
useRemoteQueryStep
|
||||
} from "@medusajs/core-flows"
|
||||
|
||||
const helloWorldWorkflow = createWorkflow(
|
||||
"hello-world",
|
||||
() => {
|
||||
const product = useRemoteQueryStep({
|
||||
entry_point: "product",
|
||||
fields: [
|
||||
"*",
|
||||
"variants.*"
|
||||
],
|
||||
variables: {
|
||||
filters: {
|
||||
id: "123"
|
||||
}
|
||||
},
|
||||
list: false,
|
||||
throw_if_key_not_found: true
|
||||
})
|
||||
}
|
||||
)
|
||||
```
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"EntryStepInput \\| ServiceStepInput","type":"[EntryStepInput](../../interfaces/helper_steps.EntryStepInput/page.mdx) \\| [ServiceStepInput](../../interfaces/helper_steps.ServiceStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} sectionTitle="useRemoteQueryStep"/>
|
||||
|
||||
@@ -23,6 +23,10 @@ import { TypeList } from "docs-ui"
|
||||
- [WorkflowTypes](../../types/types.WorkflowTypes/page.mdx)
|
||||
- [WorkflowsSdkTypes](../../types/types.WorkflowsSdkTypes/page.mdx)
|
||||
|
||||
## Enumerations
|
||||
|
||||
- [ClaimReason](../../types/enums/types.ClaimReason/page.mdx)
|
||||
|
||||
## Interfaces
|
||||
|
||||
- [DetailWidgetProps](../../types/interfaces/types.DetailWidgetProps/page.mdx)
|
||||
@@ -33,6 +37,13 @@ import { TypeList } from "docs-ui"
|
||||
- [GetUploadedFileType](../../types/interfaces/types.GetUploadedFileType/page.mdx)
|
||||
- [DeleteFileType](../../types/interfaces/types.DeleteFileType/page.mdx)
|
||||
- [UploadStreamDescriptorType](../../types/interfaces/types.UploadStreamDescriptorType/page.mdx)
|
||||
- [AdminClaimAddItems](../../types/interfaces/types.AdminClaimAddItems/page.mdx)
|
||||
- [AdminClaimUpdateItem](../../types/interfaces/types.AdminClaimUpdateItem/page.mdx)
|
||||
- [AdminClaimAddShippingMethod](../../types/interfaces/types.AdminClaimAddShippingMethod/page.mdx)
|
||||
- [AdminClaimUpdateShippingMethod](../../types/interfaces/types.AdminClaimUpdateShippingMethod/page.mdx)
|
||||
- [BaseClaimItem](../../types/interfaces/types.BaseClaimItem/page.mdx)
|
||||
- [BaseClaim](../../types/interfaces/types.BaseClaim/page.mdx)
|
||||
- [BaseClaimListParams](../../types/interfaces/types.BaseClaimListParams/page.mdx)
|
||||
- [BaseCollection](../../types/interfaces/types.BaseCollection/page.mdx)
|
||||
- [BaseCollectionParams](../../types/interfaces/types.BaseCollectionParams/page.mdx)
|
||||
- [BaseCollectionListParams](../../types/interfaces/types.BaseCollectionListParams/page.mdx)
|
||||
|
||||
@@ -10,6 +10,7 @@ This section of the documentation provides a reference to the utility functions
|
||||
|
||||
## Functions
|
||||
|
||||
- [createHook](../../workflows/functions/workflows.createHook/page.mdx)
|
||||
- [createStep](../../workflows/functions/workflows.createStep/page.mdx)
|
||||
- [createWorkflow](../../workflows/functions/workflows.createWorkflow/page.mdx)
|
||||
- [parallelize](../../workflows/functions/workflows.parallelize/page.mdx)
|
||||
|
||||
+7
@@ -0,0 +1,7 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# AdminAddClaimInboundItems
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"items","type":"`object`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reason","type":"[ClaimReason](../../../enums/types.ClaimReason/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"MISSING_ITEM","type":"`\"missing_item\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"WRONG_ITEM","type":"`\"wrong_item\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"PRODUCTION_FAILURE","type":"`\"production_failure\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"OTHER","type":"`\"other\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"description","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="AdminAddClaimInboundItems"/>
|
||||
+7
@@ -0,0 +1,7 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# AdminAddClaimItems
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"items","type":"`object`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reason","type":"[ClaimReason](../../../enums/types.ClaimReason/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"MISSING_ITEM","type":"`\"missing_item\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"WRONG_ITEM","type":"`\"wrong_item\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"PRODUCTION_FAILURE","type":"`\"production_failure\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"OTHER","type":"`\"other\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"description","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="AdminAddClaimItems"/>
|
||||
+7
@@ -0,0 +1,7 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# AdminAddClaimOutboundItems
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"items","type":"`object`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reason","type":"[ClaimReason](../../../enums/types.ClaimReason/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"MISSING_ITEM","type":"`\"missing_item\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"WRONG_ITEM","type":"`\"wrong_item\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"PRODUCTION_FAILURE","type":"`\"production_failure\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"OTHER","type":"`\"other\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"description","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="AdminAddClaimOutboundItems"/>
|
||||
+7
@@ -0,0 +1,7 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# AdminCancelClaim
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"no_notification","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="AdminCancelClaim"/>
|
||||
+7
File diff suppressed because one or more lines are too long
+7
@@ -0,0 +1,7 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# AdminClaimAddInboundShipping
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"shipping_option_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"custom_price","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="AdminClaimAddInboundShipping"/>
|
||||
+7
@@ -0,0 +1,7 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# AdminClaimAddOutboundShipping
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"shipping_option_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"custom_price","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="AdminClaimAddOutboundShipping"/>
|
||||
+7
@@ -0,0 +1,7 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# AdminClaimDeleteResponse
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"The ID of the item that was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"claim\"`","description":"The type of the item that was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted","type":"`boolean`","description":"Whether the item was deleted successfully.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent","type":"`object`","description":"The parent resource of the item that was deleted, if applicable.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="AdminClaimDeleteResponse"/>
|
||||
+9
File diff suppressed because one or more lines are too long
+7
File diff suppressed because one or more lines are too long
+7
File diff suppressed because one or more lines are too long
+7
File diff suppressed because one or more lines are too long
+7
@@ -0,0 +1,7 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# AdminClaimUpdateInboundShipping
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"custom_price","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="AdminClaimUpdateInboundShipping"/>
|
||||
+7
@@ -0,0 +1,7 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# AdminClaimUpdateOutboundShipping
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"custom_price","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="AdminClaimUpdateOutboundShipping"/>
|
||||
+7
@@ -0,0 +1,7 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# AdminCreateClaim
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"type","type":"`\"replace\"` \\| `\"refund\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="AdminCreateClaim"/>
|
||||
+3
@@ -0,0 +1,3 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# AdminRequestClaim
|
||||
+7
@@ -0,0 +1,7 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# AdminUpdateClaimInboundItem
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"quantity","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reason_id","type":"[ClaimReason](../../../enums/types.ClaimReason/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"MISSING_ITEM","type":"`\"missing_item\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"WRONG_ITEM","type":"`\"wrong_item\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"PRODUCTION_FAILURE","type":"`\"production_failure\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"OTHER","type":"`\"other\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"description","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="AdminUpdateClaimInboundItem"/>
|
||||
+7
@@ -0,0 +1,7 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# AdminUpdateClaimItem
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"quantity","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reason_id","type":"[ClaimReason](../../../enums/types.ClaimReason/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"MISSING_ITEM","type":"`\"missing_item\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"WRONG_ITEM","type":"`\"wrong_item\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"PRODUCTION_FAILURE","type":"`\"production_failure\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"OTHER","type":"`\"other\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"description","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="AdminUpdateClaimItem"/>
|
||||
+7
@@ -0,0 +1,7 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# AdminUpdateClaimOutboundItem
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"quantity","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reason_id","type":"[ClaimReason](../../../enums/types.ClaimReason/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"MISSING_ITEM","type":"`\"missing_item\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"WRONG_ITEM","type":"`\"wrong_item\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"PRODUCTION_FAILURE","type":"`\"production_failure\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"OTHER","type":"`\"other\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"description","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="AdminUpdateClaimOutboundItem"/>
|
||||
@@ -0,0 +1,21 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# ClaimReason
|
||||
|
||||
## Enumeration Members
|
||||
|
||||
### MISSING\_ITEM
|
||||
|
||||
**MISSING\_ITEM** = `"missing_item"`
|
||||
|
||||
### WRONG\_ITEM
|
||||
|
||||
**WRONG\_ITEM** = `"wrong_item"`
|
||||
|
||||
### PRODUCTION\_FAILURE
|
||||
|
||||
**PRODUCTION\_FAILURE** = `"production_failure"`
|
||||
|
||||
### OTHER
|
||||
|
||||
**OTHER** = `"other"`
|
||||
@@ -0,0 +1,7 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# AdminClaimAddItems
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"items","type":"`object`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reason","type":"[ClaimReason](../../enums/types.ClaimReason/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"MISSING_ITEM","type":"`\"missing_item\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"WRONG_ITEM","type":"`\"wrong_item\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"PRODUCTION_FAILURE","type":"`\"production_failure\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"OTHER","type":"`\"other\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"description","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="AdminClaimAddItems"/>
|
||||
+7
@@ -0,0 +1,7 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# AdminClaimAddShippingMethod
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"shipping_option_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"custom_price","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="AdminClaimAddShippingMethod"/>
|
||||
@@ -0,0 +1,7 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# AdminClaimUpdateItem
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"quantity","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reason_id","type":"[ClaimReason](../../enums/types.ClaimReason/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"MISSING_ITEM","type":"`\"missing_item\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"WRONG_ITEM","type":"`\"wrong_item\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"PRODUCTION_FAILURE","type":"`\"production_failure\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"OTHER","type":"`\"other\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"description","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="AdminClaimUpdateItem"/>
|
||||
+7
@@ -0,0 +1,7 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# AdminClaimUpdateShippingMethod
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"custom_price","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="AdminClaimUpdateShippingMethod"/>
|
||||
File diff suppressed because one or more lines are too long
@@ -0,0 +1,7 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# BaseClaimItem
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reason","type":"[ClaimReason](../../../order/types/order.ClaimReason/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_quantity","type":"[BigNumberRawValue](../../types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="BaseClaimItem"/>
|
||||
File diff suppressed because one or more lines are too long
@@ -8,6 +8,25 @@ import { TypeList } from "docs-ui"
|
||||
- [AdminUpdateCampaign](../HttpTypes/interfaces/types.HttpTypes.AdminUpdateCampaign/page.mdx)
|
||||
- [CampaignResponse](../HttpTypes/interfaces/types.HttpTypes.CampaignResponse/page.mdx)
|
||||
- [AdminCampaignResponse](../HttpTypes/interfaces/types.HttpTypes.AdminCampaignResponse/page.mdx)
|
||||
- [AdminClaim](../HttpTypes/interfaces/types.HttpTypes.AdminClaim/page.mdx)
|
||||
- [AdminCreateClaim](../HttpTypes/interfaces/types.HttpTypes.AdminCreateClaim/page.mdx)
|
||||
- [AdminAddClaimItems](../HttpTypes/interfaces/types.HttpTypes.AdminAddClaimItems/page.mdx)
|
||||
- [AdminUpdateClaimItem](../HttpTypes/interfaces/types.HttpTypes.AdminUpdateClaimItem/page.mdx)
|
||||
- [AdminAddClaimInboundItems](../HttpTypes/interfaces/types.HttpTypes.AdminAddClaimInboundItems/page.mdx)
|
||||
- [AdminUpdateClaimInboundItem](../HttpTypes/interfaces/types.HttpTypes.AdminUpdateClaimInboundItem/page.mdx)
|
||||
- [AdminAddClaimOutboundItems](../HttpTypes/interfaces/types.HttpTypes.AdminAddClaimOutboundItems/page.mdx)
|
||||
- [AdminUpdateClaimOutboundItem](../HttpTypes/interfaces/types.HttpTypes.AdminUpdateClaimOutboundItem/page.mdx)
|
||||
- [AdminClaimAddInboundShipping](../HttpTypes/interfaces/types.HttpTypes.AdminClaimAddInboundShipping/page.mdx)
|
||||
- [AdminClaimUpdateInboundShipping](../HttpTypes/interfaces/types.HttpTypes.AdminClaimUpdateInboundShipping/page.mdx)
|
||||
- [AdminClaimAddOutboundShipping](../HttpTypes/interfaces/types.HttpTypes.AdminClaimAddOutboundShipping/page.mdx)
|
||||
- [AdminClaimUpdateOutboundShipping](../HttpTypes/interfaces/types.HttpTypes.AdminClaimUpdateOutboundShipping/page.mdx)
|
||||
- [AdminRequestClaim](../HttpTypes/interfaces/types.HttpTypes.AdminRequestClaim/page.mdx)
|
||||
- [AdminCancelClaim](../HttpTypes/interfaces/types.HttpTypes.AdminCancelClaim/page.mdx)
|
||||
- [AdminClaimListParams](../HttpTypes/interfaces/types.HttpTypes.AdminClaimListParams/page.mdx)
|
||||
- [AdminClaimParams](../HttpTypes/interfaces/types.HttpTypes.AdminClaimParams/page.mdx)
|
||||
- [AdminClaimResponse](../HttpTypes/interfaces/types.HttpTypes.AdminClaimResponse/page.mdx)
|
||||
- [AdminClaimListResponse](../HttpTypes/interfaces/types.HttpTypes.AdminClaimListResponse/page.mdx)
|
||||
- [AdminClaimDeleteResponse](../HttpTypes/interfaces/types.HttpTypes.AdminClaimDeleteResponse/page.mdx)
|
||||
- [AdminCollection](../HttpTypes/interfaces/types.HttpTypes.AdminCollection/page.mdx)
|
||||
- [AdminCreateCollection](../HttpTypes/interfaces/types.HttpTypes.AdminCreateCollection/page.mdx)
|
||||
- [AdminUpdateCollection](../HttpTypes/interfaces/types.HttpTypes.AdminUpdateCollection/page.mdx)
|
||||
|
||||
@@ -0,0 +1,23 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# WorkflowResponse
|
||||
|
||||
Workflow response class encapsulates the return value of a workflow
|
||||
|
||||
## Type parameters
|
||||
|
||||
<TypeList types={[{"name":"TResult","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"THooks","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="WorkflowResponse"/>
|
||||
|
||||
## constructor
|
||||
|
||||
### Type Parameters
|
||||
|
||||
<TypeList types={[{"name":"TResult","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"THooks","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="new WorkflowResponse"/>
|
||||
|
||||
### Parameters
|
||||
|
||||
<TypeList types={[{"name":"$result","type":"[WorkflowData](../../types/workflows.WorkflowData/page.mdx)<TResult> \\| { [K in string \\| number \\| symbol]: TResult[K] \\| WorkflowDataProperties<TResult[K]> \\| WorkflowData<TResult[K]> }","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"hooks","type":"THooks","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="new WorkflowResponse"/>
|
||||
|
||||
___
|
||||
|
||||
<TypeList types={[{"name":"__type","type":"`string`","description":"","optional":false,"defaultValue":"OrchestrationUtils.SymbolMedusaWorkflowResponse","expandable":false,"children":[]},{"name":"$result","type":"[WorkflowData](../../types/workflows.WorkflowData/page.mdx)<TResult> \\| { [K in string \\| number \\| symbol]: TResult[K] \\| WorkflowDataProperties<TResult[K]> \\| WorkflowData<TResult[K]> }","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"hooks","type":"THooks","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="WorkflowResponse"/>
|
||||
@@ -0,0 +1,28 @@
|
||||
---
|
||||
slug: /references/workflows/createHook
|
||||
sidebar_label: createHook
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# createHook - Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `createHook` . It belongs to the `@medusajs/workflows-sdk` package.
|
||||
|
||||
Define a workflow hook to be executed within steps. The created hook
|
||||
is exposed publicly for the workflow consumers to inject and run
|
||||
custom logic.
|
||||
|
||||
Hooks behaves like steps
|
||||
|
||||
## Type Parameters
|
||||
|
||||
<TypeList types={[{"name":"Name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"TInvokeInput","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="createHook"/>
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"name","type":"Name","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"input","type":"TInvokeInput","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="createHook"/>
|
||||
|
||||
## Returns
|
||||
|
||||
<TypeList types={[{"name":"Hook","type":"[Hook](../../types/workflows.Hook/page.mdx)<Name, TInvokeInput>","optional":false,"defaultValue":"","description":"Define a workflow hook to be executed within steps. The created hook\nis exposed publicly for the workflow consumers to inject and run\ncustom logic.\n\nHooks behaves like steps","expandable":false,"children":[]}]} sectionTitle="createHook"/>
|
||||
@@ -59,7 +59,7 @@ export const createProductStep = createStep(
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"nameOrConfig","type":"`string` \\| `object` & Omit<TransactionStepsDefinition, \"next\" \\| \"uuid\" \\| \"action\">","description":"The name of the step or its configuration.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"invokeFn","type":"InvokeFn<TInvokeInput, TInvokeResultOutput, TInvokeResultCompensateInput>","description":"An invocation function that will be executed when the workflow is executed. The function must return an instance of [StepResponse](../../classes/workflows.StepResponse/page.mdx). The constructor of [StepResponse](../../classes/workflows.StepResponse/page.mdx)\naccepts the output of the step as a first argument, and optionally as a second argument the data to be passed to the compensation function as a parameter.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"compensateFn","type":"CompensateFn<TInvokeResultCompensateInput>","description":"A compensation function that's executed if an error occurs in the workflow. It's used to roll-back actions when errors occur.\nIt accepts as a parameter the second argument passed to the constructor of the [StepResponse](../../classes/workflows.StepResponse/page.mdx) instance returned by the invocation function. If the\ninvocation function doesn't pass the second argument to `StepResponse` constructor, the compensation function receives the first argument\npassed to the `StepResponse` constructor instead.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="createStep"/>
|
||||
<TypeList types={[{"name":"nameOrConfig","type":"`string` \\| `object` & Omit<TransactionStepsDefinition, \"next\" \\| \"uuid\" \\| \"action\">","description":"The name of the step or its configuration.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"invokeFn","type":"[InvokeFn](../../types/workflows.InvokeFn/page.mdx)<TInvokeInput, TInvokeResultOutput, TInvokeResultCompensateInput>","description":"An invocation function that will be executed when the workflow is executed. The function must return an instance of [StepResponse](../../classes/workflows.StepResponse/page.mdx). The constructor of [StepResponse](../../classes/workflows.StepResponse/page.mdx)\naccepts the output of the step as a first argument, and optionally as a second argument the data to be passed to the compensation function as a parameter.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"compensateFn","type":"[CompensateFn](../../types/workflows.CompensateFn/page.mdx)<TInvokeResultCompensateInput>","description":"A compensation function that's executed if an error occurs in the workflow. It's used to roll-back actions when errors occur.\nIt accepts as a parameter the second argument passed to the constructor of the [StepResponse](../../classes/workflows.StepResponse/page.mdx) instance returned by the invocation function. If the\ninvocation function doesn't pass the second argument to `StepResponse` constructor, the compensation function receives the first argument\npassed to the `StepResponse` constructor instead.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="createStep"/>
|
||||
|
||||
## Returns
|
||||
|
||||
|
||||
@@ -61,11 +61,11 @@ export async function GET(
|
||||
|
||||
## Type Parameters
|
||||
|
||||
<TypeList types={[{"name":"TData","type":"`object`","description":"The type of the input passed to the composer function.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"TResult","type":"`object`","description":"The type of the output returned by the composer function.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"THooks","type":"`Record<string, Function>`","description":"The type of hooks defined in the workflow.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="createWorkflow"/>
|
||||
<TypeList types={[{"name":"TData","type":"`object`","description":"The type of the input passed to the composer function.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"TResult","type":"`object`","description":"The type of the output returned by the composer function.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"THooks","type":"`any`[]","description":"The type of hooks defined in the workflow.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="createWorkflow"/>
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"nameOrConfig","type":"`string` \\| `object` & `TransactionModelOptions`","description":"The name of the workflow or its configuration.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"composer","type":"(`input`: [WorkflowData](../../types/workflows.WorkflowData/page.mdx)<TData>) => `void` \\| [WorkflowData](../../types/workflows.WorkflowData/page.mdx)<TResult> \\| { [K in string \\| number \\| symbol]: TResult[K] \\| WorkflowDataProperties<TResult[K]> \\| WorkflowData<TResult[K]> }","description":"The constructor function that is executed when the `run` method in [ReturnWorkflow](../../types/workflows.ReturnWorkflow/page.mdx) is used.\nThe function can't be an arrow function or an asynchronus function. It also can't directly manipulate data.\nYou'll have to use the [transform](../workflows.transform/page.mdx) function if you need to directly manipulate data.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="createWorkflow"/>
|
||||
<TypeList types={[{"name":"nameOrConfig","type":"`string` \\| `object` & `TransactionModelOptions`","description":"The name of the workflow or its configuration.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"composer","type":"(`input`: [WorkflowData](../../types/workflows.WorkflowData/page.mdx)<TData>) => `void` \\| [WorkflowResponse](../../classes/workflows.WorkflowResponse/page.mdx)<TResult, THooks>","description":"The constructor function that is executed when the `run` method in [ReturnWorkflow](../../types/workflows.ReturnWorkflow/page.mdx) is used.\nThe function can't be an arrow function or an asynchronus function. It also can't directly manipulate data.\nYou'll have to use the [transform](../workflows.transform/page.mdx) function if you need to directly manipulate data.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="createWorkflow"/>
|
||||
|
||||
## Returns
|
||||
|
||||
|
||||
@@ -0,0 +1,9 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# ApplyStepOptions
|
||||
|
||||
## Type parameters
|
||||
|
||||
<TypeList types={[{"name":"TStepInputs","type":"{ [K in keyof TInvokeInput]: WorkflowData<TInvokeInput[K]> }","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"TInvokeInput","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"TInvokeResultOutput","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"TInvokeResultCompensateInput","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="ApplyStepOptions"/>
|
||||
|
||||
<TypeList types={[{"name":"stepName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"invokeFn","type":"[InvokeFn](../../types/workflows.InvokeFn/page.mdx)<TInvokeInput, TInvokeResultOutput, TInvokeResultCompensateInput>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"stepConfig","type":"`TransactionStepsDefinition`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"input","type":"TStepInputs","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"compensateFn","type":"[CompensateFn](../../types/workflows.CompensateFn/page.mdx)<TInvokeResultCompensateInput>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="ApplyStepOptions"/>
|
||||
@@ -0,0 +1,21 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# CompensateFn
|
||||
|
||||
**CompensateFn**: (`input`: T \| `undefined`, `context`: [StepExecutionContext](../../interfaces/workflows.StepExecutionContext/page.mdx)) => `unknown` \| Promise<unknown>
|
||||
|
||||
The type of compensation function passed to a step.
|
||||
|
||||
## Type Parameters
|
||||
|
||||
<TypeList types={[{"name":"T","type":"`object`","description":"The type of the argument passed to the compensation function. If not specified, then it will be the same type as the invocation function's output.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="CompensateFn"/>
|
||||
|
||||
## Type declaration
|
||||
|
||||
### Parameters
|
||||
|
||||
<TypeList types={[{"name":"input","type":"T \\| `undefined`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"[StepExecutionContext](../../interfaces/workflows.StepExecutionContext/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"workflowId","type":"`string`","description":"The ID of the workflow.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attempt","type":"`number`","description":"The attempt number of the step.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotencyKey","type":"`string`","description":"The idempoency key of the step.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"stepName","type":"`string`","description":"The name of the step.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"action","type":"`\"invoke\"` \\| `\"compensate\"`","description":"The action of the step.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"container","type":"[MedusaContainer](../../../medusa/types/medusa.MedusaContainer/page.mdx)","description":"The container used to access resources, such as services, in the step.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`TransactionMetadata`","description":"Metadata passed in the input.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"[Context](../../../types/interfaces/types.Context/page.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"eventGroupId","type":"`string`","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionId","type":"`string`","description":"A string indicating the ID of the current transaction.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="__type"/>
|
||||
|
||||
### Returns
|
||||
|
||||
<TypeList types={[{"name":"unknown \\| Promise<unknown>","type":"`unknown` \\| Promise<unknown>","optional":false,"defaultValue":"","description":"There's no expected type to be returned by the compensation function.","expandable":false,"children":[]}]} sectionTitle="__type"/>
|
||||
+1
-1
@@ -6,4 +6,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"hooks_","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hooksCallback_","type":"`Record<string, Function[]>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"workflowId","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"flow","type":"`OrchestratorBuilder`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handlers","type":"`WorkflowHandler`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"stepBinder","type":"`<TOutput>`(`fn`: [StepFunctionResult](../workflows.StepFunctionResult/page.mdx)) => [WorkflowData](../workflows.WorkflowData/page.mdx)<TOutput>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hookBinder","type":"`<TOutput>`(`name`: `string`, `fn`: `Function`) => [WorkflowData](../workflows.WorkflowData/page.mdx)<TOutput>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parallelizeBinder","type":"`<TOutput>`(`fn`: (`this`: [CreateWorkflowComposerContext](page.mdx)) => TOutput) => TOutput","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="CreateWorkflowComposerContext"/>
|
||||
<TypeList types={[{"name":"__type","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hooks_","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"declared","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"registered","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"hooksCallback_","type":"`Record<string, [HookHandler](../workflows.HookHandler/page.mdx)>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"workflowId","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"flow","type":"`OrchestratorBuilder`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handlers","type":"`WorkflowHandler`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"stepBinder","type":"`<TOutput>`(`fn`: [StepFunctionResult](../workflows.StepFunctionResult/page.mdx)) => [WorkflowData](../workflows.WorkflowData/page.mdx)<TOutput>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hookBinder","type":"(`name`: `string`, `fn`: () => [HookHandler](../workflows.HookHandler/page.mdx)) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parallelizeBinder","type":"`<TOutput>`(`fn`: (`this`: [CreateWorkflowComposerContext](page.mdx)) => TOutput) => TOutput","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="CreateWorkflowComposerContext"/>
|
||||
|
||||
@@ -0,0 +1,15 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# Hook
|
||||
|
||||
**Hook**: `Object`
|
||||
|
||||
Representation of a hook definition.
|
||||
|
||||
## Type Parameters
|
||||
|
||||
<TypeList types={[{"name":"Name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"Input","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="Hook"/>
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"__type","type":"typeof `OrchestrationUtils.SymbolWorkflowHook`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"Name","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":" input","type":"Input","description":"By prefixing a key with a space, we remove it from the\nintellisense of TypeScript. This is needed because\ninput is not set at runtime. It is a type-only\nproperty to infer input data type of a hook","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="Hook"/>
|
||||
@@ -0,0 +1,15 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# HookHandler
|
||||
|
||||
**HookHandler**: (...`args`: `any`[]) => `void` \| Promise<void>
|
||||
|
||||
## Type declaration
|
||||
|
||||
### Parameters
|
||||
|
||||
<TypeList types={[{"name":"args","type":"`any`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="__type"/>
|
||||
|
||||
### Returns
|
||||
|
||||
<TypeList types={[{"name":"void \\| Promise<void>","type":"`void` \\| Promise<void>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} sectionTitle="__type"/>
|
||||
@@ -0,0 +1,21 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# InvokeFn
|
||||
|
||||
**InvokeFn**: (`input`: TInput, `context`: [StepExecutionContext](../../interfaces/workflows.StepExecutionContext/page.mdx)) => `void` \| [StepResponse](../../classes/workflows.StepResponse/page.mdx)<TOutput, TCompensateInput extends undefined ? TOutput : TCompensateInput> \| Promise<void \| [StepResponse](../../classes/workflows.StepResponse/page.mdx)<TOutput, TCompensateInput extends undefined ? TOutput : TCompensateInput>>
|
||||
|
||||
The type of invocation function passed to a step.
|
||||
|
||||
## Type Parameters
|
||||
|
||||
<TypeList types={[{"name":"TInput","type":"`object`","description":"The type of the input that the function expects.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"TOutput","type":"`object`","description":"The type of the output that the function returns.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"TCompensateInput","type":"`object`","description":"The type of the input that the compensation function expects.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="InvokeFn"/>
|
||||
|
||||
## Type declaration
|
||||
|
||||
### Parameters
|
||||
|
||||
<TypeList types={[{"name":"input","type":"TInput","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"[StepExecutionContext](../../interfaces/workflows.StepExecutionContext/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"workflowId","type":"`string`","description":"The ID of the workflow.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attempt","type":"`number`","description":"The attempt number of the step.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotencyKey","type":"`string`","description":"The idempoency key of the step.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"stepName","type":"`string`","description":"The name of the step.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"action","type":"`\"invoke\"` \\| `\"compensate\"`","description":"The action of the step.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"container","type":"[MedusaContainer](../../../medusa/types/medusa.MedusaContainer/page.mdx)","description":"The container used to access resources, such as services, in the step.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`TransactionMetadata`","description":"Metadata passed in the input.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"[Context](../../../types/interfaces/types.Context/page.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"eventGroupId","type":"`string`","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionId","type":"`string`","description":"A string indicating the ID of the current transaction.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="__type"/>
|
||||
|
||||
### Returns
|
||||
|
||||
<TypeList types={[{"name":"void \\| StepResponse<TOutput, TCompensateInput extends undefined ? TOutput : TCompensateInput> \\| Promise<void \\| StepResponse<TOutput, TCompensateInput extends undefined ? TOutput : TCompensateInput>>","type":"`void` \\| [StepResponse](../../classes/workflows.StepResponse/page.mdx)<TOutput, TCompensateInput extends undefined ? TOutput : TCompensateInput> \\| Promise<void \\| [StepResponse](../../classes/workflows.StepResponse/page.mdx)<TOutput, TCompensateInput extends undefined ? TOutput : TCompensateInput>>","optional":false,"defaultValue":"","description":"The expected output based on the type parameter `TOutput`.","expandable":false,"children":[]}]} sectionTitle="__type"/>
|
||||
@@ -2,7 +2,7 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
# ReturnWorkflow
|
||||
|
||||
**ReturnWorkflow**: `<TDataOverride, TResultOverride>`(`container?`: [MedusaContainer](../../../medusa/types/medusa.MedusaContainer/page.mdx) \| ``{ __joinerConfig: [ModuleJoinerConfig](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleJoinerConfig/page.mdx) ; __definition: [ModuleDefinition](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleDefinition/page.mdx) }``[]) => Omit<LocalWorkflow, "run" \| "registerStepSuccess" \| "registerStepFailure" \| "cancel"> & ExportedWorkflow<TData, TResult, TDataOverride, TResultOverride> & THooks & `object`
|
||||
**ReturnWorkflow**: `<TDataOverride, TResultOverride>`(`container?`: [MedusaContainer](../../../medusa/types/medusa.MedusaContainer/page.mdx) \| ``{ __joinerConfig: [ModuleJoinerConfig](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleJoinerConfig/page.mdx) ; __definition: [ModuleDefinition](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleDefinition/page.mdx) }``[]) => Omit<LocalWorkflow, "run" \| "registerStepSuccess" \| "registerStepFailure" \| "cancel"> & ExportedWorkflow<TData, TResult, TDataOverride, TResultOverride> & `object`
|
||||
|
||||
An exported workflow, which is the type of a workflow constructed by the [createWorkflow](../../functions/workflows.createWorkflow/page.mdx) function. The exported workflow can be invoked to create
|
||||
an executable workflow, optionally within a specified container. So, to execute the workflow, you must invoke the exported workflow, then run the
|
||||
@@ -53,4 +53,4 @@ export async function GET(
|
||||
|
||||
## Type Parameters
|
||||
|
||||
<TypeList types={[{"name":"TData","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"TResult","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"THooks","type":"`Record<string, Function>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="ReturnWorkflow"/>
|
||||
<TypeList types={[{"name":"TData","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"TResult","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"THooks","type":"`any`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="ReturnWorkflow"/>
|
||||
|
||||
@@ -12,7 +12,7 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
### Parameters
|
||||
|
||||
<TypeList types={[{"name":"this","type":"[CreateWorkflowComposerContext](../workflows.CreateWorkflowComposerContext/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"hooks_","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hooksCallback_","type":"`Record<string, Function[]>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"workflowId","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"flow","type":"`OrchestratorBuilder`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handlers","type":"`WorkflowHandler`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"stepBinder","type":"`<TOutput>`(`fn`: [StepFunctionResult](page.mdx)) => [WorkflowData](../workflows.WorkflowData/page.mdx)<TOutput>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hookBinder","type":"`<TOutput>`(`name`: `string`, `fn`: `Function`) => [WorkflowData](../workflows.WorkflowData/page.mdx)<TOutput>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parallelizeBinder","type":"`<TOutput>`(`fn`: (`this`: [CreateWorkflowComposerContext](../workflows.CreateWorkflowComposerContext/page.mdx)) => TOutput) => TOutput","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="__type"/>
|
||||
<TypeList types={[{"name":"this","type":"[CreateWorkflowComposerContext](../workflows.CreateWorkflowComposerContext/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"hooks_","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hooksCallback_","type":"`Record<string, [HookHandler](../workflows.HookHandler/page.mdx)>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"workflowId","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"flow","type":"`OrchestratorBuilder`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handlers","type":"`WorkflowHandler`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"stepBinder","type":"`<TOutput>`(`fn`: [StepFunctionResult](page.mdx)) => [WorkflowData](../workflows.WorkflowData/page.mdx)<TOutput>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hookBinder","type":"(`name`: `string`, `fn`: () => [HookHandler](../workflows.HookHandler/page.mdx)) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parallelizeBinder","type":"`<TOutput>`(`fn`: (`this`: [CreateWorkflowComposerContext](../workflows.CreateWorkflowComposerContext/page.mdx)) => TOutput) => TOutput","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="__type"/>
|
||||
|
||||
### Returns
|
||||
|
||||
|
||||
+1
-1
@@ -14,4 +14,4 @@ type WorkflowInputData = UnwrapWorkflowInputDataType<typeof myWorkflow>
|
||||
|
||||
## Type Parameters
|
||||
|
||||
<TypeList types={[{"name":"T","type":"[ReturnWorkflow](../workflows.ReturnWorkflow/page.mdx)<any, any, any>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"runAsStep","type":"(`{\n input,\n }`: ``{ input: TData \\| [WorkflowData](../workflows.WorkflowData/page.mdx)<TData> }``) => ReturnType<[StepFunction](../workflows.StepFunction/page.mdx)<TData, TResult>>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"run","type":"`<TDataOverride, TResultOverride>`(...`args`: Parameters<ExportedWorkflow<TData, TResult, TDataOverride, TResultOverride>[\"run\"]>) => ReturnType<ExportedWorkflow<TData, TResult, TDataOverride, TResultOverride>[\"run\"]>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"getName","type":"() => `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"(`config`: `TransactionModelOptions`) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="UnwrapWorkflowInputDataType"/>
|
||||
<TypeList types={[{"name":"T","type":"[ReturnWorkflow](../workflows.ReturnWorkflow/page.mdx)<any, any, any>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"runAsStep","type":"(`{\n input,\n }`: ``{ input: TData \\| [WorkflowData](../workflows.WorkflowData/page.mdx)<TData> }``) => ReturnType<[StepFunction](../workflows.StepFunction/page.mdx)<TData, TResult>>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"run","type":"`<TDataOverride, TResultOverride>`(...`args`: Parameters<ExportedWorkflow<TData, TResult, TDataOverride, TResultOverride>[\"run\"]>) => ReturnType<ExportedWorkflow<TData, TResult, TDataOverride, TResultOverride>[\"run\"]>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"getName","type":"() => `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"(`config`: `TransactionModelOptions`) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hooks","type":"ConvertHooksToFunctions<THooks>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="UnwrapWorkflowInputDataType"/>
|
||||
|
||||
Reference in New Issue
Block a user