@eventcatalog/create-eventcatalog 4.3.12 → 4.3.14-beta.0

package/templates/default/domains/Payments/systems/fraud-detection/services/FraudAPI/events/FraudCheckFailed/examples/index.mdx

@@ -0,0 +1,271 @@
+<Columns cols={2}>
+
+<Column>
+
+## 1. Fail a payment with a high risk score
+
+A new account places a large order for hoodies from an unusual location. The risk model scores it highly, and the FraudAPI publishes `FraudCheckFailed` so the Payment Processing System blocks the charge and cancels the order.
+
+### Payload details
+
+- `reason` is `HIGH_RISK_SCORE`: the model score is above the block threshold.
+- `score` is `0.93` on a 0 to 1 scale, where higher is riskier.
+- `paymentId` and `orderId` identify the blocked payment and order.
+
+### Using this example
+
+Consumers should stop the charge for `paymentId` and cancel `orderId`. Tests can assert that the score is kept for review.
+
+The examples use a **fictional Acme Events SDK** to publish a payload matching the FraudCheckFailed schema. The package names and publish methods are illustrative.
+
+</Column>
+
+<Column>
+
+<CodeGroup dropdown>
+
+```typescript publish-fraud-check-failed.ts
+import { EventsClient } from '@acme/events';
+import type { FraudCheckFailed } from './schemas/fraud-check-failed';
+
+const client = new EventsClient({
+  apiKey: process.env.ACME_API_KEY!,
+});
+
+const event: FraudCheckFailed = {
+  paymentId: '428dc169-43a6-479d-9661-5b07984cb556',
+  orderId: '2d7ef31b-211a-4dbc-898a-0b095e7b909c',
+  score: 0.93,
+  reason: 'HIGH_RISK_SCORE',
+  checkedAt: '2026-09-16T02:47:13Z',
+};
+
+await client.publish('FraudCheckFailed', event);
+```
+
+```python publish_fraud_check_failed.py
+import os
+from acme_events import EventsClient
+
+client = EventsClient(api_key=os.environ["ACME_API_KEY"])
+
+event = {
+    "paymentId": "428dc169-43a6-479d-9661-5b07984cb556",
+    "orderId": "2d7ef31b-211a-4dbc-898a-0b095e7b909c",
+    "score": 0.93,
+    "reason": "HIGH_RISK_SCORE",
+    "checkedAt": "2026-09-16T02:47:13Z",
+}
+
+client.publish("FraudCheckFailed", event)
+```
+
+```java PublishFraudCheckFailed.java
+import com.acme.events.EventsClient;
+import java.util.Map;
+
+public class PublishFraudCheckFailed {
+  public static void main(String[] args) {
+    var client = new EventsClient(
+      System.getenv("ACME_API_KEY")
+    );
+
+    var event = Map.of(
+      "paymentId", "428dc169-43a6-479d-9661-5b07984cb556",
+      "orderId", "2d7ef31b-211a-4dbc-898a-0b095e7b909c",
+      "score", 0.93,
+      "reason", "HIGH_RISK_SCORE",
+      "checkedAt", "2026-09-16T02:47:13Z"
+    );
+
+    client.publish("FraudCheckFailed", event);
+  }
+}
+```
+
+</CodeGroup>
+
+</Column>
+
+</Columns>
+
+---
+
+<Columns cols={2}>
+
+<Column>
+
+## 2. Fail a payment from a blocklisted card
+
+A cap order is paid with a card on the blocklist. The FraudAPI rejects it straight away without running the risk model.
+
+### Payload details
+
+- `reason` is `BLOCKLISTED`: the card or customer matched a blocklist entry.
+- `score` is omitted because a rule, not the model, made the decision.
+
+### Using this example
+
+Use this payload to check that consumers block the payment even when `score` is missing.
+
+The examples use a **fictional Acme Events SDK** to publish a payload matching the FraudCheckFailed schema. The package names and publish methods are illustrative.
+
+</Column>
+
+<Column>
+
+<CodeGroup dropdown>
+
+```typescript publish-fraud-check-failed.ts
+import { EventsClient } from '@acme/events';
+import type { FraudCheckFailed } from './schemas/fraud-check-failed';
+
+const client = new EventsClient({
+  apiKey: process.env.ACME_API_KEY!,
+});
+
+const event: FraudCheckFailed = {
+  paymentId: 'dfdffee1-3e4d-4fa3-b86e-ebe0cd93ca60',
+  orderId: '76d60366-d78a-4e10-b1ad-832445febfa1',
+  reason: 'BLOCKLISTED',
+  checkedAt: '2026-09-17T11:20:05Z',
+};
+
+await client.publish('FraudCheckFailed', event);
+```
+
+```python publish_fraud_check_failed.py
+import os
+from acme_events import EventsClient
+
+client = EventsClient(api_key=os.environ["ACME_API_KEY"])
+
+event = {
+    "paymentId": "dfdffee1-3e4d-4fa3-b86e-ebe0cd93ca60",
+    "orderId": "76d60366-d78a-4e10-b1ad-832445febfa1",
+    "reason": "BLOCKLISTED",
+    "checkedAt": "2026-09-17T11:20:05Z",
+}
+
+client.publish("FraudCheckFailed", event)
+```
+
+```java PublishFraudCheckFailed.java
+import com.acme.events.EventsClient;
+import java.util.Map;
+
+public class PublishFraudCheckFailed {
+  public static void main(String[] args) {
+    var client = new EventsClient(
+      System.getenv("ACME_API_KEY")
+    );
+
+    var event = Map.of(
+      "paymentId", "dfdffee1-3e4d-4fa3-b86e-ebe0cd93ca60",
+      "orderId", "76d60366-d78a-4e10-b1ad-832445febfa1",
+      "reason", "BLOCKLISTED",
+      "checkedAt", "2026-09-17T11:20:05Z"
+    );
+
+    client.publish("FraudCheckFailed", event);
+  }
+}
+```
+
+</CodeGroup>
+
+</Column>
+
+</Columns>
+
+---
+
+<Columns cols={2}>
+
+<Column>
+
+## 3. Fail a payment for too many attempts
+
+The same card is used for many T-shirt orders within a few minutes. The FraudAPI flags the pattern and publishes `FraudCheckFailed`.
+
+### Payload details
+
+- `reason` is `VELOCITY`: too many payment attempts in a short time.
+- `score` is `0.67`, which is moderate on its own; the velocity rule caused the failure.
+
+### Using this example
+
+Consumers should block this payment. Tests can check that the order is cancelled based on `reason`, not on `score` alone.
+
+The examples use a **fictional Acme Events SDK** to publish a payload matching the FraudCheckFailed schema. The package names and publish methods are illustrative.
+
+</Column>
+
+<Column>
+
+<CodeGroup dropdown>
+
+```typescript publish-fraud-check-failed.ts
+import { EventsClient } from '@acme/events';
+import type { FraudCheckFailed } from './schemas/fraud-check-failed';
+
+const client = new EventsClient({
+  apiKey: process.env.ACME_API_KEY!,
+});
+
+const event: FraudCheckFailed = {
+  paymentId: '0c3b8e41-5a7f-4d26-9e18-b4f2a6d09c75',
+  orderId: '99027891-075d-4561-91f8-da95f34e4a57',
+  score: 0.67,
+  reason: 'VELOCITY',
+  checkedAt: '2026-09-18T16:55:41Z',
+};
+
+await client.publish('FraudCheckFailed', event);
+```
+
+```python publish_fraud_check_failed.py
+import os
+from acme_events import EventsClient
+
+client = EventsClient(api_key=os.environ["ACME_API_KEY"])
+
+event = {
+    "paymentId": "0c3b8e41-5a7f-4d26-9e18-b4f2a6d09c75",
+    "orderId": "99027891-075d-4561-91f8-da95f34e4a57",
+    "score": 0.67,
+    "reason": "VELOCITY",
+    "checkedAt": "2026-09-18T16:55:41Z",
+}
+
+client.publish("FraudCheckFailed", event)
+```
+
+```java PublishFraudCheckFailed.java
+import com.acme.events.EventsClient;
+import java.util.Map;
+
+public class PublishFraudCheckFailed {
+  public static void main(String[] args) {
+    var client = new EventsClient(
+      System.getenv("ACME_API_KEY")
+    );
+
+    var event = Map.of(
+      "paymentId", "0c3b8e41-5a7f-4d26-9e18-b4f2a6d09c75",
+      "orderId", "99027891-075d-4561-91f8-da95f34e4a57",
+      "score", 0.67,
+      "reason", "VELOCITY",
+      "checkedAt", "2026-09-18T16:55:41Z"
+    );
+
+    client.publish("FraudCheckFailed", event);
+  }
+}
+```
+
+</CodeGroup>
+
+</Column>
+
+</Columns>

package/templates/default/domains/Payments/systems/fraud-detection/services/FraudAPI/events/FraudCheckPassed/examples/index.mdx

@@ -0,0 +1,173 @@
+<Columns cols={2}>
+
+<Column>
+
+## 1. Pass a low-risk payment with a score
+
+Fraud Detection screens the T-shirt and cap payment from a returning customer and finds it low risk. The FraudAPI publishes `FraudCheckPassed` so the Payment Processing System lets the charge go ahead.
+
+### Payload details
+
+- `paymentId` and `orderId` match the `PaymentRequested` event that was screened.
+- `score` is `0.08` on a 0 to 1 scale, where lower is safer.
+- `checkedAt` is when the screening finished.
+
+### Using this example
+
+Consumers should mark the payment as cleared for `paymentId`. Tests can also assert that `score` is between 0 and 1.
+
+The examples use a **fictional Acme Events SDK** to publish a payload matching the FraudCheckPassed schema. The package names and publish methods are illustrative.
+
+</Column>
+
+<Column>
+
+<CodeGroup dropdown>
+
+```typescript publish-fraud-check-passed.ts
+import { EventsClient } from '@acme/events';
+import type { FraudCheckPassed } from './schemas/fraud-check-passed';
+
+const client = new EventsClient({
+  apiKey: process.env.ACME_API_KEY!,
+});
+
+const event: FraudCheckPassed = {
+  paymentId: '586e57ab-77a9-406a-945d-4619c76a582e',
+  orderId: '971b5a4b-6885-405c-899b-5e0f428016c1',
+  score: 0.08,
+  checkedAt: '2026-09-11T08:12:47Z',
+};
+
+await client.publish('FraudCheckPassed', event);
+```
+
+```python publish_fraud_check_passed.py
+import os
+from acme_events import EventsClient
+
+client = EventsClient(api_key=os.environ["ACME_API_KEY"])
+
+event = {
+    "paymentId": "586e57ab-77a9-406a-945d-4619c76a582e",
+    "orderId": "971b5a4b-6885-405c-899b-5e0f428016c1",
+    "score": 0.08,
+    "checkedAt": "2026-09-11T08:12:47Z",
+}
+
+client.publish("FraudCheckPassed", event)
+```
+
+```java PublishFraudCheckPassed.java
+import com.acme.events.EventsClient;
+import java.util.Map;
+
+public class PublishFraudCheckPassed {
+  public static void main(String[] args) {
+    var client = new EventsClient(
+      System.getenv("ACME_API_KEY")
+    );
+
+    var event = Map.of(
+      "paymentId", "586e57ab-77a9-406a-945d-4619c76a582e",
+      "orderId", "971b5a4b-6885-405c-899b-5e0f428016c1",
+      "score", 0.08,
+      "checkedAt", "2026-09-11T08:12:47Z"
+    );
+
+    client.publish("FraudCheckPassed", event);
+  }
+}
+```
+
+</CodeGroup>
+
+</Column>
+
+</Columns>
+
+---
+
+<Columns cols={2}>
+
+<Column>
+
+## 2. Pass a payment without a score
+
+The guest hoodie order is cleared by an allowlist rule, so no risk model runs. The FraudAPI publishes `FraudCheckPassed` with only the required fields.
+
+### Payload details
+
+- `score` is optional and omitted because no model scored the payment.
+- `paymentId` and `orderId` identify the guest payment that was screened.
+
+### Using this example
+
+Use this payload to check that consumers do not depend on `score` being present.
+
+The examples use a **fictional Acme Events SDK** to publish a payload matching the FraudCheckPassed schema. The package names and publish methods are illustrative.
+
+</Column>
+
+<Column>
+
+<CodeGroup dropdown>
+
+```typescript publish-fraud-check-passed.ts
+import { EventsClient } from '@acme/events';
+import type { FraudCheckPassed } from './schemas/fraud-check-passed';
+
+const client = new EventsClient({
+  apiKey: process.env.ACME_API_KEY!,
+});
+
+const event: FraudCheckPassed = {
+  paymentId: '41651c3f-fa8e-40fc-a217-a83929d15081',
+  orderId: 'e39a80be-526e-4009-a22a-40c847cff088',
+  checkedAt: '2026-09-14T19:03:29Z',
+};
+
+await client.publish('FraudCheckPassed', event);
+```
+
+```python publish_fraud_check_passed.py
+import os
+from acme_events import EventsClient
+
+client = EventsClient(api_key=os.environ["ACME_API_KEY"])
+
+event = {
+    "paymentId": "41651c3f-fa8e-40fc-a217-a83929d15081",
+    "orderId": "e39a80be-526e-4009-a22a-40c847cff088",
+    "checkedAt": "2026-09-14T19:03:29Z",
+}
+
+client.publish("FraudCheckPassed", event)
+```
+
+```java PublishFraudCheckPassed.java
+import com.acme.events.EventsClient;
+import java.util.Map;
+
+public class PublishFraudCheckPassed {
+  public static void main(String[] args) {
+    var client = new EventsClient(
+      System.getenv("ACME_API_KEY")
+    );
+
+    var event = Map.of(
+      "paymentId", "41651c3f-fa8e-40fc-a217-a83929d15081",
+      "orderId", "e39a80be-526e-4009-a22a-40c847cff088",
+      "checkedAt", "2026-09-14T19:03:29Z"
+    );
+
+    client.publish("FraudCheckPassed", event);
+  }
+}
+```
+
+</CodeGroup>
+
+</Column>
+
+</Columns>

package/templates/default/domains/Payments/systems/payment-processing-system/services/PaymentWorker/events/PaymentRequested/examples/index.mdx

@@ -0,0 +1,191 @@
+<Columns cols={2}>
+
+<Column>
+
+## 1. Request a charge for a signed-in customer
+
+A signed-in customer checks out a T-shirt and a cap. The PaymentWorker publishes `PaymentRequested` so Stripe charges the card, and Fraud Detection screens the payment in parallel.
+
+### Payload details
+
+- `paymentId` is the new payment created by the PaymentWorker; `orderId` links it back to the order.
+- `customerId` is included because the shopper has an account, which lets Fraud Detection use their history.
+- `amount` is in minor units: a £24.99 T-shirt plus a £17.99 cap.
+- `currency` is the ISO 4217 code `GBP`.
+
+The charge is **4,298 pence (£42.98)**.
+
+### Using this example
+
+Consumers should charge exactly `amount` in `currency` and carry `paymentId` through to the `PaymentSucceeded` or `PaymentFailed` reply.
+
+The examples use a **fictional Acme Events SDK** to publish a payload matching the PaymentRequested schema. The package names and publish methods are illustrative.
+
+</Column>
+
+<Column>
+
+<CodeGroup dropdown>
+
+```typescript publish-payment-requested.ts
+import { EventsClient } from '@acme/events';
+import type { PaymentRequested } from './schemas/payment-requested';
+
+const client = new EventsClient({
+  apiKey: process.env.ACME_API_KEY!,
+});
+
+const event: PaymentRequested = {
+  paymentId: '586e57ab-77a9-406a-945d-4619c76a582e',
+  orderId: '971b5a4b-6885-405c-899b-5e0f428016c1',
+  customerId: '74ea26c5-fb6c-4000-a036-f1749f67032c',
+  amount: 4298,
+  currency: 'GBP',
+  requestedAt: '2026-09-11T08:12:45Z',
+};
+
+await client.publish('PaymentRequested', event);
+```
+
+```python publish_payment_requested.py
+import os
+from acme_events import EventsClient
+
+client = EventsClient(api_key=os.environ["ACME_API_KEY"])
+
+event = {
+    "paymentId": "586e57ab-77a9-406a-945d-4619c76a582e",
+    "orderId": "971b5a4b-6885-405c-899b-5e0f428016c1",
+    "customerId": "74ea26c5-fb6c-4000-a036-f1749f67032c",
+    "amount": 4298,
+    "currency": "GBP",
+    "requestedAt": "2026-09-11T08:12:45Z",
+}
+
+client.publish("PaymentRequested", event)
+```
+
+```java PublishPaymentRequested.java
+import com.acme.events.EventsClient;
+import java.util.Map;
+
+public class PublishPaymentRequested {
+  public static void main(String[] args) {
+    var client = new EventsClient(
+      System.getenv("ACME_API_KEY")
+    );
+
+    var event = Map.of(
+      "paymentId", "586e57ab-77a9-406a-945d-4619c76a582e",
+      "orderId", "971b5a4b-6885-405c-899b-5e0f428016c1",
+      "customerId", "74ea26c5-fb6c-4000-a036-f1749f67032c",
+      "amount", 4298,
+      "currency", "GBP",
+      "requestedAt", "2026-09-11T08:12:45Z"
+    );
+
+    client.publish("PaymentRequested", event);
+  }
+}
+```
+
+</CodeGroup>
+
+</Column>
+
+</Columns>
+
+---
+
+<Columns cols={2}>
+
+<Column>
+
+## 2. Request a charge for a guest checkout
+
+A guest shopper in Ireland buys three hoodies without an account. The PaymentWorker publishes `PaymentRequested` with only the required fields.
+
+### Payload details
+
+- `customerId` is omitted because guest checkouts have no customer account.
+- `amount` is three hoodies at €54.99 each, in cents.
+- `currency` is `EUR`.
+
+The charge is **16,497 cents (€164.97)**.
+
+### Using this example
+
+Use this payload to check that Fraud Detection and Stripe handle a missing `customerId` without failing.
+
+The examples use a **fictional Acme Events SDK** to publish a payload matching the PaymentRequested schema. The package names and publish methods are illustrative.
+
+</Column>
+
+<Column>
+
+<CodeGroup dropdown>
+
+```typescript publish-payment-requested.ts
+import { EventsClient } from '@acme/events';
+import type { PaymentRequested } from './schemas/payment-requested';
+
+const client = new EventsClient({
+  apiKey: process.env.ACME_API_KEY!,
+});
+
+const event: PaymentRequested = {
+  paymentId: '41651c3f-fa8e-40fc-a217-a83929d15081',
+  orderId: 'e39a80be-526e-4009-a22a-40c847cff088',
+  amount: 16497,
+  currency: 'EUR',
+  requestedAt: '2026-09-14T19:03:27Z',
+};
+
+await client.publish('PaymentRequested', event);
+```
+
+```python publish_payment_requested.py
+import os
+from acme_events import EventsClient
+
+client = EventsClient(api_key=os.environ["ACME_API_KEY"])
+
+event = {
+    "paymentId": "41651c3f-fa8e-40fc-a217-a83929d15081",
+    "orderId": "e39a80be-526e-4009-a22a-40c847cff088",
+    "amount": 16497,
+    "currency": "EUR",
+    "requestedAt": "2026-09-14T19:03:27Z",
+}
+
+client.publish("PaymentRequested", event)
+```
+
+```java PublishPaymentRequested.java
+import com.acme.events.EventsClient;
+import java.util.Map;
+
+public class PublishPaymentRequested {
+  public static void main(String[] args) {
+    var client = new EventsClient(
+      System.getenv("ACME_API_KEY")
+    );
+
+    var event = Map.of(
+      "paymentId", "41651c3f-fa8e-40fc-a217-a83929d15081",
+      "orderId", "e39a80be-526e-4009-a22a-40c847cff088",
+      "amount", 16497,
+      "currency", "EUR",
+      "requestedAt", "2026-09-14T19:03:27Z"
+    );
+
+    client.publish("PaymentRequested", event);
+  }
+}
+```
+
+</CodeGroup>
+
+</Column>
+
+</Columns>