@insurance-broker/api-client 4.10.0 → 4.12.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.
- package/dist/schema.d.ts +54 -1
- 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
|
-
|
|
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
|
|
@@ -6650,6 +6662,7 @@ export interface components {
|
|
|
6650
6662
|
CustomerQuoteResponse: {
|
|
6651
6663
|
/** Format: uuid */
|
|
6652
6664
|
id: string;
|
|
6665
|
+
reference: string;
|
|
6653
6666
|
/** Format: uuid */
|
|
6654
6667
|
productId: string;
|
|
6655
6668
|
/** Format: uuid */
|
|
@@ -7855,6 +7868,10 @@ export interface components {
|
|
|
7855
7868
|
PolicyDocumentUpload: {
|
|
7856
7869
|
file: components["schemas"]["IFormFile"];
|
|
7857
7870
|
};
|
|
7871
|
+
PolicyPage: {
|
|
7872
|
+
items: components["schemas"]["PolicyResponse"][];
|
|
7873
|
+
nextCursor: null | string;
|
|
7874
|
+
};
|
|
7858
7875
|
PolicyResponse: {
|
|
7859
7876
|
/** Format: uuid */
|
|
7860
7877
|
id: string;
|
|
@@ -8149,6 +8166,7 @@ export interface components {
|
|
|
8149
8166
|
QuoteRequestResponse: {
|
|
8150
8167
|
/** Format: uuid */
|
|
8151
8168
|
id: string;
|
|
8169
|
+
reference: string;
|
|
8152
8170
|
/** Format: uuid */
|
|
8153
8171
|
customerId: null | string;
|
|
8154
8172
|
/** Format: uuid */
|
|
@@ -18058,6 +18076,41 @@ export interface operations {
|
|
|
18058
18076
|
};
|
|
18059
18077
|
};
|
|
18060
18078
|
};
|
|
18079
|
+
ListPolicies: {
|
|
18080
|
+
parameters: {
|
|
18081
|
+
query?: {
|
|
18082
|
+
status?: string;
|
|
18083
|
+
customerId?: string;
|
|
18084
|
+
productId?: string;
|
|
18085
|
+
cursor?: string;
|
|
18086
|
+
limit?: number | string;
|
|
18087
|
+
};
|
|
18088
|
+
header?: never;
|
|
18089
|
+
path?: never;
|
|
18090
|
+
cookie?: never;
|
|
18091
|
+
};
|
|
18092
|
+
requestBody?: never;
|
|
18093
|
+
responses: {
|
|
18094
|
+
/** @description OK */
|
|
18095
|
+
200: {
|
|
18096
|
+
headers: {
|
|
18097
|
+
[name: string]: unknown;
|
|
18098
|
+
};
|
|
18099
|
+
content: {
|
|
18100
|
+
"application/json": components["schemas"]["PolicyPage"];
|
|
18101
|
+
};
|
|
18102
|
+
};
|
|
18103
|
+
/** @description Bad Request */
|
|
18104
|
+
400: {
|
|
18105
|
+
headers: {
|
|
18106
|
+
[name: string]: unknown;
|
|
18107
|
+
};
|
|
18108
|
+
content: {
|
|
18109
|
+
"application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
|
|
18110
|
+
};
|
|
18111
|
+
};
|
|
18112
|
+
};
|
|
18113
|
+
};
|
|
18061
18114
|
OpenPolicy: {
|
|
18062
18115
|
parameters: {
|
|
18063
18116
|
query?: never;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@insurance-broker/api-client",
|
|
3
|
-
"version": "4.
|
|
3
|
+
"version": "4.12.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,
|