@insurance-broker/api-client 1.28.0 → 1.31.0

package/dist/schema.d.ts

@@ -4,6 +4,268 @@
  */
 
 export interface paths {
+    "/api/v1/obligations": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Record what a customer owes against one of their policies
+         * @description PAY-002. Records an amount, a currency, a due date, the payer and the policy the money is owed against.
+         *
+         *     The **currency is not a field**: it is copied from the policy's own premium, so the pair BR-008 requires travels from one source and a caller cannot invent one. The **amount is** a field, because an instalment is a fraction of a premium and no requirement lets this platform decide a payment schedule.
+         *
+         *     The **payer is not a field** either. An obligation is owed by whoever owns the policy, so a customer identifier here could only ever agree or be wrong (ADR-0042 §3).
+         *
+         *     A **due date in the past is accepted**: a book carried across from another system arrives already in arrears, and refusing that would make a migrated debt unrepresentable.
+         */
+        post: operations["RaiseObligation"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/obligations/{id}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Read one obligation
+         * @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.
+         */
+        get: operations["GetObligation"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/obligations/{id}/cancellation": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Withdraw an obligation raised in error
+         * @description Records that the charge should never have existed. **This is not a write-off**: writing off records that a real debt will not be collected, which is a decision with money behind it and a reason attached, and it arrives in step 9.7. Collapsing the two would make "how much did this broker forgive" unanswerable.
+         *
+         *     Cancelling starts the record's retention clock (ADR-0038 §2), so it is refused a second time rather than silently re-stamped — re-stamping would move the anchor of a record that concluded earlier.
+         */
+        post: operations["CancelObligation"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/invoices": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Open a draft invoice against a policy
+         * @description ADR-0042 section 8. Opens an empty draft and pins the basis it was raised against: the premium, its currency and the cover period, copied once from the policy and never recomputed. A policy whose premium is later corrected does not silently change what a customer was invoiced.
+         *
+         *     The **currency is not a field** — it is the policy's own, so BR-008's pair travels from one source. The **payer is not a field** either: an invoice is addressed to whoever owns the policy.
+         *
+         *     A draft has **no total**. The total is fixed once, at issue, from the lines.
+         */
+        post: operations["DraftInvoice"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/invoices/{id}/lines": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Add one charge to a draft invoice
+         * @description BR-008's tax and fee components, without this platform naming a tax. **A tax or a fee is a line with a kind**, and the kind is the broker's own word: this platform declares no vocabulary for it.
+         *
+         *     There is **no currency field**. A line is in its invoice's currency or it does not exist, and that is held by a four-column foreign key rather than by this handler.
+         *
+         *     There is **no ordinal field**. The position is derived from the lines already present.
+         *
+         *     Refused once the invoice is issued: issue is a one-way door.
+         */
+        post: operations["AddInvoiceLine"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/invoices/{id}/issuance": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Issue a draft, which fixes its total and closes it
+         * @description **The one-way door** (ADR-0042 section 8, BR-010). Issuing sums the lines, stores the total and stamps the instant. After this no route changes a figure on the invoice, and a correction is a credit note — a record of its own, with its own lines — rather than an edit.
+         *
+         *     An invoice with **no lines is refused**: that would be a demand for nothing. A broker charging nil says so with a zero-rated line.
+         *
+         *     Issuing twice is a `409`, and it is not retryable: the invoice is already issued and reading it back is the resolution.
+         */
+        post: operations["IssueInvoice"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/invoices/{id}/discarding": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Abandon a draft that should never have been raised
+         * @description Records that this demand was never made — the customer never saw it and owes nothing on account of it. **Only a draft may be discarded.** An issued invoice that should not have been issued is corrected by a credit note, because the customer has seen the demand and BR-010 will not have it silently withdrawn.
+         *
+         *     Discarding starts the record's retention clock (ADR-0038 section 2), so it is refused a second time rather than silently re-stamped.
+         */
+        post: operations["DiscardInvoice"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/invoices/{id}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Read one invoice with its lines
+         * @description Another broker's invoice 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).
+         *
+         *     The **lines come with the invoice**, because an invoice without its lines is a total with nothing behind it.
+         *
+         *     There is **no balance and no amount paid**: nothing has been paid against anything until payments exist, so either field would be an unreachable zero a reader would take for a fact.
+         */
+        get: operations["GetInvoice"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/obligations/{id}/payments": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Record money that arrived against this charge
+         * @description PAY-001, ADR-0042 sections 4 and 5. Records that money arrived somewhere else. **The platform never asserts that it did**: under `ExternalRecordOnly` there is no gateway, nothing is collected here, and every payment carries the source it came through and the reference that source gave it.
+         *
+         *     **Those two fields are the idempotency key.** `(tenant, source, externalReference)` is unique, so the same money cannot be recorded twice — not because a handler checks, but because the row is unrepresentable (BR-009). There is deliberately **no `idempotencyKey` field**: a caller-invented key answers "is this the same request", and only "is this the same money" has A8's answer in it.
+         *
+         *     **A refusal is recorded, not merely returned.** Every attempt is written before the posting is tried, so a refused duplicate is findable in the reconciliation history read below.
+         *
+         *     The currency is **not** a field: it is the obligation's, held by a foreign key rather than by this handler. Nil is refused — a payment of nothing is nothing having arrived.
+         */
+        post: operations["RecordPayment"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/obligations/{id}/payment-attempts": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * The reconciliation history for this charge
+         * @description **A8's second half**: a duplicate posting must be *visible* in reconciliation history and not merely refused. One row per attempt — what arrived, from where, with which reference, at what instant, and by which subject — stamped with what the platform decided.
+         *
+         *     An `outcome` of `null` is a real state and not missing data: the attempt is written before the posting is tried, so it means a posting in flight, or a process that died between the two. That case is exactly what this read exists to surface.
+         *
+         *     `existingAmount` appears on one outcome only — a refusal because that reference is already recorded for a **different** figure. Both amounts survive and neither overwrites the other (BR-010).
+         */
+        get: operations["ReadPaymentAttempts"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/payments/{id}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Read one payment
+         * @description Another broker's payment 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 approval field**: approval is a separate recorded act and arrives in step 9.6, so a field here would be an unreachable `false` a reader would take for a fact.
+         */
+        get: operations["GetPayment"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/insurers": {
         parameters: {
             query?: never;
@@ -3396,6 +3658,12 @@ export interface components {
             phone: null | string;
             website: null | string;
         };
+        AddInvoiceLineRequest: {
+            kind: string;
+            description: string;
+            /** Format: double */
+            amount: number | string;
+        };
         AddProductCategoryRequest: {
             key: null | string;
             name: null | string;
@@ -3833,6 +4101,10 @@ export interface components {
             retiredAtUtc: null | string;
             retiredBySubjectId: null | string;
         };
+        DraftInvoiceRequest: {
+            /** Format: uuid */
+            policyId: string;
+        };
         EmergencyContactDetailsResponse: {
             providerName: string;
             contactDetail: string;
@@ -4131,6 +4403,44 @@ export interface components {
             email: null | string;
             role: null | string;
         };
+        InvoiceLineResponse: {
+            /** Format: uuid */
+            id: string;
+            /** Format: int32 */
+            ordinal: number | string;
+            kind: string;
+            description: string;
+            /** Format: double */
+            amount: number | string;
+            currency: string;
+        };
+        InvoiceResponse: {
+            /** 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;
+            lines: components["schemas"]["InvoiceLineResponse"][];
+        };
         IssuedCustomerInvitationResponse: {
             /** Format: uuid */
             id: string;
@@ -4199,6 +4509,27 @@ export interface components {
             /** Format: date */
             incidentOn: string;
         };
+        ObligationResponse: {
+            /** Format: uuid */
+            id: string;
+            /** Format: uuid */
+            customerId: string;
+            /** Format: uuid */
+            policyId: string;
+            /** Format: uuid */
+            productId: string;
+            /** Format: double */
+            amount: number | string;
+            currency: string;
+            /** Format: date */
+            dueOn: string;
+            description: string;
+            status: string;
+            /** Format: date-time */
+            raisedAtUtc: string;
+            /** Format: date-time */
+            retentionAnchorAtUtc: null | string;
+        };
         OfferedFormResponse: {
             /** Format: uuid */
             id: string;
@@ -4284,9 +4615,47 @@ export interface components {
             /** Format: date-time */
             acceptedAtUtc: null | string;
         };
-        PlaceLegalHoldRequest: {
-            moduleName: null | string;
-            entityType: null | string;
+        PaymentAttemptResponse: {
+            /** Format: uuid */
+            id: string;
+            /** Format: uuid */
+            obligationId: string;
+            /** Format: double */
+            amount: number | string;
+            currency: string;
+            source: string;
+            externalReference: string;
+            attemptedBySubjectId: string;
+            /** Format: date-time */
+            attemptedAtUtc: string;
+            outcome: null | string;
+            /** Format: date-time */
+            concludedAtUtc: null | string;
+            /** Format: uuid */
+            paymentId: null | string;
+            /** Format: double */
+            existingAmount: null | number | string;
+        };
+        PaymentResponse: {
+            /** Format: uuid */
+            id: string;
+            /** Format: uuid */
+            obligationId: string;
+            /** Format: uuid */
+            customerId: string;
+            /** Format: double */
+            amount: number | string;
+            currency: string;
+            source: string;
+            externalReference: string;
+            status: string;
+            recordedBySubjectId: string;
+            /** Format: date-time */
+            postedAtUtc: string;
+        };
+        PlaceLegalHoldRequest: {
+            moduleName: null | string;
+            entityType: null | string;
             entityId: null | string;
             trigger: null | string;
             reason: null | string;
@@ -4621,6 +4990,15 @@ export interface components {
             awaitedFrom: string;
             description: string;
         };
+        RaiseObligationRequest: {
+            /** Format: uuid */
+            policyId: string;
+            /** Format: double */
+            amount: number | string;
+            /** Format: date */
+            dueOn: string;
+            description: string;
+        };
         RaiseOutstandingItemRequest: {
             awaitedFrom: null | string;
             description: null | string;
@@ -4664,6 +5042,12 @@ export interface components {
             /** Format: date */
             submittedOn: string;
         };
+        RecordPaymentRequest: {
+            /** Format: double */
+            amount: number | string;
+            source: string;
+            externalReference: string;
+        };
         RecordRenewalCustomerInformationRequest: {
             /** Format: uuid */
             formSubmissionId: null | string;
@@ -5031,6 +5415,404 @@ export interface components {
 }
 export type $defs = Record<string, never>;
 export interface operations {
+    RaiseObligation: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["RaiseObligationRequest"];
+            };
+        };
+        responses: {
+            /** @description Created */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ObligationResponse"];
+                };
+            };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
+                };
+            };
+        };
+    };
+    GetObligation: {
+        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"]["ObligationResponse"];
+                };
+            };
+            /** @description Not Found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    CancelObligation: {
+        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"]["ObligationResponse"];
+                };
+            };
+            /** @description Not Found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Conflict */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ProblemDetails"];
+                };
+            };
+        };
+    };
+    DraftInvoice: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["DraftInvoiceRequest"];
+            };
+        };
+        responses: {
+            /** @description Created */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["InvoiceResponse"];
+                };
+            };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
+                };
+            };
+        };
+    };
+    AddInvoiceLine: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["AddInvoiceLineRequest"];
+            };
+        };
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["InvoiceResponse"];
+                };
+            };
+            /** @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 */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ProblemDetails"];
+                };
+            };
+        };
+    };
+    IssueInvoice: {
+        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"]["InvoiceResponse"];
+                };
+            };
+            /** @description Not Found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Conflict */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ProblemDetails"];
+                };
+            };
+        };
+    };
+    DiscardInvoice: {
+        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"]["InvoiceResponse"];
+                };
+            };
+            /** @description Not Found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Conflict */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ProblemDetails"];
+                };
+            };
+        };
+    };
+    GetInvoice: {
+        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"]["InvoiceResponse"];
+                };
+            };
+            /** @description Not Found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    RecordPayment: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["RecordPaymentRequest"];
+            };
+        };
+        responses: {
+            /** @description Created */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["PaymentResponse"];
+                };
+            };
+            /** @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 */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ProblemDetails"];
+                };
+            };
+        };
+    };
+    ReadPaymentAttempts: {
+        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"]["PaymentAttemptResponse"][];
+                };
+            };
+            /** @description Not Found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    GetPayment: {
+        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"]["PaymentResponse"];
+                };
+            };
+            /** @description Not Found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
     ListInsurers: {
         parameters: {
             query?: {

package/package.json

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