@insurance-broker/api-client 5.46.0 → 5.47.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.
Files changed (2) hide show
  1. package/dist/schema.d.ts +97 -4
  2. 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 */
@@ -22720,6 +22749,35 @@ export interface operations {
22720
22749
  };
22721
22750
  };
22722
22751
  };
22752
+ GetDocumentTemplate: {
22753
+ parameters: {
22754
+ query?: never;
22755
+ header?: never;
22756
+ path: {
22757
+ id: string;
22758
+ };
22759
+ cookie?: never;
22760
+ };
22761
+ requestBody?: never;
22762
+ responses: {
22763
+ /** @description OK */
22764
+ 200: {
22765
+ headers: {
22766
+ [name: string]: unknown;
22767
+ };
22768
+ content: {
22769
+ "application/json": components["schemas"]["DocumentTemplateResponse"];
22770
+ };
22771
+ };
22772
+ /** @description Not Found */
22773
+ 404: {
22774
+ headers: {
22775
+ [name: string]: unknown;
22776
+ };
22777
+ content?: never;
22778
+ };
22779
+ };
22780
+ };
22723
22781
  StartDocumentTemplateVersion: {
22724
22782
  parameters: {
22725
22783
  query?: never;
@@ -22804,7 +22862,9 @@ export interface operations {
22804
22862
  DiscardDocumentTemplateVersion: {
22805
22863
  parameters: {
22806
22864
  query?: never;
22807
- header?: never;
22865
+ header?: {
22866
+ "If-Match"?: string;
22867
+ };
22808
22868
  path: {
22809
22869
  id: string;
22810
22870
  versionId: string;
@@ -22820,6 +22880,15 @@ export interface operations {
22820
22880
  };
22821
22881
  content?: never;
22822
22882
  };
22883
+ /** @description Bad Request */
22884
+ 400: {
22885
+ headers: {
22886
+ [name: string]: unknown;
22887
+ };
22888
+ content: {
22889
+ "application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
22890
+ };
22891
+ };
22823
22892
  /** @description Not Found */
22824
22893
  404: {
22825
22894
  headers: {
@@ -22841,7 +22910,9 @@ export interface operations {
22841
22910
  ReviseDocumentTemplateVersionBody: {
22842
22911
  parameters: {
22843
22912
  query?: never;
22844
- header?: never;
22913
+ header?: {
22914
+ "If-Match"?: string;
22915
+ };
22845
22916
  path: {
22846
22917
  id: string;
22847
22918
  versionId: string;
@@ -22893,7 +22964,9 @@ export interface operations {
22893
22964
  PublishDocumentTemplateVersion: {
22894
22965
  parameters: {
22895
22966
  query?: never;
22896
- header?: never;
22967
+ header?: {
22968
+ "If-Match"?: string;
22969
+ };
22897
22970
  path: {
22898
22971
  id: string;
22899
22972
  versionId: string;
@@ -22911,6 +22984,15 @@ export interface operations {
22911
22984
  "application/json": components["schemas"]["DocumentTemplateVersionBodyResponse"];
22912
22985
  };
22913
22986
  };
22987
+ /** @description Bad Request */
22988
+ 400: {
22989
+ headers: {
22990
+ [name: string]: unknown;
22991
+ };
22992
+ content: {
22993
+ "application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
22994
+ };
22995
+ };
22914
22996
  /** @description Not Found */
22915
22997
  404: {
22916
22998
  headers: {
@@ -22941,7 +23023,9 @@ export interface operations {
22941
23023
  RetireDocumentTemplateVersion: {
22942
23024
  parameters: {
22943
23025
  query?: never;
22944
- header?: never;
23026
+ header?: {
23027
+ "If-Match"?: string;
23028
+ };
22945
23029
  path: {
22946
23030
  id: string;
22947
23031
  versionId: string;
@@ -22959,6 +23043,15 @@ export interface operations {
22959
23043
  "application/json": components["schemas"]["DocumentTemplateVersionBodyResponse"];
22960
23044
  };
22961
23045
  };
23046
+ /** @description Bad Request */
23047
+ 400: {
23048
+ headers: {
23049
+ [name: string]: unknown;
23050
+ };
23051
+ content: {
23052
+ "application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
23053
+ };
23054
+ };
22962
23055
  /** @description Not Found */
22963
23056
  404: {
22964
23057
  headers: {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@insurance-broker/api-client",
3
- "version": "5.46.0",
3
+ "version": "5.47.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,