asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

chore(docs): Generated References (automated) (#12460)

Browse Source 
Generated the following references:
- `_index.mdx`
- `api_key`
- `api_key_models`
- `auth`
- `auth_models`
- `auth_provider`
- `cart`
- `cart_models`
- `core_flows`
- `currency`
- `currency_models`
- `customer`
- `customer_models`
- `events`
- `file`
- `file_service`
- `fulfillment`
- `fulfillment_models`
- `fulfillment_provider`
- `inventory_next`
- `inventory_next_models`
- `js_sdk`
- `locking`
- `medusa`
- `module_events`
- `modules`
- `modules_sdk`
- `notification`
- `notification_service`
- `order`
- `order_models`
- `payment`
- `payment_models`
- `payment_provider`
- `pricing`
- `pricing_models`
- `product`
- `product_models`
- `promotion`
- `promotion_models`
- `region`
- `region_models`
- `sales_channel`
- `sales_channel_models`
- `stock_location_next`
- `stock_location_next_models`
- `store`
- `store_models`
- `tax`
- `tax_models`
- `tax_provider`
- `types`
- `user`
- `user_models`
- `utils`
- `workflows`

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2025-05-13 13:31:57 +00:00
committed by GitHub
parent a4ffc0b2ee
commit 5c36bafc1d
1978 changed files with 332243 additions and 279592 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
www/apps/resources/references/workflows/DistributedTransaction/methods/workflows.DistributedTransaction.addError/page.mdx Normal file
View File

@@ -0,0 +1,7 @@
import { TypeList } from "docs-ui"
# addError
## Parameters
<TypeList types={[{"name":"action","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handlerType","type":"[TransactionHandlerType](../../../enums/workflows.TransactionHandlerType/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"INVOKE","type":"`\"invoke\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"COMPENSATE","type":"`\"compensate\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"error","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="addError"/>

7
www/apps/resources/references/workflows/DistributedTransaction/methods/workflows.DistributedTransaction.addResponse/page.mdx Normal file
View File

@@ -0,0 +1,7 @@
import { TypeList } from "docs-ui"
# addResponse
## Parameters
<TypeList types={[{"name":"action","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handlerType","type":"[TransactionHandlerType](../../../enums/workflows.TransactionHandlerType/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"INVOKE","type":"`\"invoke\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"COMPENSATE","type":"`\"compensate\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"response","type":"`unknown`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="addResponse"/>

7
www/apps/resources/references/workflows/DistributedTransaction/methods/workflows.DistributedTransaction.canInvoke/page.mdx Normal file
View File

@@ -0,0 +1,7 @@
import { TypeList } from "docs-ui"
# canInvoke
## Returns
<TypeList types={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="canInvoke"/>

7
www/apps/resources/references/workflows/DistributedTransaction/methods/workflows.DistributedTransaction.canRevert/page.mdx Normal file
View File

@@ -0,0 +1,7 @@
import { TypeList } from "docs-ui"
# canRevert
## Returns
<TypeList types={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="canRevert"/>

11
www/apps/resources/references/workflows/DistributedTransaction/methods/workflows.DistributedTransaction.clearRetry/page.mdx Normal file
View File

@@ -0,0 +1,11 @@
import { TypeList } from "docs-ui"
# clearRetry
## Parameters
<TypeList types={[{"name":"step","type":"[TransactionStep](../../../classes/workflows.TransactionStep/page.mdx)","description":"TransactionStep","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"stepFailed","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"depth","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"definition","type":"[TransactionStepsDefinition](../../../types/workflows.TransactionStepsDefinition/page.mdx)","description":"Defines the structure and behavior of a single step within a transaction workflow.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"invoke","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"compensate","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attempts","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"failures","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"lastAttempt","type":"`null` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"retryRescheduledAt","type":"`null` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hasScheduledRetry","type":"`boolean`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"timedOutAt","type":"`null` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"next","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"saveResponse","type":"`boolean`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"uuid","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"startedAt","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="clearRetry"/>
## Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;void&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="clearRetry"/>

11
www/apps/resources/references/workflows/DistributedTransaction/methods/workflows.DistributedTransaction.clearStepTimeout/page.mdx Normal file
View File

@@ -0,0 +1,11 @@
import { TypeList } from "docs-ui"
# clearStepTimeout
## Parameters
<TypeList types={[{"name":"step","type":"[TransactionStep](../../../classes/workflows.TransactionStep/page.mdx)","description":"TransactionStep","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"stepFailed","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"depth","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"definition","type":"[TransactionStepsDefinition](../../../types/workflows.TransactionStepsDefinition/page.mdx)","description":"Defines the structure and behavior of a single step within a transaction workflow.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"invoke","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"compensate","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attempts","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"failures","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"lastAttempt","type":"`null` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"retryRescheduledAt","type":"`null` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hasScheduledRetry","type":"`boolean`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"timedOutAt","type":"`null` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"next","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"saveResponse","type":"`boolean`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"uuid","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"startedAt","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="clearStepTimeout"/>
## Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;void&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="clearStepTimeout"/>

7
www/apps/resources/references/workflows/DistributedTransaction/methods/workflows.DistributedTransaction.clearTransactionTimeout/page.mdx Normal file
View File

@@ -0,0 +1,7 @@
import { TypeList } from "docs-ui"
# clearTransactionTimeout
## Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;void&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="clearTransactionTimeout"/>

7
www/apps/resources/references/workflows/DistributedTransaction/methods/workflows.DistributedTransaction.getContext/page.mdx Normal file
View File

@@ -0,0 +1,7 @@
import { TypeList } from "docs-ui"
# getContext
## Returns
<TypeList types={[{"name":"payload","type":"`unknown`","description":"Object containing the initial payload.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"invoke","type":"`Record<string, unknown>`","description":"Object containing responses of Invoke handlers on steps flagged with saveResponse.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"compensate","type":"`Record<string, unknown>`","description":"Object containing responses of Compensate handlers on steps flagged with saveResponse.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"constructor","type":"(`payload?`: `unknown`, `invoke?`: `Record<string, unknown>`, `compensate?`: `Record<string, unknown>`) => [TransactionContext](../../../classes/workflows.TransactionContext/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="getContext"/>

11
www/apps/resources/references/workflows/DistributedTransaction/methods/workflows.DistributedTransaction.getErrors/page.mdx Normal file
View File

@@ -0,0 +1,11 @@
import { TypeList } from "docs-ui"
# getErrors
## Parameters
<TypeList types={[{"name":"handlerType","type":"[TransactionHandlerType](../../../enums/workflows.TransactionHandlerType/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"INVOKE","type":"`\"invoke\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"COMPENSATE","type":"`\"compensate\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="getErrors"/>
## Returns
<TypeList types={[{"name":"TransactionStepError[]","type":"[TransactionStepError](../../../classes/workflows.TransactionStepError/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"action","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handlerType","type":"[TransactionHandlerType](../../../enums/workflows.TransactionHandlerType/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"INVOKE","type":"`\"invoke\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"COMPENSATE","type":"`\"compensate\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"error","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"constructor","type":"(`action`: `string`, `handlerType`: [TransactionHandlerType](../../../enums/workflows.TransactionHandlerType/page.mdx), `error`: `any`) => [TransactionStepError](../../../classes/workflows.TransactionStepError/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="getErrors"/>

7
www/apps/resources/references/workflows/DistributedTransaction/methods/workflows.DistributedTransaction.getFlow/page.mdx Normal file
View File

File diff suppressed because one or more lines are too long

7
www/apps/resources/references/workflows/DistributedTransaction/methods/workflows.DistributedTransaction.getState/page.mdx Normal file
View File

@@ -0,0 +1,7 @@
import { TypeList } from "docs-ui"
# getState
## Returns
<TypeList types={[{"name":"NOT_STARTED","type":"`\"not_started\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"INVOKING","type":"`\"invoking\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"WAITING_TO_COMPENSATE","type":"`\"waiting_to_compensate\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"COMPENSATING","type":"`\"compensating\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"DONE","type":"`\"done\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"REVERTED","type":"`\"reverted\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"FAILED","type":"`\"failed\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="getState"/>

11
www/apps/resources/references/workflows/DistributedTransaction/methods/workflows.DistributedTransaction.getTemporaryData/page.mdx Normal file
View File

@@ -0,0 +1,11 @@
import { TypeList } from "docs-ui"
# getTemporaryData
## Parameters
<TypeList types={[{"name":"key","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="getTemporaryData"/>
## Returns
<TypeList types={[{"name":"unknown","type":"`unknown`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="getTemporaryData"/>

7
www/apps/resources/references/workflows/DistributedTransaction/methods/workflows.DistributedTransaction.getTimeout/page.mdx Normal file
View File

@@ -0,0 +1,7 @@
import { TypeList } from "docs-ui"
# getTimeout
## Returns
<TypeList types={[{"name":"undefined \\| number","type":"`undefined` \\| `number`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="getTimeout"/>

7
www/apps/resources/references/workflows/DistributedTransaction/methods/workflows.DistributedTransaction.hasFinished/page.mdx Normal file
View File

@@ -0,0 +1,7 @@
import { TypeList } from "docs-ui"
# hasFinished
## Returns
<TypeList types={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="hasFinished"/>

11
www/apps/resources/references/workflows/DistributedTransaction/methods/workflows.DistributedTransaction.hasTemporaryData/page.mdx Normal file
View File

@@ -0,0 +1,11 @@
import { TypeList } from "docs-ui"
# hasTemporaryData
## Parameters
<TypeList types={[{"name":"key","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="hasTemporaryData"/>
## Returns
<TypeList types={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="hasTemporaryData"/>

7
www/apps/resources/references/workflows/DistributedTransaction/methods/workflows.DistributedTransaction.hasTimeout/page.mdx Normal file
View File

@@ -0,0 +1,7 @@
import { TypeList } from "docs-ui"
# hasTimeout
## Returns
<TypeList types={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="hasTimeout"/>

11
www/apps/resources/references/workflows/DistributedTransaction/methods/workflows.DistributedTransaction.loadTransaction/page.mdx Normal file
View File

@@ -0,0 +1,11 @@
import { TypeList } from "docs-ui"
# loadTransaction
## Parameters
<TypeList types={[{"name":"modelId","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionId","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"isCancelling","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="loadTransaction"/>
## Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;null \\| [TransactionCheckpoint](../../../classes/workflows.TransactionCheckpoint/page.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"null \\| TransactionCheckpoint","type":"`null` \\| [TransactionCheckpoint](../../../classes/workflows.TransactionCheckpoint/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="loadTransaction"/>

11
www/apps/resources/references/workflows/DistributedTransaction/methods/workflows.DistributedTransaction.saveCheckpoint/page.mdx Normal file
View File

@@ -0,0 +1,11 @@
import { TypeList } from "docs-ui"
# saveCheckpoint
## Parameters
<TypeList types={[{"name":"ttl","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="saveCheckpoint"/>
## Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;undefined \\| [TransactionCheckpoint](../../../classes/workflows.TransactionCheckpoint/page.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"undefined \\| TransactionCheckpoint","type":"`undefined` \\| [TransactionCheckpoint](../../../classes/workflows.TransactionCheckpoint/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="saveCheckpoint"/>

11
www/apps/resources/references/workflows/DistributedTransaction/methods/workflows.DistributedTransaction.scheduleRetry/page.mdx Normal file
View File

@@ -0,0 +1,11 @@
import { TypeList } from "docs-ui"
# scheduleRetry
## Parameters
<TypeList types={[{"name":"step","type":"[TransactionStep](../../../classes/workflows.TransactionStep/page.mdx)","description":"TransactionStep","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"stepFailed","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"depth","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"definition","type":"[TransactionStepsDefinition](../../../types/workflows.TransactionStepsDefinition/page.mdx)","description":"Defines the structure and behavior of a single step within a transaction workflow.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"invoke","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"compensate","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attempts","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"failures","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"lastAttempt","type":"`null` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"retryRescheduledAt","type":"`null` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hasScheduledRetry","type":"`boolean`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"timedOutAt","type":"`null` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"next","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"saveResponse","type":"`boolean`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"uuid","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"startedAt","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"interval","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="scheduleRetry"/>
## Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;void&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="scheduleRetry"/>

11
www/apps/resources/references/workflows/DistributedTransaction/methods/workflows.DistributedTransaction.scheduleStepTimeout/page.mdx Normal file
View File

@@ -0,0 +1,11 @@
import { TypeList } from "docs-ui"
# scheduleStepTimeout
## Parameters
<TypeList types={[{"name":"step","type":"[TransactionStep](../../../classes/workflows.TransactionStep/page.mdx)","description":"TransactionStep","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"stepFailed","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"depth","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"definition","type":"[TransactionStepsDefinition](../../../types/workflows.TransactionStepsDefinition/page.mdx)","description":"Defines the structure and behavior of a single step within a transaction workflow.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"invoke","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"compensate","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attempts","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"failures","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"lastAttempt","type":"`null` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"retryRescheduledAt","type":"`null` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hasScheduledRetry","type":"`boolean`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"timedOutAt","type":"`null` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"next","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"saveResponse","type":"`boolean`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"uuid","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"startedAt","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"interval","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="scheduleStepTimeout"/>
## Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;void&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="scheduleStepTimeout"/>

11
www/apps/resources/references/workflows/DistributedTransaction/methods/workflows.DistributedTransaction.scheduleTransactionTimeout/page.mdx Normal file
View File

@@ -0,0 +1,11 @@
import { TypeList } from "docs-ui"
# scheduleTransactionTimeout
## Parameters
<TypeList types={[{"name":"interval","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="scheduleTransactionTimeout"/>
## Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;void&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="scheduleTransactionTimeout"/>

7
www/apps/resources/references/workflows/DistributedTransaction/methods/workflows.DistributedTransaction.setStorage/page.mdx Normal file
View File

@@ -0,0 +1,7 @@
import { TypeList } from "docs-ui"
# setStorage
## Parameters
<TypeList types={[{"name":"storage","type":"[IDistributedTransactionStorage](../../../interfaces/workflows.IDistributedTransactionStorage/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="setStorage"/>

7
www/apps/resources/references/workflows/DistributedTransaction/methods/workflows.DistributedTransaction.setTemporaryData/page.mdx Normal file
View File

@@ -0,0 +1,7 @@
import { TypeList } from "docs-ui"
# setTemporaryData
## Parameters
<TypeList types={[{"name":"key","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`unknown`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="setTemporaryData"/>