@eventcatalog/create-eventcatalog 4.2.2 → 4.2.3

package/templates/default/domains/Payment/services/PaymentService/events/PaymentInitiated/examples/examples.config.yaml

@@ -0,0 +1,15 @@
+standard-checkout.json:
+  name: Standard Checkout
+  summary: Payment initiated through the standard web checkout flow with a Visa credit card and multiple items.
+  usage: |
+    curl -X POST http://localhost:3000/events/publish \
+      -H "Content-Type: application/json" \
+      -d @standard-checkout.json
+
+express-checkout.json:
+  name: Express Checkout
+  summary: Payment initiated via Apple Pay express checkout on mobile for a single item with a discount code applied.
+  usage: |
+    curl -X POST http://localhost:3000/events/publish \
+      -H "Content-Type: application/json" \
+      -d @express-checkout.json

package/templates/default/domains/Payment/services/PaymentService/events/PaymentInitiated/examples/express-checkout.json

@@ -0,0 +1,45 @@
+{
+  "eventId": "evt_pi_9f8e7d6c-5b4a-3f2e-1d0c-9b8a7f6e5d4c",
+  "timestamp": "2024-03-16T07:33:41.890Z",
+  "type": "PaymentInitiated",
+  "source": "payment-service",
+  "data": {
+    "paymentId": "pay_3e2d1c0b-9a8f-7e6d-5c4b-3a2f1e0d9c8b",
+    "orderId": "ord_92855010",
+    "customerId": "cust_55832",
+    "amount": 29.99,
+    "currency": "USD",
+    "paymentMethod": {
+      "type": "apple_pay",
+      "brand": "mastercard",
+      "last4": "7654",
+      "walletType": "apple_pay"
+    },
+    "checkoutType": "express",
+    "shippingAddress": {
+      "line1": "890 Broadway",
+      "city": "New York",
+      "state": "NY",
+      "postalCode": "10003",
+      "country": "US"
+    },
+    "items": [
+      {
+        "productId": "prod_8210",
+        "name": "Phone Case - Clear",
+        "quantity": 1,
+        "unitPrice": 29.99
+      }
+    ],
+    "discountCode": "SAVE10",
+    "taxAmount": 2.66,
+    "shippingCost": 0.0,
+    "initiatedAt": "2024-03-16T07:33:41.890Z"
+  },
+  "metadata": {
+    "correlationId": "corr_c3d4e5f6-a7b8-9012-cdef-345678901234",
+    "channel": "mobile_app",
+    "ipAddress": "10.0.0.201",
+    "sessionId": "sess_2r3s4t5u6v7w8x9y"
+  }
+}

package/templates/default/domains/Payment/services/PaymentService/events/PaymentInitiated/examples/standard-checkout.json

@@ -0,0 +1,52 @@
+{
+  "eventId": "evt_pi_1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
+  "timestamp": "2024-03-15T10:58:22.104Z",
+  "type": "PaymentInitiated",
+  "source": "payment-service",
+  "data": {
+    "paymentId": "pay_4b5c6d7e-8f9a-0b1c-2d3e-4f5a6b7c8d9e",
+    "orderId": "ord_92840123",
+    "customerId": "cust_10482",
+    "amount": 189.97,
+    "currency": "USD",
+    "paymentMethod": {
+      "type": "credit_card",
+      "brand": "visa",
+      "last4": "4242",
+      "expiryMonth": 11,
+      "expiryYear": 2026
+    },
+    "checkoutType": "standard",
+    "shippingAddress": {
+      "line1": "123 Main Street",
+      "city": "San Francisco",
+      "state": "CA",
+      "postalCode": "94102",
+      "country": "US"
+    },
+    "items": [
+      {
+        "productId": "prod_5001",
+        "name": "Wireless Headphones",
+        "quantity": 1,
+        "unitPrice": 149.99
+      },
+      {
+        "productId": "prod_5032",
+        "name": "USB-C Cable",
+        "quantity": 2,
+        "unitPrice": 19.99
+      }
+    ],
+    "discountCode": null,
+    "taxAmount": 15.58,
+    "shippingCost": 0.0,
+    "initiatedAt": "2024-03-15T10:58:22.104Z"
+  },
+  "metadata": {
+    "correlationId": "corr_b2c3d4e5-f6a7-8901-bcde-f23456789012",
+    "channel": "web",
+    "ipAddress": "192.168.1.42",
+    "sessionId": "sess_7k8l9m0n1o2p3q4r"
+  }
+}

package/templates/default/domains/Payment/services/PaymentService/events/PaymentProcessed/examples/examples.config.yaml

@@ -0,0 +1,15 @@
+successful-payment.json:
+  name: Successful Payment
+  summary: A standard credit card payment completed successfully for a domestic order with multiple items.
+  usage: |
+    curl -X POST http://localhost:3000/events/publish \
+      -H "Content-Type: application/json" \
+      -d @successful-payment.json
+
+international-payment.json:
+  name: International Payment
+  summary: Payment processed for an international order in GBP with currency conversion details included.
+  usage: |
+    curl -X POST http://localhost:3000/events/publish \
+      -H "Content-Type: application/json" \
+      -d @international-payment.json

package/templates/default/domains/Payment/services/PaymentService/events/PaymentProcessed/examples/international-payment.json

@@ -0,0 +1,48 @@
+{
+  "eventId": "evt_pp_d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f9a",
+  "timestamp": "2024-03-15T18:22:10.556Z",
+  "type": "PaymentProcessed",
+  "source": "payment-service",
+  "data": {
+    "paymentId": "pay_8f9a0b1c-2d3e-4f5a-6b7c-8d9e0f1a2b3c",
+    "orderId": "ord_92847892",
+    "customerId": "cust_44219",
+    "amount": 74.5,
+    "currency": "GBP",
+    "paymentMethod": {
+      "type": "credit_card",
+      "brand": "mastercard",
+      "last4": "3391"
+    },
+    "status": "completed",
+    "transactionId": "txn_Uk4Lm5Np6Qr7St8",
+    "processingFee": 2.46,
+    "netAmount": 72.04,
+    "currencyConversion": {
+      "originalCurrency": "GBP",
+      "originalAmount": 74.5,
+      "convertedCurrency": "USD",
+      "convertedAmount": 94.27,
+      "exchangeRate": 1.2654
+    },
+    "billingAddress": {
+      "line1": "45 Oxford Road",
+      "city": "London",
+      "postalCode": "W1D 2DZ",
+      "country": "GB"
+    },
+    "items": [
+      {
+        "productId": "prod_7820",
+        "name": "Running Shoes - Size 10",
+        "quantity": 1,
+        "unitPrice": 74.5
+      }
+    ],
+    "completedAt": "2024-03-15T18:22:10.556Z"
+  },
+  "metadata": {
+    "correlationId": "corr_e5f6a7b8-c9d0-1e2f-3a4b-5c6d7e8f9a0b",
+    "channel": "mobile_app"
+  }
+}

package/templates/default/domains/Payment/services/PaymentService/events/PaymentProcessed/examples/successful-payment.json

@@ -0,0 +1,48 @@
+{
+  "eventId": "evt_pp_a1b2c3d4-e5f6-7890-abcd-ef1234567890",
+  "timestamp": "2024-03-15T11:04:33.218Z",
+  "type": "PaymentProcessed",
+  "source": "payment-service",
+  "data": {
+    "paymentId": "pay_4b5c6d7e-8f9a-0b1c-2d3e-4f5a6b7c8d9e",
+    "orderId": "ord_92840123",
+    "customerId": "cust_10482",
+    "amount": 189.97,
+    "currency": "USD",
+    "paymentMethod": {
+      "type": "credit_card",
+      "brand": "visa",
+      "last4": "4242"
+    },
+    "status": "completed",
+    "transactionId": "txn_XyZ1AbC2DeF3GhI",
+    "processingFee": 5.8,
+    "netAmount": 184.17,
+    "billingAddress": {
+      "line1": "123 Main Street",
+      "city": "San Francisco",
+      "state": "CA",
+      "postalCode": "94102",
+      "country": "US"
+    },
+    "items": [
+      {
+        "productId": "prod_5001",
+        "name": "Wireless Headphones",
+        "quantity": 1,
+        "unitPrice": 149.99
+      },
+      {
+        "productId": "prod_5032",
+        "name": "USB-C Cable",
+        "quantity": 2,
+        "unitPrice": 19.99
+      }
+    ],
+    "completedAt": "2024-03-15T11:04:33.218Z"
+  },
+  "metadata": {
+    "correlationId": "corr_b2c3d4e5-f6a7-8901-bcde-f23456789012",
+    "channel": "web"
+  }
+}

package/templates/default/domains/Subscriptions/services/BillingService/events/SubscriptionPaymentDue/examples/examples.config.yaml

@@ -0,0 +1,7 @@
+upcoming-renewal.json:
+  name: Upcoming Renewal Payment
+  summary: A payment reminder generated 3 days before a Pro Monthly subscription renewal is due.
+  usage: |
+    curl -X POST http://localhost:3000/events/publish \
+      -H "Content-Type: application/json" \
+      -d @upcoming-renewal.json

package/templates/default/domains/Subscriptions/services/BillingService/events/SubscriptionPaymentDue/examples/upcoming-renewal.json

@@ -0,0 +1,28 @@
+{
+  "eventId": "evt_pay_due_5a72bf",
+  "eventType": "SubscriptionPaymentDue",
+  "timestamp": "2024-04-12T06:00:00Z",
+  "data": {
+    "subscriptionId": "sub_9f84kd02",
+    "userId": "usr_28471",
+    "plan": {
+      "planId": "plan_monthly_pro",
+      "name": "Pro Monthly"
+    },
+    "amount": 32.39,
+    "currency": "USD",
+    "dueDate": "2024-04-15",
+    "billingPeriod": {
+      "start": "2024-04-15",
+      "end": "2024-05-15"
+    },
+    "paymentMethodId": "pm_card_4242",
+    "paymentMethodLast4": "4242",
+    "remindersSent": 1,
+    "daysUntilDue": 3
+  },
+  "metadata": {
+    "correlationId": "corr_due_001",
+    "version": "1.0.0"
+  }
+}

package/templates/default/domains/Subscriptions/services/SubscriptionService/events/UserSubscriptionCancelled/examples/examples.config.yaml

@@ -0,0 +1,15 @@
+voluntary-cancellation.json:
+  name: Voluntary Cancellation
+  summary: A customer voluntarily cancels their Pro Monthly subscription, effective at the end of the current billing cycle.
+  usage: |
+    curl -X POST http://localhost:3000/events/publish \
+      -H "Content-Type: application/json" \
+      -d @voluntary-cancellation.json
+
+payment-failure.json:
+  name: Payment Failure Cancellation
+  summary: System automatically cancels an Enterprise Annual subscription after 3 consecutive failed payment attempts.
+  usage: |
+    curl -X POST http://localhost:3000/events/publish \
+      -H "Content-Type: application/json" \
+      -d @payment-failure.json

package/templates/default/domains/Subscriptions/services/SubscriptionService/events/UserSubscriptionCancelled/examples/payment-failure.json

@@ -0,0 +1,25 @@
+{
+  "eventId": "evt_sub_cancel_b19c3f",
+  "eventType": "UserSubscriptionCancelled",
+  "timestamp": "2024-07-03T08:12:55Z",
+  "data": {
+    "subscriptionId": "sub_7j21np48",
+    "userId": "usr_41839",
+    "plan": {
+      "planId": "plan_annual_enterprise",
+      "name": "Enterprise Annual"
+    },
+    "cancellationReason": "payment_failure",
+    "cancellationNote": "Automatic cancellation after 3 failed payment attempts",
+    "cancelledBy": "system",
+    "effectiveDate": "2024-07-03",
+    "refundAmount": 0,
+    "failedPaymentAttempts": 3,
+    "lastPaymentAttempt": "2024-07-02T23:00:00Z",
+    "subscriptionDurationDays": 182
+  },
+  "metadata": {
+    "correlationId": "corr_aa11bb22",
+    "version": "1.0.0"
+  }
+}

package/templates/default/domains/Subscriptions/services/SubscriptionService/events/UserSubscriptionCancelled/examples/voluntary-cancellation.json

@@ -0,0 +1,23 @@
+{
+  "eventId": "evt_sub_cancel_4d82ea",
+  "eventType": "UserSubscriptionCancelled",
+  "timestamp": "2024-05-20T16:45:12Z",
+  "data": {
+    "subscriptionId": "sub_9f84kd02",
+    "userId": "usr_28471",
+    "plan": {
+      "planId": "plan_monthly_pro",
+      "name": "Pro Monthly"
+    },
+    "cancellationReason": "no_longer_needed",
+    "cancellationNote": "Switching to a competitor product",
+    "cancelledBy": "customer",
+    "effectiveDate": "2024-06-15",
+    "refundAmount": 0,
+    "subscriptionDurationDays": 67
+  },
+  "metadata": {
+    "correlationId": "corr_cd45ef67",
+    "version": "1.0.0"
+  }
+}

package/templates/default/domains/Subscriptions/services/SubscriptionService/events/UserSubscriptionStarted/examples/annual-plan.json

@@ -0,0 +1,26 @@
+{
+  "eventId": "evt_sub_start_e91f2a",
+  "eventType": "UserSubscriptionStarted",
+  "timestamp": "2024-06-01T14:05:33Z",
+  "data": {
+    "subscriptionId": "sub_3k72mf91",
+    "userId": "usr_55102",
+    "plan": {
+      "planId": "plan_annual_enterprise",
+      "name": "Enterprise Annual",
+      "billingCycle": "annual",
+      "price": 499.0,
+      "currency": "USD"
+    },
+    "trialPeriodDays": 0,
+    "startDate": "2024-06-01",
+    "nextBillingDate": "2025-06-01",
+    "paymentMethodId": "pm_card_1881",
+    "source": "sales_team",
+    "discountCode": "ENTERPRISE20"
+  },
+  "metadata": {
+    "correlationId": "corr_ff93aa12",
+    "version": "1.0.0"
+  }
+}

package/templates/default/domains/Subscriptions/services/SubscriptionService/events/UserSubscriptionStarted/examples/examples.config.yaml

@@ -0,0 +1,15 @@
+monthly-plan.json:
+  name: Monthly Plan Subscription
+  summary: A user subscribes to the Pro Monthly plan with a 14-day trial period via web checkout.
+  usage: |
+    curl -X POST http://localhost:3000/events/publish \
+      -H "Content-Type: application/json" \
+      -d @monthly-plan.json
+
+annual-plan.json:
+  name: Annual Enterprise Plan
+  summary: A user subscribes to the Enterprise Annual plan through the sales team with a discount code applied.
+  usage: |
+    curl -X POST http://localhost:3000/events/publish \
+      -H "Content-Type: application/json" \
+      -d @annual-plan.json

package/templates/default/domains/Subscriptions/services/SubscriptionService/events/UserSubscriptionStarted/examples/monthly-plan.json

@@ -0,0 +1,25 @@
+{
+  "eventId": "evt_sub_start_7a3b1c",
+  "eventType": "UserSubscriptionStarted",
+  "timestamp": "2024-03-15T09:22:41Z",
+  "data": {
+    "subscriptionId": "sub_9f84kd02",
+    "userId": "usr_28471",
+    "plan": {
+      "planId": "plan_monthly_pro",
+      "name": "Pro Monthly",
+      "billingCycle": "monthly",
+      "price": 29.99,
+      "currency": "USD"
+    },
+    "trialPeriodDays": 14,
+    "startDate": "2024-03-15",
+    "nextBillingDate": "2024-04-15",
+    "paymentMethodId": "pm_card_4242",
+    "source": "web_checkout"
+  },
+  "metadata": {
+    "correlationId": "corr_ab12cd34",
+    "version": "1.0.0"
+  }
+}