@insurance-broker/api-client 4.17.0 → 4.21.0

package/dist/schema.d.ts

@@ -298,6 +298,8 @@ export interface paths {
          *     **A refusal is recorded, not merely returned.** Every attempt is written before the posting is tried, so a refused duplicate is findable in the reconciliation history read below.
          *
          *     The currency is **not** a field: it is the obligation's, held by a foreign key rather than by this handler. Nil is refused — a payment of nothing is nothing having arrived.
+         *
+         *     **Name a payment method or type a source, exactly one** (#530). `paymentMethodId` is one of this broker's active payment methods: its code becomes the payment's `source`, and customers see the method's label. `source` alone is free text, as before, and customers see it as typed. Both, neither, a retired method or another broker's method are refused with `400` and nothing is recorded.
          */
         post: operations["RecordPayment"];
         delete?: never;
@@ -690,6 +692,8 @@ export interface paths {
          *     **No `asOf`**, unlike the charges list: a payment was recorded at an instant this row holds, and nothing about this list moves at midnight.
          *
          *     **Each payment names the one charge it was recorded against**, and the policy that charge is owed under.
+         *
+         *     **Show `sourceLabel`, not `source`.** `sourceLabel` is never null. It is your broker's current wording for the payment method the money came through, or, for a payment your broker recorded as free text, that text as typed. `source` is kept for older apps and may be a code.
          */
         get: operations["ListOwnPayments"];
         put?: never;
@@ -750,6 +754,98 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/payment-methods": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * The ways this broker's customers pay, with the words customers read
+         * @description #530. Every payment method this broker has configured, active and retired, by label. A payment is recorded against an active one by its `id`; its `code` becomes the payment's `source` and its `label` is what customers see.
+         *
+         *     **A retired method stays on this list**, because it still labels the payments recorded against it. It cannot be chosen for a new payment.
+         *
+         *     The platform ships no payment method: which banks, services and counters a broker takes money through is the broker's own configuration.
+         */
+        get: operations["ListPaymentMethods"];
+        put?: never;
+        /**
+         * Add a way this broker's customers pay
+         * @description #530. `code` is a stable identifier — lower-case letters, digits and hyphens, at most 40 characters — unique within this broker and never changed. `label` is what customers read, at most 80 characters, and can be changed later.
+         *
+         *     **A code is never reused**, even after its method is retired, because payments recorded against the method carry it as their `source`. A code already taken is `409`.
+         */
+        post: operations["CreatePaymentMethod"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/payment-methods/{id}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Read one of this broker's payment methods
+         * @description Another broker's method answers `404`, exactly as one that does not exist: the tenant filter removes it before the read runs.
+         */
+        get: operations["GetPaymentMethod"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/payment-methods/{id}/label": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        /**
+         * Change what customers read for a payment method
+         * @description #530. **The label is read when a customer's payment is shown, not copied onto the payment**, so the new wording reaches every payment already recorded against this method, and no payment changes. A retired method can be relabelled too, because it still labels its payments.
+         *
+         *     **`409` here is only the platform's concurrency conflict**: another write changed this method after it was read. The body is `urn:brokerplatform:problem:concurrency-conflict` with `retryable: true`; read the method again and retry.
+         */
+        put: operations["RelabelPaymentMethod"];
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/payment-methods/{id}/retirement": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Stop a payment method being chosen for new payments
+         * @description #530. **One-way.** A retired method cannot be chosen when recording a payment, keeps labelling the payments already recorded against it, and keeps its code, which is never given to another method. Retiring one already retired is `409`. A `409` can also be the platform's concurrency conflict, with `retryable: true`, when another write changed the method after it was read.
+         */
+        post: operations["RetirePaymentMethod"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/insurers": {
         parameters: {
             query?: never;
@@ -3297,6 +3393,26 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/staff": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * The names of this broker's people, for the subject identifiers asked about.
+         * @description Repeat `ids` once per subject identifier, up to 50. Each subject that belongs to one of this broker's memberships comes back with the name the identity provider last gave for them; any other subject is simply absent, whichever broker it belongs to. Names are personal data.
+         */
+        get: operations["ResolveStaffNames"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/tenant": {
         parameters: {
             query?: never;
@@ -6370,6 +6486,10 @@ export interface components {
             name: null | string;
             registrationNumber: null | string;
         };
+        CreatePaymentMethodRequest: {
+            code: string;
+            label: string;
+        };
         CreditNoteLineRequest: {
             kind: string;
             description: string;
@@ -6579,6 +6699,7 @@ export interface components {
             /** Format: date-time */
             recordedAtUtc: string;
             state: string;
+            sourceLabel: string;
         };
         CustomerPolicyDocumentPage: {
             items: components["schemas"]["CustomerPolicyDocumentResponse"][];
@@ -6650,6 +6771,8 @@ export interface components {
             paymentRequirementMetAtUtc: null | string;
             /** Format: uuid */
             paymentEvidenceReference: null | string;
+            productName: null | string;
+            lineOfBusinessName: null | string;
         };
         CustomerPresentedOption: {
             /** Format: uuid */
@@ -7951,6 +8074,17 @@ export interface components {
             setAtUtc: string;
             setBySubjectId: string;
         };
+        PaymentMethodResponse: {
+            /** Format: uuid */
+            id: string;
+            code: string;
+            label: string;
+            active: boolean;
+            /** Format: date-time */
+            createdAtUtc: string;
+            /** Format: date-time */
+            retiredAtUtc: null | string;
+        };
         PaymentPage: {
             items: components["schemas"]["PaymentSummaryResponse"][];
             nextCursor: null | string;
@@ -7974,6 +8108,8 @@ export interface components {
             approvedBySubjectId: null | string;
             /** Format: date-time */
             approvedAtUtc: null | string;
+            /** Format: uuid */
+            paymentMethodId: null | string;
         };
         PaymentReversalResponse: {
             /** Format: uuid */
@@ -8006,6 +8142,8 @@ export interface components {
             /** Format: date-time */
             approvedAtUtc: null | string;
             reversed: boolean;
+            /** Format: uuid */
+            paymentMethodId: null | string;
         };
         PlacedMemberResponse: {
             /** Format: uuid */
@@ -8173,6 +8311,8 @@ export interface components {
             paymentRequirementMetBySubjectId: null | string;
             /** Format: uuid */
             paymentEvidenceReference: null | string;
+            productName: null | string;
+            lineOfBusinessName: null | string;
         };
         PolicyViolationResponse: {
             field: string;
@@ -8490,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;
@@ -8536,8 +8702,10 @@ export interface components {
         RecordPaymentRequest: {
             /** Format: double */
             amount: number | string;
-            source: string;
+            source?: null | string;
             externalReference: string;
+            /** Format: uuid */
+            paymentMethodId?: null | string;
         };
         RecordPaymentRequirementMetRequest: {
             /** Format: uuid */
@@ -8600,6 +8768,9 @@ export interface components {
             name: null | string;
             registrationNumber: null | string;
         };
+        RelabelPaymentMethodRequest: {
+            label: string;
+        };
         ReleaseLegalHoldRequest: {
             releaseReason: null | string;
         };
@@ -8912,6 +9083,10 @@ export interface components {
             amount: null | number | string;
             unit: null | string;
         };
+        StaffNameResponse: {
+            subjectId: string;
+            displayName: string;
+        };
         StartComparisonSchemaVersionRequest: {
             /** Format: uuid */
             productId: null | string;
@@ -10397,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: {
@@ -10626,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: {
@@ -10667,6 +10864,186 @@ export interface operations {
             };
         };
     };
+    ListPaymentMethods: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["PaymentMethodResponse"][];
+                };
+            };
+        };
+    };
+    CreatePaymentMethod: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["CreatePaymentMethodRequest"];
+            };
+        };
+        responses: {
+            /** @description Created */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["PaymentMethodResponse"];
+                };
+            };
+            /** @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"];
+                };
+            };
+        };
+    };
+    GetPaymentMethod: {
+        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"]["PaymentMethodResponse"];
+                };
+            };
+            /** @description Not Found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    RelabelPaymentMethod: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["RelabelPaymentMethodRequest"];
+            };
+        };
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["PaymentMethodResponse"];
+                };
+            };
+            /** @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"];
+                };
+            };
+        };
+    };
+    RetirePaymentMethod: {
+        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"]["PaymentMethodResponse"];
+                };
+            };
+            /** @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"];
+                };
+            };
+        };
+    };
     ListInsurers: {
         parameters: {
             query?: {
@@ -17163,6 +17540,44 @@ export interface operations {
             };
         };
     };
+    ResolveStaffNames: {
+        parameters: {
+            query?: {
+                ids?: string[];
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["StaffNameResponse"][];
+                };
+            };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ProblemDetails"];
+                };
+            };
+            /** @description Forbidden */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
     GetTenantSettings: {
         parameters: {
             query?: never;
@@ -19660,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.17.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,