@insurance-broker/api-client 5.16.0 → 5.18.0

package/dist/schema.d.ts

@@ -769,7 +769,7 @@ export interface paths {
          *
          *     **Every export is logged before the file is handed over.** A receipt row and an audit entry naming what was exported, by whom, how much and a SHA-256 of the exact bytes are committed in one transaction first; if that commit fails, no data leaves. The receipts are readable at `GET /exports` under a separate key.
          *
-         *     **Nothing is stored.** The bytes are produced for this response and never written to the object store, so there is no link to fetch later and no file to orphan (ADR-0038 section 7 and section 11). The price is a ceiling: a selection of more than 5000 charges is refused with a `422` naming the count, and the caller narrows by customer, by policy or by view.
+         *     **Nothing is stored.** The bytes are produced for this response and never written to the object store, so there is no link to fetch later and no file to orphan (ADR-0038 section 7 and section 11). The price is a ceiling: a selection of more than 5000 charges is refused with a `422` naming the count, typed `urn:brokerplatform:problem:export-too-large` (#630), and the caller narrows by customer, by policy or by view.
          *
          *     **A PDF stops far sooner — 500 charges.** It is laid out one paragraph per charge and rendered under a lock the whole process shares, so a hundred-page one would be paid for by every other tenant's documents. The `422` names the format and its own ceiling; the same selection as a CSV carries the full amount.
          *
@@ -1656,6 +1656,28 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/customer/form-submissions/{id}/pinned-version": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Moves their draft onto the version of its form that is live now.
+         * @description Moves the customer's own draft onto the version of its form that is live now — the answer to a draft read with `pinnedVersionIsLive: false`. Every answer whose question survived is carried, and the ones the new version no longer asks are named in `droppedAnswerKeys`.
+         *
+         *     **A `409` here is a settled fact, and `type` says which** (#459, #470). `urn:brokerplatform:problem:product-not-open-to-new-business` means the product is no longer offered, or no longer exists, so the draft stays on the version it has. `urn:brokerplatform:problem:form-has-no-live-version` means the broker took the form's live version down and there is nothing to move onto. `urn:brokerplatform:problem:draft-already-on-live-version` means there is nothing to move: the draft already answers the live version. `urn:brokerplatform:problem:submission-already-submitted` means the form has been submitted and is never moved. `urn:brokerplatform:problem:form-version-unreadable` means the version it is on, or the one it would move onto, is in a schema this engine cannot read. `urn:brokerplatform:problem:recorded-answers-unreadable` means the answers saved so far cannot be read, so nothing could be carried; saving them again replaces them. `urn:brokerplatform:problem:concurrency-conflict` means another of their devices wrote first; read again and retry.
+         */
+        post: operations["RepinCustomerFormSubmission"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/form-submissions/{id}/attachments/{evidenceKey}": {
         parameters: {
             query?: never;
@@ -5704,7 +5726,12 @@ export interface paths {
         };
         get?: never;
         put?: never;
-        /** Takes exactly one option on exactly one presented version. Terminal. */
+        /**
+         * Takes exactly one option on exactly one presented version. Terminal.
+         * @description Accepts one option on the version that is presented now. Accepting is terminal: the quote request is settled and no further decision is recorded on it.
+         *
+         *     **An option whose premium is above the approval limit the acting member's role carries is a `409` typed `urn:brokerplatform:problem:acceptance-above-approval-limit`** (#197, #630). The limit is the broker's configuration, not the caller's permission, so retrying never helps: a member whose role carries a higher limit accepts it, or the caller accepts a smaller option. The other `409`s — a second acceptance, an option whose price has lapsed, a superseded version, a lost update — say which in their `detail`.
+         */
         post: operations["AcceptCustomerQuote"];
         delete?: never;
         options?: never;
@@ -5869,6 +5896,8 @@ export interface paths {
         /**
          * Keep a category for a period of this broker's own
          * @description Records a deliberate departure from the platform's default. A category carrying a minimum is configurable upward only: an audit trail a tenant can shorten is a weaker control than one they cannot, and the party most motivated to shorten it is the party under investigation (ADR-0038 section 8).
+         *
+         *     **A period beneath the category's minimum is a `422` typed `urn:brokerplatform:problem:retention-below-minimum`** (#630), carrying the category in a `categoryKey` field. It is a refusal of the number supplied: a longer period is accepted, a shorter one never is.
          */
         put: operations["SetRetentionOverride"];
         post?: never;
@@ -5918,6 +5947,8 @@ export interface paths {
         /**
          * End a hold, keeping the record of it
          * @description The hold row is never deleted: why a record was still here in 2031 must be answerable in 2032. A reason is required, because this is the act that exposes a record to destruction.
+         *
+         *     **Releasing a hold that is already released is a `409` typed `urn:brokerplatform:problem:legal-hold-already-released`** (#630): retrying cannot change it, so read the hold back. The other `409` is a lost update (ADR-0023): somebody else wrote the hold first, and a retry can succeed.
          */
         post: operations["ReleaseLegalHold"];
         delete?: never;
@@ -7140,6 +7171,11 @@ export interface components {
             /** Format: date-time */
             openedAtUtc: string;
         };
+        CustomerRepinnedSubmissionResponse: {
+            submission: components["schemas"]["CustomerFormSubmissionResponse"];
+            carriedAnswerKeys: string[];
+            droppedAnswerKeys: string[];
+        };
         CustomerResponse: {
             /** Format: uuid */
             id: string;
@@ -13633,6 +13669,53 @@ export interface operations {
             };
         };
     };
+    RepinCustomerFormSubmission: {
+        parameters: {
+            query?: never;
+            header?: {
+                /** @description The organisation to act for: one of the identifiers GET /api/v1/customer/contexts lists. Omit it, or send it empty, to act for your own account; there is no mode in which it becomes mandatory. A value you hold no active membership of, or one that is not an organisation identifier, is refused with 403 naming nothing, and never quietly treated as your own account. */
+                "X-Broker-Acting-For"?: components["parameters"]["ActingFor"];
+            };
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    /** @description The party this request actually acted for. Present, carrying the organisation identifier, when it acted for an organisation; absent when it acted for your own account. It mirrors the request header, so it can be sent back unchanged. Compare it with what you meant to send: it is the only way to see that a request you meant for an organisation was made personally. */
+                    "X-Broker-Acting-For"?: string;
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["CustomerRepinnedSubmissionResponse"];
+                };
+            };
+            /** @description Not Found */
+            404: {
+                headers: {
+                    /** @description The party this request actually acted for. Present, carrying the organisation identifier, when it acted for an organisation; absent when it acted for your own account. It mirrors the request header, so it can be sent back unchanged. Compare it with what you meant to send: it is the only way to see that a request you meant for an organisation was made personally. */
+                    "X-Broker-Acting-For"?: string;
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Conflict. A type of urn:brokerplatform:problem:concurrency-conflict means someone else changed the record first and nothing was written: read it again and decide again. Any other type is a conflict this operation decided itself, and retrying it unchanged will not help. */
+            409: {
+                headers: {
+                    /** @description The party this request actually acted for. Present, carrying the organisation identifier, when it acted for an organisation; absent when it acted for your own account. It mirrors the request header, so it can be sent back unchanged. Compare it with what you meant to send: it is the only way to see that a request you meant for an organisation was made personally. */
+                    "X-Broker-Acting-For"?: string;
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ConcurrencyConflictProblem"] | components["schemas"]["ProblemDetails"];
+                };
+            };
+        };
+    };
     UploadSubmissionAttachment: {
         parameters: {
             query?: never;

package/package.json

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