@insurance-broker/api-client 5.21.0 → 5.23.0

package/dist/schema.d.ts

@@ -3061,11 +3061,19 @@ export interface paths {
         };
         /**
          * The ways this broker's staff may verify a customer before signing them out, in the broker's order.
-         * @description The broker's closed set of verification methods (ADR-0049). A member of staff signing a customer out of every session picks one of these keys and the choice is recorded in the audit entry. The set is configuration, never empty once configured; an empty list means this broker has not configured one yet, and staff-assisted sign-out is refused until it does.
+         * @description The broker's closed set of verification methods (ADR-0049). A member of staff signing a customer out of every session picks one of these keys and the choice is recorded in the audit entry. The set is configuration, never without an active method once configured; an empty list means this broker has not configured one yet, and staff-assisted sign-out is refused until it does.
+         *
+         *     **Only active methods by default**, because only those can be chosen. `includeRetired=true` adds the retired ones, marked `isActive: false` with `retiredAtUtc`, for somebody managing the set (#648); they cannot be chosen and keep their keys.
          */
         get: operations["ListCustomerVerificationMethods"];
         put?: never;
-        post?: never;
+        /**
+         * Add a way this broker's staff may verify a customer before signing them out
+         * @description #648. `key` is a stable identifier — lower-case letters, digits and hyphens, at most 64 characters — unique within this broker and never changed or reused, because audit entries for staff sign-outs record it. `name` is what staff read, at most 120 characters; `description`, optional and at most 500, says what staff must actually have checked. Neither may hold control or invisible formatting characters. The method is appended to the end of the set and is active at once. A broker with no set may add its first method here.
+         *
+         *     **Refusals.** `400` for a malformed field. `409` `urn:brokerplatform:problem:verification-method-key-taken` when this broker already has a method with that key, active or retired: choose another key, or reactivate the retired one.
+         */
+        post: operations["AddCustomerVerificationMethod"];
         delete?: never;
         options?: never;
         head?: never;
@@ -3087,7 +3095,7 @@ export interface paths {
          *
          *     **Verify the customer first, then say how.** `verificationMethod` is a key from `GET /api/v1/customer-verification-methods`, this broker's closed set; `reason` is required, at most 500 characters, and is recorded with the method and the member of staff in the audit entry on the customer record (action `crm.customer.sessions-revoked-by-staff`). Tell the customer to change their password and secure their email account: signing out does not stop somebody who knows the password.
          *
-         *     **Refusals.** `400` when either field is missing or the reason is too long. `404` when the customer is not this broker's. `409` with problem type `urn:brokerplatform:problem:verification-method-not-offered` when the method is not in this broker's set (or the broker has configured none) — read the set and choose from it. `409` with no type when the customer has never attached a sign-in account, so has no session to end.
+         *     **Refusals.** `400` when either field is missing or the reason is too long. `404` when the customer is not this broker's. `409` with problem type `urn:brokerplatform:problem:verification-method-not-offered` when the method is not in this broker's set, has been retired, or the broker has configured none — read the set and choose from it. `409` with no type when the customer has never attached a sign-in account, so has no session to end.
          *
          *     **What it does not do yet.** It does not end the sessions at the identity provider or list them; those need the isolated identity-management component ADR-0049 describes.
          */
@@ -3115,6 +3123,135 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/customer-verification-methods/{key}/label": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        /**
+         * Correct what staff read for one of this broker's verification methods
+         * @description #648. Replaces the method's `name` and `description` (an absent or blank description removes it). **The key does not change**, so every audit entry naming it keeps its meaning: correct the wording here, and retire the method and add another to change what it is. A retired method can be corrected too.
+         *
+         *     **Refusals.** `400` for a malformed field. `404` when this broker has no method with that key. `409` `urn:brokerplatform:problem:concurrency-conflict` with `retryable: true` when another write changed the method after it was read: read it again and retry.
+         */
+        put: operations["RelabelCustomerVerificationMethod"];
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/customer-verification-methods/{key}/retirement": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Stop offering one of this broker's verification methods
+         * @description #648. A retired method cannot be chosen for a staff sign-out, drops out of `GET /api/v1/customer-verification-methods` unless `includeRetired=true`, and keeps its key, which is never given to another method. Retiring one already retired changes nothing and answers `200` with it as it stands.
+         *
+         *     **A broker always keeps one active method.** Retiring the last is `409` `urn:brokerplatform:problem:last-active-verification-method`, which is not retryable: add or reactivate another method first. `404` when this broker has no method with that key. A `409` can also be `urn:brokerplatform:problem:concurrency-conflict` with `retryable: true` when another write changed the method after it was read.
+         */
+        post: operations["RetireCustomerVerificationMethod"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/customer-verification-methods/{key}/reactivation": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Offer a retired verification method again
+         * @description #648. The method comes back under the key it always had, in its old place in the set. Reactivating one already active changes nothing and answers `200` with it as it stands. `404` when this broker has no method with that key. `409` `urn:brokerplatform:problem:concurrency-conflict` with `retryable: true` when another write changed the method after it was read.
+         */
+        post: operations["ReactivateCustomerVerificationMethod"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/customers/imports": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * This broker's customer import runs, newest first
+         * @description Paged by cursor, newest first (ADR-0031): pass `nextCursor` back as `cursor` until it is null. A cursor this list did not issue is a `400`.
+         */
+        get: operations["ListCustomerImports"];
+        put?: never;
+        /**
+         * Uploads a file of customers to validate and import
+         * @description Reads a CSV file of customers and stages every row as a new import run, answering `202` with the run in status `Staged`. Nothing is written to the customer records: each row is validated, and the whole file is committed later, all of it or none (ADR-0051).
+         *
+         *     **The file.** One `multipart/form-data` file part. UTF-8 (a leading byte-order mark is tolerated), comma-delimited, RFC 4180 quoting, a header row naming `full_name`, `email`, `legacy_source` and `legacy_reference`, and optionally `phone`, each at most once and nothing else. At most 10,000 data rows and 5 MiB by default. `legacy_reference` is the previous system's record key, never an identity-document number.
+         *
+         *     **Refusals.** `413` when the file is larger than this broker accepts. `400` when the body is not multipart, and `400` with problem type `urn:brokerplatform:problem:import-file-refused` when the file cannot be read — invalid UTF-8, a NUL or other control character, a duplicate, unknown or missing header, a record whose field count differs from the header's, a misplaced or unclosed quote, more rows than allowed, no rows, or an unusable file name. That problem carries `fault` (`invalid-encoding`, `control-character`, `no-header`, `duplicate-header`, `unknown-column`, `missing-column`, `field-count`, `misplaced-quote`, `unterminated-quote`, `too-many-rows`, `no-rows`, `no-file-part` or `file-name`) and, when the fault is on a line, `line`; its message names the line and never repeats the file's content. **A refused file creates no run.** `409` with problem type `urn:brokerplatform:problem:import-run-in-progress` when this broker already has a customer import staged, validated or committing — one at a time. `429` when this broker has used its upload budget: every admitted upload counts, including refused ones.
+         */
+        post: operations["UploadCustomerImport"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/customers/imports/{id}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** One customer import run: its status, counts and who did what when */
+        get: operations["GetCustomerImport"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/customers/imports/{id}/rows": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * A customer import run's rows, in file order
+         * @description Each row's line number in the file, its outcome, the customer it created once committed, and every reason it was refused — a column, a stable code and a fixed sentence, never a value from the file. Filter with `outcome` (`Pending`, `Accepted` or `Refused`). Paged by cursor in file order (ADR-0031). `404` when the run is not this broker's.
+         */
+        get: operations["ListCustomerImportRows"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/organisations": {
         parameters: {
             query?: never;
@@ -6440,6 +6577,11 @@ export interface components {
             kind: string;
             role: null | string;
         };
+        AddCustomerVerificationMethodRequest: {
+            key: null | string;
+            name: null | string;
+            description: null | string;
+        };
         AddInsurerRequest: {
             code: null | string;
             name: null | string;
@@ -7000,6 +7142,54 @@ export interface components {
             isSatisfied: boolean;
             enteredBy: string;
         };
+        CustomerImportRowPage: {
+            items: components["schemas"]["CustomerImportRowResponse"][];
+            nextCursor: null | string;
+        };
+        CustomerImportRowReason: {
+            column: string;
+            code: string;
+            message: string;
+        };
+        CustomerImportRowResponse: {
+            /** Format: int32 */
+            lineNumber: number;
+            outcome: string;
+            /** Format: uuid */
+            customerId: null | string;
+            reasons: components["schemas"]["CustomerImportRowReason"][];
+        };
+        CustomerImportRunPage: {
+            items: components["schemas"]["CustomerImportRunResponse"][];
+            nextCursor: null | string;
+        };
+        CustomerImportRunResponse: {
+            /** Format: uuid */
+            id: string;
+            status: string;
+            fileName: string;
+            /** Format: int32 */
+            rowCount: number;
+            /** Format: int32 */
+            acceptedCount: null | number;
+            /** Format: int32 */
+            refusedCount: null | number;
+            /** Format: int32 */
+            committedCount: null | number;
+            submittedBySubjectId: string;
+            /** Format: date-time */
+            stagedAtUtc: string;
+            /** Format: date-time */
+            validatedAtUtc: null | string;
+            commitRequestedBySubjectId: null | string;
+            /** Format: date-time */
+            commitRequestedAtUtc: null | string;
+            /** Format: date-time */
+            concludedAtUtc: null | string;
+        };
+        CustomerImportUpload: {
+            file: components["schemas"]["IFormFile"];
+        };
         CustomerInsurerOutcomeResponse: {
             /** Format: uuid */
             id: string;
@@ -7351,6 +7541,9 @@ export interface components {
             key: string;
             name: string;
             description: null | string;
+            isActive: boolean;
+            /** Format: date-time */
+            retiredAtUtc: null | string;
         };
         DataClassificationResponse: {
             key: string;
@@ -9149,7 +9342,7 @@ 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. */
+        /** @description RFC 9457 problem answered when a request to render, produce or export, or to upload an import file, was refused because a rate limit's budget is spent (ADR-0050, ADR-0051). 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.
@@ -9290,6 +9483,10 @@ export interface components {
             name: null | string;
             registrationNumber: null | string;
         };
+        RelabelCustomerVerificationMethodRequest: {
+            name: null | string;
+            description: null | string;
+        };
         RelabelPaymentMethodRequest: {
             label: string;
         };
@@ -16827,7 +17024,9 @@ export interface operations {
     };
     ListCustomerVerificationMethods: {
         parameters: {
-            query?: never;
+            query?: {
+                includeRetired?: boolean;
+            };
             header?: never;
             path?: never;
             cookie?: never;
@@ -16845,6 +17044,48 @@ export interface operations {
             };
         };
     };
+    AddCustomerVerificationMethod: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["AddCustomerVerificationMethodRequest"];
+            };
+        };
+        responses: {
+            /** @description Created */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["CustomerVerificationMethodResponse"];
+                };
+            };
+            /** @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"];
+                };
+            };
+        };
+    };
     RevokeCustomerSessions: {
         parameters: {
             query?: never;
@@ -16921,6 +17162,298 @@ export interface operations {
             };
         };
     };
+    RelabelCustomerVerificationMethod: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                key: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["RelabelCustomerVerificationMethodRequest"];
+            };
+        };
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["CustomerVerificationMethodResponse"];
+                };
+            };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
+                };
+            };
+            /** @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"];
+                };
+            };
+        };
+    };
+    RetireCustomerVerificationMethod: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                key: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["CustomerVerificationMethodResponse"];
+                };
+            };
+            /** @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"];
+                };
+            };
+        };
+    };
+    ReactivateCustomerVerificationMethod: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                key: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["CustomerVerificationMethodResponse"];
+                };
+            };
+            /** @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"];
+                };
+            };
+        };
+    };
+    ListCustomerImports: {
+        parameters: {
+            query?: {
+                cursor?: string;
+                limit?: number | string;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["CustomerImportRunPage"];
+                };
+            };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
+                };
+            };
+        };
+    };
+    UploadCustomerImport: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "multipart/form-data": components["schemas"]["CustomerImportUpload"];
+            };
+        };
+        responses: {
+            /** @description Accepted */
+            202: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["CustomerImportRunResponse"];
+                };
+            };
+            /** @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"];
+                };
+            };
+            /** @description Payload Too Large */
+            413: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ProblemDetails"];
+                };
+            };
+            /** @description Too Many Requests (ADR-0051). Your organisation has used its budget of import uploads for this kind of record in the last day; every admitted upload counts, including ones refused because the file could not be read. Nothing was read and no import was started. budget is always tenant. 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"];
+                };
+            };
+        };
+    };
+    GetCustomerImport: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["CustomerImportRunResponse"];
+                };
+            };
+            /** @description Not Found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    ListCustomerImportRows: {
+        parameters: {
+            query?: {
+                outcome?: string;
+                cursor?: string;
+                limit?: number | string;
+            };
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["CustomerImportRowPage"];
+                };
+            };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
+                };
+            };
+            /** @description Not Found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
     ListOrganisations: {
         parameters: {
             query?: {

package/package.json

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