@insurance-broker/api-client 1.37.0 → 1.39.0

package/dist/schema.d.ts

@@ -2633,6 +2633,126 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/roles": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** This broker's roles, the platform's and its own, with the keys each holds. */
+        get: operations["ListRoles"];
+        put?: never;
+        /** Defines a role of this broker's own, holding nothing until it is granted. */
+        post: operations["DefineRole"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/roles/{id}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** One role of this broker's. */
+        get: operations["GetRole"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/roles/assignable-permissions": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** Every permission a tenant role may hold. Platform keys are never listed. */
+        get: operations["ListAssignablePermissions"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/roles/templates": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** The platform's role templates and what each grants. Read-only. */
+        get: operations["ListRoleTemplates"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/roles/{id}/rename": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /** Changes what a role is called. The key never moves. */
+        post: operations["RenameRole"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/roles/{id}/grants": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /** Adds permissions to a role this broker defined. */
+        post: operations["GrantRolePermissions"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/roles/{id}/withdrawals": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /** Takes permissions away from a role this broker defined. */
+        post: operations["WithdrawRolePermissions"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/tenant": {
         parameters: {
             query?: never;
@@ -2841,7 +2961,9 @@ export interface paths {
         put?: never;
         /**
          * Record what the insurer confirmed
-         * @description Records the insurer's own reference and the date the insurer confirmed cover from, and makes the policy active. This is the only way a policy becomes active: the platform does not bind cover, so active is what an insurer confirmed and never something a caller asserts.
+         * @description Records the insurer's own reference and the date the insurer confirmed cover from. This is the only way a policy leaves `pendingInsurer`: the platform does not bind cover, so what happens next is what an insurer confirmed and never something a caller asserts.
+         *
+         *     **Where it lands depends on whether this broker has declared a payment gate** (`GET /policies/payment-gates`, BR-004). With no gate - which is every broker that has configured nothing - the policy becomes `active`. With one, it becomes `pendingPayment`, and cover begins when somebody records that the requirement was met.
          */
         post: operations["RecordInsurerConfirmation"];
         delete?: never;
@@ -2850,6 +2972,32 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/policies/{id}/payment-requirement": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Record that the outstanding payment requirement has been met
+         * @description BR-004. Releases a policy this broker's payment gate is holding, naming the billing record the recorder relied on, and makes it `active`.
+         *
+         *     **A payment posting does not do this** (ADR-0042 section 7). If it did, the platform would be asserting that cover began. A person looks at a payment and records that the requirement is discharged: the payment is the evidence, the person is the actor, and the platform is neither. There is no consumer, no sweep and no side effect that reaches this route.
+         *
+         *     **Only a policy in `pendingPayment` can be released, and only once.** Recording it against a policy no gate ever held would write an evidence trail for a requirement that never existed.
+         *
+         *     **The `paymentId` is recorded and not verified.** The payment lives in another module this one may not read (ADR-0002), so a mistyped identifier is a bad record rather than a refusal - issue #306 carries the contract that would check it.
+         */
+        post: operations["RecordPaymentRequirementMet"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/policies/{id}": {
         parameters: {
             query?: never;
@@ -2867,6 +3015,62 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/policies/payment-gates": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Whether this broker's cover waits for a payment
+         * @description BR-004. Every gate this broker has declared: one for its whole book, one per product, or any combination.
+         *
+         *     **An empty list is the normal answer and it means no gate.** Cover begins when the insurer's confirmation is recorded, which is what this platform did before step 9.11. A row exists only where a broker has asked for the gate, so there is nothing to turn off and nothing to seed.
+         *
+         *     **A gate for the whole book cannot be exempted for one product.** An exemption would be a claim about a broker's credit policy that BR-004 does not ask this platform to model; a broker wanting to gate all but one product declares the rest.
+         */
+        get: operations["ReadPaymentGates"];
+        put?: never;
+        /**
+         * Declare that cover waits for a payment
+         * @description BR-004. Records that a payment must be recorded before cover begins - for every product this broker sells, or for one of them.
+         *
+         *     **It changes no existing policy.** A confirmation resolves the gate at the instant it is recorded, so a policy already active stays active and one already held stays held. What changes is where the *next* confirmation lands: `PendingPayment` instead of `Active`.
+         *
+         *     **Declaring the same gate twice is a `409`.** The row is the declaration, so a second one would be the same fact recorded twice with two authors and two instants.
+         *
+         *     **A product this broker does not sell is a `400`.** Checked through the catalogue before the row is written.
+         */
+        post: operations["DeclarePaymentGate"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/policies/payment-gates/{id}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post?: never;
+        /**
+         * Stop requiring a payment before cover begins
+         * @description Deletes the declaration. No gate applies by absence, which is what an empty table means.
+         *
+         *     **Policies already held are not released by this.** They stay `PendingPayment` until somebody records that the requirement was met, because releasing cover is an act with an author and evidence (ADR-0042 section 7) and withdrawing a rule is neither. A broker that gated its book by mistake releases each held policy deliberately.
+         */
+        delete: operations["WithdrawPaymentGate"];
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/policies/{id}/documents/{kind}": {
         parameters: {
             query?: never;
@@ -4056,6 +4260,11 @@ export interface components {
             note: null | string;
             idempotencyKey: null | string;
         };
+        AssignablePermissionResponse: {
+            key: string;
+            name: string;
+            description: null | string;
+        };
         AssignLeadRequest: {
             advisorSubjectId: null | string;
         };
@@ -4096,6 +4305,9 @@ export interface components {
             items: components["schemas"]["ProductResponse"][];
             nextCursor: null | string;
         };
+        ChangeRolePermissionsRequest: {
+            permissionKeys: string[];
+        };
         ClaimAppointmentResponse: {
             /** Format: uuid */
             id: string;
@@ -4451,12 +4663,21 @@ export interface components {
             key: null | string;
             name: null | string;
         };
+        DeclarePaymentGateRequest: {
+            /** Format: uuid */
+            productId: null | string;
+        };
         DeclineQuoteRequest: {
             /** Format: uuid */
             presentationVersionId: null | string;
             note: null | string;
             idempotencyKey: null | string;
         };
+        DefineRoleRequest: {
+            key: string;
+            name: string;
+            description: null | string;
+        };
         DocumentTemplateResponse: {
             /** Format: uuid */
             id: string;
@@ -5092,6 +5313,16 @@ export interface components {
         PaymentEvidenceUpload: {
             file: components["schemas"]["IFormFile"];
         };
+        PaymentGateResponse: {
+            /** Format: uuid */
+            id: string;
+            /** Format: uuid */
+            productId: null | string;
+            appliesToEveryProduct: boolean;
+            /** Format: date-time */
+            setAtUtc: string;
+            setBySubjectId: string;
+        };
         PaymentPage: {
             items: components["schemas"]["PaymentSummaryResponse"][];
             nextCursor: null | string;
@@ -5240,6 +5471,11 @@ export interface components {
             /** Format: date-time */
             importedAtUtc: null | string;
             importedBySubjectId: null | string;
+            /** Format: date-time */
+            paymentRequirementMetAtUtc: null | string;
+            paymentRequirementMetBySubjectId: null | string;
+            /** Format: uuid */
+            paymentEvidenceReference: null | string;
         };
         PresentationBodyResponse: {
             version: components["schemas"]["PresentationVersionResponse"];
@@ -5552,6 +5788,10 @@ export interface components {
             source: string;
             externalReference: string;
         };
+        RecordPaymentRequirementMetRequest: {
+            /** Format: uuid */
+            paymentId: null | string;
+        };
         RecordRenewalCustomerInformationRequest: {
             /** Format: uuid */
             formSubmissionId: null | string;
@@ -5592,6 +5832,10 @@ export interface components {
         RenameFormDefinitionRequest: {
             name: null | string;
         };
+        RenameRoleRequest: {
+            name: string;
+            description: null | string;
+        };
         RenewalCaseDetailResponse: {
             case: components["schemas"]["RenewalCaseSummaryResponse"];
             /** Format: uuid */
@@ -5769,6 +6013,26 @@ export interface components {
             /** Format: int32 */
             bodySchemaVersion: null | number | string;
         };
+        RoleResponse: {
+            /** Format: uuid */
+            id: string;
+            key: string;
+            name: string;
+            description: null | string;
+            isSystem: boolean;
+            roleTemplateCode: null | string;
+            permissionKeys: string[];
+            /** Format: date-time */
+            createdAtUtc: string;
+            /** Format: date-time */
+            updatedAtUtc: string;
+        };
+        RoleTemplateResponse: {
+            code: string;
+            name: string;
+            description: null | string;
+            permissionKeys: string[];
+        };
         SaveInsurerContactRequest: {
             fullName: null | string;
             jobTitle: null | string;
@@ -12041,7 +12305,7 @@ export interface operations {
             };
         };
     };
-    GetTenantSettings: {
+    ListRoles: {
         parameters: {
             query?: never;
             header?: never;
@@ -12056,57 +12320,73 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["TenantSettingsResponse"];
+                    "application/json": components["schemas"]["RoleResponse"][];
+                };
+            };
+            /** @description Forbidden */
+            403: {
+                headers: {
+                    [name: string]: unknown;
                 };
+                content?: never;
             };
         };
     };
-    GetTenantBranding: {
+    DefineRole: {
         parameters: {
             query?: never;
             header?: never;
             path?: never;
             cookie?: never;
         };
-        requestBody?: never;
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["DefineRoleRequest"];
+            };
+        };
         responses: {
-            /** @description OK */
-            200: {
+            /** @description Created */
+            201: {
                 headers: {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["TenantBrandingResponse"];
+                    "application/json": components["schemas"]["RoleResponse"];
                 };
             };
-        };
-    };
-    GetTenantEntitlements: {
-        parameters: {
-            query?: never;
-            header?: never;
-            path?: never;
-            cookie?: never;
-        };
-        requestBody?: never;
-        responses: {
-            /** @description OK */
-            200: {
+            /** @description Bad Request */
+            400: {
                 headers: {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["EntitlementResponse"][];
+                    "application/problem+json": components["schemas"]["ProblemDetails"];
+                };
+            };
+            /** @description Forbidden */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Conflict */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ProblemDetails"];
                 };
             };
         };
     };
-    GetTenantEntitlement: {
+    GetRole: {
         parameters: {
             query?: never;
             header?: never;
             path: {
-                featureKey: string;
+                id: string;
             };
             cookie?: never;
         };
@@ -12118,12 +12398,336 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["EntitlementResponse"];
+                    "application/json": components["schemas"]["RoleResponse"];
                 };
             };
-        };
-    };
-    ListIntegrationCredentials: {
+            /** @description Forbidden */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Not Found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    ListAssignablePermissions: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AssignablePermissionResponse"][];
+                };
+            };
+            /** @description Forbidden */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    ListRoleTemplates: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["RoleTemplateResponse"][];
+                };
+            };
+            /** @description Forbidden */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    RenameRole: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["RenameRoleRequest"];
+            };
+        };
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["RoleResponse"];
+                };
+            };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ProblemDetails"];
+                };
+            };
+            /** @description Forbidden */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Not Found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Conflict */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ProblemDetails"];
+                };
+            };
+        };
+    };
+    GrantRolePermissions: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["ChangeRolePermissionsRequest"];
+            };
+        };
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["RoleResponse"];
+                };
+            };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ProblemDetails"];
+                };
+            };
+            /** @description Forbidden */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Not Found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Conflict */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ProblemDetails"];
+                };
+            };
+        };
+    };
+    WithdrawRolePermissions: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["ChangeRolePermissionsRequest"];
+            };
+        };
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["RoleResponse"];
+                };
+            };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ProblemDetails"];
+                };
+            };
+            /** @description Forbidden */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Not Found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Conflict */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ProblemDetails"];
+                };
+            };
+        };
+    };
+    GetTenantSettings: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["TenantSettingsResponse"];
+                };
+            };
+        };
+    };
+    GetTenantBranding: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["TenantBrandingResponse"];
+                };
+            };
+        };
+    };
+    GetTenantEntitlements: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["EntitlementResponse"][];
+                };
+            };
+        };
+    };
+    GetTenantEntitlement: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                featureKey: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["EntitlementResponse"];
+                };
+            };
+        };
+    };
+    ListIntegrationCredentials: {
         parameters: {
             query?: never;
             header?: never;
@@ -12527,6 +13131,59 @@ export interface operations {
             };
         };
     };
+    RecordPaymentRequirementMet: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["RecordPaymentRequirementMetRequest"];
+            };
+        };
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["PolicyResponse"];
+                };
+            };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
+                };
+            };
+            /** @description Not Found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ProblemDetails"];
+                };
+            };
+            /** @description Conflict */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ProblemDetails"];
+                };
+            };
+        };
+    };
     GetPolicy: {
         parameters: {
             query?: never;
@@ -12558,6 +13215,95 @@ export interface operations {
             };
         };
     };
+    ReadPaymentGates: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["PaymentGateResponse"][];
+                };
+            };
+        };
+    };
+    DeclarePaymentGate: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["DeclarePaymentGateRequest"];
+            };
+        };
+        responses: {
+            /** @description Created */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["PaymentGateResponse"];
+                };
+            };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
+                };
+            };
+            /** @description Conflict */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ProblemDetails"];
+                };
+            };
+        };
+    };
+    WithdrawPaymentGate: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description No Content */
+            204: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Not Found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
     UploadPolicyDocument: {
         parameters: {
             query?: never;

package/package.json

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