@insurance-broker/api-client 1.23.0 → 1.25.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 +370 -0
- package/package.json +1 -1
package/dist/schema.d.ts
CHANGED
|
@@ -1049,6 +1049,58 @@ export interface paths {
|
|
|
1049
1049
|
patch?: never;
|
|
1050
1050
|
trace?: never;
|
|
1051
1051
|
};
|
|
1052
|
+
"/api/v1/claims/{id}/evidence": {
|
|
1053
|
+
parameters: {
|
|
1054
|
+
query?: never;
|
|
1055
|
+
header?: never;
|
|
1056
|
+
path?: never;
|
|
1057
|
+
cookie?: never;
|
|
1058
|
+
};
|
|
1059
|
+
get?: never;
|
|
1060
|
+
put?: never;
|
|
1061
|
+
/**
|
|
1062
|
+
* File a file against a claim
|
|
1063
|
+
* @description CLM-004. Stores one file against a claim — a photograph, a police abstract, an assessor's report, an estimate for repairs.
|
|
1064
|
+
*
|
|
1065
|
+
* **The file is quarantined the moment it is stored and only a malware scan moves it**, so a client that has just uploaded should say the file is being checked rather than that it is ready. Nothing but a `Clean` verdict is ever served back.
|
|
1066
|
+
*
|
|
1067
|
+
* **The type is taken from the file's own bytes, never from the part header.** A part declaring one thing and holding another is refused rather than believed.
|
|
1068
|
+
*
|
|
1069
|
+
* **Closing the claim starts this file's retention clock**, along with the claim's own and everything else filed against it (ADR-0041 section 8).
|
|
1070
|
+
*/
|
|
1071
|
+
post: operations["UploadClaimEvidence"];
|
|
1072
|
+
delete?: never;
|
|
1073
|
+
options?: never;
|
|
1074
|
+
head?: never;
|
|
1075
|
+
patch?: never;
|
|
1076
|
+
trace?: never;
|
|
1077
|
+
};
|
|
1078
|
+
"/api/v1/claims/{id}/evidence/{evidenceId}/content": {
|
|
1079
|
+
parameters: {
|
|
1080
|
+
query?: never;
|
|
1081
|
+
header?: never;
|
|
1082
|
+
path?: never;
|
|
1083
|
+
cookie?: never;
|
|
1084
|
+
};
|
|
1085
|
+
/**
|
|
1086
|
+
* Streams a claim's evidence back, if the malware scan cleared it
|
|
1087
|
+
* @description CLM-004. Returns the stored bytes as an attachment.
|
|
1088
|
+
*
|
|
1089
|
+
* **Only a `Clean` verdict is served.** A file still being scanned, one the scanner rejected and one it could form no opinion about are three different 409s with three different problem `type`s, because the next thing to do differs: wait, or file a replacement, or file a replacement and never expect this one.
|
|
1090
|
+
*
|
|
1091
|
+
* **The file's integrity is re-verified as it streams**, so a transfer that does not complete is a file that no longer matches what was uploaded rather than a network fault.
|
|
1092
|
+
*
|
|
1093
|
+
* There is no shareable link. Sending evidence to an insurer is a separate act with its own record (ADR-0041 section 8).
|
|
1094
|
+
*/
|
|
1095
|
+
get: operations["DownloadClaimEvidence"];
|
|
1096
|
+
put?: never;
|
|
1097
|
+
post?: never;
|
|
1098
|
+
delete?: never;
|
|
1099
|
+
options?: never;
|
|
1100
|
+
head?: never;
|
|
1101
|
+
patch?: never;
|
|
1102
|
+
trace?: never;
|
|
1103
|
+
};
|
|
1052
1104
|
"/api/v1/customer/claims": {
|
|
1053
1105
|
parameters: {
|
|
1054
1106
|
query?: never;
|
|
@@ -1123,6 +1175,60 @@ export interface paths {
|
|
|
1123
1175
|
patch?: never;
|
|
1124
1176
|
trace?: never;
|
|
1125
1177
|
};
|
|
1178
|
+
"/api/v1/claims/emergency-contacts": {
|
|
1179
|
+
parameters: {
|
|
1180
|
+
query?: never;
|
|
1181
|
+
header?: never;
|
|
1182
|
+
path?: never;
|
|
1183
|
+
cookie?: never;
|
|
1184
|
+
};
|
|
1185
|
+
/**
|
|
1186
|
+
* The emergency contacts this broker gives its customers
|
|
1187
|
+
* @description CLM-003. Every emergency contact the platform declares for this broker's country, with the platform's own provider, number and instruction, this broker's override where it has one, the resolved answer, and which of the three levels that answer came from.
|
|
1188
|
+
*
|
|
1189
|
+
* Pass productId to see the contacts for one product rather than this broker's default across every product.
|
|
1190
|
+
*
|
|
1191
|
+
* The country is this broker's own and is not a parameter. A broker with no overrides gets the platform's contacts, because an absent row means the platform's default rather than a gap.
|
|
1192
|
+
*/
|
|
1193
|
+
get: operations["ReadEmergencyContacts"];
|
|
1194
|
+
put?: never;
|
|
1195
|
+
post?: never;
|
|
1196
|
+
delete?: never;
|
|
1197
|
+
options?: never;
|
|
1198
|
+
head?: never;
|
|
1199
|
+
patch?: never;
|
|
1200
|
+
trace?: never;
|
|
1201
|
+
};
|
|
1202
|
+
"/api/v1/claims/emergency-contacts/{contact}": {
|
|
1203
|
+
parameters: {
|
|
1204
|
+
query?: never;
|
|
1205
|
+
header?: never;
|
|
1206
|
+
path?: never;
|
|
1207
|
+
cookie?: never;
|
|
1208
|
+
};
|
|
1209
|
+
get?: never;
|
|
1210
|
+
/**
|
|
1211
|
+
* Give this broker's own answer for one emergency contact
|
|
1212
|
+
* @description CLM-003. Records a deliberate departure from the platform's contact, for every product or for one.
|
|
1213
|
+
*
|
|
1214
|
+
* **All three fields together.** An override replaces the whole contact rather than part of one: this broker's provider name beside the platform's number reads as one coherent instruction and is not one (ADR-0041 section 6).
|
|
1215
|
+
*
|
|
1216
|
+
* A contact the platform does not declare for this broker's country is answered 404 — a broker configures the contacts that exist where it operates, and the set for a country is the platform's.
|
|
1217
|
+
*/
|
|
1218
|
+
put: operations["SetEmergencyContact"];
|
|
1219
|
+
post?: never;
|
|
1220
|
+
/**
|
|
1221
|
+
* Go back to the platform's contact
|
|
1222
|
+
* @description CLM-003. Deletes this broker's override. The platform's contact applies again by absence, which is what an empty override table means (ADR-0041 section 6).
|
|
1223
|
+
*
|
|
1224
|
+
* Clearing a product override does not clear this broker's default for every product, and clearing the default does not clear a product override: they are separate rows at separate scopes, and the response says which level answers now.
|
|
1225
|
+
*/
|
|
1226
|
+
delete: operations["ClearEmergencyContact"];
|
|
1227
|
+
options?: never;
|
|
1228
|
+
head?: never;
|
|
1229
|
+
patch?: never;
|
|
1230
|
+
trace?: never;
|
|
1231
|
+
};
|
|
1126
1232
|
"/api/v1/leads": {
|
|
1127
1233
|
parameters: {
|
|
1128
1234
|
query?: never;
|
|
@@ -3091,6 +3197,28 @@ export interface components {
|
|
|
3091
3197
|
items: components["schemas"]["ProductResponse"][];
|
|
3092
3198
|
nextCursor: null | string;
|
|
3093
3199
|
};
|
|
3200
|
+
ClaimEvidenceResponse: {
|
|
3201
|
+
/** Format: uuid */
|
|
3202
|
+
id: string;
|
|
3203
|
+
/** Format: uuid */
|
|
3204
|
+
claimId: string;
|
|
3205
|
+
fileName: string;
|
|
3206
|
+
contentType: string;
|
|
3207
|
+
/** Format: int64 */
|
|
3208
|
+
sizeBytes: number | string;
|
|
3209
|
+
contentSha256: string;
|
|
3210
|
+
/** Format: date-time */
|
|
3211
|
+
uploadedAtUtc: string;
|
|
3212
|
+
uploadedBySubjectId: string;
|
|
3213
|
+
scanVerdict: string;
|
|
3214
|
+
/** Format: date-time */
|
|
3215
|
+
scannedAtUtc: null | string;
|
|
3216
|
+
/** Format: date-time */
|
|
3217
|
+
retentionAnchorAtUtc: null | string;
|
|
3218
|
+
};
|
|
3219
|
+
ClaimEvidenceUpload: {
|
|
3220
|
+
file: components["schemas"]["IFormFile"];
|
|
3221
|
+
};
|
|
3094
3222
|
ClaimNoteResponse: {
|
|
3095
3223
|
/** Format: uuid */
|
|
3096
3224
|
id: string;
|
|
@@ -3363,6 +3491,29 @@ export interface components {
|
|
|
3363
3491
|
retiredAtUtc: null | string;
|
|
3364
3492
|
retiredBySubjectId: null | string;
|
|
3365
3493
|
};
|
|
3494
|
+
EmergencyContactDetailsResponse: {
|
|
3495
|
+
providerName: string;
|
|
3496
|
+
contactDetail: string;
|
|
3497
|
+
instruction: string;
|
|
3498
|
+
};
|
|
3499
|
+
EmergencyContactResponse: {
|
|
3500
|
+
countryCode: string;
|
|
3501
|
+
contact: string;
|
|
3502
|
+
name: string;
|
|
3503
|
+
description: null | string;
|
|
3504
|
+
/** Format: int32 */
|
|
3505
|
+
sortOrder: number | string;
|
|
3506
|
+
/** Format: uuid */
|
|
3507
|
+
productId: null | string;
|
|
3508
|
+
platform: components["schemas"]["EmergencyContactDetailsResponse"];
|
|
3509
|
+
tenantDefault: null | components["schemas"]["EmergencyContactDetailsResponse"];
|
|
3510
|
+
productOverride: null | components["schemas"]["EmergencyContactDetailsResponse"];
|
|
3511
|
+
resolved: components["schemas"]["EmergencyContactDetailsResponse"];
|
|
3512
|
+
source: string;
|
|
3513
|
+
/** Format: date-time */
|
|
3514
|
+
changedAtUtc: null | string;
|
|
3515
|
+
changedBySubjectId: null | string;
|
|
3516
|
+
};
|
|
3366
3517
|
EntitlementResponse: {
|
|
3367
3518
|
featureKey: string;
|
|
3368
3519
|
name: null | string;
|
|
@@ -4343,6 +4494,11 @@ export interface components {
|
|
|
4343
4494
|
email: null | string;
|
|
4344
4495
|
phone: null | string;
|
|
4345
4496
|
};
|
|
4497
|
+
SetEmergencyContactRequest: {
|
|
4498
|
+
providerName: null | string;
|
|
4499
|
+
contactDetail: null | string;
|
|
4500
|
+
instruction: null | string;
|
|
4501
|
+
};
|
|
4346
4502
|
SetRenewalLeadTimeRequest: {
|
|
4347
4503
|
/** Format: int32 */
|
|
4348
4504
|
leadDays: null | number | string;
|
|
@@ -7267,6 +7423,105 @@ export interface operations {
|
|
|
7267
7423
|
};
|
|
7268
7424
|
};
|
|
7269
7425
|
};
|
|
7426
|
+
UploadClaimEvidence: {
|
|
7427
|
+
parameters: {
|
|
7428
|
+
query?: never;
|
|
7429
|
+
header?: {
|
|
7430
|
+
"X-Document-Sha256"?: string;
|
|
7431
|
+
};
|
|
7432
|
+
path: {
|
|
7433
|
+
id: string;
|
|
7434
|
+
};
|
|
7435
|
+
cookie?: never;
|
|
7436
|
+
};
|
|
7437
|
+
requestBody: {
|
|
7438
|
+
content: {
|
|
7439
|
+
"multipart/form-data": components["schemas"]["ClaimEvidenceUpload"];
|
|
7440
|
+
};
|
|
7441
|
+
};
|
|
7442
|
+
responses: {
|
|
7443
|
+
/** @description Created */
|
|
7444
|
+
201: {
|
|
7445
|
+
headers: {
|
|
7446
|
+
[name: string]: unknown;
|
|
7447
|
+
};
|
|
7448
|
+
content: {
|
|
7449
|
+
"application/json": components["schemas"]["ClaimEvidenceResponse"];
|
|
7450
|
+
};
|
|
7451
|
+
};
|
|
7452
|
+
/** @description Bad Request */
|
|
7453
|
+
400: {
|
|
7454
|
+
headers: {
|
|
7455
|
+
[name: string]: unknown;
|
|
7456
|
+
};
|
|
7457
|
+
content: {
|
|
7458
|
+
"application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
|
|
7459
|
+
};
|
|
7460
|
+
};
|
|
7461
|
+
/** @description Not Found */
|
|
7462
|
+
404: {
|
|
7463
|
+
headers: {
|
|
7464
|
+
[name: string]: unknown;
|
|
7465
|
+
};
|
|
7466
|
+
content?: never;
|
|
7467
|
+
};
|
|
7468
|
+
/** @description Conflict */
|
|
7469
|
+
409: {
|
|
7470
|
+
headers: {
|
|
7471
|
+
[name: string]: unknown;
|
|
7472
|
+
};
|
|
7473
|
+
content: {
|
|
7474
|
+
"application/problem+json": components["schemas"]["ProblemDetails"];
|
|
7475
|
+
};
|
|
7476
|
+
};
|
|
7477
|
+
/** @description Payload Too Large */
|
|
7478
|
+
413: {
|
|
7479
|
+
headers: {
|
|
7480
|
+
[name: string]: unknown;
|
|
7481
|
+
};
|
|
7482
|
+
content: {
|
|
7483
|
+
"application/problem+json": components["schemas"]["ProblemDetails"];
|
|
7484
|
+
};
|
|
7485
|
+
};
|
|
7486
|
+
};
|
|
7487
|
+
};
|
|
7488
|
+
DownloadClaimEvidence: {
|
|
7489
|
+
parameters: {
|
|
7490
|
+
query?: never;
|
|
7491
|
+
header?: never;
|
|
7492
|
+
path: {
|
|
7493
|
+
id: string;
|
|
7494
|
+
evidenceId: string;
|
|
7495
|
+
};
|
|
7496
|
+
cookie?: never;
|
|
7497
|
+
};
|
|
7498
|
+
requestBody?: never;
|
|
7499
|
+
responses: {
|
|
7500
|
+
/** @description OK */
|
|
7501
|
+
200: {
|
|
7502
|
+
headers: {
|
|
7503
|
+
[name: string]: unknown;
|
|
7504
|
+
};
|
|
7505
|
+
content?: never;
|
|
7506
|
+
};
|
|
7507
|
+
/** @description Not Found */
|
|
7508
|
+
404: {
|
|
7509
|
+
headers: {
|
|
7510
|
+
[name: string]: unknown;
|
|
7511
|
+
};
|
|
7512
|
+
content?: never;
|
|
7513
|
+
};
|
|
7514
|
+
/** @description Conflict */
|
|
7515
|
+
409: {
|
|
7516
|
+
headers: {
|
|
7517
|
+
[name: string]: unknown;
|
|
7518
|
+
};
|
|
7519
|
+
content: {
|
|
7520
|
+
"application/problem+json": components["schemas"]["ProblemDetails"];
|
|
7521
|
+
};
|
|
7522
|
+
};
|
|
7523
|
+
};
|
|
7524
|
+
};
|
|
7270
7525
|
ReportOwnClaim: {
|
|
7271
7526
|
parameters: {
|
|
7272
7527
|
query?: never;
|
|
@@ -7358,6 +7613,121 @@ export interface operations {
|
|
|
7358
7613
|
};
|
|
7359
7614
|
};
|
|
7360
7615
|
};
|
|
7616
|
+
ReadEmergencyContacts: {
|
|
7617
|
+
parameters: {
|
|
7618
|
+
query?: {
|
|
7619
|
+
productId?: string;
|
|
7620
|
+
};
|
|
7621
|
+
header?: never;
|
|
7622
|
+
path?: never;
|
|
7623
|
+
cookie?: never;
|
|
7624
|
+
};
|
|
7625
|
+
requestBody?: never;
|
|
7626
|
+
responses: {
|
|
7627
|
+
/** @description OK */
|
|
7628
|
+
200: {
|
|
7629
|
+
headers: {
|
|
7630
|
+
[name: string]: unknown;
|
|
7631
|
+
};
|
|
7632
|
+
content: {
|
|
7633
|
+
"application/json": components["schemas"]["EmergencyContactResponse"][];
|
|
7634
|
+
};
|
|
7635
|
+
};
|
|
7636
|
+
};
|
|
7637
|
+
};
|
|
7638
|
+
SetEmergencyContact: {
|
|
7639
|
+
parameters: {
|
|
7640
|
+
query?: {
|
|
7641
|
+
productId?: string;
|
|
7642
|
+
};
|
|
7643
|
+
header?: never;
|
|
7644
|
+
path: {
|
|
7645
|
+
contact: string;
|
|
7646
|
+
};
|
|
7647
|
+
cookie?: never;
|
|
7648
|
+
};
|
|
7649
|
+
requestBody: {
|
|
7650
|
+
content: {
|
|
7651
|
+
"application/json": components["schemas"]["SetEmergencyContactRequest"];
|
|
7652
|
+
};
|
|
7653
|
+
};
|
|
7654
|
+
responses: {
|
|
7655
|
+
/** @description OK */
|
|
7656
|
+
200: {
|
|
7657
|
+
headers: {
|
|
7658
|
+
[name: string]: unknown;
|
|
7659
|
+
};
|
|
7660
|
+
content: {
|
|
7661
|
+
"application/json": components["schemas"]["EmergencyContactResponse"];
|
|
7662
|
+
};
|
|
7663
|
+
};
|
|
7664
|
+
/** @description Bad Request */
|
|
7665
|
+
400: {
|
|
7666
|
+
headers: {
|
|
7667
|
+
[name: string]: unknown;
|
|
7668
|
+
};
|
|
7669
|
+
content: {
|
|
7670
|
+
"application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
|
|
7671
|
+
};
|
|
7672
|
+
};
|
|
7673
|
+
/** @description Not Found */
|
|
7674
|
+
404: {
|
|
7675
|
+
headers: {
|
|
7676
|
+
[name: string]: unknown;
|
|
7677
|
+
};
|
|
7678
|
+
content?: never;
|
|
7679
|
+
};
|
|
7680
|
+
/** @description Conflict */
|
|
7681
|
+
409: {
|
|
7682
|
+
headers: {
|
|
7683
|
+
[name: string]: unknown;
|
|
7684
|
+
};
|
|
7685
|
+
content: {
|
|
7686
|
+
"application/problem+json": components["schemas"]["ProblemDetails"];
|
|
7687
|
+
};
|
|
7688
|
+
};
|
|
7689
|
+
};
|
|
7690
|
+
};
|
|
7691
|
+
ClearEmergencyContact: {
|
|
7692
|
+
parameters: {
|
|
7693
|
+
query?: {
|
|
7694
|
+
productId?: string;
|
|
7695
|
+
};
|
|
7696
|
+
header?: never;
|
|
7697
|
+
path: {
|
|
7698
|
+
contact: string;
|
|
7699
|
+
};
|
|
7700
|
+
cookie?: never;
|
|
7701
|
+
};
|
|
7702
|
+
requestBody?: never;
|
|
7703
|
+
responses: {
|
|
7704
|
+
/** @description OK */
|
|
7705
|
+
200: {
|
|
7706
|
+
headers: {
|
|
7707
|
+
[name: string]: unknown;
|
|
7708
|
+
};
|
|
7709
|
+
content: {
|
|
7710
|
+
"application/json": components["schemas"]["EmergencyContactResponse"];
|
|
7711
|
+
};
|
|
7712
|
+
};
|
|
7713
|
+
/** @description Not Found */
|
|
7714
|
+
404: {
|
|
7715
|
+
headers: {
|
|
7716
|
+
[name: string]: unknown;
|
|
7717
|
+
};
|
|
7718
|
+
content?: never;
|
|
7719
|
+
};
|
|
7720
|
+
/** @description Conflict */
|
|
7721
|
+
409: {
|
|
7722
|
+
headers: {
|
|
7723
|
+
[name: string]: unknown;
|
|
7724
|
+
};
|
|
7725
|
+
content: {
|
|
7726
|
+
"application/problem+json": components["schemas"]["ProblemDetails"];
|
|
7727
|
+
};
|
|
7728
|
+
};
|
|
7729
|
+
};
|
|
7730
|
+
};
|
|
7361
7731
|
ListLeads: {
|
|
7362
7732
|
parameters: {
|
|
7363
7733
|
query?: {
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@insurance-broker/api-client",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.25.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,
|