@insurance-broker/api-client 1.33.0 → 1.34.0

package/dist/schema.d.ts

@@ -74,6 +74,34 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/obligations/{id}/write-off": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Forgive a debt that will not be collected
+         * @description PAY-002, and ADR-0042 section 12's anchoring event. Records that a **real** debt will not be collected, with the reason on the record.
+         *
+         *     **This is not a cancellation.** Cancelling says the charge should never have existed; writing off says it should have been paid and will not be. A broker asking "how much did we forgive" needs the two apart, so they are separate acts with separate audit actions.
+         *
+         *     **The reason is required and is the broker's own words.** This platform declares no vocabulary of write-off reasons, because why a debt is forgiven is a broker's collections policy rather than a platform's.
+         *
+         *     **It is why an obligation nobody will chase is not kept for ever.** An unsettled charge has no retention anchor and is therefore kept (ADR-0038 section 2); writing one off is the event that starts its clock.
+         *
+         *     Refused on a charge that has already concluded — a settled one was paid and a cancelled one was never owed — rather than silently re-stamping an anchor.
+         */
+        post: operations["WriteOffObligation"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/invoices": {
         parameters: {
             query?: never;
@@ -4641,6 +4669,7 @@ export interface components {
             raisedAtUtc: string;
             /** Format: date-time */
             retentionAnchorAtUtc: null | string;
+            writeOffReason: null | string;
         };
         OfferedFormResponse: {
             /** Format: uuid */
@@ -5551,6 +5580,9 @@ export interface components {
         WriteClaimNoteRequest: {
             body: string;
         };
+        WriteOffObligationRequest: {
+            reason: string;
+        };
     };
     responses: never;
     parameters: never;
@@ -5660,6 +5692,57 @@ export interface operations {
             };
         };
     };
+    WriteOffObligation: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["WriteOffObligationRequest"];
+            };
+        };
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ObligationResponse"];
+                };
+            };
+            /** @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"];
+                };
+            };
+        };
+    };
     DraftInvoice: {
         parameters: {
             query?: never;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@insurance-broker/api-client",
-  "version": "1.33.0",
+  "version": "1.34.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,