@insurance-broker/api-client 4.13.0 → 4.15.0

package/dist/schema.d.ts

@@ -2080,6 +2080,8 @@ export interface paths {
          *
          *     Ordered on when an item was **raised** and never on when it was resolved: the list is a history, and ordering on a column that changes moves the boundaries under a reader.
          *
+         *     `publishedAtUtc` is when an item was copied onto the customer's timeline, or null if it never was - so a client can leave an already-published item out of the publication control rather than offering one that is refused with 409.
+         *
          *     **Staff only.** A customer is told what you need from them by being told, on their timeline, in words you chose - not by being handed the working list, which also names everything you owe.
          */
         get: operations["ListClaimOutstandingItems"];
@@ -2162,6 +2164,8 @@ export interface paths {
          * Read the visits arranged about a claim
          * @description CLM-005. Every visit recorded against this claim, soonest first, cancelled ones included and marked as such - a diary is read forwards, and a visit that was called off is part of the account of how the claim went.
          *
+         *     `publishedAtUtc` is when a visit was copied onto the customer's timeline, or null if it never was, as on an outstanding item.
+         *
          *     **Staff only**, for the same reason the outstanding items are.
          */
         get: operations["ListClaimAppointments"];
@@ -2336,7 +2340,7 @@ export interface paths {
          * Read what your insurer has said about your claim
          * @description CLM-006, CLM-008. What the insurer has decided about your claim, oldest decision first.
          *
-         *     **These are the insurer's decisions and not your broker's.** Acceptance and settlement are decided by the insurer; your broker records what they were told. So each entry says the day the insurer decided it, how their answer reached your broker, and the day your broker wrote it down - and your claim's own status says what your broker is doing about it, never what the insurer concluded.
+         *     **These are the insurer's decisions and not your broker's.** Acceptance and settlement are decided by the insurer; your broker records what they were told. So each entry says which insurer decided it, what they decided, the day they decided it, and the day your broker wrote it down - and your claim's own status says what your broker is doing about it, never what the insurer concluded.
          *
          *     It does not say which member of staff wrote it down, for the same reason your timeline does not.
          */
@@ -5436,6 +5440,34 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/quote-request-reference-format": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * The format this broker's quote request references are issued in
+         * @description The format the next quote request is numbered in, whether it is the platform default, the default itself, and a preview of the next reference. References already issued keep theirs: a reference is stored when its quote request is first saved and is never re-rendered, and numbering carries on from where it is rather than restarting. {year} is the UTC year a request is raised in, not the year in the broker's time zone. Numbering never restarts each year.
+         */
+        get: operations["ReadQuoteRequestReferenceFormat"];
+        /**
+         * Set the format this broker's quote request references are issued in
+         * @description Literal text, {year}, and exactly one {number} or {number:000000}, at most 32 characters; literal text is letters, digits, spaces and . _ / - and does not begin or end with a space. Applies to quote requests raised from now on. References already issued keep theirs: a reference is stored when its quote request is first saved and is never re-rendered, and numbering carries on from where it is rather than restarting. {year} is the UTC year a request is raised in, not the year in the broker's time zone. Numbering never restarts each year. A format that would issue a reference this broker already holds is refused with 409.
+         */
+        put: operations["SetQuoteRequestReferenceFormat"];
+        post?: never;
+        /**
+         * Issue quote request references in the platform default format again
+         * @description Removes this broker's own format, so quote requests raised from now on are numbered in the platform default. References already issued keep theirs: a reference is stored when its quote request is first saved and is never re-rendered, and numbering carries on from where it is rather than restarting. {year} is the UTC year a request is raised in, not the year in the broker's time zone. Numbering never restarts each year. Answers 404 when this broker is already on the default, and 409 when the default would issue a reference this broker already holds.
+         */
+        delete: operations["ClearQuoteRequestReferenceFormat"];
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/retention/schedule": {
         parameters: {
             query?: never;
@@ -6071,6 +6103,8 @@ export interface components {
             /** Format: date-time */
             cancelledAtUtc: null | string;
             isCancelled: boolean;
+            /** Format: date-time */
+            publishedAtUtc: null | string;
         };
         ClaimDetailResponse: {
             /** Format: uuid */
@@ -6140,6 +6174,8 @@ export interface components {
             /** Format: date-time */
             resolvedAtUtc: null | string;
             isOutstanding: boolean;
+            /** Format: date-time */
+            publishedAtUtc: null | string;
         };
         ClaimPage: {
             items: components["schemas"]["ClaimSummaryResponse"][];
@@ -8205,6 +8241,12 @@ 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;
         };
+        QuoteRequestReferenceFormatResponse: {
+            format: string;
+            isPlatformDefault: boolean;
+            platformDefaultFormat: string;
+            nextReference: string;
+        };
         QuoteRequestResponse: {
             /** Format: uuid */
             id: string;
@@ -8669,6 +8711,9 @@ export interface components {
             email: null | boolean;
             push: null | boolean;
         };
+        SetQuoteRequestReferenceFormatRequest: {
+            format: null | string;
+        };
         SetRenewalLeadTimeRequest: {
             /** Format: int32 */
             leadDays: null | number | string;
@@ -22517,6 +22562,104 @@ export interface operations {
             };
         };
     };
+    ReadQuoteRequestReferenceFormat: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["QuoteRequestReferenceFormatResponse"];
+                };
+            };
+        };
+    };
+    SetQuoteRequestReferenceFormat: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["SetQuoteRequestReferenceFormatRequest"];
+            };
+        };
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["QuoteRequestReferenceFormatResponse"];
+                };
+            };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
+                };
+            };
+            /** @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: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ConcurrencyConflictProblem"] | components["schemas"]["ProblemDetails"];
+                };
+            };
+        };
+    };
+    ClearQuoteRequestReferenceFormat: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["QuoteRequestReferenceFormatResponse"];
+                };
+            };
+            /** @description Not Found */
+            404: {
+                headers: {
+                    [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: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ConcurrencyConflictProblem"] | components["schemas"]["ProblemDetails"];
+                };
+            };
+        };
+    };
     ReadRetentionSchedule: {
         parameters: {
             query?: never;

package/package.json

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