@insurance-broker/api-client 4.20.0 → 4.21.0

package/dist/schema.d.ts

@@ -8630,6 +8630,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 +10572,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 +10812,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: {
@@ -20027,6 +20075,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": "4.21.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,