@insurance-broker/api-client 1.31.0 → 1.32.0

package/dist/schema.d.ts

@@ -266,6 +266,32 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/payments/{id}/events": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * What happened to this payment, and who said so
+         * @description ADR-0042 section 8's *"every payment's history is explainable"*. One row per thing that happened to this payment, in the order it happened, each naming the subject that caused it.
+         *
+         *     **Append-only in the strong sense.** `UPDATE` and `DELETE` are revoked from the application role on this table, so a row here cannot be rewritten by a data fix or a restored backup - which is the half a convention cannot give.
+         *
+         *     **It is not an event source.** The payment carries its own state and this explains how it got there; deriving the state by replaying these rows would be a second representation able to disagree with the first.
+         *
+         *     A refusal row **names the attempt** it is about rather than repeating its figures. The amounts, the source and the reference are on that attempt, which the reconciliation history read returns.
+         */
+        get: operations["ReadPaymentHistory"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/insurers": {
         parameters: {
             query?: never;
@@ -4636,6 +4662,16 @@ export interface components {
             /** Format: double */
             existingAmount: null | number | string;
         };
+        PaymentEventResponse: {
+            /** Format: uuid */
+            id: string;
+            kind: string;
+            /** Format: date-time */
+            occurredAtUtc: string;
+            actorSubjectId: string;
+            /** Format: uuid */
+            paymentAttemptId: null | string;
+        };
         PaymentResponse: {
             /** Format: uuid */
             id: string;
@@ -5813,6 +5849,35 @@ export interface operations {
             };
         };
     };
+    ReadPaymentHistory: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["PaymentEventResponse"][];
+                };
+            };
+            /** @description Not Found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
     ListInsurers: {
         parameters: {
             query?: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@insurance-broker/api-client",
-  "version": "1.31.0",
+  "version": "1.32.0",
   "description": "Generated TypeScript client for the Insurance Broker Platform API. Do not edit by hand: regenerate with scripts/update-api-contract.",
   "license": "UNLICENSED",
   "private": false,