@insurance-broker/api-client 5.25.0 → 5.27.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 +165 -1
- package/package.json +1 -1
package/dist/schema.d.ts
CHANGED
|
@@ -4541,7 +4541,7 @@ export interface paths {
|
|
|
4541
4541
|
put?: never;
|
|
4542
4542
|
/**
|
|
4543
4543
|
* Record a policy carried across from a system the broker used before this one
|
|
4544
|
-
* @description Creates a policy case from a legacy record, with no quote behind it. Unlike every other route here it accepts the policy's status, because an imported policy's state is a fact the old system already recorded rather than something this platform is deciding — but an active one must carry the insurer's own reference and the date the insurer confirmed cover from, because POL-004's evidence requirement does not stop applying to history. Importing the same legacy record twice is refused rather than duplicated.
|
|
4544
|
+
* @description Creates a policy case from a legacy record, with no quote behind it. Unlike every other route here it accepts the policy's status, because an imported policy's state is a fact the old system already recorded rather than something this platform is deciding — but an active one must carry the insurer's own reference and the date the insurer confirmed cover from, because POL-004's evidence requirement does not stop applying to history. Importing the same legacy record twice is refused rather than duplicated. A text field holding a control character, a line or paragraph separator or an invisible formatting character is refused on that field, as the bulk import refuses such a cell; the import notes and validation sentence may hold line breaks and tabs, and legacy metadata values may too.
|
|
4545
4545
|
*/
|
|
4546
4546
|
post: operations["ImportPolicy"];
|
|
4547
4547
|
delete?: never;
|
|
@@ -4700,6 +4700,50 @@ export interface paths {
|
|
|
4700
4700
|
patch?: never;
|
|
4701
4701
|
trace?: never;
|
|
4702
4702
|
};
|
|
4703
|
+
"/api/v1/policies/imports/{id}/commitment": {
|
|
4704
|
+
parameters: {
|
|
4705
|
+
query?: never;
|
|
4706
|
+
header?: never;
|
|
4707
|
+
path?: never;
|
|
4708
|
+
cookie?: never;
|
|
4709
|
+
};
|
|
4710
|
+
get?: never;
|
|
4711
|
+
put?: never;
|
|
4712
|
+
/**
|
|
4713
|
+
* Asks for a validated policy import to be committed, every row or none
|
|
4714
|
+
* @description Accepted only from `Validated`. Moves the run to `Committing` and answers `202` with it; the commit then runs in the background and ends `Committed` (one policy per row, each exactly as `POST /policies/imported` would record it, with the run as its import batch), `CommitRefused` (nothing written; `commitRefusalReason` says why, and a row that failed the commit's re-check is `Refused` with its reasons), or `CommitFailed` (nothing written, after the commit stalled). Read the run to follow it.
|
|
4715
|
+
*
|
|
4716
|
+
* **Requires `If-Match`** with the run's `concurrencyToken`. Without it, or with `*`, `428`; a token that is no longer current is `409` with problem type `urn:brokerplatform:problem:concurrency-conflict` — read the run again. `409` with problem type `urn:brokerplatform:problem:import-run-state-conflict` when the run is not `Validated`; its `runStatus` says what it is. `404` when the run is not this broker's.
|
|
4717
|
+
*/
|
|
4718
|
+
post: operations["CommitPolicyImport"];
|
|
4719
|
+
delete?: never;
|
|
4720
|
+
options?: never;
|
|
4721
|
+
head?: never;
|
|
4722
|
+
patch?: never;
|
|
4723
|
+
trace?: never;
|
|
4724
|
+
};
|
|
4725
|
+
"/api/v1/policies/imports/{id}/abandonment": {
|
|
4726
|
+
parameters: {
|
|
4727
|
+
query?: never;
|
|
4728
|
+
header?: never;
|
|
4729
|
+
path?: never;
|
|
4730
|
+
cookie?: never;
|
|
4731
|
+
};
|
|
4732
|
+
get?: never;
|
|
4733
|
+
put?: never;
|
|
4734
|
+
/**
|
|
4735
|
+
* Abandons a policy import that has not been committed
|
|
4736
|
+
* @description Accepted only from `Staged` or `Validated`. Ends the run `Abandoned`, removes every value the file held, and frees this broker's policy import slot; the report (line numbers, outcomes and reasons) stays readable. Answers `200` with the run.
|
|
4737
|
+
*
|
|
4738
|
+
* **Requires `If-Match`** with the run's `concurrencyToken`. Without it, or with `*`, `428`; a token that is no longer current is `409` with problem type `urn:brokerplatform:problem:concurrency-conflict`. `409` with problem type `urn:brokerplatform:problem:import-run-state-conflict` when the run has already ended — including `Refused`, which is already ended and purged — or is committing; its `runStatus` says what it is. `404` when the run is not this broker's.
|
|
4739
|
+
*/
|
|
4740
|
+
post: operations["AbandonPolicyImport"];
|
|
4741
|
+
delete?: never;
|
|
4742
|
+
options?: never;
|
|
4743
|
+
head?: never;
|
|
4744
|
+
patch?: never;
|
|
4745
|
+
trace?: never;
|
|
4746
|
+
};
|
|
4703
4747
|
"/api/v1/policies/payment-gates": {
|
|
4704
4748
|
parameters: {
|
|
4705
4749
|
query?: never;
|
|
@@ -9109,6 +9153,8 @@ export interface components {
|
|
|
9109
9153
|
commitRequestedAtUtc: null | string;
|
|
9110
9154
|
/** Format: date-time */
|
|
9111
9155
|
concludedAtUtc: null | string;
|
|
9156
|
+
commitRefusalReason: null | string;
|
|
9157
|
+
concurrencyToken: string;
|
|
9112
9158
|
};
|
|
9113
9159
|
PolicyImportUpload: {
|
|
9114
9160
|
file: components["schemas"]["IFormFile"];
|
|
@@ -21528,6 +21574,124 @@ export interface operations {
|
|
|
21528
21574
|
};
|
|
21529
21575
|
};
|
|
21530
21576
|
};
|
|
21577
|
+
CommitPolicyImport: {
|
|
21578
|
+
parameters: {
|
|
21579
|
+
query?: never;
|
|
21580
|
+
header: {
|
|
21581
|
+
/** @description Required. The concurrencyToken of the record as it was read, sent back unchanged. A write without it, or with *, is refused with 428; a token that is no longer current is refused with 409 (issue #517, client 5.0.0). */
|
|
21582
|
+
"If-Match": string;
|
|
21583
|
+
};
|
|
21584
|
+
path: {
|
|
21585
|
+
id: string;
|
|
21586
|
+
};
|
|
21587
|
+
cookie?: never;
|
|
21588
|
+
};
|
|
21589
|
+
requestBody?: never;
|
|
21590
|
+
responses: {
|
|
21591
|
+
/** @description Accepted */
|
|
21592
|
+
202: {
|
|
21593
|
+
headers: {
|
|
21594
|
+
[name: string]: unknown;
|
|
21595
|
+
};
|
|
21596
|
+
content: {
|
|
21597
|
+
"application/json": components["schemas"]["PolicyImportRunResponse"];
|
|
21598
|
+
};
|
|
21599
|
+
};
|
|
21600
|
+
/** @description Bad Request */
|
|
21601
|
+
400: {
|
|
21602
|
+
headers: {
|
|
21603
|
+
[name: string]: unknown;
|
|
21604
|
+
};
|
|
21605
|
+
content: {
|
|
21606
|
+
"application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
|
|
21607
|
+
};
|
|
21608
|
+
};
|
|
21609
|
+
/** @description Not Found */
|
|
21610
|
+
404: {
|
|
21611
|
+
headers: {
|
|
21612
|
+
[name: string]: unknown;
|
|
21613
|
+
};
|
|
21614
|
+
content?: never;
|
|
21615
|
+
};
|
|
21616
|
+
/** @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. */
|
|
21617
|
+
409: {
|
|
21618
|
+
headers: {
|
|
21619
|
+
[name: string]: unknown;
|
|
21620
|
+
};
|
|
21621
|
+
content: {
|
|
21622
|
+
"application/problem+json": components["schemas"]["ConcurrencyConflictProblem"] | components["schemas"]["ProblemDetails"];
|
|
21623
|
+
};
|
|
21624
|
+
};
|
|
21625
|
+
/** @description Precondition Required (RFC 6585). The request carried no If-Match, or carried If-Match: *, which protects nothing. Nothing was read or written. Read the record, then send its concurrencyToken as If-Match. */
|
|
21626
|
+
428: {
|
|
21627
|
+
headers: {
|
|
21628
|
+
[name: string]: unknown;
|
|
21629
|
+
};
|
|
21630
|
+
content: {
|
|
21631
|
+
"application/problem+json": components["schemas"]["PreconditionRequiredProblem"];
|
|
21632
|
+
};
|
|
21633
|
+
};
|
|
21634
|
+
};
|
|
21635
|
+
};
|
|
21636
|
+
AbandonPolicyImport: {
|
|
21637
|
+
parameters: {
|
|
21638
|
+
query?: never;
|
|
21639
|
+
header: {
|
|
21640
|
+
/** @description Required. The concurrencyToken of the record as it was read, sent back unchanged. A write without it, or with *, is refused with 428; a token that is no longer current is refused with 409 (issue #517, client 5.0.0). */
|
|
21641
|
+
"If-Match": string;
|
|
21642
|
+
};
|
|
21643
|
+
path: {
|
|
21644
|
+
id: string;
|
|
21645
|
+
};
|
|
21646
|
+
cookie?: never;
|
|
21647
|
+
};
|
|
21648
|
+
requestBody?: never;
|
|
21649
|
+
responses: {
|
|
21650
|
+
/** @description OK */
|
|
21651
|
+
200: {
|
|
21652
|
+
headers: {
|
|
21653
|
+
[name: string]: unknown;
|
|
21654
|
+
};
|
|
21655
|
+
content: {
|
|
21656
|
+
"application/json": components["schemas"]["PolicyImportRunResponse"];
|
|
21657
|
+
};
|
|
21658
|
+
};
|
|
21659
|
+
/** @description Bad Request */
|
|
21660
|
+
400: {
|
|
21661
|
+
headers: {
|
|
21662
|
+
[name: string]: unknown;
|
|
21663
|
+
};
|
|
21664
|
+
content: {
|
|
21665
|
+
"application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
|
|
21666
|
+
};
|
|
21667
|
+
};
|
|
21668
|
+
/** @description Not Found */
|
|
21669
|
+
404: {
|
|
21670
|
+
headers: {
|
|
21671
|
+
[name: string]: unknown;
|
|
21672
|
+
};
|
|
21673
|
+
content?: never;
|
|
21674
|
+
};
|
|
21675
|
+
/** @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. */
|
|
21676
|
+
409: {
|
|
21677
|
+
headers: {
|
|
21678
|
+
[name: string]: unknown;
|
|
21679
|
+
};
|
|
21680
|
+
content: {
|
|
21681
|
+
"application/problem+json": components["schemas"]["ConcurrencyConflictProblem"] | components["schemas"]["ProblemDetails"];
|
|
21682
|
+
};
|
|
21683
|
+
};
|
|
21684
|
+
/** @description Precondition Required (RFC 6585). The request carried no If-Match, or carried If-Match: *, which protects nothing. Nothing was read or written. Read the record, then send its concurrencyToken as If-Match. */
|
|
21685
|
+
428: {
|
|
21686
|
+
headers: {
|
|
21687
|
+
[name: string]: unknown;
|
|
21688
|
+
};
|
|
21689
|
+
content: {
|
|
21690
|
+
"application/problem+json": components["schemas"]["PreconditionRequiredProblem"];
|
|
21691
|
+
};
|
|
21692
|
+
};
|
|
21693
|
+
};
|
|
21694
|
+
};
|
|
21531
21695
|
ReadPaymentGates: {
|
|
21532
21696
|
parameters: {
|
|
21533
21697
|
query?: never;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@insurance-broker/api-client",
|
|
3
|
-
"version": "5.
|
|
3
|
+
"version": "5.27.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,
|