@insurance-broker/api-client 1.43.0 → 1.45.0

package/dist/schema.d.ts

@@ -4636,6 +4636,206 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/audit-entries": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * What happened to this broker's records, and who did it
+         * @description NFR-012's question — reconstruct who changed a sensitive record — over this broker's own trail and no one else's. Newest first, paged by an opaque cursor, with no total count. Filter by action, actor, entity, correlation identifier, outcome and period; every filter has an index behind it. An action this platform does not record is refused rather than answered with an empty page.
+         */
+        get: operations["SearchAuditTrail"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/audit-entries/actions": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * The values the action filter accepts
+         * @description Built from the platform's audit action inventory rather than from a seeded catalogue (ADR-0014). The same list on every deployment. It is six values short while issue #313 is open, which the response says rather than leaves to be inferred.
+         */
+        get: operations["ListAuditTrailActions"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/platform/audit-entries": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * What platform operations did, and who did it
+         * @description The platform's record of itself: credentials issued, rotated and revoked, administrators granted and withdrawn, and every cross-tenant read of a broker's trail. Newest first, paged by an opaque cursor, with no total count. Filter by action, operator, entity, correlation identifier, outcome, period and the broker an entry was about.
+         */
+        get: operations["SearchPlatformAuditTrail"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/platform/audit-entries/actions": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * The values the action filter accepts
+         * @description Built from the platform's audit action inventory rather than from a seeded catalogue (ADR-0014). One list for both trails, because both carry one vocabulary and one check constraint. It is six values short while issue #313 is open.
+         */
+        get: operations["ListPlatformAuditTrailActions"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/platform/tenants/{tenantKey}/audit-entries": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * What a named broker's staff did, read from platform scope
+         * @description The question support is asked after an incident and cannot otherwise answer. Every invocation writes a platform audit entry naming the broker read, the operator who read it and what they filtered for — ADR-0010's accountability rests on that entry, so the read is refused if it cannot be recorded. Newest first, paged by an opaque cursor, with no total count.
+         */
+        get: operations["SearchTenantAuditTrail"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/platform/tenants/{tenantKey}/audit-entries/actions": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * The values the action filter accepts
+         * @description Built from the platform's audit action inventory rather than from a seeded catalogue (ADR-0014). It discloses nothing about the broker named in the path — the vocabulary is a property of the software — so unlike the listing beside it, this route records no audit entry. It is six values short while issue #313 is open.
+         */
+        get: operations["ListTenantAuditTrailActions"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/platform/outbox-messages": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * What has not been published, and what the platform has given up on
+         * @description Every module's outbox in one walk, oldest first, paged by an opaque cursor with no total count. Filter by state (abandoned, failing or pending), by module and by broker. Machinery only: the message payload is deliberately not returned.
+         */
+        get: operations["ListOutboxMessages"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/platform/outbox-messages/{moduleName}/{id}/resumption": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Put a message the publisher gave up on back in front of it
+         * @description Clears the terminal state and the backoff, so the next drain pass picks the row up. The attempt count is kept on purpose, so a message that still cannot publish returns to this list rather than spending another full budget failing quietly. Permitted for a suspended broker: resuming completes work that has already committed.
+         */
+        post: operations["ResumeOutboxMessage"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/platform/dead-letters": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Deliveries the dispatcher gave up on
+         * @description The platform's index of its own dead-lettered deliveries, newest first, paged by an opaque cursor with no total count. It names the queue the message is sitting in and never returns its body — a payload is a broker's business data and stays where ADR-0019 put it.
+         */
+        get: operations["ListDeadLetters"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/notifications": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * What this broker's platform tried to tell somebody
+         * @description Newest first, paged by an opaque cursor with no total count. Filter by status — the one worth opening this for is Undeliverable, which means the platform raised a notification and had nobody to send it to. The message body is not returned; the kind, the reference and the subject say what it was about.
+         */
+        get: operations["ListNotifications"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
 }
 export type webhooks = Record<string, never>;
 export interface components {
@@ -4717,6 +4917,39 @@ export interface components {
             /** Format: uuid */
             insurerId: null | string;
         };
+        AuditActionsResponse: {
+            actions: string[];
+            incomplete: boolean;
+        };
+        AuditChangeResponse: {
+            property: string;
+            from: null | string;
+            to: null | string;
+        };
+        AuditEntryPage: {
+            items: components["schemas"]["AuditEntryResponse"][];
+            nextCursor: null | string;
+        };
+        AuditEntryResponse: {
+            /** Format: uuid */
+            id: string;
+            /** Format: date-time */
+            occurredAtUtc: string;
+            action: string;
+            outcome: string;
+            entityType: string;
+            entityId: string;
+            reference: null | string;
+            actorSubjectId: null | string;
+            /** Format: uuid */
+            actingPartyId: null | string;
+            source: string;
+            correlationId: null | string;
+            clientIpAddress: null | string;
+            clientUserAgent: null | string;
+            detail: null | string;
+            changes: components["schemas"]["AuditChangeResponse"][];
+        };
         BranchResponse: {
             /** Format: uuid */
             id: string;
@@ -5102,6 +5335,30 @@ export interface components {
             /** Format: int32 */
             sortOrder: number | string;
         };
+        DeadLetterPage: {
+            items: components["schemas"]["DeadLetterResponse"][];
+            nextCursor: null | string;
+        };
+        DeadLetterResponse: {
+            /** Format: uuid */
+            id: string;
+            /** Format: date-time */
+            deadLetteredAtUtc: string;
+            queue: string;
+            deadLetterQueue: string;
+            eventType: string;
+            consumerName: string;
+            /** Format: uuid */
+            messageId: null | string;
+            tenantKey: null | string;
+            /** Format: int32 */
+            attempts: number | string;
+            cause: string;
+            error: string;
+            /** Format: date-time */
+            occurredAtUtc: null | string;
+            correlationId: null | string;
+        };
         DeclareDocumentTemplateRequest: {
             kind: null | string;
             key: null | string;
@@ -5615,6 +5872,24 @@ export interface components {
             /** Format: date-time */
             publishedAtUtc: string;
         };
+        NotificationPage: {
+            items: components["schemas"]["NotificationResponse"][];
+            nextCursor: null | string;
+        };
+        NotificationResponse: {
+            /** Format: uuid */
+            id: string;
+            kind: string;
+            reference: null | string;
+            subject: string;
+            status: string;
+            intendedAudience: null | string;
+            recipientSubjectId: null | string;
+            /** Format: date-time */
+            createdAtUtc: string;
+            /** Format: date-time */
+            sentAtUtc: null | string;
+        };
         NotifyClaimRequest: {
             /** Format: uuid */
             policyId: string;
@@ -5742,6 +6017,39 @@ export interface components {
             /** Format: date-time */
             updatedAtUtc: string;
         };
+        OutboxMessagePage: {
+            items: components["schemas"]["OutboxMessageResponse"][];
+            nextCursor: null | string;
+        };
+        OutboxMessageResponse: {
+            module: string;
+            /** Format: uuid */
+            id: string;
+            /** Format: uuid */
+            tenantId: string;
+            eventType: string;
+            /** Format: int32 */
+            eventVersion: number | string;
+            /** Format: date-time */
+            occurredAtUtc: string;
+            /** Format: int32 */
+            attempts: number | string;
+            lastError: null | string;
+            /** Format: date-time */
+            nextAttemptAtUtc: null | string;
+            /** Format: date-time */
+            abandonedAtUtc: null | string;
+            correlationId: null | string;
+        };
+        OutboxResumptionResponse: {
+            module: string;
+            /** Format: uuid */
+            id: string;
+            tenantKey: null | string;
+            eventType: string;
+            /** Format: int32 */
+            attempts: number | string;
+        };
         OverrideEntitlementRequest: {
             featureKey: null | string;
             value: null | string;
@@ -5928,6 +6236,31 @@ export interface components {
             /** Format: date-time */
             updatedAtUtc: string;
         };
+        PlatformAuditEntryPage: {
+            items: components["schemas"]["PlatformAuditEntryResponse"][];
+            nextCursor: null | string;
+        };
+        PlatformAuditEntryResponse: {
+            /** Format: uuid */
+            id: string;
+            /** Format: date-time */
+            occurredAtUtc: string;
+            action: string;
+            outcome: string;
+            entityType: string;
+            entityId: string;
+            reference: null | string;
+            /** Format: uuid */
+            affectedTenantId: null | string;
+            affectedTenantKey: null | string;
+            actorSubjectId: null | string;
+            source: string;
+            correlationId: null | string;
+            clientIpAddress: null | string;
+            clientUserAgent: null | string;
+            detail: null | string;
+            changes: components["schemas"]["AuditChangeResponse"][];
+        };
         PlatformPlanFeatureResponse: {
             featureKey: string;
             value: string;
@@ -18402,4 +18735,414 @@ export interface operations {
             };
         };
     };
+    SearchAuditTrail: {
+        parameters: {
+            query?: {
+                action?: string;
+                actor?: string;
+                entityType?: string;
+                entityId?: string;
+                correlationId?: string;
+                outcome?: string;
+                from?: string;
+                to?: 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"]["AuditEntryPage"];
+                };
+            };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
+                };
+            };
+        };
+    };
+    ListAuditTrailActions: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AuditActionsResponse"];
+                };
+            };
+        };
+    };
+    SearchPlatformAuditTrail: {
+        parameters: {
+            query?: {
+                action?: string;
+                actor?: string;
+                entityType?: string;
+                entityId?: string;
+                correlationId?: string;
+                outcome?: string;
+                from?: string;
+                to?: string;
+                affectedTenant?: 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"]["PlatformAuditEntryPage"];
+                };
+            };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
+                };
+            };
+            /** @description Forbidden */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    ListPlatformAuditTrailActions: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AuditActionsResponse"];
+                };
+            };
+            /** @description Forbidden */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    SearchTenantAuditTrail: {
+        parameters: {
+            query?: {
+                action?: string;
+                actor?: string;
+                entityType?: string;
+                entityId?: string;
+                correlationId?: string;
+                outcome?: string;
+                from?: string;
+                to?: string;
+                cursor?: string;
+                limit?: number | string;
+            };
+            header?: never;
+            path: {
+                tenantKey: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AuditEntryPage"];
+                };
+            };
+            /** @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 Not Found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    ListTenantAuditTrailActions: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                tenantKey: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AuditActionsResponse"];
+                };
+            };
+            /** @description Forbidden */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Not Found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    ListOutboxMessages: {
+        parameters: {
+            query?: {
+                state?: string;
+                module?: string;
+                tenantKey?: 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"]["OutboxMessagePage"];
+                };
+            };
+            /** @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 Not Found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    ResumeOutboxMessage: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                moduleName: string;
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["OutboxResumptionResponse"];
+                };
+            };
+            /** @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?: never;
+            };
+        };
+    };
+    ListDeadLetters: {
+        parameters: {
+            query?: {
+                queue?: string;
+                tenantKey?: string;
+                cause?: 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"]["DeadLetterPage"];
+                };
+            };
+            /** @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 Not Found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    ListNotifications: {
+        parameters: {
+            query?: {
+                status?: string;
+                kind?: 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"]["NotificationPage"];
+                };
+            };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
+                };
+            };
+            /** @description Forbidden */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
 }

package/package.json

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