@insurance-broker/api-client 4.10.0 → 4.11.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/dist/schema.d.ts +52 -1
  2. package/package.json +1 -1
package/dist/schema.d.ts CHANGED
@@ -3856,7 +3856,19 @@ export interface paths {
3856
3856
  path?: never;
3857
3857
  cookie?: never;
3858
3858
  };
3859
- get?: never;
3859
+ /**
3860
+ * This broker's policies, most recently opened first
3861
+ * @description The policy register (POL-002, issue #547). Every policy this broker holds, paged by cursor and ordered newest-opened first.
3862
+ *
3863
+ * **Narrowed by `status`, `customerId` and `productId`**, any combination of them; each is optional and an absent one is no filter. `status` is one of the policy statuses, by name and ignoring case, and an unknown one is a `400` that lists them. `customerId` and `productId` select within this broker's own book: an identifier that names nothing here is an empty page, never another broker's rows.
3864
+ *
3865
+ * **`status` is not the answer to "is this policy covering today".** That is the status and the cover dates together: a policy reading `Active` whose cover has ended is an ordinary row (ADR-0035 section 4). Both dates are on every row.
3866
+ *
3867
+ * **The cursor names a position, not a search.** Send the same filters with it that produced it; a cursor sent with different filters continues the new search from that position. A cursor this route did not issue is a `400`.
3868
+ *
3869
+ * Carries identifiers and no names: a customer's name lives in CRM and a product's and an insurer's in the catalogue, so a client reads them from their own routes.
3870
+ */
3871
+ get: operations["ListPolicies"];
3860
3872
  put?: never;
3861
3873
  /**
3862
3874
  * Open a policy case from an accepted quote
@@ -7855,6 +7867,10 @@ export interface components {
7855
7867
  PolicyDocumentUpload: {
7856
7868
  file: components["schemas"]["IFormFile"];
7857
7869
  };
7870
+ PolicyPage: {
7871
+ items: components["schemas"]["PolicyResponse"][];
7872
+ nextCursor: null | string;
7873
+ };
7858
7874
  PolicyResponse: {
7859
7875
  /** Format: uuid */
7860
7876
  id: string;
@@ -18058,6 +18074,41 @@ export interface operations {
18058
18074
  };
18059
18075
  };
18060
18076
  };
18077
+ ListPolicies: {
18078
+ parameters: {
18079
+ query?: {
18080
+ status?: string;
18081
+ customerId?: string;
18082
+ productId?: string;
18083
+ cursor?: string;
18084
+ limit?: number | string;
18085
+ };
18086
+ header?: never;
18087
+ path?: never;
18088
+ cookie?: never;
18089
+ };
18090
+ requestBody?: never;
18091
+ responses: {
18092
+ /** @description OK */
18093
+ 200: {
18094
+ headers: {
18095
+ [name: string]: unknown;
18096
+ };
18097
+ content: {
18098
+ "application/json": components["schemas"]["PolicyPage"];
18099
+ };
18100
+ };
18101
+ /** @description Bad Request */
18102
+ 400: {
18103
+ headers: {
18104
+ [name: string]: unknown;
18105
+ };
18106
+ content: {
18107
+ "application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
18108
+ };
18109
+ };
18110
+ };
18111
+ };
18061
18112
  OpenPolicy: {
18062
18113
  parameters: {
18063
18114
  query?: never;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@insurance-broker/api-client",
3
- "version": "4.10.0",
3
+ "version": "4.11.0",
4
4
  "description": "Generated TypeScript client for the Insurance Broker Platform API. Do not edit by hand: regenerate with scripts/update-api-contract.",
5
5
  "license": "UNLICENSED",
6
6
  "private": false,