docs: fix broken links utility + uncaught broken links (#12637)
* fix broken links * update broken links utility * add missing payment evens * generate llms * fix segment link
This commit is contained in:
Shahed Nasser authored and 
GitHub committed
1 parent
9866baa852
commit
40e73c6ea2
64 files changed
+151813
-150840
No files matched your search
+52
@@ -146,3 +146,55 @@ const myWorkflow = createWorkflow(
|
||||
## Output
|
||||
|
||||
<TypeList types={[{"name":"null \\| PaymentDTO","type":"`null` \\| [PaymentDTO](../../../../../payment/interfaces/payment.PaymentDTO/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"null \\| PaymentDTO","type":"`null` \\| [PaymentDTO](../../../../../payment/interfaces/payment.PaymentDTO/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="markPaymentCollectionAsPaid"/>
|
||||
|
||||
## Emitted Events
|
||||
|
||||
This section lists the events that are either triggered by the `emitEventStep` in the workflow, or by another workflow executed within this workflow.
|
||||
|
||||
You can listen to these events in a subscriber, as explained in the [Subscribers](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers) documentation.
|
||||
|
||||
<Table>
|
||||
<Table.Header>
|
||||
<Table.Row>
|
||||
<Table.HeaderCell>
|
||||
Event
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Description
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Payload
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Action
|
||||
</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
<Table.Body>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
`payment.captured`
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
Emitted when a payment is captured.
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
```ts blockStyle="inline"
|
||||
{
|
||||
id, // the ID of the payment
|
||||
}
|
||||
```
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
|
||||
event: "payment.captured",
|
||||
payload: `\`\`\`ts
|
||||
{
|
||||
id, // the ID of the payment
|
||||
}
|
||||
\`\`\``
|
||||
}}/>
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
</Table>
|
||||
+52
@@ -140,3 +140,55 @@ const myWorkflow = createWorkflow(
|
||||
## Output
|
||||
|
||||
<TypeList types={[{"name":"PaymentDTO","type":"[PaymentDTO](../../../../../payment/interfaces/payment.PaymentDTO/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the payment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberValue](../../../../../payment/types/payment.BigNumberValue/page.mdx)","description":"The payment's total amount.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../../../payment/types/payment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"currency_code","type":"`string`","description":"The ISO 3 character currency code of the payment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"The ID of the associated payment provider.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_collection_id","type":"`string`","description":"The ID of the associated payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_amount","type":"[BigNumberValue](../../../../../payment/types/payment.BigNumberValue/page.mdx)","description":"The raw amount of the payment.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../../../payment/types/payment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"authorized_amount","type":"[BigNumberValue](../../../../../payment/types/payment.BigNumberValue/page.mdx)","description":"The authorized amount of the payment.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../../../payment/types/payment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"raw_authorized_amount","type":"[BigNumberValue](../../../../../payment/types/payment.BigNumberValue/page.mdx)","description":"The raw authorized amount of the payment.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../../../payment/types/payment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"data","type":"`Record<string, unknown>`","description":"The data relevant for the payment provider to process the payment.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the payment was created.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the payment was updated.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"captured_at","type":"`string` \\| `Date`","description":"When the payment was captured.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`string` \\| `Date`","description":"When the payment was canceled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"captured_amount","type":"[BigNumberValue](..Line truncated
|
||||
|
||||
## Emitted Events
|
||||
|
||||
This section lists the events that are either triggered by the `emitEventStep` in the workflow, or by another workflow executed within this workflow.
|
||||
|
||||
You can listen to these events in a subscriber, as explained in the [Subscribers](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers) documentation.
|
||||
|
||||
<Table>
|
||||
<Table.Header>
|
||||
<Table.Row>
|
||||
<Table.HeaderCell>
|
||||
Event
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Description
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Payload
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Action
|
||||
</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
<Table.Body>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
`payment.captured`
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
Emitted when a payment is captured.
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
```ts blockStyle="inline"
|
||||
{
|
||||
id, // the ID of the payment
|
||||
}
|
||||
```
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
|
||||
event: "payment.captured",
|
||||
payload: `\`\`\`ts
|
||||
{
|
||||
id, // the ID of the payment
|
||||
}
|
||||
\`\`\``
|
||||
}}/>
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
</Table>
|
||||
+25
@@ -206,6 +206,31 @@ order.
|
||||
{
|
||||
id, // The ID of the order
|
||||
}
|
||||
\`\`\``
|
||||
}}/>
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
`payment.captured`
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
Emitted when a payment is captured.
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
```ts blockStyle="inline"
|
||||
{
|
||||
id, // the ID of the payment
|
||||
}
|
||||
```
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
|
||||
event: "payment.captured",
|
||||
payload: `\`\`\`ts
|
||||
{
|
||||
id, // the ID of the payment
|
||||
}
|
||||
\`\`\``
|
||||
}}/>
|
||||
</Table.Cell>
|
||||
|
||||
+52
@@ -136,3 +136,55 @@ const myWorkflow = createWorkflow(
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"RefundPaymentWorkflowInput","type":"[RefundPaymentWorkflowInput](../../../../types/core_flows.RefundPaymentWorkflowInput/page.mdx)","optional":false,"defaultValue":"","description":"The data to refund a payment.","expandable":false,"children":[{"name":"payment_id","type":"`string`","description":"The ID of the payment to refund.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"The ID of the user that refunded the payment.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberInput](../../../../../types/types/types.BigNumberInput/page.mdx)","description":"The amount to refund. If not provided, the full payment amount will be refunded.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="refundPaymentWorkflow"/>
|
||||
|
||||
## Emitted Events
|
||||
|
||||
This section lists the events that are either triggered by the `emitEventStep` in the workflow, or by another workflow executed within this workflow.
|
||||
|
||||
You can listen to these events in a subscriber, as explained in the [Subscribers](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers) documentation.
|
||||
|
||||
<Table>
|
||||
<Table.Header>
|
||||
<Table.Row>
|
||||
<Table.HeaderCell>
|
||||
Event
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Description
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Payload
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Action
|
||||
</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
<Table.Body>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
`payment.refunded`
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
Emitted when a payment is refunded.
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
```ts blockStyle="inline"
|
||||
{
|
||||
id, // the ID of the payment
|
||||
}
|
||||
```
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
<CopyGeneratedSnippetButton tooltipText="Copy subscriber for event" type="subscriber" options={{
|
||||
event: "payment.refunded",
|
||||
payload: `\`\`\`ts
|
||||
{
|
||||
id, // the ID of the payment
|
||||
}
|
||||
\`\`\``
|
||||
}}/>
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
</Table>
|
||||
+9
@@ -0,0 +1,9 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# PaymentEvents
|
||||
|
||||
`Const` **PaymentEvents**: `Object`
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"CAPTURED","type":"`string`","description":"Emitted when a payment is captured.","optional":false,"defaultValue":"\"payment.captured\"","expandable":false,"children":[]},{"name":"REFUNDED","type":"`string`","description":"Emitted when a payment is refunded.","optional":false,"defaultValue":"\"payment.refunded\"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="PaymentEvents"/>
|
||||
@@ -0,0 +1,7 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# Payment
|
||||
|
||||
## Variables
|
||||
|
||||
- [PaymentEvents](../Payment/variables/events.Payment.PaymentEvents/page.mdx)
|
||||
@@ -0,0 +1,91 @@
|
||||
---
|
||||
slug: /references/payment/events
|
||||
sidebar_label: Events Reference
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# Payment Module Events Reference
|
||||
|
||||
This reference shows all the events emitted by the Medusa application related to the Payment Module. If you use the module outside the Medusa application, these events aren't emitted.
|
||||
|
||||
## Summary
|
||||
|
||||
<Table>
|
||||
<Table.Header>
|
||||
<Table.Row>
|
||||
<Table.HeaderCell>
|
||||
Event
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Description
|
||||
</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
<Table.Body>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
[payment.captured](#paymentcaptured)
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
Emitted when a payment is captured.
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
[payment.refunded](#paymentrefunded)
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
Emitted when a payment is refunded.
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
</Table>
|
||||
|
||||
<EventHeader headerLvl="2" headerProps={{ id: "paymentcaptured", children: (<>payment.captured</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="payment.captured" payload={`\`\`\`ts
|
||||
{
|
||||
id, // the ID of the payment
|
||||
}
|
||||
\`\`\``} />
|
||||
|
||||
Emitted when a payment is captured.
|
||||
|
||||
### Payload
|
||||
|
||||
```ts
|
||||
{
|
||||
id, // the ID of the payment
|
||||
}
|
||||
```
|
||||
|
||||
### Workflows Emitting this Event
|
||||
|
||||
The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the [Store](https://docs.medusajs.com/api/store) and [Admin](https://docs.medusajs.com/api/admin) API references.
|
||||
|
||||
- [capturePaymentWorkflow](/references/medusa-workflows/capturePaymentWorkflow)
|
||||
- [processPaymentWorkflow](/references/medusa-workflows/processPaymentWorkflow)
|
||||
- [markPaymentCollectionAsPaid](/references/medusa-workflows/markPaymentCollectionAsPaid)
|
||||
|
||||
---
|
||||
|
||||
<EventHeader headerLvl="2" headerProps={{ id: "paymentrefunded", children: (<>payment.refunded</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="payment.refunded" payload={`\`\`\`ts
|
||||
{
|
||||
id, // the ID of the payment
|
||||
}
|
||||
\`\`\``} />
|
||||
|
||||
Emitted when a payment is refunded.
|
||||
|
||||
### Payload
|
||||
|
||||
```ts
|
||||
{
|
||||
id, // the ID of the payment
|
||||
}
|
||||
```
|
||||
|
||||
### Workflows Emitting this Event
|
||||
|
||||
The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the [Store](https://docs.medusajs.com/api/store) and [Admin](https://docs.medusajs.com/api/admin) API references.
|
||||
|
||||
- [refundPaymentWorkflow](/references/medusa-workflows/refundPaymentWorkflow)
|
||||
@@ -2306,3 +2306,88 @@ Emitted when a fulfillment is marked as delivered.
|
||||
The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the [Store](https://docs.medusajs.com/api/store) and [Admin](https://docs.medusajs.com/api/admin) API references.
|
||||
|
||||
- [markOrderFulfillmentAsDeliveredWorkflow](/references/medusa-workflows/markOrderFulfillmentAsDeliveredWorkflow)
|
||||
|
||||
---
|
||||
|
||||
## Payment Events Events
|
||||
|
||||
### Summary
|
||||
|
||||
<Table>
|
||||
<Table.Header>
|
||||
<Table.Row>
|
||||
<Table.HeaderCell>
|
||||
Event
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Description
|
||||
</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
<Table.Body>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
[payment.captured](#paymentcaptured)
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
Emitted when a payment is captured.
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
[payment.refunded](#paymentrefunded)
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
Emitted when a payment is refunded.
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
</Table>
|
||||
|
||||
<EventHeader headerLvl="3" headerProps={{ id: "paymentcaptured", children: (<>payment.captured</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="payment.captured" payload={`\`\`\`ts
|
||||
{
|
||||
id, // the ID of the payment
|
||||
}
|
||||
\`\`\``} />
|
||||
|
||||
Emitted when a payment is captured.
|
||||
|
||||
#### Payload
|
||||
|
||||
```ts
|
||||
{
|
||||
id, // the ID of the payment
|
||||
}
|
||||
```
|
||||
|
||||
#### Workflows Emitting this Event
|
||||
|
||||
The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the [Store](https://docs.medusajs.com/api/store) and [Admin](https://docs.medusajs.com/api/admin) API references.
|
||||
|
||||
- [capturePaymentWorkflow](/references/medusa-workflows/capturePaymentWorkflow)
|
||||
- [processPaymentWorkflow](/references/medusa-workflows/processPaymentWorkflow)
|
||||
- [markPaymentCollectionAsPaid](/references/medusa-workflows/markPaymentCollectionAsPaid)
|
||||
|
||||
---
|
||||
|
||||
<EventHeader headerLvl="3" headerProps={{ id: "paymentrefunded", children: (<>payment.refunded</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="payment.refunded" payload={`\`\`\`ts
|
||||
{
|
||||
id, // the ID of the payment
|
||||
}
|
||||
\`\`\``} />
|
||||
|
||||
Emitted when a payment is refunded.
|
||||
|
||||
#### Payload
|
||||
|
||||
```ts
|
||||
{
|
||||
id, // the ID of the payment
|
||||
}
|
||||
```
|
||||
|
||||
#### Workflows Emitting this Event
|
||||
|
||||
The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the [Store](https://docs.medusajs.com/api/store) and [Admin](https://docs.medusajs.com/api/admin) API references.
|
||||
|
||||
- [refundPaymentWorkflow](/references/medusa-workflows/refundPaymentWorkflow)
|
||||
Reference in new issue
Block a user