@insurance-broker/api-client 5.22.0 → 5.24.0

package/dist/schema.d.ts

@@ -3187,6 +3187,115 @@ export interface paths {
         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/customers/imports/{id}/commitment": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Asks for a validated customer import to be committed, every row or none
+         * @description Accepted only from `Validated`. Moves the run to `Committing` and answers `202` with it; the commit then runs in the background and ends `Committed` (one `Invited` customer per row, with its legacy source and reference and no invitation), `CommitRefused` (nothing written; `commitRefusalReason` says why, and a row that failed the commit's re-check is `Refused` with its reasons), or `CommitFailed` (nothing written, after the commit stalled). Read the run to follow it.
+         *
+         *     **Requires `If-Match`** with the run's `concurrencyToken`. Without it, or with `*`, `428`; a token that is no longer current is `409` with problem type `urn:brokerplatform:problem:concurrency-conflict` — read the run again. `409` with problem type `urn:brokerplatform:problem:import-run-state-conflict` when the run is not `Validated`; its `runStatus` says what it is. `404` when the run is not this broker's.
+         */
+        post: operations["CommitCustomerImport"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/customers/imports/{id}/abandonment": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Abandons a customer import that has not been committed
+         * @description Accepted only from `Staged` or `Validated`. Ends the run `Abandoned`, removes every value the file held, and frees this broker's import slot; the report (line numbers, outcomes and reasons) stays readable. Answers `200` with the run.
+         *
+         *     **Requires `If-Match`** with the run's `concurrencyToken`. Without it, or with `*`, `428`; a token that is no longer current is `409` with problem type `urn:brokerplatform:problem:concurrency-conflict`. `409` with problem type `urn:brokerplatform:problem:import-run-state-conflict` when the run has already ended — including `Refused`, which is already ended and purged — or is committing; its `runStatus` says what it is. `404` when the run is not this broker's.
+         */
+        post: operations["AbandonCustomerImport"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/organisations": {
         parameters: {
             query?: never;
@@ -7077,6 +7186,56 @@ 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;
+            commitRefusalReason: null | string;
+            concurrencyToken: string;
+        };
+        CustomerImportUpload: {
+            file: components["schemas"]["IFormFile"];
+        };
         CustomerInsurerOutcomeResponse: {
             /** Format: uuid */
             id: string;
@@ -9229,7 +9388,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.
@@ -17176,6 +17335,289 @@ export interface operations {
             };
         };
     };
+    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;
+            };
+        };
+    };
+    CommitCustomerImport: {
+        parameters: {
+            query?: never;
+            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;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        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 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"];
+                };
+            };
+            /** @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"];
+                };
+            };
+        };
+    };
+    AbandonCustomerImport: {
+        parameters: {
+            query?: never;
+            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;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                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 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"];
+                };
+            };
+            /** @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"];
+                };
+            };
+        };
+    };
     ListOrganisations: {
         parameters: {
             query?: {

package/package.json

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