@insurance-broker/api-client 5.15.0 → 5.17.0

package/dist/schema.d.ts

@@ -769,7 +769,7 @@ export interface paths {
          *
          *     **Every export is logged before the file is handed over.** A receipt row and an audit entry naming what was exported, by whom, how much and a SHA-256 of the exact bytes are committed in one transaction first; if that commit fails, no data leaves. The receipts are readable at `GET /exports` under a separate key.
          *
-         *     **Nothing is stored.** The bytes are produced for this response and never written to the object store, so there is no link to fetch later and no file to orphan (ADR-0038 section 7 and section 11). The price is a ceiling: a selection of more than 5000 charges is refused with a `422` naming the count, and the caller narrows by customer, by policy or by view.
+         *     **Nothing is stored.** The bytes are produced for this response and never written to the object store, so there is no link to fetch later and no file to orphan (ADR-0038 section 7 and section 11). The price is a ceiling: a selection of more than 5000 charges is refused with a `422` naming the count, typed `urn:brokerplatform:problem:export-too-large` (#630), and the caller narrows by customer, by policy or by view.
          *
          *     **A PDF stops far sooner — 500 charges.** It is laid out one paragraph per charge and rendered under a lock the whole process shares, so a hundred-page one would be paid for by every other tenant's documents. The `422` names the format and its own ceiling; the same selection as a CSV carries the full amount.
          *
@@ -3555,6 +3555,26 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/members": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * This broker's memberships, with status, roles and placement, oldest first.
+         * @description Paged by an opaque cursor: pass `nextCursor` back as `cursor` until it is null. `limit` is 25 by default and at most 100; zero or less means the default. `status` narrows the list to `Invited`, `Active`, `Suspended` or `Revoked`. A revoked member whose name has been erased comes back as "Former member of staff". Names are personal data.
+         */
+        get: operations["ListMembers"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/members/{membershipId}/revocation": {
         parameters: {
             query?: never;
@@ -5684,7 +5704,12 @@ export interface paths {
         };
         get?: never;
         put?: never;
-        /** Takes exactly one option on exactly one presented version. Terminal. */
+        /**
+         * Takes exactly one option on exactly one presented version. Terminal.
+         * @description Accepts one option on the version that is presented now. Accepting is terminal: the quote request is settled and no further decision is recorded on it.
+         *
+         *     **An option whose premium is above the approval limit the acting member's role carries is a `409` typed `urn:brokerplatform:problem:acceptance-above-approval-limit`** (#197, #630). The limit is the broker's configuration, not the caller's permission, so retrying never helps: a member whose role carries a higher limit accepts it, or the caller accepts a smaller option. The other `409`s — a second acceptance, an option whose price has lapsed, a superseded version, a lost update — say which in their `detail`.
+         */
         post: operations["AcceptCustomerQuote"];
         delete?: never;
         options?: never;
@@ -5849,6 +5874,8 @@ export interface paths {
         /**
          * Keep a category for a period of this broker's own
          * @description Records a deliberate departure from the platform's default. A category carrying a minimum is configurable upward only: an audit trail a tenant can shorten is a weaker control than one they cannot, and the party most motivated to shorten it is the party under investigation (ADR-0038 section 8).
+         *
+         *     **A period beneath the category's minimum is a `422` typed `urn:brokerplatform:problem:retention-below-minimum`** (#630), carrying the category in a `categoryKey` field. It is a refusal of the number supplied: a longer period is accepted, a shorter one never is.
          */
         put: operations["SetRetentionOverride"];
         post?: never;
@@ -5898,6 +5925,8 @@ export interface paths {
         /**
          * End a hold, keeping the record of it
          * @description The hold row is never deleted: why a record was still here in 2031 must be answerable in 2032. A reason is required, because this is the act that exposes a record to destruction.
+         *
+         *     **Releasing a hold that is already released is a `409` typed `urn:brokerplatform:problem:legal-hold-already-released`** (#630): retrying cannot change it, so read the hold back. The other `409` is a lost update (ADR-0023): somebody else wrote the hold first, and a retry can succeed.
          */
         post: operations["ReleaseLegalHold"];
         delete?: never;
@@ -8041,6 +8070,28 @@ export interface components {
         MapPaymentSourceRequest: {
             source: string;
         };
+        MemberPage: {
+            items: components["schemas"]["MemberResponse"][];
+            nextCursor: null | string;
+        };
+        MemberResponse: {
+            /** Format: uuid */
+            membershipId: string;
+            subjectId: string;
+            displayName: string;
+            status: string;
+            roles: components["schemas"]["MemberRoleResponse"][];
+            /** Format: uuid */
+            branchId: null | string;
+            /** Format: uuid */
+            teamId: null | string;
+        };
+        MemberRoleResponse: {
+            /** Format: uuid */
+            roleId: string;
+            key: string;
+            name: string;
+        };
         MissingTemplateValueResponse: {
             key: string;
             /** @description Which refusal this is, as a stable name from a closed set. Key grouping, counting and translation on this, never on message. A new code is additive; renaming one is a break. */
@@ -18188,6 +18239,46 @@ export interface operations {
             };
         };
     };
+    ListMembers: {
+        parameters: {
+            query?: {
+                status?: string;
+                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"]["MemberPage"];
+                };
+            };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
+                };
+            };
+            /** @description Forbidden */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
     RevokeMembership: {
         parameters: {
             query?: never;

package/package.json

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