@insurance-broker/api-client 2.5.0 → 2.7.0

package/dist/schema.d.ts

@@ -34,6 +34,16 @@ export interface paths {
          *     The **payer is not a field** either. An obligation is owed by whoever owns the policy, so a customer identifier here could only ever agree or be wrong (ADR-0042 §3).
          *
          *     A **due date in the past is accepted**: a book carried across from another system arrives already in arrears, and refusing that would make a migrated debt unrepresentable.
+         *
+         *     **`idempotencyKey` is optional, and it is the only thing that makes a retry safe.** Without one, a double-tapped button, a client retry after a timeout or two officers recording the same instalment each raise a separate debt — and that is correct, because two identical instalments falling due on one day is legitimate and nothing about `(policy, amount, due date, description)` can be made unique.
+         *
+         *     With one: a repeat carrying a key already used **returns the original charge and the same `201 Created` with the same `Location`**, so an honest retry is indistinguishable from a first call and no second debt exists. A repeat carrying that key with a **different** policy, amount, due date or description is a `409` and raises nothing.
+         *
+         *     **A key is honoured for as long as the charge it raised is kept, and nothing sweeps keys.** It is stored on the obligation rather than in a store of its own. Mint a fresh key per intended charge; do not recycle one (#394).
+         *
+         *     **What a key does not do**: it assumes the retrying client owns it. Two people at two desks recording the same instalment invent two keys, and both charges are raised (ADR-0042 §19).
+         *
+         *     **Two different things answer `409` here.** A key collision is settled — retrying it can only fail again — and carries no `retryable` marker. The group's concurrency conflict is the other one and says it is retryable. Branch on that, not on the status.
          */
         post: operations["RaiseObligation"];
         delete?: never;
@@ -2484,7 +2494,12 @@ export interface paths {
             path?: never;
             cookie?: never;
         };
-        /** The account this broker holds for the signed-in customer. */
+        /**
+         * The account this broker holds for the signed-in customer.
+         * @description **A `403` here is usually not an error.** `urn:brokerplatform:problem:customer-not-attached` means this sign-in has never been linked to a broker — the ordinary state of a customer who has registered but not yet redeemed an invitation, and the cue to show onboarding rather than a failure. A `403` *without* that type is an ordinary refusal and must not be read as onboarding: it is what a caller whose broker may not transact receives, and what a caller whose account the broker has suspended or closed receives.
+         *
+         *     **The `404` is retained for compatibility and is not the unattached state.** It means the caller holds the permission and the record is gone, which cannot happen through this API today; a client keying its onboarding branch on `404` will never reach it.
+         */
         get: operations["GetOwnCustomerAccount"];
         put?: never;
         post?: never;
@@ -7184,6 +7199,7 @@ export interface components {
             /** Format: date */
             dueOn: string;
             description: string;
+            idempotencyKey?: null | string;
         };
         RaiseOutstandingItemRequest: {
             awaitedFrom: null | string;
@@ -7854,6 +7870,15 @@ export interface operations {
                     "application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
                 };
             };
+            /** @description Conflict */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ProblemDetails"];
+                };
+            };
         };
     };
     GetObligation: {
@@ -13257,6 +13282,15 @@ export interface operations {
                     "application/json": components["schemas"]["OwnCustomerAccountResponse"];
                 };
             };
+            /** @description Forbidden */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ProblemDetails"];
+                };
+            };
             /** @description Not Found */
             404: {
                 headers: {

package/package.json

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