@insurance-broker/api-client 1.47.0 → 2.0.0

package/dist/schema.d.ts

@@ -628,6 +628,66 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/customer/charges": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * See what you owe, and what you have already covered
+         * @description PAY-002, PAY-005. Every charge your broker has raised against your policies, oldest due date first, paged by cursor.
+         *
+         *     **You are not named in the request.** There is no customer field and no broker field: the list is whoever is signed in, resolved from the session. Another person's charges are not in it - not filtered out of it, but absent.
+         *
+         *     **This is a live position, not a statement.** Nothing here was produced for you in advance: the figures and the state on each row are worked out as this answer is written, so it can change between one request and the next. A statement is the other thing - a document your broker produced deliberately, for a period, fixed at the moment they produced it - and it is on `/api/v1/customer/statements`.
+         *
+         *     **`state` is one of `due`, `overdue`, `paid` and `closed`**, and nothing stores it. A charge is `overdue` when its due date is before the day this page was measured against and something is still owed on it; that day is returned as `asOf`, so you can bucket the page against your own clock without asking again. `closed` means the charge has finished and nothing further is owed on it.
+         *
+         *     **One walk is measured against one day.** `asOf` is read from the clock on the first page and carried inside the cursor, so a walk crossing UTC midnight stays consistent. A walk resumed the next morning therefore serves the previous day's buckets: compare `asOf` with your own clock and start a new walk without a cursor.
+         *
+         *     **`balance` is not always `amount` less `paid`.** A charge your broker cancelled is owed nothing, so anything you paid against it counts in your favour; a charge your broker wrote off is owed only what had already arrived, because the rest was forgiven. The same rule your statement uses, so the two cannot disagree.
+         *
+         *     **There is no total.** What you owe overall is a sum across a whole book and across currencies, which is what a statement is for.
+         */
+        get: operations["ListOwnCharges"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/customer/payments": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * See the payments your broker has recorded from you
+         * @description PAY-005. Every payment recorded against your charges, most recently recorded first, paged by cursor.
+         *
+         *     **Recorded, not taken.** This platform does not collect money: a payment here is your broker writing down that money reached them somewhere else - a bank, a mobile-money service, a counter - with the reference it arrived under. **There is no route here that pays anything**, deliberately.
+         *
+         *     **`state` is `received` or `returned`.** `received` means your broker has recorded the money and it counts against what you owe. `returned` means a reversal was recorded afterwards - the money did not arrive after all, or went back - so it no longer counts. A returned payment stays on this list rather than disappearing from it, because it happened.
+         *
+         *     **No `asOf`**, unlike the charges list: a payment was recorded at an instant this row holds, and nothing about this list moves at midnight.
+         *
+         *     **Each payment names the one charge it was recorded against**, and the policy that charge is owed under.
+         */
+        get: operations["ListOwnPayments"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/exports/obligations": {
         parameters: {
             query?: never;
@@ -3620,6 +3680,32 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/policies/{id}/documents/{documentId}/download-links": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Mints a short-lived, single-use URL for a client that cannot send a header
+         * @description DOC-003, ADR-0034 section 7. Answers `{ url, expiresAtUtc }` for one document of one policy.
+         *
+         *     **This is for the clients that cannot send an `Authorization` header** - a native viewer, an image tag, an operating system downloader. Anything that can send a header should fetch `/content` instead.
+         *
+         *     **The URL is single-use and expires in minutes.** Treat it as spent the moment it is handed to anything. `expiresAtUtc` is this deployment's configured lifetime, so read it rather than assuming five minutes.
+         *
+         *     A document whose scan verdict is not `Clean` is refused here as well as at download, and the refusal names the verdict.
+         */
+        post: operations["MintPolicyDocumentDownloadLink"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/document-templates": {
         parameters: {
             query?: never;
@@ -3975,7 +4061,13 @@ export interface paths {
         };
         /**
          * Everything filed against this customer's policies, newest first
-         * @description Lists the documents on every policy this customer holds — policy documents, certificates, invoices, receipts and correspondence. A document is quarantined the moment it is stored and only a malware scan moves it, so a row whose verdict is not Clean is listed and cannot be downloaded.
+         * @description Lists the documents on every policy this customer holds - policy documents, certificates, invoices, receipts and correspondence - paged by cursor.
+         *
+         *     A document is quarantined the moment it is stored and only a malware scan moves it, so a row whose `scanVerdict` is not `Clean` is listed here and cannot be downloaded. The refusal names which verdict it was.
+         *
+         *     **Paged, and the shape changed in step 11.8** (issue #177). This answers `{ items, nextCursor }` where it used to answer a bare array capped at a hundred rows, past which the oldest documents were unreachable. Pass `nextCursor` back as `cursor`; a null one means this is the last page.
+         *
+         *     For the documents of one policy rather than of all of them, use `/customer/policies/{id}/documents`.
          */
         get: operations["ListCustomerPolicyDocuments"];
         put?: never;
@@ -4026,6 +4118,149 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/customer/policy-documents/{documentId}/download-links": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Mints a short-lived, single-use URL for a viewer that cannot send a header
+         * @description DOC-003, ADR-0034 section 7. Answers `{ url, expiresAtUtc }` for one of your own documents.
+         *
+         *     **This is for the clients that cannot send an `Authorization` header** - your device's own PDF viewer, an image tag, an operating system downloader. Anything that can send a header should fetch `/content` instead.
+         *
+         *     **The URL is single-use and expires in minutes.** Treat it as spent the moment you hand it to anything: a viewer that probes it before fetching will consume it. Mint one per view rather than caching one. `expiresAtUtc` is this deployment's configured lifetime, so read it rather than assuming five minutes.
+         *
+         *     A document whose scan verdict is not `Clean` is refused here as well as at download, and the refusal names the verdict. A document belonging to another customer answers exactly as one that does not exist.
+         */
+        post: operations["MintCustomerPolicyDocumentDownloadLink"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/customer/policies": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * The policies your broker has placed for you, most recent first
+         * @description POL-006. Every policy of yours, paged by cursor.
+         *
+         *     **You are not named in the request.** There is no customer field and no broker field: the list is whoever is signed in, resolved from the session. Another person's policies are not in it - not filtered out of it, but absent, because a policy that is not yours is not visible to this route at all.
+         *
+         *     **`status` is not the answer to "am I covered today".** That question is the status and the cover dates together: a policy reading `Active` whose cover period has ended is an ordinary row, and so is one reading `Expired` that a renewal later reinstates (ADR-0035 section 4). Both dates are on every row.
+         *
+         *     **`insurerId` and `productId` are identifiers, not names.** The insurer and the product are records your broker's catalogue owns; read their names from their own routes.
+         *
+         *     Your broker's migration working notes are not here. A policy carried across from an older system says so in `source`, and what the old system recorded verbatim is a separate record with a permission of its own.
+         */
+        get: operations["ListCustomerPolicies"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/customer/policies/{id}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * One of your own policies
+         * @description POL-006. When the cover runs from and to, who it is placed with, what it costs and where it is in its life.
+         *
+         *     Another person's policy and a policy that does not exist are one 404, because a policy belonging to somebody else is not visible to this route at all rather than hidden from it by a filter somebody remembered to write.
+         */
+        get: operations["GetCustomerPolicy"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/customer/policies/{id}/documents": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * The documents filed against one of your policies, newest first
+         * @description POL-006 and DOC-003. What your broker has filed against this policy - the policy document itself, certificates, invoices, receipts and correspondence - paged by cursor.
+         *
+         *     A document is quarantined the moment it is stored and only a malware scan moves it, so a row whose `scanVerdict` is not `Clean` is listed here and cannot be downloaded. The refusal names which verdict it was.
+         *
+         *     A policy belonging to somebody else answers exactly as one that does not exist.
+         */
+        get: operations["ListCustomerPolicyDocumentsForPolicy"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/customer/policies/{id}/documents/{documentId}/download-links": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Mints a short-lived, single-use URL for a viewer that cannot send a header
+         * @description DOC-003, ADR-0034 section 7. Answers `{ url, expiresAtUtc }` for one document of one of your policies.
+         *
+         *     **This is for the clients that cannot send an `Authorization` header** - your device's own PDF viewer, an image tag, an operating system downloader. Anything that can send a header should fetch `/content` instead.
+         *
+         *     **The URL is single-use and expires in minutes.** Treat it as spent the moment you hand it to anything: a viewer that probes it before fetching will consume it. Mint one per view rather than caching one. `expiresAtUtc` is this deployment's configured lifetime, so read it rather than assuming five minutes.
+         *
+         *     A document whose scan verdict is not `Clean` is refused here as well as at download, and the refusal names the verdict.
+         */
+        post: operations["MintCustomerPolicyDocumentDownloadLinkForPolicy"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/policy-documents/download-links/{token}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** Redeems a short-lived download link and streams the policy document it names. */
+        get: operations["RedeemPolicyDocumentDownloadLink"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/quote-requests": {
         parameters: {
             query?: never;
@@ -5307,6 +5542,29 @@ export interface components {
             issuedBySubjectId: string;
             lines: components["schemas"]["CreditNoteLineResponse"][];
         };
+        CustomerChargePageResponse: {
+            items: components["schemas"]["CustomerChargeResponse"][];
+            nextCursor: null | string;
+            /** Format: date */
+            asOf: string;
+        };
+        CustomerChargeResponse: {
+            /** Format: uuid */
+            id: string;
+            /** Format: uuid */
+            policyId: string;
+            /** Format: double */
+            amount: number | string;
+            /** Format: double */
+            paid: number | string;
+            /** Format: double */
+            balance: number | string;
+            currency: string;
+            /** Format: date */
+            dueOn: string;
+            description: string;
+            state: string;
+        };
         CustomerClaimPage: {
             items: components["schemas"]["ClaimResponse"][];
             nextCursor: null | string;
@@ -5340,6 +5598,30 @@ export interface components {
             /** Format: date-time */
             revokedAtUtc: null | string;
         };
+        CustomerPaymentPageResponse: {
+            items: components["schemas"]["CustomerPaymentResponse"][];
+            nextCursor: null | string;
+        };
+        CustomerPaymentResponse: {
+            /** Format: uuid */
+            id: string;
+            /** Format: uuid */
+            chargeId: string;
+            /** Format: uuid */
+            policyId: string;
+            /** Format: double */
+            amount: number | string;
+            currency: string;
+            source: string;
+            externalReference: string;
+            /** Format: date-time */
+            recordedAtUtc: string;
+            state: string;
+        };
+        CustomerPolicyPage: {
+            items: components["schemas"]["PolicyResponse"][];
+            nextCursor: null | string;
+        };
         CustomerPresentedQuoteResponse: {
             /** Format: uuid */
             presentationVersionId: string;
@@ -6441,6 +6723,15 @@ export interface components {
             sortOrder: number | string;
             features: components["schemas"]["PlatformPlanFeatureResponse"][];
         };
+        PolicyDocumentDownloadLinkResponse: {
+            url: string;
+            /** Format: date-time */
+            expiresAtUtc: string;
+        };
+        PolicyDocumentPage: {
+            items: components["schemas"]["PolicyDocumentResponse"][];
+            nextCursor: null | string;
+        };
         PolicyDocumentResponse: {
             /** Format: uuid */
             id: string;
@@ -8407,7 +8698,71 @@ export interface operations {
                 headers: {
                     [name: string]: unknown;
                 };
-                content?: never;
+                content?: never;
+            };
+        };
+    };
+    ListOwnCharges: {
+        parameters: {
+            query?: {
+                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"]["CustomerChargePageResponse"];
+                };
+            };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
+                };
+            };
+        };
+    };
+    ListOwnPayments: {
+        parameters: {
+            query?: {
+                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"]["CustomerPaymentPageResponse"];
+                };
+            };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
+                };
             };
         };
     };
@@ -15940,6 +16295,45 @@ export interface operations {
             };
         };
     };
+    MintPolicyDocumentDownloadLink: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+                documentId: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Created */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["PolicyDocumentDownloadLinkResponse"];
+                };
+            };
+            /** @description Not Found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Conflict */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ProblemDetails"];
+                };
+            };
+        };
+    };
     ListDocumentTemplates: {
         parameters: {
             query?: {
@@ -16787,6 +17181,7 @@ export interface operations {
     ListCustomerPolicyDocuments: {
         parameters: {
             query?: {
+                cursor?: string;
                 limit?: number | string;
             };
             header?: never;
@@ -16801,7 +17196,16 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["PolicyDocumentResponse"][];
+                    "application/json": components["schemas"]["PolicyDocumentPage"];
+                };
+            };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
                 };
             };
         };
@@ -16871,6 +17275,221 @@ export interface operations {
             };
         };
     };
+    MintCustomerPolicyDocumentDownloadLink: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                documentId: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Created */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["PolicyDocumentDownloadLinkResponse"];
+                };
+            };
+            /** @description Not Found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Conflict */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ProblemDetails"];
+                };
+            };
+        };
+    };
+    ListCustomerPolicies: {
+        parameters: {
+            query?: {
+                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"]["CustomerPolicyPage"];
+                };
+            };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
+                };
+            };
+        };
+    };
+    GetCustomerPolicy: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["PolicyResponse"];
+                };
+            };
+            /** @description Not Found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    ListCustomerPolicyDocumentsForPolicy: {
+        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"]["PolicyDocumentPage"];
+                };
+            };
+            /** @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;
+            };
+        };
+    };
+    MintCustomerPolicyDocumentDownloadLinkForPolicy: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+                documentId: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Created */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["PolicyDocumentDownloadLinkResponse"];
+                };
+            };
+            /** @description Not Found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Conflict */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ProblemDetails"];
+                };
+            };
+        };
+    };
+    RedeemPolicyDocumentDownloadLink: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                token: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                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"];
+                };
+            };
+        };
+    };
     ListQuoteRequests: {
         parameters: {
             query?: {

package/package.json

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