@insurance-broker/api-client 5.4.0 → 5.7.0

package/dist/schema.d.ts

@@ -66,6 +66,8 @@ export interface paths {
          * @description PAY-002. Another broker's obligation and another customer's are invisible here rather than refused: the tenant and owner query filters remove them before the read runs, so all three cases answer the same `404` (ADR-0008, ADR-0030).
          *
          *     There is **no overdue field**. Whether an obligation is overdue is a comparison between its due date and the clock, and step 9.10's lists compute it at read time and return the day they measured against — ADR-0035 §4's rule, which forbids storing a status a date comparison answers.
+         *
+         *     **`paid` and `balance` are computed as the response is written** (#595), by the same rule as the list. `paid` is read a moment after the charge itself, so a payment that lands in between can show in `paid` and `balance` before `status` reflects it; read again and the two agree. `balance` is not always `amount` less `paid`: a cancelled charge is owed nothing, so money paid against one leaves the customer in credit, and a written-off charge is owed what actually arrived and no more.
          */
         get: operations["GetObligation"];
         put?: never;
@@ -133,7 +135,15 @@ export interface paths {
             path?: never;
             cookie?: never;
         };
-        get?: never;
+        /**
+         * List what this broker has invoiced, newest first
+         * @description ADR-0042 section 8, ADR-0031. Every invoice this broker has drafted — drafts, issued invoices and discarded drafts — **most recently drafted first**, ordered by `draftedAtUtc` and then `id`, both descending, and paged by cursor. The drafting instant is the key because it never changes: an invoice keeps its place in the walk when it is issued or discarded.
+         *
+         *     `customerId`, `policyId` and `status` (`Draft`, `Issued`, `Discarded`) narrow the list and combine. **None of them is authorisation**: the broker whose invoices these are comes from the session, and naming another broker's customer selects nothing rather than refusing.
+         *
+         *     A row carries no lines; `GET /invoices/{id}` returns one invoice with its lines. There is no total and no count: `nextCursor` is null at the end of the walk (ADR-0031 section 4). A cursor this endpoint did not issue is a `400`.
+         */
+        get: operations["ListInvoices"];
         put?: never;
         /**
          * Open a draft invoice against a policy
@@ -6378,7 +6388,7 @@ export interface components {
             fileName: string;
             contentType: string;
             /** Format: int64 */
-            sizeBytes: number | string;
+            sizeBytes: number;
             contentSha256: string;
             /** Format: date-time */
             uploadedAtUtc: string;
@@ -6537,10 +6547,10 @@ export interface components {
             /** Format: uuid */
             productId: string;
             /** Format: int32 */
-            versionNumber: number | string;
+            versionNumber: number;
             status: string;
             /** Format: int32 */
-            bodySchemaVersion: number | string;
+            bodySchemaVersion: number;
             contentHash: null | string;
             /** Format: date-time */
             createdAtUtc: string;
@@ -6604,7 +6614,7 @@ export interface components {
             /** Format: uuid */
             id: string;
             /** Format: int32 */
-            ordinal: number | string;
+            ordinal: number;
             kind: string;
             description: string;
             /** Format: double */
@@ -6715,14 +6725,14 @@ export interface components {
             /** Format: uuid */
             definitionVersionId: string;
             /** Format: int32 */
-            versionNumber: number | string;
+            versionNumber: number;
             versionStatus: components["schemas"]["FormVersionStatus"];
             status: components["schemas"]["SubmissionStatus"];
             /** Format: date */
             evaluatedAsOf: string;
             contentHashVerified: boolean;
             /** Format: int32 */
-            answersSchemaVersion: number | string;
+            answersSchemaVersion: number;
             /** Format: date-time */
             createdAtUtc: string;
             /** Format: date-time */
@@ -6733,7 +6743,7 @@ export interface components {
             /** Format: uuid */
             liveVersionId: null | string;
             /** Format: int32 */
-            liveVersionNumber: null | number | string;
+            liveVersionNumber: null | number;
             answers: components["schemas"]["CustomerSubmittedAnswerResponse"][];
             evidence: components["schemas"]["SubmittedEvidenceResponse"][];
             isSatisfied: boolean;
@@ -6820,7 +6830,7 @@ export interface components {
             fileName: string;
             contentType: string;
             /** Format: int64 */
-            sizeBytes: number | string;
+            sizeBytes: number;
             contentSha256: string;
             /** Format: date-time */
             uploadedAtUtc: string;
@@ -6898,9 +6908,9 @@ export interface components {
             /** Format: uuid */
             presentationVersionId: string;
             /** Format: int32 */
-            versionNumber: number | string;
+            versionNumber: number;
             /** Format: int32 */
-            bodySchemaVersion: number | string;
+            bodySchemaVersion: number;
             body: string;
             /** Format: date */
             pricedAsOf: string;
@@ -6917,7 +6927,7 @@ export interface components {
             /** Format: uuid */
             presentationVersionId: null | string;
             /** Format: int32 */
-            versionNumber: null | number | string;
+            versionNumber: null | number;
             /** Format: date */
             asOf: string;
             currency: null | string;
@@ -7053,7 +7063,7 @@ export interface components {
             fileName: string;
             contentType: string;
             /** Format: int64 */
-            sizeBytes: number | string;
+            sizeBytes: number;
             contentSha256: string;
             /** Format: date-time */
             uploadedAtUtc: string;
@@ -7082,7 +7092,7 @@ export interface components {
             name: string;
             description: null | string;
             /** Format: int32 */
-            sortOrder: number | string;
+            sortOrder: number;
         };
         DeadLetterPage: {
             items: components["schemas"]["DeadLetterResponse"][];
@@ -7101,7 +7111,7 @@ export interface components {
             messageId: null | string;
             tenantKey: null | string;
             /** Format: int32 */
-            attempts: number | string;
+            attempts: number;
             cause: string;
             error: string;
             /** Format: date-time */
@@ -7158,9 +7168,9 @@ export interface components {
             /** Format: uuid */
             versionId: string;
             /** Format: int32 */
-            versionNumber: number | string;
+            versionNumber: number;
             /** Format: int32 */
-            bodySchemaVersion: number | string;
+            bodySchemaVersion: number;
             /** Format: date-time */
             createdAtUtc: string;
             createdBySubjectId: string;
@@ -7181,7 +7191,7 @@ export interface components {
             draft: null | components["schemas"]["DocumentTemplateVersionResponse"];
             published: null | components["schemas"]["DocumentTemplateVersionResponse"];
             /** Format: int32 */
-            versionCount: number | string;
+            versionCount: number;
         };
         DocumentTemplateVersionBodyResponse: {
             version: components["schemas"]["DocumentTemplateVersionResponse"];
@@ -7191,10 +7201,10 @@ export interface components {
             /** Format: uuid */
             id: string;
             /** Format: int32 */
-            versionNumber: number | string;
+            versionNumber: number;
             status: string;
             /** Format: int32 */
-            bodySchemaVersion: number | string;
+            bodySchemaVersion: number;
             contentHash: null | string;
             /** Format: date-time */
             createdAtUtc: string;
@@ -7221,7 +7231,7 @@ export interface components {
             name: string;
             description: null | string;
             /** Format: int32 */
-            sortOrder: number | string;
+            sortOrder: number;
             /** Format: uuid */
             productId: null | string;
             platform: components["schemas"]["EmergencyContactDetailsResponse"];
@@ -7261,9 +7271,9 @@ export interface components {
             view: string;
             format: string;
             /** Format: int32 */
-            rowCount: number | string;
+            rowCount: number;
             /** Format: int64 */
-            byteCount: number | string;
+            byteCount: number;
             contentSha256: string;
             /** Format: uuid */
             customerId: null | string;
@@ -7456,7 +7466,7 @@ export interface components {
             draft: null | components["schemas"]["FormVersionResponse"];
             published: null | components["schemas"]["FormVersionResponse"];
             /** Format: int32 */
-            versionCount: number | string;
+            versionCount: number;
         };
         /** @enum {string} */
         FormKind: "Quote" | "Claim";
@@ -7474,14 +7484,14 @@ export interface components {
             /** Format: uuid */
             definitionVersionId: string;
             /** Format: int32 */
-            versionNumber: number | string;
+            versionNumber: number;
             versionStatus: components["schemas"]["FormVersionStatus"];
             status: components["schemas"]["SubmissionStatus"];
             /** Format: date */
             evaluatedAsOf: string;
             contentHashVerified: boolean;
             /** Format: int32 */
-            answersSchemaVersion: number | string;
+            answersSchemaVersion: number;
             /** Format: date-time */
             createdAtUtc: string;
             createdBySubjectId: string;
@@ -7494,7 +7504,7 @@ export interface components {
             /** Format: uuid */
             liveVersionId: null | string;
             /** Format: int32 */
-            liveVersionNumber: null | number | string;
+            liveVersionNumber: null | number;
             answers: components["schemas"]["SubmittedAnswerResponse"][];
             evidence: components["schemas"]["SubmittedEvidenceResponse"][];
             isSatisfied: boolean;
@@ -7516,10 +7526,10 @@ export interface components {
             /** Format: uuid */
             id: string;
             /** Format: int32 */
-            versionNumber: number | string;
+            versionNumber: number;
             status: components["schemas"]["FormVersionStatus"];
             /** Format: int32 */
-            bodySchemaVersion: number | string;
+            bodySchemaVersion: number;
             contentHash: null | string;
             /** Format: date-time */
             createdAtUtc: string;
@@ -7536,7 +7546,7 @@ export interface components {
         FreeTextPaymentSourceResponse: {
             source: string;
             /** Format: int32 */
-            payments: number | string;
+            payments: number;
         };
         FreeTextPaymentSourcesResponse: {
             sources: components["schemas"]["FreeTextPaymentSourceResponse"][];
@@ -7563,7 +7573,7 @@ export interface components {
             type?: null | string;
             title?: null | string;
             /** Format: int32 */
-            status?: null | number | string;
+            status?: null | number;
             detail?: null | string;
             instance?: null | string;
             errors?: {
@@ -7700,12 +7710,14 @@ export interface components {
             email: null | string;
             phone: null | string;
             website: null | string;
-            status: string;
+            status: components["schemas"]["InsurerStatus"];
             /** Format: date-time */
             createdAtUtc: string;
             /** Format: date-time */
             updatedAtUtc: string;
         };
+        /** @enum {string} */
+        InsurerStatus: "Active" | "Suspended";
         InsurerSubmissionResponse: {
             /** Format: uuid */
             id: string;
@@ -7741,13 +7753,17 @@ export interface components {
             /** Format: uuid */
             id: string;
             /** Format: int32 */
-            ordinal: number | string;
+            ordinal: number;
             kind: string;
             description: string;
             /** Format: double */
             amount: number | string;
             currency: string;
         };
+        InvoicePage: {
+            items: components["schemas"]["InvoiceSummaryResponse"][];
+            nextCursor: null | string;
+        };
         InvoiceResponse: {
             /** Format: uuid */
             id: string;
@@ -7775,6 +7791,32 @@ export interface components {
             retentionAnchorAtUtc: null | string;
             lines: components["schemas"]["InvoiceLineResponse"][];
         };
+        InvoiceSummaryResponse: {
+            /** Format: uuid */
+            id: string;
+            /** Format: uuid */
+            customerId: string;
+            /** Format: uuid */
+            policyId: string;
+            /** Format: uuid */
+            productId: string;
+            /** Format: double */
+            premiumAmount: number | string;
+            currency: string;
+            /** Format: date */
+            coverStart: null | string;
+            /** Format: date */
+            coverEnd: null | string;
+            status: string;
+            /** Format: date-time */
+            draftedAtUtc: string;
+            /** Format: date-time */
+            issuedAtUtc: null | string;
+            /** Format: double */
+            totalAmount: null | number | string;
+            /** Format: date-time */
+            retentionAnchorAtUtc: null | string;
+        };
         IssueCreditNoteRequest: {
             reason: string;
             lines: components["schemas"]["CreditNoteLineRequest"][];
@@ -7811,11 +7853,11 @@ export interface components {
             to: null | string;
             source: null | string;
             /** Format: int32 */
-            arrived: number | string;
+            arrived: number;
             /** Format: int32 */
-            unassigned: number | string;
+            unassigned: number;
             /** Format: int32 */
-            assigned: number | string;
+            assigned: number;
             bySource: components["schemas"]["LeadFunnelSourceRow"][];
             /** Format: date-time */
             asAtUtc: null | string;
@@ -7841,11 +7883,11 @@ export interface components {
         LeadFunnelSourceRow: {
             source: string;
             /** Format: int32 */
-            arrived: number | string;
+            arrived: number;
             /** Format: int32 */
-            unassigned: number | string;
+            unassigned: number;
             /** Format: int32 */
-            assigned: number | string;
+            assigned: number;
         };
         LeadResponse: {
             /** Format: uuid */
@@ -7887,7 +7929,7 @@ export interface components {
             id: string;
             kind: string;
             /** Format: int32 */
-            version: number | string;
+            version: number;
             body: string;
             /** Format: date-time */
             publishedAtUtc: string;
@@ -7963,6 +8005,10 @@ export interface components {
             productId: string;
             /** Format: double */
             amount: number | string;
+            /** Format: double */
+            paid: number | string;
+            /** Format: double */
+            balance: number | string;
             currency: string;
             /** Format: date */
             dueOn: string;
@@ -8002,7 +8048,7 @@ export interface components {
             name: string;
             kind: components["schemas"]["FormKind"];
             /** Format: int32 */
-            publishedVersionNumber: number | string;
+            publishedVersionNumber: number;
         };
         OfferedLineOfBusinessResponse: {
             /** Format: uuid */
@@ -8011,7 +8057,7 @@ export interface components {
             name: string;
             description: null | string;
             /** Format: int32 */
-            sortOrder: number | string;
+            sortOrder: number;
         };
         OfferedProductResponse: {
             /** Format: uuid */
@@ -8077,11 +8123,11 @@ export interface components {
             tenantId: string;
             eventType: string;
             /** Format: int32 */
-            eventVersion: number | string;
+            eventVersion: number;
             /** Format: date-time */
             occurredAtUtc: string;
             /** Format: int32 */
-            attempts: number | string;
+            attempts: number;
             lastError: null | string;
             /** Format: date-time */
             nextAttemptAtUtc: null | string;
@@ -8096,7 +8142,7 @@ export interface components {
             tenantKey: null | string;
             eventType: string;
             /** Format: int32 */
-            attempts: number | string;
+            attempts: number;
         };
         OverrideEntitlementRequest: {
             featureKey: null | string;
@@ -8164,7 +8210,7 @@ export interface components {
             fileName: string;
             contentType: string;
             /** Format: int64 */
-            sizeBytes: number | string;
+            sizeBytes: number;
             contentSha256: string;
             /** Format: date-time */
             uploadedAtUtc: string;
@@ -8248,13 +8294,13 @@ export interface components {
             paymentMethodId: string;
             source: string;
             /** Format: int32 */
-            mapped: number | string;
+            mapped: number;
             /** Format: int32 */
-            alreadyMapped: number | string;
+            alreadyMapped: number;
             /** Format: int32 */
-            mappedToAnotherMethod: number | string;
+            mappedToAnotherMethod: number;
             /** Format: int32 */
-            skippedCount: number | string;
+            skippedCount: number;
             skipped: components["schemas"]["SkippedPaymentResponse"][];
         };
         PaymentSourceRemappingResponse: {
@@ -8264,22 +8310,22 @@ export interface components {
             paymentMethodId: string;
             source: string;
             /** Format: int32 */
-            remapped: number | string;
+            remapped: number;
             /** Format: int32 */
-            recordedAgainstMethod: number | string;
+            recordedAgainstMethod: number;
             /** Format: int32 */
-            notYetCorrectable: number | string;
+            notYetCorrectable: number;
         };
         PaymentSourceUnmappingResponse: {
             /** Format: uuid */
             paymentMethodId: string;
             source: string;
             /** Format: int32 */
-            unmapped: number | string;
+            unmapped: number;
             /** Format: int32 */
-            recordedAgainstMethod: number | string;
+            recordedAgainstMethod: number;
             /** Format: int32 */
-            notYetCorrectable: number | string;
+            notYetCorrectable: number;
         };
         PaymentSummaryResponse: {
             /** Format: uuid */
@@ -8380,7 +8426,7 @@ export interface components {
             description: null | string;
             isPubliclyAvailable: boolean;
             /** Format: int32 */
-            sortOrder: number | string;
+            sortOrder: number;
             features: components["schemas"]["PlatformPlanFeatureResponse"][];
         };
         PolicyDocumentDownloadLinkResponse: {
@@ -8401,7 +8447,7 @@ export interface components {
             fileName: string;
             contentType: string;
             /** Format: int64 */
-            sizeBytes: number | string;
+            sizeBytes: number;
             contentSha256: string;
             /** Format: date-time */
             uploadedAtUtc: string;
@@ -8524,10 +8570,10 @@ export interface components {
             /** Format: uuid */
             customerId: null | string;
             /** Format: int32 */
-            versionNumber: number | string;
+            versionNumber: number;
             status: string;
             /** Format: int32 */
-            bodySchemaVersion: number | string;
+            bodySchemaVersion: number;
             contentHash: null | string;
             /** Format: date */
             pricedAsOf: string;
@@ -8550,7 +8596,7 @@ export interface components {
             type?: null | string;
             title?: null | string;
             /** Format: int32 */
-            status?: null | number | string;
+            status?: null | number;
             detail?: null | string;
             instance?: null | string;
         };
@@ -8570,13 +8616,13 @@ export interface components {
             name: string;
             description: null | string;
             /** Format: int32 */
-            sortOrder: number | string;
+            sortOrder: number;
             /** Format: date-time */
             createdAtUtc: string;
             /** Format: date-time */
             updatedAtUtc: string;
             /** Format: int32 */
-            productCount: number | string;
+            productCount: number;
         };
         ProductInsurerResponse: {
             /** Format: uuid */
@@ -8698,7 +8744,7 @@ export interface components {
             /** Format: uuid */
             insurerRequestId: string;
             /** Format: int32 */
-            optionCount: number | string;
+            optionCount: number;
             /** Format: date-time */
             importedAtUtc: string;
             importedBySubjectId: string;
@@ -9051,21 +9097,21 @@ export interface components {
             description: null | string;
             platformAction: string;
             /** Format: int32 */
-            sortOrder: number | string;
+            sortOrder: number;
             /** Format: uuid */
             productId: null | string;
             /** Format: int32 */
-            defaultLeadDays: number | string;
+            defaultLeadDays: number;
             /** Format: int32 */
-            minimumLeadDays: number | string;
+            minimumLeadDays: number;
             /** Format: int32 */
-            maximumLeadDays: number | string;
+            maximumLeadDays: number;
             /** Format: int32 */
-            tenantLeadDays: null | number | string;
+            tenantLeadDays: null | number;
             /** Format: int32 */
-            productLeadDays: null | number | string;
+            productLeadDays: null | number;
             /** Format: int32 */
-            leadDays: number | string;
+            leadDays: number;
             source: string;
             /** Format: date-time */
             changedAtUtc: null | string;
@@ -9116,7 +9162,7 @@ export interface components {
         };
         RetentionPeriodResponse: {
             /** Format: int32 */
-            amount: number | string;
+            amount: number;
             unit: string;
         };
         RetentionScheduleEntryResponse: {
@@ -9386,7 +9432,7 @@ export interface components {
             fileName: string;
             contentType: string;
             /** Format: int64 */
-            sizeBytes: number | string;
+            sizeBytes: number;
             contentSha256: string;
             /** Format: date-time */
             uploadedAtUtc: string;
@@ -10021,6 +10067,41 @@ export interface operations {
             };
         };
     };
+    ListInvoices: {
+        parameters: {
+            query?: {
+                customerId?: string;
+                policyId?: string;
+                status?: 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"]["InvoicePage"];
+                };
+            };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
+                };
+            };
+        };
+    };
     DraftInvoice: {
         parameters: {
             query?: never;

package/package.json

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