@insurance-broker/api-client 4.20.0 → 5.0.0

package/dist/schema.d.ts

@@ -8321,6 +8321,22 @@ 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;
         };
+        /** @description RFC 9457 problem answered when a write that requires a precondition arrived without one: no If-Match, or If-Match: * (issue #517). Nothing was read or written. Read the record and send its concurrencyToken as If-Match. Branch on type, not on title or detail, which are human-readable and not fixed. */
+        PreconditionRequiredProblem: {
+            /**
+             * @description Identifies the problem kind. A stable URN; it is not promised to resolve.
+             * @constant
+             */
+            type: "urn:brokerplatform:problem:precondition-required";
+            title: string;
+            /**
+             * Format: int32
+             * @enum {integer}
+             */
+            status: 428;
+            detail?: string;
+            instance?: null | string;
+        };
         PresentationBodyResponse: {
             version: components["schemas"]["PresentationVersionResponse"];
             body: string;
@@ -8630,6 +8646,32 @@ export interface components {
             /** Format: uuid */
             formSubmissionId: null | string;
         };
+        /** @description RFC 9457 problem answered when a request to render, produce or export was refused because a rate limit's budget is spent (ADR-0050). Nothing was done. Branch on type, not on title or detail, which are human-readable and not fixed. */
+        RateLimitedProblem: {
+            /**
+             * @description Identifies the problem kind. A stable URN; it is not promised to resolve.
+             * @constant
+             */
+            type: "urn:brokerplatform:problem:rate-limited";
+            title: string;
+            /**
+             * Format: int32
+             * @enum {integer}
+             */
+            status: 429;
+            detail?: string;
+            instance?: null | string;
+            /**
+             * Format: int32
+             * @description The same whole number of seconds as the Retry-After header, for a client that cannot read response headers. At least 1.
+             */
+            retryAfterSeconds: number;
+            /**
+             * @description Whose allowance is spent: user means this caller's own, tenant means the one their organisation's people share.
+             * @enum {string}
+             */
+            budget: "user" | "tenant";
+        };
         RebrandTenantRequest: {
             logoUrl: null | string;
             primaryColour: null | string;
@@ -10546,6 +10588,17 @@ export interface operations {
                     "application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
                 };
             };
+            /** @description Too Many Requests (ADR-0050). This operation renders, produces or exports, and the caller's own budget for such work, or their organisation's, is spent. Nothing was done: no document, statement, export or receipt exists for this request. Wait the number of seconds in Retry-After (also in retryAfterSeconds) before trying again. */
+            429: {
+                headers: {
+                    /** @description Whole seconds to wait before retrying; at least 1. */
+                    "Retry-After": number;
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["RateLimitedProblem"];
+                };
+            };
         };
     };
     GetStatement: {
@@ -10775,6 +10828,17 @@ export interface operations {
                     "application/problem+json": components["schemas"]["ProblemDetails"];
                 };
             };
+            /** @description Too Many Requests (ADR-0050). This operation renders, produces or exports, and the caller's own budget for such work, or their organisation's, is spent. Nothing was done: no document, statement, export or receipt exists for this request. Wait the number of seconds in Retry-After (also in retryAfterSeconds) before trying again. */
+            429: {
+                headers: {
+                    /** @description Whole seconds to wait before retrying; at least 1. */
+                    "Retry-After": number;
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["RateLimitedProblem"];
+                };
+            };
         };
     };
     ListExportReceipts: {
@@ -11657,8 +11721,9 @@ export interface operations {
     UpdateProduct: {
         parameters: {
             query?: never;
-            header?: {
-                "If-Match"?: string;
+            header: {
+                /** @description Required. The concurrencyToken of the record as it was read, sent back unchanged. A write without it, or with *, is refused with 428; a token that is no longer current is refused with 409 (issue #517, client 5.0.0). */
+                "If-Match": string;
             };
             path: {
                 id: string;
@@ -11705,13 +11770,23 @@ export interface operations {
                     "application/problem+json": components["schemas"]["ConcurrencyConflictProblem"] | components["schemas"]["ProblemDetails"];
                 };
             };
+            /** @description Precondition Required (RFC 6585). The request carried no If-Match, or carried If-Match: *, which protects nothing. Nothing was read or written. Read the record, then send its concurrencyToken as If-Match. */
+            428: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["PreconditionRequiredProblem"];
+                };
+            };
         };
     };
     ReclassifyProduct: {
         parameters: {
             query?: never;
-            header?: {
-                "If-Match"?: string;
+            header: {
+                /** @description Required. The concurrencyToken of the record as it was read, sent back unchanged. A write without it, or with *, is refused with 428; a token that is no longer current is refused with 409 (issue #517, client 5.0.0). */
+                "If-Match": string;
             };
             path: {
                 id: string;
@@ -11758,13 +11833,23 @@ export interface operations {
                     "application/problem+json": components["schemas"]["ConcurrencyConflictProblem"] | components["schemas"]["ProblemDetails"];
                 };
             };
+            /** @description Precondition Required (RFC 6585). The request carried no If-Match, or carried If-Match: *, which protects nothing. Nothing was read or written. Read the record, then send its concurrencyToken as If-Match. */
+            428: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["PreconditionRequiredProblem"];
+                };
+            };
         };
     };
     ActivateProduct: {
         parameters: {
             query?: never;
-            header?: {
-                "If-Match"?: string;
+            header: {
+                /** @description Required. The concurrencyToken of the record as it was read, sent back unchanged. A write without it, or with *, is refused with 428; a token that is no longer current is refused with 409 (issue #517, client 5.0.0). */
+                "If-Match": string;
             };
             path: {
                 id: string;
@@ -11798,13 +11883,23 @@ export interface operations {
                     "application/problem+json": components["schemas"]["ConcurrencyConflictProblem"] | components["schemas"]["ProblemDetails"];
                 };
             };
+            /** @description Precondition Required (RFC 6585). The request carried no If-Match, or carried If-Match: *, which protects nothing. Nothing was read or written. Read the record, then send its concurrencyToken as If-Match. */
+            428: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["PreconditionRequiredProblem"];
+                };
+            };
         };
     };
     WithdrawProduct: {
         parameters: {
             query?: never;
-            header?: {
-                "If-Match"?: string;
+            header: {
+                /** @description Required. The concurrencyToken of the record as it was read, sent back unchanged. A write without it, or with *, is refused with 428; a token that is no longer current is refused with 409 (issue #517, client 5.0.0). */
+                "If-Match": string;
             };
             path: {
                 id: string;
@@ -11838,6 +11933,15 @@ export interface operations {
                     "application/problem+json": components["schemas"]["ConcurrencyConflictProblem"] | components["schemas"]["ProblemDetails"];
                 };
             };
+            /** @description Precondition Required (RFC 6585). The request carried no If-Match, or carried If-Match: *, which protects nothing. Nothing was read or written. Read the record, then send its concurrencyToken as If-Match. */
+            428: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["PreconditionRequiredProblem"];
+                };
+            };
         };
     };
     AttachProductInsurer: {
@@ -20027,6 +20131,17 @@ export interface operations {
                     "application/problem+json": components["schemas"]["UnrenderableTemplateProblem"] | components["schemas"]["UnpublishableTemplateBodyProblem"];
                 };
             };
+            /** @description Too Many Requests (ADR-0050). This operation renders, produces or exports, and the caller's own budget for such work, or their organisation's, is spent. Nothing was done: no document, statement, export or receipt exists for this request. Wait the number of seconds in Retry-After (also in retryAfterSeconds) before trying again. */
+            429: {
+                headers: {
+                    /** @description Whole seconds to wait before retrying; at least 1. */
+                    "Retry-After": number;
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["RateLimitedProblem"];
+                };
+            };
         };
     };
     ReadRenewalLeadTimes: {

package/package.json

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