@insurance-broker/api-client 5.27.0 → 5.29.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 +122 -9
  2. 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. 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.
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, an invisible formatting character, a noncharacter, a blank filler, or a run of more than four combining marks (ADR-0051) 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;
@@ -6764,6 +6764,19 @@ export interface components {
6764
6764
  name: null | string;
6765
6765
  description: null | string;
6766
6766
  };
6767
+ /** @description The members of errors that defining a product can answer 400 with, each keyed by the request member's own name. Any member may be absent; each present one is a list of sentences for a person. */
6768
+ AddProductValidationErrors: {
6769
+ /** @description The key is missing, or is not lower-case letters, digits and hyphens within the length limit. */
6770
+ Key?: string[];
6771
+ /** @description The name is missing or too long. */
6772
+ Name?: string[];
6773
+ /** @description The description is too long. */
6774
+ Description?: string[];
6775
+ /** @description The line of business is missing, or this broker has no line of business with that identifier. */
6776
+ CategoryId?: string[];
6777
+ } & {
6778
+ [key: string]: string[];
6779
+ };
6767
6780
  ApproachInsurerRequest: {
6768
6781
  /** Format: uuid */
6769
6782
  insurerId: null | string;
@@ -6801,6 +6814,13 @@ export interface components {
6801
6814
  /** Format: uuid */
6802
6815
  insurerId: null | string;
6803
6816
  };
6817
+ /** @description The members of errors that naming an insurer on a product's panel can answer 400 with, each keyed by the request member's own name. Any member may be absent; each present one is a list of sentences for a person. */
6818
+ AttachProductInsurerValidationErrors: {
6819
+ /** @description The insurer is missing, or this broker has no insurer with that identifier. */
6820
+ InsurerId?: string[];
6821
+ } & {
6822
+ [key: string]: string[];
6823
+ };
6804
6824
  AuditActionsResponse: {
6805
6825
  actions: string[];
6806
6826
  incomplete: boolean;
@@ -9331,6 +9351,13 @@ export interface components {
9331
9351
  /** Format: date-time */
9332
9352
  attachedAtUtc: string;
9333
9353
  };
9354
+ /** @description The members of errors that activating or withdrawing a product can answer 400 with. The routes take no body, so the If-Match header is the only key. */
9355
+ ProductLifecycleValidationErrors: {
9356
+ /** @description The If-Match header is not a concurrencyToken this API issued: send it exactly as it was read. */
9357
+ "If-Match"?: string[];
9358
+ } & {
9359
+ [key: string]: string[];
9360
+ };
9334
9361
  ProductResponse: {
9335
9362
  /** Format: uuid */
9336
9363
  id: string;
@@ -9585,6 +9612,15 @@ export interface components {
9585
9612
  /** Format: uuid */
9586
9613
  categoryId: null | string;
9587
9614
  };
9615
+ /** @description The members of errors that reclassifying a product can answer 400 with, each keyed by the request member's own name, or If-Match for the header. Any member may be absent; each present one is a list of sentences for a person. */
9616
+ ReclassifyProductValidationErrors: {
9617
+ /** @description The line of business is missing, or this broker has no line of business with that identifier. */
9618
+ CategoryId?: string[];
9619
+ /** @description The If-Match header is not a concurrencyToken this API issued: send it exactly as it was read. */
9620
+ "If-Match"?: string[];
9621
+ } & {
9622
+ [key: string]: string[];
9623
+ };
9588
9624
  RecordAnswersRequest: {
9589
9625
  answers: null | components["schemas"]["JsonElement"];
9590
9626
  source: null | string;
@@ -10583,6 +10619,17 @@ export interface components {
10583
10619
  name: null | string;
10584
10620
  description: null | string;
10585
10621
  };
10622
+ /** @description The members of errors that correcting a product can answer 400 with, each keyed by the request member's own name, or If-Match for the header. Any member may be absent; each present one is a list of sentences for a person. */
10623
+ UpdateProductValidationErrors: {
10624
+ /** @description The name is missing or too long. */
10625
+ Name?: string[];
10626
+ /** @description The description is too long. */
10627
+ Description?: string[];
10628
+ /** @description The If-Match header is not a concurrencyToken this API issued: send it exactly as it was read. */
10629
+ "If-Match"?: string[];
10630
+ } & {
10631
+ [key: string]: string[];
10632
+ };
10586
10633
  VerifyServiceLocationRequest: {
10587
10634
  assurance: null | string;
10588
10635
  };
@@ -12829,13 +12876,21 @@ export interface operations {
12829
12876
  "application/json": components["schemas"]["ProductResponse"];
12830
12877
  };
12831
12878
  };
12832
- /** @description Bad Request */
12879
+ /** @description Bad Request. errors is keyed by the request member's own name, or by a header's name, and the keys this operation can send are the members of errors in this schema: Key, Name, Description, CategoryId. Each holds sentences for a person. A body the server could not read is answered 400 with no errors at all. */
12833
12880
  400: {
12834
12881
  headers: {
12835
12882
  [name: string]: unknown;
12836
12883
  };
12837
12884
  content: {
12838
- "application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
12885
+ "application/problem+json": {
12886
+ type?: null | string;
12887
+ title?: null | string;
12888
+ /** Format: int32 */
12889
+ status?: null | number;
12890
+ detail?: null | string;
12891
+ instance?: null | string;
12892
+ errors?: components["schemas"]["AddProductValidationErrors"];
12893
+ };
12839
12894
  };
12840
12895
  };
12841
12896
  /** @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. */
@@ -12941,13 +12996,21 @@ export interface operations {
12941
12996
  "application/json": components["schemas"]["ProductResponse"];
12942
12997
  };
12943
12998
  };
12944
- /** @description Bad Request */
12999
+ /** @description Bad Request. errors is keyed by the request member's own name, or by a header's name, and the keys this operation can send are the members of errors in this schema: Name, Description, If-Match. Each holds sentences for a person. A body the server could not read is answered 400 with no errors at all. */
12945
13000
  400: {
12946
13001
  headers: {
12947
13002
  [name: string]: unknown;
12948
13003
  };
12949
13004
  content: {
12950
- "application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
13005
+ "application/problem+json": {
13006
+ type?: null | string;
13007
+ title?: null | string;
13008
+ /** Format: int32 */
13009
+ status?: null | number;
13010
+ detail?: null | string;
13011
+ instance?: null | string;
13012
+ errors?: components["schemas"]["UpdateProductValidationErrors"];
13013
+ };
12951
13014
  };
12952
13015
  };
12953
13016
  /** @description Not Found */
@@ -13004,13 +13067,21 @@ export interface operations {
13004
13067
  "application/json": components["schemas"]["ProductResponse"];
13005
13068
  };
13006
13069
  };
13007
- /** @description Bad Request */
13070
+ /** @description Bad Request. errors is keyed by the request member's own name, or by a header's name, and the keys this operation can send are the members of errors in this schema: CategoryId, If-Match. Each holds sentences for a person. A body the server could not read is answered 400 with no errors at all. */
13008
13071
  400: {
13009
13072
  headers: {
13010
13073
  [name: string]: unknown;
13011
13074
  };
13012
13075
  content: {
13013
- "application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
13076
+ "application/problem+json": {
13077
+ type?: null | string;
13078
+ title?: null | string;
13079
+ /** Format: int32 */
13080
+ status?: null | number;
13081
+ detail?: null | string;
13082
+ instance?: null | string;
13083
+ errors?: components["schemas"]["ReclassifyProductValidationErrors"];
13084
+ };
13014
13085
  };
13015
13086
  };
13016
13087
  /** @description Not Found */
@@ -13063,6 +13134,23 @@ export interface operations {
13063
13134
  "application/json": components["schemas"]["ProductResponse"];
13064
13135
  };
13065
13136
  };
13137
+ /** @description Bad Request. errors is keyed by the request member's own name, or by a header's name, and the keys this operation can send are the members of errors in this schema: If-Match. Each holds sentences for a person. A body the server could not read is answered 400 with no errors at all. */
13138
+ 400: {
13139
+ headers: {
13140
+ [name: string]: unknown;
13141
+ };
13142
+ content: {
13143
+ "application/problem+json": {
13144
+ type?: null | string;
13145
+ title?: null | string;
13146
+ /** Format: int32 */
13147
+ status?: null | number;
13148
+ detail?: null | string;
13149
+ instance?: null | string;
13150
+ errors?: components["schemas"]["ProductLifecycleValidationErrors"];
13151
+ };
13152
+ };
13153
+ };
13066
13154
  /** @description Not Found */
13067
13155
  404: {
13068
13156
  headers: {
@@ -13113,6 +13201,23 @@ export interface operations {
13113
13201
  "application/json": components["schemas"]["ProductResponse"];
13114
13202
  };
13115
13203
  };
13204
+ /** @description Bad Request. errors is keyed by the request member's own name, or by a header's name, and the keys this operation can send are the members of errors in this schema: If-Match. Each holds sentences for a person. A body the server could not read is answered 400 with no errors at all. */
13205
+ 400: {
13206
+ headers: {
13207
+ [name: string]: unknown;
13208
+ };
13209
+ content: {
13210
+ "application/problem+json": {
13211
+ type?: null | string;
13212
+ title?: null | string;
13213
+ /** Format: int32 */
13214
+ status?: null | number;
13215
+ detail?: null | string;
13216
+ instance?: null | string;
13217
+ errors?: components["schemas"]["ProductLifecycleValidationErrors"];
13218
+ };
13219
+ };
13220
+ };
13116
13221
  /** @description Not Found */
13117
13222
  404: {
13118
13223
  headers: {
@@ -13164,13 +13269,21 @@ export interface operations {
13164
13269
  "application/json": components["schemas"]["ProductResponse"];
13165
13270
  };
13166
13271
  };
13167
- /** @description Bad Request */
13272
+ /** @description Bad Request. errors is keyed by the request member's own name, or by a header's name, and the keys this operation can send are the members of errors in this schema: InsurerId. Each holds sentences for a person. A body the server could not read is answered 400 with no errors at all. */
13168
13273
  400: {
13169
13274
  headers: {
13170
13275
  [name: string]: unknown;
13171
13276
  };
13172
13277
  content: {
13173
- "application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
13278
+ "application/problem+json": {
13279
+ type?: null | string;
13280
+ title?: null | string;
13281
+ /** Format: int32 */
13282
+ status?: null | number;
13283
+ detail?: null | string;
13284
+ instance?: null | string;
13285
+ errors?: components["schemas"]["AttachProductInsurerValidationErrors"];
13286
+ };
13174
13287
  };
13175
13288
  };
13176
13289
  /** @description Not Found */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@insurance-broker/api-client",
3
- "version": "5.27.0",
3
+ "version": "5.29.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,