@insurance-broker/api-client 4.13.0 → 4.14.0

package/dist/schema.d.ts

@@ -5436,6 +5436,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;
@@ -8205,6 +8233,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 +8703,9 @@ export interface components {
             email: null | boolean;
             push: null | boolean;
         };
+        SetQuoteRequestReferenceFormatRequest: {
+            format: null | string;
+        };
         SetRenewalLeadTimeRequest: {
             /** Format: int32 */
             leadDays: null | number | string;
@@ -22517,6 +22554,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.14.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,