@insurance-broker/api-client 2.14.0 → 2.16.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 +204 -2
  2. package/package.json +1 -1
package/dist/schema.d.ts CHANGED
@@ -2105,6 +2105,10 @@ export interface paths {
2105
2105
  * **The insurer decides, and this platform records.** A claim has no approved, declined or settled state, because those are not states this platform can enter (ADR-0041 section 2).
2106
2106
  *
2107
2107
  * To retract a claim, tell your broker. Concluding a case starts its retention clock, so it is recorded by the person who was told.
2108
+ *
2109
+ * **`idempotencyKey` is optional, and it is the only thing that makes a retry safe.** Without one, sending the report twice opens two claims. With one: a repeat carrying a key you already used **returns the original claim and the same `201 Created` with the same `Location`**, so a retry after a lost response opens nothing new. A repeat carrying that key with a **different** policy or incident day is a `409` and opens nothing.
2110
+ *
2111
+ * **A key is honoured for 30 days from the moment the claim was reported, and then stops being honoured.** After that the same key is one this platform has never seen. Mint a fresh key per intended report and reuse it only to retry that report (#444). A key is yours alone: another customer sending the same string never meets your claim.
2108
2112
  */
2109
2113
  post: operations["ReportOwnClaim"];
2110
2114
  delete?: never;
@@ -3270,6 +3274,41 @@ export interface paths {
3270
3274
  patch?: never;
3271
3275
  trace?: never;
3272
3276
  };
3277
+ "/api/v1/platform/tenants/{tenantKey}/native-applications": {
3278
+ parameters: {
3279
+ query?: never;
3280
+ header?: never;
3281
+ path?: never;
3282
+ cookie?: never;
3283
+ };
3284
+ /** Every native application identifier registered to a broker, active and retired. */
3285
+ get: operations["ListNativeApplications"];
3286
+ put?: never;
3287
+ /** Registers a build's public application identifier to a broker, so installs of it resolve that broker's public branding before sign-in. */
3288
+ post: operations["RegisterNativeApplication"];
3289
+ delete?: never;
3290
+ options?: never;
3291
+ head?: never;
3292
+ patch?: never;
3293
+ trace?: never;
3294
+ };
3295
+ "/api/v1/platform/tenants/{tenantKey}/native-applications/{registrationId}/retirement": {
3296
+ parameters: {
3297
+ query?: never;
3298
+ header?: never;
3299
+ path?: never;
3300
+ cookie?: never;
3301
+ };
3302
+ get?: never;
3303
+ put?: never;
3304
+ /** Stops an identifier resolving. Terminal; the identifier may then be registered again. */
3305
+ post: operations["RetireNativeApplication"];
3306
+ delete?: never;
3307
+ options?: never;
3308
+ head?: never;
3309
+ patch?: never;
3310
+ trace?: never;
3311
+ };
3273
3312
  "/api/v1/platform/tenants": {
3274
3313
  parameters: {
3275
3314
  query?: never;
@@ -3476,7 +3515,7 @@ export interface paths {
3476
3515
  path?: never;
3477
3516
  cookie?: never;
3478
3517
  };
3479
- /** The branding of the broker whose verified domain the request arrived on. */
3518
+ /** The branding of the broker whose verified domain the request arrived on, or whose registered native application sent it. */
3480
3519
  get: operations["GetPublicBranding"];
3481
3520
  put?: never;
3482
3521
  post?: never;
@@ -6915,6 +6954,16 @@ export interface components {
6915
6954
  /** Format: date-time */
6916
6955
  publishedAtUtc: string;
6917
6956
  };
6957
+ NativeApplicationResponse: {
6958
+ /** Format: uuid */
6959
+ id: string;
6960
+ identifier: string;
6961
+ status: string;
6962
+ /** Format: date-time */
6963
+ registeredAtUtc: string;
6964
+ /** Format: date-time */
6965
+ retiredAtUtc: null | string;
6966
+ };
6918
6967
  NotificationPage: {
6919
6968
  items: components["schemas"]["NotificationResponse"][];
6920
6969
  nextCursor: null | string;
@@ -7793,6 +7842,9 @@ export interface components {
7793
7842
  token: null | string;
7794
7843
  appVersion: null | string;
7795
7844
  };
7845
+ RegisterNativeApplicationRequest: {
7846
+ identifier: null | string;
7847
+ };
7796
7848
  RegisterOrganisationRequest: {
7797
7849
  name: null | string;
7798
7850
  registrationNumber: null | string;
@@ -7934,6 +7986,7 @@ export interface components {
7934
7986
  policyId: string;
7935
7987
  /** Format: date */
7936
7988
  incidentOn: string;
7989
+ idempotencyKey?: null | string;
7937
7990
  };
7938
7991
  RespondToRenewalRequest: {
7939
7992
  answer: null | string;
@@ -13005,6 +13058,15 @@ export interface operations {
13005
13058
  "application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
13006
13059
  };
13007
13060
  };
13061
+ /** @description Conflict */
13062
+ 409: {
13063
+ headers: {
13064
+ [name: string]: unknown;
13065
+ };
13066
+ content: {
13067
+ "application/problem+json": components["schemas"]["ProblemDetails"];
13068
+ };
13069
+ };
13008
13070
  };
13009
13071
  };
13010
13072
  GetOwnClaimTimeline: {
@@ -16036,6 +16098,144 @@ export interface operations {
16036
16098
  };
16037
16099
  };
16038
16100
  };
16101
+ ListNativeApplications: {
16102
+ parameters: {
16103
+ query?: never;
16104
+ header?: never;
16105
+ path: {
16106
+ tenantKey: string;
16107
+ };
16108
+ cookie?: never;
16109
+ };
16110
+ requestBody?: never;
16111
+ responses: {
16112
+ /** @description OK */
16113
+ 200: {
16114
+ headers: {
16115
+ [name: string]: unknown;
16116
+ };
16117
+ content: {
16118
+ "application/json": components["schemas"]["NativeApplicationResponse"][];
16119
+ };
16120
+ };
16121
+ /** @description Forbidden */
16122
+ 403: {
16123
+ headers: {
16124
+ [name: string]: unknown;
16125
+ };
16126
+ content?: never;
16127
+ };
16128
+ /** @description Not Found */
16129
+ 404: {
16130
+ headers: {
16131
+ [name: string]: unknown;
16132
+ };
16133
+ content?: never;
16134
+ };
16135
+ };
16136
+ };
16137
+ RegisterNativeApplication: {
16138
+ parameters: {
16139
+ query?: never;
16140
+ header?: never;
16141
+ path: {
16142
+ tenantKey: string;
16143
+ };
16144
+ cookie?: never;
16145
+ };
16146
+ requestBody: {
16147
+ content: {
16148
+ "application/json": components["schemas"]["RegisterNativeApplicationRequest"];
16149
+ };
16150
+ };
16151
+ responses: {
16152
+ /** @description Created */
16153
+ 201: {
16154
+ headers: {
16155
+ [name: string]: unknown;
16156
+ };
16157
+ content: {
16158
+ "application/json": components["schemas"]["NativeApplicationResponse"];
16159
+ };
16160
+ };
16161
+ /** @description Bad Request */
16162
+ 400: {
16163
+ headers: {
16164
+ [name: string]: unknown;
16165
+ };
16166
+ content: {
16167
+ "application/problem+json": components["schemas"]["ProblemDetails"];
16168
+ };
16169
+ };
16170
+ /** @description Forbidden */
16171
+ 403: {
16172
+ headers: {
16173
+ [name: string]: unknown;
16174
+ };
16175
+ content?: never;
16176
+ };
16177
+ /** @description Not Found */
16178
+ 404: {
16179
+ headers: {
16180
+ [name: string]: unknown;
16181
+ };
16182
+ content?: never;
16183
+ };
16184
+ /** @description Conflict */
16185
+ 409: {
16186
+ headers: {
16187
+ [name: string]: unknown;
16188
+ };
16189
+ content: {
16190
+ "application/problem+json": components["schemas"]["ProblemDetails"];
16191
+ };
16192
+ };
16193
+ };
16194
+ };
16195
+ RetireNativeApplication: {
16196
+ parameters: {
16197
+ query?: never;
16198
+ header?: never;
16199
+ path: {
16200
+ tenantKey: string;
16201
+ registrationId: string;
16202
+ };
16203
+ cookie?: never;
16204
+ };
16205
+ requestBody?: never;
16206
+ responses: {
16207
+ /** @description No Content */
16208
+ 204: {
16209
+ headers: {
16210
+ [name: string]: unknown;
16211
+ };
16212
+ content?: never;
16213
+ };
16214
+ /** @description Forbidden */
16215
+ 403: {
16216
+ headers: {
16217
+ [name: string]: unknown;
16218
+ };
16219
+ content?: never;
16220
+ };
16221
+ /** @description Not Found */
16222
+ 404: {
16223
+ headers: {
16224
+ [name: string]: unknown;
16225
+ };
16226
+ content?: never;
16227
+ };
16228
+ /** @description Conflict */
16229
+ 409: {
16230
+ headers: {
16231
+ [name: string]: unknown;
16232
+ };
16233
+ content: {
16234
+ "application/problem+json": components["schemas"]["ProblemDetails"];
16235
+ };
16236
+ };
16237
+ };
16238
+ };
16039
16239
  ListTenants: {
16040
16240
  parameters: {
16041
16241
  query?: never;
@@ -16521,7 +16721,9 @@ export interface operations {
16521
16721
  GetPublicBranding: {
16522
16722
  parameters: {
16523
16723
  query?: never;
16524
- header?: never;
16724
+ header?: {
16725
+ "X-App-Id"?: string;
16726
+ };
16525
16727
  path?: never;
16526
16728
  cookie?: never;
16527
16729
  };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@insurance-broker/api-client",
3
- "version": "2.14.0",
3
+ "version": "2.16.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,