@insurance-broker/api-client 5.42.0 → 5.44.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 +194 -0
- package/package.json +1 -1
package/dist/schema.d.ts
CHANGED
|
@@ -4629,6 +4629,30 @@ export interface paths {
|
|
|
4629
4629
|
patch?: never;
|
|
4630
4630
|
trace?: never;
|
|
4631
4631
|
};
|
|
4632
|
+
"/api/v1/policies/manually-placed": {
|
|
4633
|
+
parameters: {
|
|
4634
|
+
query?: never;
|
|
4635
|
+
header?: never;
|
|
4636
|
+
path?: never;
|
|
4637
|
+
cookie?: never;
|
|
4638
|
+
};
|
|
4639
|
+
get?: never;
|
|
4640
|
+
put?: never;
|
|
4641
|
+
/**
|
|
4642
|
+
* Record cover placed with an insurer outside this platform
|
|
4643
|
+
* @description POL-001's manual placement: cover a member of staff arranged with the insurer by telephone, in person or on the insurer's own system, with no quote on this platform behind it. The policy is created proposed, with source `ManualBackfill`, and reaches active only through the referral and insurer-confirmation routes, which take the insurer's reference and date as evidence - this platform records cover and does not bind it.
|
|
4644
|
+
*
|
|
4645
|
+
* The customer, product and insurer must be this broker's; one message covers "does not exist" and "belongs to another broker". A premium is an amount and a currency or neither, and cover cannot end before it starts. These are the rules the import route applies to the same fields, with the same field names and messages.
|
|
4646
|
+
*
|
|
4647
|
+
* Not idempotent: sending the same placement twice records two policies.
|
|
4648
|
+
*/
|
|
4649
|
+
post: operations["RecordManualPlacement"];
|
|
4650
|
+
delete?: never;
|
|
4651
|
+
options?: never;
|
|
4652
|
+
head?: never;
|
|
4653
|
+
patch?: never;
|
|
4654
|
+
trace?: never;
|
|
4655
|
+
};
|
|
4632
4656
|
"/api/v1/policies/{id}/referral": {
|
|
4633
4657
|
parameters: {
|
|
4634
4658
|
query?: never;
|
|
@@ -5345,6 +5369,36 @@ export interface paths {
|
|
|
5345
5369
|
patch?: never;
|
|
5346
5370
|
trace?: never;
|
|
5347
5371
|
};
|
|
5372
|
+
"/api/v1/renewals/{id}/assignment": {
|
|
5373
|
+
parameters: {
|
|
5374
|
+
query?: never;
|
|
5375
|
+
header?: never;
|
|
5376
|
+
path?: never;
|
|
5377
|
+
cookie?: never;
|
|
5378
|
+
};
|
|
5379
|
+
get?: never;
|
|
5380
|
+
put?: never;
|
|
5381
|
+
/**
|
|
5382
|
+
* Give a renewal to a member of staff, or move it to a different one
|
|
5383
|
+
* @description REN-002 and REN-008. Records who is working a renewal, which is what the list's `assignedToSubjectId` filter groups by. The sweep opens every renewal unassigned (ADR-0040 section 2).
|
|
5384
|
+
*
|
|
5385
|
+
* The assignee must be an active member of this broker who holds `policies.renewals.manage` - somebody who can work the renewal they are given. A subject that is not, or that belongs to another broker, is refused with the same `400`, so the route cannot be used to learn who works where.
|
|
5386
|
+
*
|
|
5387
|
+
* Giving a renewal to the person who already has it changes nothing and answers `200`. A renewal that has concluded is refused with `409` and type `urn:brokerplatform:problem:renewal-concluded`: its assignee is kept as the record of who had it.
|
|
5388
|
+
*
|
|
5389
|
+
* **Never shown to the customer.** The customer's view of their renewal carries no member of staff.
|
|
5390
|
+
*/
|
|
5391
|
+
post: operations["AssignRenewal"];
|
|
5392
|
+
/**
|
|
5393
|
+
* Take a renewal off whoever has it
|
|
5394
|
+
* @description Returns a renewal to unassigned work. A renewal nobody has changes nothing and answers `200`. A renewal that has concluded is refused with `409`, for the reason assigning one is.
|
|
5395
|
+
*/
|
|
5396
|
+
delete: operations["UnassignRenewal"];
|
|
5397
|
+
options?: never;
|
|
5398
|
+
head?: never;
|
|
5399
|
+
patch?: never;
|
|
5400
|
+
trace?: never;
|
|
5401
|
+
};
|
|
5348
5402
|
"/api/v1/customer/policy-documents": {
|
|
5349
5403
|
parameters: {
|
|
5350
5404
|
query?: never;
|
|
@@ -6919,6 +6973,9 @@ export interface components {
|
|
|
6919
6973
|
AssignQuoteRequestRequest: {
|
|
6920
6974
|
advisorSubjectId: null | string;
|
|
6921
6975
|
};
|
|
6976
|
+
AssignRenewalRequest: {
|
|
6977
|
+
assigneeSubjectId: null | string;
|
|
6978
|
+
};
|
|
6922
6979
|
AttachProductInsurerRequest: {
|
|
6923
6980
|
/** Format: uuid */
|
|
6924
6981
|
insurerId: null | string;
|
|
@@ -9795,6 +9852,21 @@ export interface components {
|
|
|
9795
9852
|
/** Format: date */
|
|
9796
9853
|
submittedOn: string;
|
|
9797
9854
|
};
|
|
9855
|
+
RecordManualPlacementRequest: {
|
|
9856
|
+
/** Format: uuid */
|
|
9857
|
+
customerId: string;
|
|
9858
|
+
/** Format: uuid */
|
|
9859
|
+
productId: string;
|
|
9860
|
+
/** Format: uuid */
|
|
9861
|
+
insurerId: string;
|
|
9862
|
+
/** Format: date */
|
|
9863
|
+
coverStart: null | string;
|
|
9864
|
+
/** Format: date */
|
|
9865
|
+
coverEnd: null | string;
|
|
9866
|
+
/** Format: double */
|
|
9867
|
+
premiumAmount: null | number | string;
|
|
9868
|
+
premiumCurrency: null | string;
|
|
9869
|
+
};
|
|
9798
9870
|
RecordPaymentRequest: {
|
|
9799
9871
|
/** Format: double */
|
|
9800
9872
|
amount: number | string;
|
|
@@ -21777,6 +21849,39 @@ export interface operations {
|
|
|
21777
21849
|
};
|
|
21778
21850
|
};
|
|
21779
21851
|
};
|
|
21852
|
+
RecordManualPlacement: {
|
|
21853
|
+
parameters: {
|
|
21854
|
+
query?: never;
|
|
21855
|
+
header?: never;
|
|
21856
|
+
path?: never;
|
|
21857
|
+
cookie?: never;
|
|
21858
|
+
};
|
|
21859
|
+
requestBody: {
|
|
21860
|
+
content: {
|
|
21861
|
+
"application/json": components["schemas"]["RecordManualPlacementRequest"];
|
|
21862
|
+
};
|
|
21863
|
+
};
|
|
21864
|
+
responses: {
|
|
21865
|
+
/** @description Created */
|
|
21866
|
+
201: {
|
|
21867
|
+
headers: {
|
|
21868
|
+
[name: string]: unknown;
|
|
21869
|
+
};
|
|
21870
|
+
content: {
|
|
21871
|
+
"application/json": components["schemas"]["PolicyResponse"];
|
|
21872
|
+
};
|
|
21873
|
+
};
|
|
21874
|
+
/** @description Bad Request */
|
|
21875
|
+
400: {
|
|
21876
|
+
headers: {
|
|
21877
|
+
[name: string]: unknown;
|
|
21878
|
+
};
|
|
21879
|
+
content: {
|
|
21880
|
+
"application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
|
|
21881
|
+
};
|
|
21882
|
+
};
|
|
21883
|
+
};
|
|
21884
|
+
};
|
|
21780
21885
|
ReferPolicyToInsurer: {
|
|
21781
21886
|
parameters: {
|
|
21782
21887
|
query?: never;
|
|
@@ -23422,6 +23527,95 @@ export interface operations {
|
|
|
23422
23527
|
};
|
|
23423
23528
|
};
|
|
23424
23529
|
};
|
|
23530
|
+
AssignRenewal: {
|
|
23531
|
+
parameters: {
|
|
23532
|
+
query?: never;
|
|
23533
|
+
header?: never;
|
|
23534
|
+
path: {
|
|
23535
|
+
id: string;
|
|
23536
|
+
};
|
|
23537
|
+
cookie?: never;
|
|
23538
|
+
};
|
|
23539
|
+
requestBody: {
|
|
23540
|
+
content: {
|
|
23541
|
+
"application/json": components["schemas"]["AssignRenewalRequest"];
|
|
23542
|
+
};
|
|
23543
|
+
};
|
|
23544
|
+
responses: {
|
|
23545
|
+
/** @description OK */
|
|
23546
|
+
200: {
|
|
23547
|
+
headers: {
|
|
23548
|
+
[name: string]: unknown;
|
|
23549
|
+
};
|
|
23550
|
+
content: {
|
|
23551
|
+
"application/json": components["schemas"]["RenewalCaseSummaryResponse"];
|
|
23552
|
+
};
|
|
23553
|
+
};
|
|
23554
|
+
/** @description Bad Request */
|
|
23555
|
+
400: {
|
|
23556
|
+
headers: {
|
|
23557
|
+
[name: string]: unknown;
|
|
23558
|
+
};
|
|
23559
|
+
content: {
|
|
23560
|
+
"application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
|
|
23561
|
+
};
|
|
23562
|
+
};
|
|
23563
|
+
/** @description Not Found */
|
|
23564
|
+
404: {
|
|
23565
|
+
headers: {
|
|
23566
|
+
[name: string]: unknown;
|
|
23567
|
+
};
|
|
23568
|
+
content?: never;
|
|
23569
|
+
};
|
|
23570
|
+
/** @description Conflict. A type of urn:brokerplatform:problem:concurrency-conflict means someone else changed the record first and nothing was written: read it again and decide again. Any other type is a conflict this operation decided itself, and retrying it unchanged will not help. */
|
|
23571
|
+
409: {
|
|
23572
|
+
headers: {
|
|
23573
|
+
[name: string]: unknown;
|
|
23574
|
+
};
|
|
23575
|
+
content: {
|
|
23576
|
+
"application/problem+json": components["schemas"]["ConcurrencyConflictProblem"] | components["schemas"]["ProblemDetails"];
|
|
23577
|
+
};
|
|
23578
|
+
};
|
|
23579
|
+
};
|
|
23580
|
+
};
|
|
23581
|
+
UnassignRenewal: {
|
|
23582
|
+
parameters: {
|
|
23583
|
+
query?: never;
|
|
23584
|
+
header?: never;
|
|
23585
|
+
path: {
|
|
23586
|
+
id: string;
|
|
23587
|
+
};
|
|
23588
|
+
cookie?: never;
|
|
23589
|
+
};
|
|
23590
|
+
requestBody?: never;
|
|
23591
|
+
responses: {
|
|
23592
|
+
/** @description OK */
|
|
23593
|
+
200: {
|
|
23594
|
+
headers: {
|
|
23595
|
+
[name: string]: unknown;
|
|
23596
|
+
};
|
|
23597
|
+
content: {
|
|
23598
|
+
"application/json": components["schemas"]["RenewalCaseSummaryResponse"];
|
|
23599
|
+
};
|
|
23600
|
+
};
|
|
23601
|
+
/** @description Not Found */
|
|
23602
|
+
404: {
|
|
23603
|
+
headers: {
|
|
23604
|
+
[name: string]: unknown;
|
|
23605
|
+
};
|
|
23606
|
+
content?: never;
|
|
23607
|
+
};
|
|
23608
|
+
/** @description Conflict. A type of urn:brokerplatform:problem:concurrency-conflict means someone else changed the record first and nothing was written: read it again and decide again. Any other type is a conflict this operation decided itself, and retrying it unchanged will not help. */
|
|
23609
|
+
409: {
|
|
23610
|
+
headers: {
|
|
23611
|
+
[name: string]: unknown;
|
|
23612
|
+
};
|
|
23613
|
+
content: {
|
|
23614
|
+
"application/problem+json": components["schemas"]["ConcurrencyConflictProblem"] | components["schemas"]["ProblemDetails"];
|
|
23615
|
+
};
|
|
23616
|
+
};
|
|
23617
|
+
};
|
|
23618
|
+
};
|
|
23425
23619
|
ListCustomerPolicyDocuments: {
|
|
23426
23620
|
parameters: {
|
|
23427
23621
|
query?: {
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@insurance-broker/api-client",
|
|
3
|
-
"version": "5.
|
|
3
|
+
"version": "5.44.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,
|