@insurance-broker/api-client 5.23.0 → 5.24.0

package/dist/schema.d.ts

@@ -3252,6 +3252,50 @@ export interface paths {
         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;
@@ -7186,6 +7230,8 @@ export interface components {
             commitRequestedAtUtc: null | string;
             /** Format: date-time */
             concludedAtUtc: null | string;
+            commitRefusalReason: null | string;
+            concurrencyToken: string;
         };
         CustomerImportUpload: {
             file: components["schemas"]["IFormFile"];
@@ -17454,6 +17500,124 @@ export interface operations {
             };
         };
     };
+    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.23.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,