@insurance-broker/api-client 5.48.0 → 5.50.0

package/dist/schema.d.ts

@@ -2990,6 +2990,96 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/customers/{id}/notes": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Read a customer's internal notes, logged calls and emails
+         * @description CRM-009. Newest first, each saying who wrote it and whether it has been shared with the customer. Paged by cursor (ADR-0031): pass `nextCursor` back as `cursor` until it is null. A cursor this list did not issue is a `400`.
+         */
+        get: operations["ListCustomerNotes"];
+        put?: never;
+        /**
+         * Write an internal note about a customer, or log a call or an email
+         * @description CRM-009. `kind` is `Consultation`, `Call` or `Email`. The note is internal: **the customer never sees it** unless a member of staff shares it. Writing one counts as contact with the customer, so it moves their last activity forward.
+         *
+         *     A closed customer takes no further notes, because its retention clock has already started (409).
+         */
+        post: operations["WriteCustomerNote"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/customers/{id}/notes/{noteId}/sharing": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Share an internal note's words with the customer
+         * @description CRM-009. Copies the note's words into what the customer may be shown, recording who decided to and when. **A copy, not a flag**: the note is unchanged, a share cannot be undone, and sharing the same note twice is a `409`. A closed customer's notes cannot be shared (409).
+         */
+        post: operations["ShareCustomerNote"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/customers/{id}/next-actions": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Read a customer's next actions, open and done
+         * @description CRM-008, CRM-009. Newest first, each with its owner, due date and whether it is done. Paged by cursor (ADR-0031): pass `nextCursor` back as `cursor` until it is null.
+         */
+        get: operations["ListCustomerNextActions"];
+        put?: never;
+        /**
+         * Record what a member of staff has to do next for a customer
+         * @description CRM-009. An owner, a due date and a description. The owner must be an active member of this broker holding `crm.customer-actions.manage`. A closed customer takes no further actions (409).
+         */
+        post: operations["RecordCustomerNextAction"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/customers/{id}/next-actions/{actionId}/completion": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Mark a customer's next action done
+         * @description CRM-009. Records who did it and when. An action already done is a `409`, and so is the second of two completions racing each other.
+         */
+        post: operations["CompleteCustomerNextAction"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/customer-account": {
         parameters: {
             query?: never;
@@ -7070,6 +7160,12 @@ export interface components {
             phone: null | string;
             productInterest: null | string;
             message: null | string;
+            sourcePage?: null | string;
+            campaignSource?: null | string;
+            campaignMedium?: null | string;
+            campaignName?: null | string;
+            marketingConsent?: null | string;
+            marketingConsentTextVersion?: null | string;
         };
         CaptureQuoteOptionRequest: {
             /** Format: double */
@@ -7594,6 +7690,44 @@ export interface components {
             /** Format: date-time */
             revokedAtUtc: null | string;
         };
+        CustomerNextActionPage: {
+            items: components["schemas"]["CustomerNextActionResponse"][];
+            nextCursor: null | string;
+        };
+        CustomerNextActionResponse: {
+            /** Format: uuid */
+            id: string;
+            /** Format: uuid */
+            customerId: string;
+            description: string;
+            ownerSubjectId: string;
+            /** Format: date */
+            dueOn: string;
+            done: boolean;
+            /** Format: date-time */
+            createdAtUtc: string;
+            createdBySubjectId: string;
+            /** Format: date-time */
+            completedAtUtc: null | string;
+            completedBySubjectId: null | string;
+        };
+        CustomerNotePage: {
+            items: components["schemas"]["CustomerNoteResponse"][];
+            nextCursor: null | string;
+        };
+        CustomerNoteResponse: {
+            /** Format: uuid */
+            id: string;
+            /** Format: uuid */
+            customerId: string;
+            kind: string;
+            body: string;
+            /** Format: date-time */
+            writtenAtUtc: string;
+            writtenBySubjectId: string;
+            /** Format: date-time */
+            sharedAtUtc: null | string;
+        };
         CustomerNotificationPage: {
             items: components["schemas"]["CustomerNotificationResponse"][];
             nextCursor: null | string;
@@ -7881,6 +8015,19 @@ export interface components {
             /** Format: date-time */
             revokedAtUtc: string;
         };
+        CustomerSharedNoteResponse: {
+            /** Format: uuid */
+            id: string;
+            /** Format: uuid */
+            noteId: string;
+            /** Format: uuid */
+            customerId: string;
+            kind: string;
+            body: string;
+            /** Format: date-time */
+            sharedAtUtc: string;
+            sharedBySubjectId: string;
+        };
         CustomerSubmissionAttachmentResponse: {
             /** Format: uuid */
             id: string;
@@ -8762,6 +8909,14 @@ export interface components {
             createdAtUtc: string;
             /** Format: date-time */
             convertedAtUtc: null | string;
+            sourcePage: null | string;
+            campaignSource: null | string;
+            campaignMedium: null | string;
+            campaignName: null | string;
+            marketingConsent: null | string;
+            marketingConsentTextVersion: null | string;
+            /** Format: date-time */
+            marketingConsentRecordedAtUtc: null | string;
         };
         LegalHoldPage: {
             items: components["schemas"]["LegalHoldResponse"][];
@@ -9872,6 +10027,12 @@ export interface components {
             /** Format: uuid */
             submissionId: string;
         };
+        RecordCustomerNextActionRequest: {
+            description: null | string;
+            ownerSubjectId: null | string;
+            /** Format: date */
+            dueOn: null | string;
+        };
         RecordFollowUpRequest: {
             /** Format: date */
             dueOn: null | string;
@@ -10932,6 +11093,10 @@ export interface components {
         WriteClaimNoteRequest: {
             body: string;
         };
+        WriteCustomerNoteRequest: {
+            kind: null | string;
+            body: null | string;
+        };
         WriteOffObligationRequest: {
             reason: string;
         };
@@ -17530,6 +17695,268 @@ export interface operations {
             };
         };
     };
+    ListCustomerNotes: {
+        parameters: {
+            query?: {
+                cursor?: string;
+                limit?: number | string;
+            };
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["CustomerNotePage"];
+                };
+            };
+            /** @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;
+            };
+        };
+    };
+    WriteCustomerNote: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["WriteCustomerNoteRequest"];
+            };
+        };
+        responses: {
+            /** @description Created */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["CustomerNoteResponse"];
+                };
+            };
+            /** @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"];
+                };
+            };
+        };
+    };
+    ShareCustomerNote: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+                noteId: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Created */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["CustomerSharedNoteResponse"];
+                };
+            };
+            /** @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"];
+                };
+            };
+        };
+    };
+    ListCustomerNextActions: {
+        parameters: {
+            query?: {
+                cursor?: string;
+                limit?: number | string;
+            };
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["CustomerNextActionPage"];
+                };
+            };
+            /** @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;
+            };
+        };
+    };
+    RecordCustomerNextAction: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["RecordCustomerNextActionRequest"];
+            };
+        };
+        responses: {
+            /** @description Created */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["CustomerNextActionResponse"];
+                };
+            };
+            /** @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"];
+                };
+            };
+        };
+    };
+    CompleteCustomerNextAction: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+                actionId: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["CustomerNextActionResponse"];
+                };
+            };
+            /** @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"];
+                };
+            };
+        };
+    };
     GetOwnCustomerAccount: {
         parameters: {
             query?: never;

package/package.json

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