@insurance-broker/api-client 5.40.0 → 5.42.0

package/dist/schema.d.ts

@@ -2962,7 +2962,10 @@ export interface paths {
         /** This customer's invitations and their lifecycle. Never the code or its hash. */
         get: operations["ListCustomerInvitations"];
         put?: never;
-        /** Issues a single-use code the customer redeems to attach a sign-in account. The code is shown once. */
+        /**
+         * Issues a single-use code the customer redeems to attach a sign-in account. The code is shown once.
+         * @description The code is returned once and is for the member of staff to hand to the customer. Issuing it also creates the customer's sign-in account, where the deployment has enabled that, and the sign-in service emails the customer a link to verify their address and choose a password. If no such email arrives, the customer may already have an account: they sign in with it, or use "Forgot password" on the sign-in page with the address the invitation was issued to. Whether an account already existed is never reported.
+         */
         post: operations["IssueCustomerInvitation"];
         delete?: never;
         options?: never;
@@ -3843,7 +3846,11 @@ export interface paths {
          */
         get: operations["ListMembers"];
         put?: never;
-        post?: never;
+        /**
+         * Gives a person with a staff account access to this broker, holding the named roles.
+         * @description The subject must name an account that already exists in the staff realm; this platform does not create staff accounts. The membership is active at once, as the platform's own grant is: there is no acceptance step. At least one role is required, and each must hold only permissions the caller holds. A person who already has a live membership of this broker is refused 409.
+         */
+        post: operations["InviteMember"];
         delete?: never;
         options?: never;
         head?: never;
@@ -3870,6 +3877,30 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/members/{membershipId}/roles/{roleId}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        /**
+         * Gives a member of staff one of this broker's roles. Idempotent.
+         * @description The member can do what the role grants from their next request onward. The role must hold only permissions the caller holds. A caller may not change their own roles, and a revoked membership's roles are not changed. Assigning a role the member already holds answers the member as they stand and writes nothing.
+         */
+        put: operations["AssignMemberRole"];
+        post?: never;
+        /**
+         * Takes one of this broker's roles away from a member of staff. Idempotent.
+         * @description The member can no longer do what only that role granted from their next request onward. The role must hold only permissions the caller holds: a caller may not take away what they could not have given. A caller may not change their own roles, and a revoked membership's roles are not changed. Removing a role the member does not hold answers the member as they stand and writes nothing.
+         */
+        delete: operations["RemoveMemberRole"];
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/staff": {
         parameters: {
             query?: never;
@@ -8474,6 +8505,11 @@ export interface components {
             /** Format: date-time */
             revokedAtUtc: null | string;
         };
+        InviteMemberRequest: {
+            subjectId: null | string;
+            displayName: null | string;
+            roleIds: null | string[];
+        };
         InviteOrganisationMemberRequest: {
             email: null | string;
             role: null | string;
@@ -19698,6 +19734,55 @@ export interface operations {
             };
         };
     };
+    InviteMember: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["InviteMemberRequest"];
+            };
+        };
+        responses: {
+            /** @description Created */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["MemberResponse"];
+                };
+            };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
+                };
+            };
+            /** @description Forbidden */
+            403: {
+                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"];
+                };
+            };
+        };
+    };
     RevokeMembership: {
         parameters: {
             query?: never;
@@ -19756,6 +19841,102 @@ export interface operations {
             };
         };
     };
+    AssignMemberRole: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                membershipId: string;
+                roleId: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["MemberResponse"];
+                };
+            };
+            /** @description Forbidden */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Not Found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ProblemDetails"];
+                };
+            };
+            /** @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"];
+                };
+            };
+        };
+    };
+    RemoveMemberRole: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                membershipId: string;
+                roleId: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["MemberResponse"];
+                };
+            };
+            /** @description Forbidden */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Not Found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ProblemDetails"];
+                };
+            };
+            /** @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"];
+                };
+            };
+        };
+    };
     ResolveStaffNames: {
         parameters: {
             query?: {

package/package.json

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