docs: document missing events in reference (#10779)

2024-12-31 12:44:38 +02:00
parent 0e2f608db8
commit 6780ea9f13
11 changed files with 205 additions and 2 deletions
@@ -0,0 +1,55 @@
+import { Table } from "docs-ui"
+
+<Table>
+  <Table.Header>
+    <Table.Row>
+      <Table.HeaderCell>Event Name</Table.HeaderCell>
+      <Table.HeaderCell>Description</Table.HeaderCell>
+      <Table.HeaderCell className="w-1/3">Payload</Table.HeaderCell>
+    </Table.Row>
+  </Table.Header>
+  <Table.Body>
+    <Table.Row>
+      <Table.Cell>
+
+      `shipment.created`
+
+      </Table.Cell>
+      <Table.Cell>
+
+      Emitted when an admin user creates a shipment.
+
+      </Table.Cell>
+      <Table.Cell>
+
+```ts blockStyle="inline"
+{
+  id, // The ID of the shipment
+}
+```
+
+      </Table.Cell>
+    </Table.Row>
+    <Table.Row>
+      <Table.Cell>
+
+      `delivery.created`
+
+      </Table.Cell>
+      <Table.Cell>
+
+      Emitted when the admin user marks an order fulfillment as delivered.
+
+      </Table.Cell>
+      <Table.Cell>
+
+```ts blockStyle="inline"
+{
+  id, // The ID of the fulfillment
+}
+```
+
+      </Table.Cell>
+    </Table.Row>
+  </Table.Body>
+</Table>
@@ -0,0 +1,11 @@
+import Content from "./_content.mdx"
+
+export const metadata = {
+  title: `Fulfillment Module Events Reference`,
+}
+
+# {metadata.title}
+
+This reference shows all the events emitted by the Medusa application related to the Fulfillment Module. If you use the module outside the Medusa application, these events aren't emitted. 
+
+<Content />
@@ -9,6 +9,27 @@ import { Table } from "docs-ui"
    </Table.Row>
  </Table.Header>
  <Table.Body>
+    <Table.Row>
+      <Table.Cell>
+
+      `order.updated`
+
+      </Table.Cell>
+      <Table.Cell>
+
+      Emitted when an admin user updates an order's details.
+
+      </Table.Cell>
+      <Table.Cell>
+
+```ts blockStyle="inline"
+{
+  id, // The ID of the order
+}
+```
+
+      </Table.Cell>
+    </Table.Row>
    <Table.Row>
      <Table.Cell>

@@ -0,0 +1,55 @@
+import { Table } from "docs-ui"
+
+<Table>
+  <Table.Header>
+    <Table.Row>
+      <Table.HeaderCell>Event Name</Table.HeaderCell>
+      <Table.HeaderCell>Description</Table.HeaderCell>
+      <Table.HeaderCell className="w-1/3">Payload</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.Row>
+    <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.Row>
+  </Table.Body>
+</Table>
@@ -0,0 +1,11 @@
+import Content from "./_content.mdx"
+
+export const metadata = {
+  title: `Payment Module Events Reference`,
+}
+
+# {metadata.title}
+
+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. 
+
+<Content />