chore(docs): Generated References (#8495)

Generated the following references:
- `modules`
- `order`
- `types`
This commit is contained in:
github-actions[bot] authored and GitHub committed 2024-08-08 06:38:28 +00:00
1 parent eb09a063dc
commit 3259b9204c
57 files changed
+111661 -111072

No files matched your search

@@ -2849,7 +2849,7 @@ const helloWorldWorkflow = createWorkflow(
#### Returns
<TypeList types={[{"name":"Omit","type":"Omit&#60;LocalWorkflow, \"run\" \\| \"registerStepSuccess\" \\| \"registerStepFailure\" \\| \"cancel\"&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"LocalWorkflow","type":"`LocalWorkflow`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"\"run\" \\| \"registerStepSuccess\" \\| \"registerStepFailure\" \\| \"cancel\"","type":"`\"run\"` \\| `\"registerStepSuccess\"` \\| `\"registerStepFailure\"` \\| `\"cancel\"`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]},{"name":"ExportedWorkflow","type":"ExportedWorkflow&#60;CreateCartWorkflowInputDTO, [CartDTO](../../cart/interfaces/cart.CartDTO/page.mdx), TDataOverride, TResultOverride&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"CreateCartWorkflowInputDTO","type":"`CreateCartWorkflowInputDTO`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"CartDTO","type":"`object`","description":"The cart details.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"TDataOverride","type":"TDataOverride","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"TResultOverride","type":"TResultOverride","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} sectionTitle="createCartWorkflow"/>
<TypeList types={[{"name":"Omit","type":"Omit&#60;LocalWorkflow, \"run\" \\| \"registerStepSuccess\" \\| \"registerStepFailure\" \\| \"cancel\"&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"LocalWorkflow","type":"`LocalWorkflow`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"\"run\" \\| \"registerStepSuccess\" \\| \"registerStepFailure\" \\| \"cancel\"","type":"`\"run\"` \\| `\"registerStepSuccess\"` \\| `\"registerStepFailure\"` \\| `\"cancel\"`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]},{"name":"ExportedWorkflow","type":"ExportedWorkflow&#60;CreateCartWorkflowInputDTO & [AdditionalData](../../types/HttpTypes/types/types.HttpTypes.AdditionalData/page.mdx), [CartDTO](../../cart/interfaces/cart.CartDTO/page.mdx), TDataOverride, TResultOverride&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"CreateCartWorkflowInputDTO","type":"`CreateCartWorkflowInputDTO`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"AdditionalData","type":"`object`","description":"Represents the additional\\_data property accepted in HTTP\nrequests to allow arbitrary values","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"CartDTO","type":"`object`","description":"The cart details.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"TDataOverride","type":"TDataOverride","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"TResultOverride","type":"TResultOverride","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} sectionTitle="createCartWorkflow"/>
### createPaymentCollectionForCartWorkflow
@@ -2919,7 +2919,7 @@ const helloWorldWorkflow = createWorkflow(
#### Returns
<TypeList types={[{"name":"Omit","type":"Omit&#60;LocalWorkflow, \"run\" \\| \"registerStepSuccess\" \\| \"registerStepFailure\" \\| \"cancel\"&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"LocalWorkflow","type":"`LocalWorkflow`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"\"run\" \\| \"registerStepSuccess\" \\| \"registerStepFailure\" \\| \"cancel\"","type":"`\"run\"` \\| `\"registerStepSuccess\"` \\| `\"registerStepFailure\"` \\| `\"cancel\"`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]},{"name":"ExportedWorkflow","type":"ExportedWorkflow&#60;UpdateCartWorkflowInputDTO, unknown, TDataOverride, TResultOverride&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"UpdateCartWorkflowInputDTO","type":"`UpdateCartWorkflowInputDTO`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"unknown","type":"`unknown`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"TDataOverride","type":"TDataOverride","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"TResultOverride","type":"TResultOverride","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} sectionTitle="updateCartWorkflow"/>
<TypeList types={[{"name":"Omit","type":"Omit&#60;LocalWorkflow, \"run\" \\| \"registerStepSuccess\" \\| \"registerStepFailure\" \\| \"cancel\"&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"LocalWorkflow","type":"`LocalWorkflow`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"\"run\" \\| \"registerStepSuccess\" \\| \"registerStepFailure\" \\| \"cancel\"","type":"`\"run\"` \\| `\"registerStepSuccess\"` \\| `\"registerStepFailure\"` \\| `\"cancel\"`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]},{"name":"ExportedWorkflow","type":"ExportedWorkflow&#60;UpdateCartWorkflowInputDTO & [AdditionalData](../../types/HttpTypes/types/types.HttpTypes.AdditionalData/page.mdx), undefined, TDataOverride, TResultOverride&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"UpdateCartWorkflowInputDTO","type":"`UpdateCartWorkflowInputDTO`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"AdditionalData","type":"`object`","description":"Represents the additional\\_data property accepted in HTTP\nrequests to allow arbitrary values","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"undefined","type":"`undefined`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"TDataOverride","type":"TDataOverride","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"TResultOverride","type":"TResultOverride","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} sectionTitle="updateCartWorkflow"/>
### updateLineItemInCartWorkflow
@@ -3755,7 +3755,7 @@ const helloWorldWorkflow = createWorkflow(
#### Input
<TypeList types={[{"name":"claim_id","type":"`string`","description":"The claim's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The associated exchange's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`string`","description":"The internal note of the action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string`","description":"The name of the data model the action\nreferences. For example, `return`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the record of the data model\nspecified in [reference](../../order/interfaces/order.CancelOrderClaimDTO/page.mdx#reference).\n\nFor example, if `reference` is `return`, the\nvalue is `return_123`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"The user or customer that created this action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="cancelOrderClaimStep"/>
<TypeList types={[{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The associated claim's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The associated exchange's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`string`","description":"The internal note of the action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string`","description":"The name of the data model the action\nreferences. For example, `return`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the record of the data model\nspecified in [reference](../../order/interfaces/order.CancelOrderClaimDTO/page.mdx#reference).\n\nFor example, if `reference` is `return`, the\nvalue is `return_123`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"The user or customer that created this action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="cancelOrderClaimStep"/>
#### Output
@@ -3879,7 +3879,7 @@ const helloWorldWorkflow = createWorkflow(
#### Input
<TypeList types={[{"name":"exchange_id","type":"`string`","description":"The exchange's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The associated claim's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`string`","description":"The internal note of the action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string`","description":"The name of the data model the action\nreferences. For example, `return`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the record of the data model\nspecified in [reference](../../order/interfaces/order.CancelOrderExchangeDTO/page.mdx#reference).\n\nFor example, if `reference` is `return`, the\nvalue is `return_123`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"The user or customer that created this action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="cancelOrderExchangeStep"/>
<TypeList types={[{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The associated exchange's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The associated claim's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`string`","description":"The internal note of the action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string`","description":"The name of the data model the action\nreferences. For example, `return`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the record of the data model\nspecified in [reference](../../order/interfaces/order.CancelOrderExchangeDTO/page.mdx#reference).\n\nFor example, if `reference` is `return`, the\nvalue is `return_123`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"The user or customer that created this action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="cancelOrderExchangeStep"/>
#### Output
@@ -3955,7 +3955,7 @@ const helloWorldWorkflow = createWorkflow(
#### Input
<TypeList types={[{"name":"return_id","type":"`string`","description":"The return's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The associated claim's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The associated exchange's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`string`","description":"The internal note of the action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string`","description":"The name of the data model the action\nreferences. For example, `return`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the record of the data model\nspecified in [reference](../../order/interfaces/order.CancelOrderReturnDTO/page.mdx#reference).\n\nFor example, if `reference` is `return`, the\nvalue is `return_123`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"The user or customer that created this action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="cancelOrderReturnStep"/>
<TypeList types={[{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The associated claim's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The associated exchange's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`string`","description":"The internal note of the action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string`","description":"The name of the data model the action\nreferences. For example, `return`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the record of the data model\nspecified in [reference](../../order/interfaces/order.CancelOrderReturnDTO/page.mdx#reference).\n\nFor example, if `reference` is `return`, the\nvalue is `return_123`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"The user or customer that created this action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="cancelOrderReturnStep"/>
#### Output
@@ -7269,6 +7269,18 @@ const helloWorldWorkflow = createWorkflow(
<TypeList types={[{"name":"input","type":"__object","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"ids","type":"`string`[] \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)&#60;string[]&#62; & `string`[]","description":"","optional":false,"defaultValue":"input.ids","expandable":false,"children":[]}]}]} sectionTitle="addressesDeleted"/>
### cartCreated
#### Parameters
<TypeList types={[{"name":"input","type":"__object","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"cart","type":"[WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)&#60;[CartDTO](../../cart/interfaces/cart.CartDTO/page.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"__step__","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`undefined` \\| (Record&#60;string, unknown&#62; \\| WorkflowData&#60;Record&#60;string, unknown&#62; \\| undefined&#62;) & Record&#60;string, unknown&#62;","description":"","optional":false,"defaultValue":"input.additional_data","expandable":false,"children":[]}]}]} sectionTitle="cartCreated"/>
### cartUpdated
#### Parameters
<TypeList types={[{"name":"input","type":"__object","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"cart","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"additional_data","type":"`undefined` \\| (Record&#60;string, unknown&#62; \\| WorkflowData&#60;Record&#60;string, unknown&#62; \\| undefined&#62;) & Record&#60;string, unknown&#62;","description":"","optional":false,"defaultValue":"input.additional_data","expandable":false,"children":[]}]}]} sectionTitle="cartUpdated"/>
### collectionsCreated
#### Parameters