@insurance-broker/api-client 5.46.0 → 5.48.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 +99 -4
- package/package.json +1 -1
package/dist/schema.d.ts
CHANGED
|
@@ -5012,6 +5012,26 @@ export interface paths {
|
|
|
5012
5012
|
patch?: never;
|
|
5013
5013
|
trace?: never;
|
|
5014
5014
|
};
|
|
5015
|
+
"/api/v1/document-templates/{id}": {
|
|
5016
|
+
parameters: {
|
|
5017
|
+
query?: never;
|
|
5018
|
+
header?: never;
|
|
5019
|
+
path?: never;
|
|
5020
|
+
cookie?: never;
|
|
5021
|
+
};
|
|
5022
|
+
/**
|
|
5023
|
+
* One of the broker's document templates, with its live version and its draft
|
|
5024
|
+
* @description The same shape as an item of the list, read by identifier, so a template stays reachable when the broker has more templates than one list request returns (#799).
|
|
5025
|
+
*/
|
|
5026
|
+
get: operations["GetDocumentTemplate"];
|
|
5027
|
+
put?: never;
|
|
5028
|
+
post?: never;
|
|
5029
|
+
delete?: never;
|
|
5030
|
+
options?: never;
|
|
5031
|
+
head?: never;
|
|
5032
|
+
patch?: never;
|
|
5033
|
+
trace?: never;
|
|
5034
|
+
};
|
|
5015
5035
|
"/api/v1/document-templates/{id}/versions": {
|
|
5016
5036
|
parameters: {
|
|
5017
5037
|
query?: never;
|
|
@@ -5046,6 +5066,8 @@ export interface paths {
|
|
|
5046
5066
|
/**
|
|
5047
5067
|
* Discard a draft that is not going to be published
|
|
5048
5068
|
* @description The way out of an abandoned draft. At most one draft of a template exists at a time, so a draft nobody finishes would otherwise block every future version of that template for good. Only a draft can be discarded: a published or retired version is what generated documents say and is kept (BR-002, DOC-008).
|
|
5069
|
+
*
|
|
5070
|
+
* **`If-Match` is optional and honoured** (ADR-0023's 2026-10-26 amendment, #799). Send the version's `concurrencyToken` to be refused with `409` `urn:brokerplatform:problem:concurrency-conflict` if the version changed since it was read; leave it out and the write behaves as it did before the token was published. A token this API could not have issued is a `400` keyed `If-Match`.
|
|
5049
5071
|
*/
|
|
5050
5072
|
delete: operations["DiscardDocumentTemplateVersion"];
|
|
5051
5073
|
options?: never;
|
|
@@ -5064,6 +5086,8 @@ export interface paths {
|
|
|
5064
5086
|
/**
|
|
5065
5087
|
* Replace a draft's body
|
|
5066
5088
|
* @description Only a draft's body can be replaced, and the body is not validated here beyond being a JSON object within the size cap: an author needs more than one sitting to write a template. Everything else is checked when the version is published.
|
|
5089
|
+
*
|
|
5090
|
+
* **`If-Match` is optional and honoured** (ADR-0023's 2026-10-26 amendment, #799). Send the version's `concurrencyToken` to be refused with `409` `urn:brokerplatform:problem:concurrency-conflict` if the version changed since it was read; leave it out and the write behaves as it did before the token was published. A token this API could not have issued is a `400` keyed `If-Match`.
|
|
5067
5091
|
*/
|
|
5068
5092
|
put: operations["ReviseDocumentTemplateVersionBody"];
|
|
5069
5093
|
post?: never;
|
|
@@ -5085,6 +5109,8 @@ export interface paths {
|
|
|
5085
5109
|
/**
|
|
5086
5110
|
* Make a draft live, retiring whatever version it supersedes
|
|
5087
5111
|
* @description The one place the body language runs as a gate. The canonical serialisation is what gets stored and the hash over it is what a generated document is later proved against (BR-002, DOC-005).
|
|
5112
|
+
*
|
|
5113
|
+
* **`If-Match` is optional and honoured** (ADR-0023's 2026-10-26 amendment, #799). Send the version's `concurrencyToken` to be refused with `409` `urn:brokerplatform:problem:concurrency-conflict` if the version changed since it was read; leave it out and the write behaves as it did before the token was published. A token this API could not have issued is a `400` keyed `If-Match`.
|
|
5088
5114
|
*/
|
|
5089
5115
|
post: operations["PublishDocumentTemplateVersion"];
|
|
5090
5116
|
delete?: never;
|
|
@@ -5105,6 +5131,8 @@ export interface paths {
|
|
|
5105
5131
|
/**
|
|
5106
5132
|
* Take the live version down, leaving the template generating nothing
|
|
5107
5133
|
* @description Publishing the next version is the usual way a version retires; this is the deliberate one, for a broker that has found a mistake in live wording and has nothing ready to replace it. The template then has no live version, so generating from it is refused until one is published. The retired version stays readable: documents generated from it name it (DOC-005, DOC-008).
|
|
5134
|
+
*
|
|
5135
|
+
* **`If-Match` is optional and honoured** (ADR-0023's 2026-10-26 amendment, #799). Send the version's `concurrencyToken` to be refused with `409` `urn:brokerplatform:problem:concurrency-conflict` if the version changed since it was read; leave it out and the write behaves as it did before the token was published. A token this API could not have issued is a `400` keyed `If-Match`.
|
|
5108
5136
|
*/
|
|
5109
5137
|
post: operations["RetireDocumentTemplateVersion"];
|
|
5110
5138
|
delete?: never;
|
|
@@ -8020,6 +8048,7 @@ export interface components {
|
|
|
8020
8048
|
/** Format: date-time */
|
|
8021
8049
|
retiredAtUtc: null | string;
|
|
8022
8050
|
retiredBySubjectId: null | string;
|
|
8051
|
+
concurrencyToken: string;
|
|
8023
8052
|
};
|
|
8024
8053
|
DraftInvoiceRequest: {
|
|
8025
8054
|
/** Format: uuid */
|
|
@@ -8731,6 +8760,8 @@ export interface components {
|
|
|
8731
8760
|
assignedToSubjectId: null | string;
|
|
8732
8761
|
/** Format: date-time */
|
|
8733
8762
|
createdAtUtc: string;
|
|
8763
|
+
/** Format: date-time */
|
|
8764
|
+
convertedAtUtc: null | string;
|
|
8734
8765
|
};
|
|
8735
8766
|
LegalHoldPage: {
|
|
8736
8767
|
items: components["schemas"]["LegalHoldResponse"][];
|
|
@@ -22720,6 +22751,35 @@ export interface operations {
|
|
|
22720
22751
|
};
|
|
22721
22752
|
};
|
|
22722
22753
|
};
|
|
22754
|
+
GetDocumentTemplate: {
|
|
22755
|
+
parameters: {
|
|
22756
|
+
query?: never;
|
|
22757
|
+
header?: never;
|
|
22758
|
+
path: {
|
|
22759
|
+
id: string;
|
|
22760
|
+
};
|
|
22761
|
+
cookie?: never;
|
|
22762
|
+
};
|
|
22763
|
+
requestBody?: never;
|
|
22764
|
+
responses: {
|
|
22765
|
+
/** @description OK */
|
|
22766
|
+
200: {
|
|
22767
|
+
headers: {
|
|
22768
|
+
[name: string]: unknown;
|
|
22769
|
+
};
|
|
22770
|
+
content: {
|
|
22771
|
+
"application/json": components["schemas"]["DocumentTemplateResponse"];
|
|
22772
|
+
};
|
|
22773
|
+
};
|
|
22774
|
+
/** @description Not Found */
|
|
22775
|
+
404: {
|
|
22776
|
+
headers: {
|
|
22777
|
+
[name: string]: unknown;
|
|
22778
|
+
};
|
|
22779
|
+
content?: never;
|
|
22780
|
+
};
|
|
22781
|
+
};
|
|
22782
|
+
};
|
|
22723
22783
|
StartDocumentTemplateVersion: {
|
|
22724
22784
|
parameters: {
|
|
22725
22785
|
query?: never;
|
|
@@ -22804,7 +22864,9 @@ export interface operations {
|
|
|
22804
22864
|
DiscardDocumentTemplateVersion: {
|
|
22805
22865
|
parameters: {
|
|
22806
22866
|
query?: never;
|
|
22807
|
-
header?:
|
|
22867
|
+
header?: {
|
|
22868
|
+
"If-Match"?: string;
|
|
22869
|
+
};
|
|
22808
22870
|
path: {
|
|
22809
22871
|
id: string;
|
|
22810
22872
|
versionId: string;
|
|
@@ -22820,6 +22882,15 @@ export interface operations {
|
|
|
22820
22882
|
};
|
|
22821
22883
|
content?: never;
|
|
22822
22884
|
};
|
|
22885
|
+
/** @description Bad Request */
|
|
22886
|
+
400: {
|
|
22887
|
+
headers: {
|
|
22888
|
+
[name: string]: unknown;
|
|
22889
|
+
};
|
|
22890
|
+
content: {
|
|
22891
|
+
"application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
|
|
22892
|
+
};
|
|
22893
|
+
};
|
|
22823
22894
|
/** @description Not Found */
|
|
22824
22895
|
404: {
|
|
22825
22896
|
headers: {
|
|
@@ -22841,7 +22912,9 @@ export interface operations {
|
|
|
22841
22912
|
ReviseDocumentTemplateVersionBody: {
|
|
22842
22913
|
parameters: {
|
|
22843
22914
|
query?: never;
|
|
22844
|
-
header?:
|
|
22915
|
+
header?: {
|
|
22916
|
+
"If-Match"?: string;
|
|
22917
|
+
};
|
|
22845
22918
|
path: {
|
|
22846
22919
|
id: string;
|
|
22847
22920
|
versionId: string;
|
|
@@ -22893,7 +22966,9 @@ export interface operations {
|
|
|
22893
22966
|
PublishDocumentTemplateVersion: {
|
|
22894
22967
|
parameters: {
|
|
22895
22968
|
query?: never;
|
|
22896
|
-
header?:
|
|
22969
|
+
header?: {
|
|
22970
|
+
"If-Match"?: string;
|
|
22971
|
+
};
|
|
22897
22972
|
path: {
|
|
22898
22973
|
id: string;
|
|
22899
22974
|
versionId: string;
|
|
@@ -22911,6 +22986,15 @@ export interface operations {
|
|
|
22911
22986
|
"application/json": components["schemas"]["DocumentTemplateVersionBodyResponse"];
|
|
22912
22987
|
};
|
|
22913
22988
|
};
|
|
22989
|
+
/** @description Bad Request */
|
|
22990
|
+
400: {
|
|
22991
|
+
headers: {
|
|
22992
|
+
[name: string]: unknown;
|
|
22993
|
+
};
|
|
22994
|
+
content: {
|
|
22995
|
+
"application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
|
|
22996
|
+
};
|
|
22997
|
+
};
|
|
22914
22998
|
/** @description Not Found */
|
|
22915
22999
|
404: {
|
|
22916
23000
|
headers: {
|
|
@@ -22941,7 +23025,9 @@ export interface operations {
|
|
|
22941
23025
|
RetireDocumentTemplateVersion: {
|
|
22942
23026
|
parameters: {
|
|
22943
23027
|
query?: never;
|
|
22944
|
-
header?:
|
|
23028
|
+
header?: {
|
|
23029
|
+
"If-Match"?: string;
|
|
23030
|
+
};
|
|
22945
23031
|
path: {
|
|
22946
23032
|
id: string;
|
|
22947
23033
|
versionId: string;
|
|
@@ -22959,6 +23045,15 @@ export interface operations {
|
|
|
22959
23045
|
"application/json": components["schemas"]["DocumentTemplateVersionBodyResponse"];
|
|
22960
23046
|
};
|
|
22961
23047
|
};
|
|
23048
|
+
/** @description Bad Request */
|
|
23049
|
+
400: {
|
|
23050
|
+
headers: {
|
|
23051
|
+
[name: string]: unknown;
|
|
23052
|
+
};
|
|
23053
|
+
content: {
|
|
23054
|
+
"application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
|
|
23055
|
+
};
|
|
23056
|
+
};
|
|
22962
23057
|
/** @description Not Found */
|
|
22963
23058
|
404: {
|
|
22964
23059
|
headers: {
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@insurance-broker/api-client",
|
|
3
|
-
"version": "5.
|
|
3
|
+
"version": "5.48.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,
|