@insurance-broker/api-client 1.30.0 → 1.32.0

package/dist/schema.d.ts

@@ -194,6 +194,104 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/obligations/{id}/payments": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Record money that arrived against this charge
+         * @description PAY-001, ADR-0042 sections 4 and 5. Records that money arrived somewhere else. **The platform never asserts that it did**: under `ExternalRecordOnly` there is no gateway, nothing is collected here, and every payment carries the source it came through and the reference that source gave it.
+         *
+         *     **Those two fields are the idempotency key.** `(tenant, source, externalReference)` is unique, so the same money cannot be recorded twice — not because a handler checks, but because the row is unrepresentable (BR-009). There is deliberately **no `idempotencyKey` field**: a caller-invented key answers "is this the same request", and only "is this the same money" has A8's answer in it.
+         *
+         *     **A refusal is recorded, not merely returned.** Every attempt is written before the posting is tried, so a refused duplicate is findable in the reconciliation history read below.
+         *
+         *     The currency is **not** a field: it is the obligation's, held by a foreign key rather than by this handler. Nil is refused — a payment of nothing is nothing having arrived.
+         */
+        post: operations["RecordPayment"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/obligations/{id}/payment-attempts": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * The reconciliation history for this charge
+         * @description **A8's second half**: a duplicate posting must be *visible* in reconciliation history and not merely refused. One row per attempt — what arrived, from where, with which reference, at what instant, and by which subject — stamped with what the platform decided.
+         *
+         *     An `outcome` of `null` is a real state and not missing data: the attempt is written before the posting is tried, so it means a posting in flight, or a process that died between the two. That case is exactly what this read exists to surface.
+         *
+         *     `existingAmount` appears on one outcome only — a refusal because that reference is already recorded for a **different** figure. Both amounts survive and neither overwrites the other (BR-010).
+         */
+        get: operations["ReadPaymentAttempts"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/payments/{id}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Read one payment
+         * @description Another broker's payment and another customer's are invisible here rather than refused: the tenant and owner query filters remove them before the read runs, so all three cases answer the same `404` (ADR-0008, ADR-0030).
+         *
+         *     There is **no approval field**: approval is a separate recorded act and arrives in step 9.6, so a field here would be an unreachable `false` a reader would take for a fact.
+         */
+        get: operations["GetPayment"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        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;
@@ -4543,6 +4641,54 @@ export interface components {
             /** Format: date-time */
             acceptedAtUtc: null | string;
         };
+        PaymentAttemptResponse: {
+            /** Format: uuid */
+            id: string;
+            /** Format: uuid */
+            obligationId: string;
+            /** Format: double */
+            amount: number | string;
+            currency: string;
+            source: string;
+            externalReference: string;
+            attemptedBySubjectId: string;
+            /** Format: date-time */
+            attemptedAtUtc: string;
+            outcome: null | string;
+            /** Format: date-time */
+            concludedAtUtc: null | string;
+            /** Format: uuid */
+            paymentId: null | string;
+            /** 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;
+            /** Format: uuid */
+            obligationId: string;
+            /** Format: uuid */
+            customerId: string;
+            /** Format: double */
+            amount: number | string;
+            currency: string;
+            source: string;
+            externalReference: string;
+            status: string;
+            recordedBySubjectId: string;
+            /** Format: date-time */
+            postedAtUtc: string;
+        };
         PlaceLegalHoldRequest: {
             moduleName: null | string;
             entityType: null | string;
@@ -4932,6 +5078,12 @@ export interface components {
             /** Format: date */
             submittedOn: string;
         };
+        RecordPaymentRequest: {
+            /** Format: double */
+            amount: number | string;
+            source: string;
+            externalReference: string;
+        };
         RecordRenewalCustomerInformationRequest: {
             /** Format: uuid */
             formSubmissionId: null | string;
@@ -5588,6 +5740,144 @@ export interface operations {
             };
         };
     };
+    RecordPayment: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["RecordPaymentRequest"];
+            };
+        };
+        responses: {
+            /** @description Created */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["PaymentResponse"];
+                };
+            };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
+                };
+            };
+            /** @description Not Found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Conflict */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ProblemDetails"];
+                };
+            };
+        };
+    };
+    ReadPaymentAttempts: {
+        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"]["PaymentAttemptResponse"][];
+                };
+            };
+            /** @description Not Found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    GetPayment: {
+        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"]["PaymentResponse"];
+                };
+            };
+            /** @description Not Found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    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.30.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,