@insurance-broker/api-client 3.1.0 → 4.0.0

package/dist/schema.d.ts

@@ -757,7 +757,12 @@ export interface paths {
             path?: never;
             cookie?: never;
         };
-        /** The broker's insurer panel, by name. */
+        /**
+         * The broker's insurer panel, by name.
+         * @description Lists the broker's insurers by name, then code. `activeOnly=true` narrows it to the insurers new business may be placed with.
+         *
+         *     **Paged, and the shape changed in client 4.0.0** (issue #506). This answers `{ items, nextCursor }` where it used to answer a bare array capped at two hundred rows, past which the panel could not be walked and a complete list was indistinguishable from a truncated one. Pass `nextCursor` back as `cursor`; a null one means this is the last page. `limit` is a page size, not a cap on the panel.
+         */
         get: operations["ListInsurers"];
         put?: never;
         /** Adds an insurer to the broker's panel, active from the start. */
@@ -863,7 +868,12 @@ export interface paths {
             path?: never;
             cookie?: never;
         };
-        /** The broker's lines of business, in the broker's own ordering. */
+        /**
+         * The broker's lines of business, in the broker's own ordering.
+         * @description Lists the broker's lines of business by their sort order, then name, then key.
+         *
+         *     **Paged, and the shape changed in client 4.0.0** (issue #506). This answers `{ items, nextCursor }` where it used to answer a bare array capped at two hundred rows. Pass `nextCursor` back as `cursor`; a null one means this is the last page. `limit` is a page size, not a cap on the list.
+         */
         get: operations["ListProductCategories"];
         put?: never;
         /** Adds a line of business to the broker's catalogue. */
@@ -3915,9 +3925,9 @@ export interface paths {
          *
          *     **A payment posting does not do this** (ADR-0042 section 7). If it did, the platform would be asserting that cover began. A person looks at a payment and records that the requirement is discharged: the payment is the evidence, the person is the actor, and the platform is neither. There is no consumer, no sweep and no side effect that reaches this route.
          *
-         *     **Only a policy in `pendingPayment` can be released, and only once.** Recording it against a policy no gate ever held would write an evidence trail for a requirement that never existed.
+         *     **Only a policy in `pendingPayment` can be released, and only once.** Recording it against a policy no gate ever held would write an evidence trail for a requirement that never existed; that is a `409`.
          *
-         *     **The `paymentId` is recorded and not verified.** The payment lives in another module this one may not read (ADR-0002), so a mistyped identifier is a bad record rather than a refusal - issue #306 carries the contract that would check it.
+         *     **The `paymentId` must name an approved payment against a charge for this policy** (PAY-003, ADR-0042 section 7). A payment posts and settles its charge the moment it is recorded, but it releases cover only once a second person has approved it. Anything else is a `422` of type `urn:brokerplatform:problem:unusable-payment-evidence`, with one entry under `violations` whose `code` is `payment-not-this-policys` (no such payment in this broker's books, or one against another policy - deliberately the same answer), `payment-reversed`, or `payment-not-approved`.
          */
         post: operations["RecordPaymentRequirementMet"];
         delete?: never;
@@ -4029,6 +4039,8 @@ export interface paths {
         /**
          * The documents filed against a policy, newest first
          * @description Lists what has been filed against one policy — the policy document itself, certificates, invoices, receipts and correspondence. A document is quarantined the moment it is stored and only a malware scan moves it, so a row whose verdict is not Clean is listed and cannot be downloaded.
+         *
+         *     **Paged, and the shape changed in client 4.0.0** (issue #177). This answers `{ items, nextCursor }` where it used to answer a bare array capped at a hundred rows, past which the oldest documents were unreachable. Pass `nextCursor` back as `cursor`; a null one means this is the last page. `limit` is a page size, not a cap on the collection.
          */
         get: operations["ListPolicyDocuments"];
         put?: never;
@@ -5992,10 +6004,18 @@ export interface components {
             validUntil: null | string;
             attributes: null | string;
         };
+        CataloguePageOfInsurerResponse: {
+            items: components["schemas"]["InsurerResponse"][];
+            nextCursor: null | string;
+        };
         CataloguePageOfOfferedProductResponse: {
             items: components["schemas"]["OfferedProductResponse"][];
             nextCursor: null | string;
         };
+        CataloguePageOfProductCategoryResponse: {
+            items: components["schemas"]["ProductCategoryResponse"][];
+            nextCursor: null | string;
+        };
         CataloguePageOfProductResponse: {
             items: components["schemas"]["ProductResponse"][];
             nextCursor: null | string;
@@ -6339,6 +6359,38 @@ export interface components {
             contactDetail: string;
             instruction: string;
         };
+        CustomerFormSubmissionResponse: {
+            /** Format: uuid */
+            id: string;
+            /** Format: uuid */
+            formDefinitionId: string;
+            formDefinitionKey: string;
+            /** Format: uuid */
+            definitionVersionId: string;
+            /** Format: int32 */
+            versionNumber: number | string;
+            versionStatus: string;
+            status: string;
+            /** Format: date */
+            evaluatedAsOf: string;
+            contentHashVerified: boolean;
+            /** Format: int32 */
+            answersSchemaVersion: number | string;
+            /** Format: date-time */
+            createdAtUtc: string;
+            /** Format: date-time */
+            updatedAtUtc: string;
+            /** Format: date-time */
+            submittedAtUtc: null | string;
+            pinnedVersionIsLive: boolean;
+            /** Format: uuid */
+            liveVersionId: null | string;
+            /** Format: int32 */
+            liveVersionNumber: null | number | string;
+            answers: components["schemas"]["CustomerSubmittedAnswerResponse"][];
+            evidence: components["schemas"]["SubmittedEvidenceResponse"][];
+            isSatisfied: boolean;
+        };
         CustomerInsurerOutcomeResponse: {
             /** Format: uuid */
             id: string;
@@ -6638,6 +6690,37 @@ export interface components {
             /** Format: double */
             distanceKm: null | number | string;
         };
+        CustomerSubmissionAttachmentResponse: {
+            /** Format: uuid */
+            id: string;
+            evidenceKey: string;
+            fileName: string;
+            contentType: string;
+            /** Format: int64 */
+            sizeBytes: number | string;
+            contentSha256: string;
+            /** Format: date-time */
+            uploadedAtUtc: string;
+            scanVerdict: string;
+            /** Format: date-time */
+            scannedAtUtc: null | string;
+            classification: null | string;
+        };
+        CustomerSubmittedAnswerResponse: {
+            questionKey: string;
+            label: string;
+            type: string;
+            value: null | components["schemas"]["JsonElement"];
+            source: null | string;
+            /** Format: date-time */
+            atUtc: null | string;
+            visibility: string;
+            failures: string[];
+            options: components["schemas"]["FormQuestionOptionResponse"][];
+            isRequired: boolean;
+            help: null | string;
+            section: null | string;
+        };
         DataClassificationResponse: {
             key: string;
             name: string;
@@ -7683,6 +7766,10 @@ export interface components {
             /** Format: date-time */
             expiresAtUtc: string;
         };
+        PolicyDocumentPage: {
+            items: components["schemas"]["PolicyDocumentResponse"][];
+            nextCursor: null | string;
+        };
         PolicyDocumentResponse: {
             /** Format: uuid */
             id: string;
@@ -9932,6 +10019,7 @@ export interface operations {
         parameters: {
             query?: {
                 activeOnly?: boolean;
+                cursor?: string;
                 limit?: number | string;
             };
             header?: never;
@@ -9946,7 +10034,16 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["InsurerResponse"][];
+                    "application/json": components["schemas"]["CataloguePageOfInsurerResponse"];
+                };
+            };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
                 };
             };
         };
@@ -10294,6 +10391,7 @@ export interface operations {
     ListProductCategories: {
         parameters: {
             query?: {
+                cursor?: string;
                 limit?: number | string;
             };
             header?: never;
@@ -10308,7 +10406,16 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["ProductCategoryResponse"][];
+                    "application/json": components["schemas"]["CataloguePageOfProductCategoryResponse"];
+                };
+            };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
                 };
             };
         };
@@ -11520,7 +11627,7 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["FormSubmissionResponse"][];
+                    "application/json": components["schemas"]["CustomerFormSubmissionResponse"][];
                 };
             };
         };
@@ -11549,7 +11656,7 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["FormSubmissionResponse"];
+                    "application/json": components["schemas"]["CustomerFormSubmissionResponse"];
                 };
             };
             /** @description Bad Request */
@@ -11598,7 +11705,7 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["FormSubmissionResponse"];
+                    "application/json": components["schemas"]["CustomerFormSubmissionResponse"];
                 };
             };
             /** @description Not Found */
@@ -11638,7 +11745,7 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["FormSubmissionResponse"];
+                    "application/json": components["schemas"]["CustomerFormSubmissionResponse"];
                 };
             };
             /** @description Bad Request */
@@ -11700,7 +11807,7 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["FormSubmissionResponse"];
+                    "application/json": components["schemas"]["CustomerFormSubmissionResponse"];
                 };
             };
             /** @description Not Found */
@@ -11969,7 +12076,7 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["SubmissionAttachmentResponse"];
+                    "application/json": components["schemas"]["CustomerSubmissionAttachmentResponse"];
                 };
             };
             /** @description Bad Request */
@@ -12038,7 +12145,7 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["SubmissionAttachmentResponse"][];
+                    "application/json": components["schemas"]["CustomerSubmissionAttachmentResponse"][];
                 };
             };
             /** @description Not Found */
@@ -18084,6 +18191,15 @@ export interface operations {
                     "application/problem+json": components["schemas"]["ProblemDetails"];
                 };
             };
+            /** @description Unprocessable Entity */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ProblemDetails"];
+                };
+            };
         };
     };
     GetPolicy: {
@@ -18264,6 +18380,7 @@ export interface operations {
     ListPolicyDocuments: {
         parameters: {
             query?: {
+                cursor?: string;
                 limit?: number | string;
             };
             header?: never;
@@ -18280,7 +18397,16 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["PolicyDocumentResponse"][];
+                    "application/json": components["schemas"]["PolicyDocumentPage"];
+                };
+            };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
                 };
             };
             /** @description Not Found */

package/package.json

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