@insurance-broker/api-client 5.45.0 → 5.47.0

package/dist/schema.d.ts

@@ -5012,6 +5012,26 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/document-templates/{id}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * One of the broker's document templates, with its live version and its draft
+         * @description The same shape as an item of the list, read by identifier, so a template stays reachable when the broker has more templates than one list request returns (#799).
+         */
+        get: operations["GetDocumentTemplate"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/document-templates/{id}/versions": {
         parameters: {
             query?: never;
@@ -5046,6 +5066,8 @@ export interface paths {
         /**
          * Discard a draft that is not going to be published
          * @description The way out of an abandoned draft. At most one draft of a template exists at a time, so a draft nobody finishes would otherwise block every future version of that template for good. Only a draft can be discarded: a published or retired version is what generated documents say and is kept (BR-002, DOC-008).
+         *
+         *     **`If-Match` is optional and honoured** (ADR-0023's 2026-10-26 amendment, #799). Send the version's `concurrencyToken` to be refused with `409` `urn:brokerplatform:problem:concurrency-conflict` if the version changed since it was read; leave it out and the write behaves as it did before the token was published. A token this API could not have issued is a `400` keyed `If-Match`.
          */
         delete: operations["DiscardDocumentTemplateVersion"];
         options?: never;
@@ -5064,6 +5086,8 @@ export interface paths {
         /**
          * Replace a draft's body
          * @description Only a draft's body can be replaced, and the body is not validated here beyond being a JSON object within the size cap: an author needs more than one sitting to write a template. Everything else is checked when the version is published.
+         *
+         *     **`If-Match` is optional and honoured** (ADR-0023's 2026-10-26 amendment, #799). Send the version's `concurrencyToken` to be refused with `409` `urn:brokerplatform:problem:concurrency-conflict` if the version changed since it was read; leave it out and the write behaves as it did before the token was published. A token this API could not have issued is a `400` keyed `If-Match`.
          */
         put: operations["ReviseDocumentTemplateVersionBody"];
         post?: never;
@@ -5085,6 +5109,8 @@ export interface paths {
         /**
          * Make a draft live, retiring whatever version it supersedes
          * @description The one place the body language runs as a gate. The canonical serialisation is what gets stored and the hash over it is what a generated document is later proved against (BR-002, DOC-005).
+         *
+         *     **`If-Match` is optional and honoured** (ADR-0023's 2026-10-26 amendment, #799). Send the version's `concurrencyToken` to be refused with `409` `urn:brokerplatform:problem:concurrency-conflict` if the version changed since it was read; leave it out and the write behaves as it did before the token was published. A token this API could not have issued is a `400` keyed `If-Match`.
          */
         post: operations["PublishDocumentTemplateVersion"];
         delete?: never;
@@ -5105,6 +5131,8 @@ export interface paths {
         /**
          * Take the live version down, leaving the template generating nothing
          * @description Publishing the next version is the usual way a version retires; this is the deliberate one, for a broker that has found a mistake in live wording and has nothing ready to replace it. The template then has no live version, so generating from it is refused until one is published. The retired version stays readable: documents generated from it name it (DOC-005, DOC-008).
+         *
+         *     **`If-Match` is optional and honoured** (ADR-0023's 2026-10-26 amendment, #799). Send the version's `concurrencyToken` to be refused with `409` `urn:brokerplatform:problem:concurrency-conflict` if the version changed since it was read; leave it out and the write behaves as it did before the token was published. A token this API could not have issued is a `400` keyed `If-Match`.
          */
         post: operations["RetireDocumentTemplateVersion"];
         delete?: never;
@@ -7483,6 +7511,8 @@ export interface components {
             isSatisfied: boolean;
             enteredBy: string;
         };
+        /** @enum {string} */
+        CustomerImportRowOutcome: "Pending" | "Accepted" | "Refused";
         CustomerImportRowPage: {
             items: components["schemas"]["CustomerImportRowResponse"][];
             nextCursor: null | string;
@@ -7495,7 +7525,7 @@ export interface components {
         CustomerImportRowResponse: {
             /** Format: int32 */
             lineNumber: number;
-            outcome: string;
+            outcome: components["schemas"]["CustomerImportRowOutcome"];
             /** Format: uuid */
             customerId: null | string;
             reasons: components["schemas"]["CustomerImportRowReason"][];
@@ -7507,7 +7537,7 @@ export interface components {
         CustomerImportRunResponse: {
             /** Format: uuid */
             id: string;
-            status: string;
+            status: components["schemas"]["CustomerImportRunStatus"];
             fileName: string;
             /** Format: int32 */
             rowCount: number;
@@ -7530,6 +7560,8 @@ export interface components {
             commitRefusalReason: null | string;
             concurrencyToken: string;
         };
+        /** @enum {string} */
+        CustomerImportRunStatus: "Staged" | "Validated" | "Refused" | "ValidationFailed" | "Abandoned" | "Committing" | "Committed" | "CommitRefused" | "CommitFailed" | "Expired";
         CustomerImportUpload: {
             file: components["schemas"]["IFormFile"];
         };
@@ -7982,7 +8014,7 @@ export interface components {
         DocumentTemplateResponse: {
             /** Format: uuid */
             id: string;
-            kind: string;
+            kind: components["schemas"]["PolicyDocumentKind"];
             key: string;
             name: string;
             /** Format: date-time */
@@ -8003,7 +8035,7 @@ export interface components {
             id: string;
             /** Format: int32 */
             versionNumber: number;
-            status: string;
+            status: components["schemas"]["TemplateVersionStatus"];
             /** Format: int32 */
             bodySchemaVersion: number;
             contentHash: null | string;
@@ -8016,6 +8048,7 @@ export interface components {
             /** Format: date-time */
             retiredAtUtc: null | string;
             retiredBySubjectId: null | string;
+            concurrencyToken: string;
         };
         DraftInvoiceRequest: {
             /** Format: uuid */
@@ -8749,10 +8782,12 @@ export interface components {
             releaseReason: null | string;
             isOpen: boolean;
         };
+        /** @enum {string} */
+        LegalTextKind: "TermsOfBusiness" | "PrivacyNotice" | "ComplaintsProcedure";
         LegalTextResponse: {
             /** Format: uuid */
             id: string;
-            kind: string;
+            kind: components["schemas"]["LegalTextKind"];
             /** Format: int32 */
             version: number;
             body: string;
@@ -9290,6 +9325,8 @@ export interface components {
             /** Format: date-time */
             expiresAtUtc: string;
         };
+        /** @enum {string} */
+        PolicyDocumentKind: "Policy" | "Certificate" | "Invoice" | "Receipt" | "Correspondence" | "DebitNote" | "CreditNote";
         PolicyDocumentPage: {
             items: components["schemas"]["PolicyDocumentResponse"][];
             nextCursor: null | string;
@@ -9318,6 +9355,8 @@ export interface components {
         PolicyDocumentUpload: {
             file: components["schemas"]["IFormFile"];
         };
+        /** @enum {string} */
+        PolicyImportRowOutcome: "Pending" | "Accepted" | "Refused";
         PolicyImportRowPage: {
             items: components["schemas"]["PolicyImportRowResponse"][];
             nextCursor: null | string;
@@ -9330,7 +9369,7 @@ export interface components {
         PolicyImportRowResponse: {
             /** Format: int32 */
             lineNumber: number;
-            outcome: string;
+            outcome: components["schemas"]["PolicyImportRowOutcome"];
             /** Format: uuid */
             policyId: null | string;
             reasons: components["schemas"]["PolicyImportRowReason"][];
@@ -9342,7 +9381,7 @@ export interface components {
         PolicyImportRunResponse: {
             /** Format: uuid */
             id: string;
-            status: string;
+            status: components["schemas"]["PolicyImportRunStatus"];
             fileName: string;
             /** Format: int32 */
             rowCount: number;
@@ -9365,6 +9404,8 @@ export interface components {
             commitRefusalReason: null | string;
             concurrencyToken: string;
         };
+        /** @enum {string} */
+        PolicyImportRunStatus: "Staged" | "Validated" | "Refused" | "ValidationFailed" | "Abandoned" | "Committing" | "Committed" | "CommitRefused" | "CommitFailed" | "Expired";
         PolicyImportUpload: {
             file: components["schemas"]["IFormFile"];
         };
@@ -10502,6 +10543,8 @@ export interface components {
             /** @description Why, in a sentence a person can act on. Prose: it will be reworded, so never parse it or key on it. */
             message: string;
         };
+        /** @enum {string} */
+        TemplateVersionStatus: "Draft" | "Published" | "Retired";
         TenantAdministratorResponse: {
             /** Format: uuid */
             membershipId: string;
@@ -22706,6 +22749,35 @@ export interface operations {
             };
         };
     };
+    GetDocumentTemplate: {
+        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"]["DocumentTemplateResponse"];
+                };
+            };
+            /** @description Not Found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
     StartDocumentTemplateVersion: {
         parameters: {
             query?: never;
@@ -22790,7 +22862,9 @@ export interface operations {
     DiscardDocumentTemplateVersion: {
         parameters: {
             query?: never;
-            header?: never;
+            header?: {
+                "If-Match"?: string;
+            };
             path: {
                 id: string;
                 versionId: string;
@@ -22806,6 +22880,15 @@ export interface operations {
                 };
                 content?: never;
             };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
+                };
+            };
             /** @description Not Found */
             404: {
                 headers: {
@@ -22827,7 +22910,9 @@ export interface operations {
     ReviseDocumentTemplateVersionBody: {
         parameters: {
             query?: never;
-            header?: never;
+            header?: {
+                "If-Match"?: string;
+            };
             path: {
                 id: string;
                 versionId: string;
@@ -22879,7 +22964,9 @@ export interface operations {
     PublishDocumentTemplateVersion: {
         parameters: {
             query?: never;
-            header?: never;
+            header?: {
+                "If-Match"?: string;
+            };
             path: {
                 id: string;
                 versionId: string;
@@ -22897,6 +22984,15 @@ export interface operations {
                     "application/json": components["schemas"]["DocumentTemplateVersionBodyResponse"];
                 };
             };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
+                };
+            };
             /** @description Not Found */
             404: {
                 headers: {
@@ -22927,7 +23023,9 @@ export interface operations {
     RetireDocumentTemplateVersion: {
         parameters: {
             query?: never;
-            header?: never;
+            header?: {
+                "If-Match"?: string;
+            };
             path: {
                 id: string;
                 versionId: string;
@@ -22945,6 +23043,15 @@ export interface operations {
                     "application/json": components["schemas"]["DocumentTemplateVersionBodyResponse"];
                 };
             };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
+                };
+            };
             /** @description Not Found */
             404: {
                 headers: {

package/package.json

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