@insurance-broker/api-client 1.41.0 → 1.42.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 +443 -0
- package/package.json +1 -1
package/dist/schema.d.ts
CHANGED
|
@@ -2633,6 +2633,24 @@ export interface paths {
|
|
|
2633
2633
|
patch?: never;
|
|
2634
2634
|
trace?: never;
|
|
2635
2635
|
};
|
|
2636
|
+
"/api/v1/platform/tenants/{tenantKey}/administrators": {
|
|
2637
|
+
parameters: {
|
|
2638
|
+
query?: never;
|
|
2639
|
+
header?: never;
|
|
2640
|
+
path?: never;
|
|
2641
|
+
cookie?: never;
|
|
2642
|
+
};
|
|
2643
|
+
/** Who holds a membership of this broker, and what each holds. A platform read of the broker's own rows, and it is audited as one. */
|
|
2644
|
+
get: operations["ListTenantAdministrators"];
|
|
2645
|
+
put?: never;
|
|
2646
|
+
/** Gives a named person this broker's access, holding roles materialised from named role templates. The audited replacement for a seeded membership. */
|
|
2647
|
+
post: operations["GrantTenantAdministrator"];
|
|
2648
|
+
delete?: never;
|
|
2649
|
+
options?: never;
|
|
2650
|
+
head?: never;
|
|
2651
|
+
patch?: never;
|
|
2652
|
+
trace?: never;
|
|
2653
|
+
};
|
|
2636
2654
|
"/api/v1/roles": {
|
|
2637
2655
|
parameters: {
|
|
2638
2656
|
query?: never;
|
|
@@ -3099,6 +3117,75 @@ export interface paths {
|
|
|
3099
3117
|
patch?: never;
|
|
3100
3118
|
trace?: never;
|
|
3101
3119
|
};
|
|
3120
|
+
"/api/v1/platform/tenants": {
|
|
3121
|
+
parameters: {
|
|
3122
|
+
query?: never;
|
|
3123
|
+
header?: never;
|
|
3124
|
+
path?: never;
|
|
3125
|
+
cookie?: never;
|
|
3126
|
+
};
|
|
3127
|
+
/** Every broker on the platform, oldest first. Registry fields only. */
|
|
3128
|
+
get: operations["ListTenants"];
|
|
3129
|
+
put?: never;
|
|
3130
|
+
/** Registers a broker and brings it into force, ready to transact. */
|
|
3131
|
+
post: operations["ProvisionTenant"];
|
|
3132
|
+
delete?: never;
|
|
3133
|
+
options?: never;
|
|
3134
|
+
head?: never;
|
|
3135
|
+
patch?: never;
|
|
3136
|
+
trace?: never;
|
|
3137
|
+
};
|
|
3138
|
+
"/api/v1/platform/tenants/{tenantKey}": {
|
|
3139
|
+
parameters: {
|
|
3140
|
+
query?: never;
|
|
3141
|
+
header?: never;
|
|
3142
|
+
path?: never;
|
|
3143
|
+
cookie?: never;
|
|
3144
|
+
};
|
|
3145
|
+
/** One broker's registry row, including whether it may currently transact. */
|
|
3146
|
+
get: operations["GetTenant"];
|
|
3147
|
+
put?: never;
|
|
3148
|
+
post?: never;
|
|
3149
|
+
delete?: never;
|
|
3150
|
+
options?: never;
|
|
3151
|
+
head?: never;
|
|
3152
|
+
patch?: never;
|
|
3153
|
+
trace?: never;
|
|
3154
|
+
};
|
|
3155
|
+
"/api/v1/platform/tenants/{tenantKey}/suspension": {
|
|
3156
|
+
parameters: {
|
|
3157
|
+
query?: never;
|
|
3158
|
+
header?: never;
|
|
3159
|
+
path?: never;
|
|
3160
|
+
cookie?: never;
|
|
3161
|
+
};
|
|
3162
|
+
get?: never;
|
|
3163
|
+
put?: never;
|
|
3164
|
+
/** Bars a broker from transacting, recording why. Reversible, and it does not stop work already queued. */
|
|
3165
|
+
post: operations["SuspendTenant"];
|
|
3166
|
+
delete?: never;
|
|
3167
|
+
options?: never;
|
|
3168
|
+
head?: never;
|
|
3169
|
+
patch?: never;
|
|
3170
|
+
trace?: never;
|
|
3171
|
+
};
|
|
3172
|
+
"/api/v1/platform/tenants/{tenantKey}/resumption": {
|
|
3173
|
+
parameters: {
|
|
3174
|
+
query?: never;
|
|
3175
|
+
header?: never;
|
|
3176
|
+
path?: never;
|
|
3177
|
+
cookie?: never;
|
|
3178
|
+
};
|
|
3179
|
+
get?: never;
|
|
3180
|
+
put?: never;
|
|
3181
|
+
/** Returns a suspended broker to transacting. */
|
|
3182
|
+
post: operations["ResumeTenant"];
|
|
3183
|
+
delete?: never;
|
|
3184
|
+
options?: never;
|
|
3185
|
+
head?: never;
|
|
3186
|
+
patch?: never;
|
|
3187
|
+
trace?: never;
|
|
3188
|
+
};
|
|
3102
3189
|
"/api/v1/public/branding": {
|
|
3103
3190
|
parameters: {
|
|
3104
3191
|
query?: never;
|
|
@@ -5103,6 +5190,11 @@ export interface components {
|
|
|
5103
5190
|
displayName: null | string;
|
|
5104
5191
|
platformRoleCodes: null | string[];
|
|
5105
5192
|
};
|
|
5193
|
+
GrantTenantAdministratorRequest: {
|
|
5194
|
+
subjectId: null | string;
|
|
5195
|
+
displayName: null | string;
|
|
5196
|
+
roleTemplateCodes: null | string[];
|
|
5197
|
+
};
|
|
5106
5198
|
HttpValidationProblemDetails: {
|
|
5107
5199
|
type?: null | string;
|
|
5108
5200
|
title?: null | string;
|
|
@@ -5884,6 +5976,15 @@ export interface components {
|
|
|
5884
5976
|
updatedAtUtc: string;
|
|
5885
5977
|
insurers: components["schemas"]["ProductInsurerResponse"][];
|
|
5886
5978
|
};
|
|
5979
|
+
ProvisionTenantRequest: {
|
|
5980
|
+
key: null | string;
|
|
5981
|
+
name: null | string;
|
|
5982
|
+
legalName: null | string;
|
|
5983
|
+
countryCode: null | string;
|
|
5984
|
+
currencyCode: null | string;
|
|
5985
|
+
timeZoneId: null | string;
|
|
5986
|
+
locale: null | string;
|
|
5987
|
+
};
|
|
5887
5988
|
PublicBrandingResponse: {
|
|
5888
5989
|
name: string;
|
|
5889
5990
|
logoUrl: null | string;
|
|
@@ -6511,6 +6612,9 @@ export interface components {
|
|
|
6511
6612
|
attachmentId: null | string;
|
|
6512
6613
|
scanVerdict: null | string;
|
|
6513
6614
|
};
|
|
6615
|
+
SuspendTenantRequest: {
|
|
6616
|
+
reason: null | string;
|
|
6617
|
+
};
|
|
6514
6618
|
TeamResponse: {
|
|
6515
6619
|
/** Format: uuid */
|
|
6516
6620
|
id: string;
|
|
@@ -6524,6 +6628,16 @@ export interface components {
|
|
|
6524
6628
|
/** Format: date-time */
|
|
6525
6629
|
updatedAtUtc: string;
|
|
6526
6630
|
};
|
|
6631
|
+
TenantAdministratorResponse: {
|
|
6632
|
+
/** Format: uuid */
|
|
6633
|
+
membershipId: string;
|
|
6634
|
+
subjectId: string;
|
|
6635
|
+
displayName: string;
|
|
6636
|
+
status: string;
|
|
6637
|
+
roleKeys: string[];
|
|
6638
|
+
/** Format: date-time */
|
|
6639
|
+
createdAtUtc: string;
|
|
6640
|
+
};
|
|
6527
6641
|
TenantBrandingResponse: {
|
|
6528
6642
|
name: string;
|
|
6529
6643
|
logoUrl: null | string;
|
|
@@ -6543,6 +6657,26 @@ export interface components {
|
|
|
6543
6657
|
contactEmail: null | string;
|
|
6544
6658
|
contactPhone: null | string;
|
|
6545
6659
|
};
|
|
6660
|
+
TenantResponse: {
|
|
6661
|
+
/** Format: uuid */
|
|
6662
|
+
id: string;
|
|
6663
|
+
key: string;
|
|
6664
|
+
name: string;
|
|
6665
|
+
legalName: null | string;
|
|
6666
|
+
status: string;
|
|
6667
|
+
countryCode: string;
|
|
6668
|
+
currencyCode: string;
|
|
6669
|
+
timeZoneId: string;
|
|
6670
|
+
locale: string;
|
|
6671
|
+
canTransact: boolean;
|
|
6672
|
+
suspensionReason: null | string;
|
|
6673
|
+
/** Format: date-time */
|
|
6674
|
+
createdAtUtc: string;
|
|
6675
|
+
/** Format: date-time */
|
|
6676
|
+
activatedAtUtc: null | string;
|
|
6677
|
+
/** Format: date-time */
|
|
6678
|
+
suspendedAtUtc: null | string;
|
|
6679
|
+
};
|
|
6546
6680
|
TenantSettingsResponse: {
|
|
6547
6681
|
/** Format: uuid */
|
|
6548
6682
|
id: string;
|
|
@@ -12638,6 +12772,100 @@ export interface operations {
|
|
|
12638
12772
|
};
|
|
12639
12773
|
};
|
|
12640
12774
|
};
|
|
12775
|
+
ListTenantAdministrators: {
|
|
12776
|
+
parameters: {
|
|
12777
|
+
query?: never;
|
|
12778
|
+
header?: never;
|
|
12779
|
+
path: {
|
|
12780
|
+
tenantKey: string;
|
|
12781
|
+
};
|
|
12782
|
+
cookie?: never;
|
|
12783
|
+
};
|
|
12784
|
+
requestBody?: never;
|
|
12785
|
+
responses: {
|
|
12786
|
+
/** @description OK */
|
|
12787
|
+
200: {
|
|
12788
|
+
headers: {
|
|
12789
|
+
[name: string]: unknown;
|
|
12790
|
+
};
|
|
12791
|
+
content: {
|
|
12792
|
+
"application/json": components["schemas"]["TenantAdministratorResponse"][];
|
|
12793
|
+
};
|
|
12794
|
+
};
|
|
12795
|
+
/** @description Forbidden */
|
|
12796
|
+
403: {
|
|
12797
|
+
headers: {
|
|
12798
|
+
[name: string]: unknown;
|
|
12799
|
+
};
|
|
12800
|
+
content?: never;
|
|
12801
|
+
};
|
|
12802
|
+
/** @description Not Found */
|
|
12803
|
+
404: {
|
|
12804
|
+
headers: {
|
|
12805
|
+
[name: string]: unknown;
|
|
12806
|
+
};
|
|
12807
|
+
content?: never;
|
|
12808
|
+
};
|
|
12809
|
+
};
|
|
12810
|
+
};
|
|
12811
|
+
GrantTenantAdministrator: {
|
|
12812
|
+
parameters: {
|
|
12813
|
+
query?: never;
|
|
12814
|
+
header?: never;
|
|
12815
|
+
path: {
|
|
12816
|
+
tenantKey: string;
|
|
12817
|
+
};
|
|
12818
|
+
cookie?: never;
|
|
12819
|
+
};
|
|
12820
|
+
requestBody: {
|
|
12821
|
+
content: {
|
|
12822
|
+
"application/json": components["schemas"]["GrantTenantAdministratorRequest"];
|
|
12823
|
+
};
|
|
12824
|
+
};
|
|
12825
|
+
responses: {
|
|
12826
|
+
/** @description Created */
|
|
12827
|
+
201: {
|
|
12828
|
+
headers: {
|
|
12829
|
+
[name: string]: unknown;
|
|
12830
|
+
};
|
|
12831
|
+
content: {
|
|
12832
|
+
"application/json": components["schemas"]["TenantAdministratorResponse"];
|
|
12833
|
+
};
|
|
12834
|
+
};
|
|
12835
|
+
/** @description Bad Request */
|
|
12836
|
+
400: {
|
|
12837
|
+
headers: {
|
|
12838
|
+
[name: string]: unknown;
|
|
12839
|
+
};
|
|
12840
|
+
content: {
|
|
12841
|
+
"application/problem+json": components["schemas"]["ProblemDetails"];
|
|
12842
|
+
};
|
|
12843
|
+
};
|
|
12844
|
+
/** @description Forbidden */
|
|
12845
|
+
403: {
|
|
12846
|
+
headers: {
|
|
12847
|
+
[name: string]: unknown;
|
|
12848
|
+
};
|
|
12849
|
+
content?: never;
|
|
12850
|
+
};
|
|
12851
|
+
/** @description Not Found */
|
|
12852
|
+
404: {
|
|
12853
|
+
headers: {
|
|
12854
|
+
[name: string]: unknown;
|
|
12855
|
+
};
|
|
12856
|
+
content?: never;
|
|
12857
|
+
};
|
|
12858
|
+
/** @description Conflict */
|
|
12859
|
+
409: {
|
|
12860
|
+
headers: {
|
|
12861
|
+
[name: string]: unknown;
|
|
12862
|
+
};
|
|
12863
|
+
content: {
|
|
12864
|
+
"application/problem+json": components["schemas"]["ProblemDetails"];
|
|
12865
|
+
};
|
|
12866
|
+
};
|
|
12867
|
+
};
|
|
12868
|
+
};
|
|
12641
12869
|
ListRoles: {
|
|
12642
12870
|
parameters: {
|
|
12643
12871
|
query?: never;
|
|
@@ -13983,6 +14211,221 @@ export interface operations {
|
|
|
13983
14211
|
};
|
|
13984
14212
|
};
|
|
13985
14213
|
};
|
|
14214
|
+
ListTenants: {
|
|
14215
|
+
parameters: {
|
|
14216
|
+
query?: never;
|
|
14217
|
+
header?: never;
|
|
14218
|
+
path?: never;
|
|
14219
|
+
cookie?: never;
|
|
14220
|
+
};
|
|
14221
|
+
requestBody?: never;
|
|
14222
|
+
responses: {
|
|
14223
|
+
/** @description OK */
|
|
14224
|
+
200: {
|
|
14225
|
+
headers: {
|
|
14226
|
+
[name: string]: unknown;
|
|
14227
|
+
};
|
|
14228
|
+
content: {
|
|
14229
|
+
"application/json": components["schemas"]["TenantResponse"][];
|
|
14230
|
+
};
|
|
14231
|
+
};
|
|
14232
|
+
/** @description Forbidden */
|
|
14233
|
+
403: {
|
|
14234
|
+
headers: {
|
|
14235
|
+
[name: string]: unknown;
|
|
14236
|
+
};
|
|
14237
|
+
content?: never;
|
|
14238
|
+
};
|
|
14239
|
+
};
|
|
14240
|
+
};
|
|
14241
|
+
ProvisionTenant: {
|
|
14242
|
+
parameters: {
|
|
14243
|
+
query?: never;
|
|
14244
|
+
header?: never;
|
|
14245
|
+
path?: never;
|
|
14246
|
+
cookie?: never;
|
|
14247
|
+
};
|
|
14248
|
+
requestBody: {
|
|
14249
|
+
content: {
|
|
14250
|
+
"application/json": components["schemas"]["ProvisionTenantRequest"];
|
|
14251
|
+
};
|
|
14252
|
+
};
|
|
14253
|
+
responses: {
|
|
14254
|
+
/** @description Created */
|
|
14255
|
+
201: {
|
|
14256
|
+
headers: {
|
|
14257
|
+
[name: string]: unknown;
|
|
14258
|
+
};
|
|
14259
|
+
content: {
|
|
14260
|
+
"application/json": components["schemas"]["TenantResponse"];
|
|
14261
|
+
};
|
|
14262
|
+
};
|
|
14263
|
+
/** @description Bad Request */
|
|
14264
|
+
400: {
|
|
14265
|
+
headers: {
|
|
14266
|
+
[name: string]: unknown;
|
|
14267
|
+
};
|
|
14268
|
+
content: {
|
|
14269
|
+
"application/problem+json": components["schemas"]["ProblemDetails"];
|
|
14270
|
+
};
|
|
14271
|
+
};
|
|
14272
|
+
/** @description Forbidden */
|
|
14273
|
+
403: {
|
|
14274
|
+
headers: {
|
|
14275
|
+
[name: string]: unknown;
|
|
14276
|
+
};
|
|
14277
|
+
content?: never;
|
|
14278
|
+
};
|
|
14279
|
+
/** @description Conflict */
|
|
14280
|
+
409: {
|
|
14281
|
+
headers: {
|
|
14282
|
+
[name: string]: unknown;
|
|
14283
|
+
};
|
|
14284
|
+
content: {
|
|
14285
|
+
"application/problem+json": components["schemas"]["ProblemDetails"];
|
|
14286
|
+
};
|
|
14287
|
+
};
|
|
14288
|
+
};
|
|
14289
|
+
};
|
|
14290
|
+
GetTenant: {
|
|
14291
|
+
parameters: {
|
|
14292
|
+
query?: never;
|
|
14293
|
+
header?: never;
|
|
14294
|
+
path: {
|
|
14295
|
+
tenantKey: string;
|
|
14296
|
+
};
|
|
14297
|
+
cookie?: never;
|
|
14298
|
+
};
|
|
14299
|
+
requestBody?: never;
|
|
14300
|
+
responses: {
|
|
14301
|
+
/** @description OK */
|
|
14302
|
+
200: {
|
|
14303
|
+
headers: {
|
|
14304
|
+
[name: string]: unknown;
|
|
14305
|
+
};
|
|
14306
|
+
content: {
|
|
14307
|
+
"application/json": components["schemas"]["TenantResponse"];
|
|
14308
|
+
};
|
|
14309
|
+
};
|
|
14310
|
+
/** @description Forbidden */
|
|
14311
|
+
403: {
|
|
14312
|
+
headers: {
|
|
14313
|
+
[name: string]: unknown;
|
|
14314
|
+
};
|
|
14315
|
+
content?: never;
|
|
14316
|
+
};
|
|
14317
|
+
/** @description Not Found */
|
|
14318
|
+
404: {
|
|
14319
|
+
headers: {
|
|
14320
|
+
[name: string]: unknown;
|
|
14321
|
+
};
|
|
14322
|
+
content?: never;
|
|
14323
|
+
};
|
|
14324
|
+
};
|
|
14325
|
+
};
|
|
14326
|
+
SuspendTenant: {
|
|
14327
|
+
parameters: {
|
|
14328
|
+
query?: never;
|
|
14329
|
+
header?: never;
|
|
14330
|
+
path: {
|
|
14331
|
+
tenantKey: string;
|
|
14332
|
+
};
|
|
14333
|
+
cookie?: never;
|
|
14334
|
+
};
|
|
14335
|
+
requestBody: {
|
|
14336
|
+
content: {
|
|
14337
|
+
"application/json": components["schemas"]["SuspendTenantRequest"];
|
|
14338
|
+
};
|
|
14339
|
+
};
|
|
14340
|
+
responses: {
|
|
14341
|
+
/** @description OK */
|
|
14342
|
+
200: {
|
|
14343
|
+
headers: {
|
|
14344
|
+
[name: string]: unknown;
|
|
14345
|
+
};
|
|
14346
|
+
content: {
|
|
14347
|
+
"application/json": components["schemas"]["TenantResponse"];
|
|
14348
|
+
};
|
|
14349
|
+
};
|
|
14350
|
+
/** @description Bad Request */
|
|
14351
|
+
400: {
|
|
14352
|
+
headers: {
|
|
14353
|
+
[name: string]: unknown;
|
|
14354
|
+
};
|
|
14355
|
+
content: {
|
|
14356
|
+
"application/problem+json": components["schemas"]["ProblemDetails"];
|
|
14357
|
+
};
|
|
14358
|
+
};
|
|
14359
|
+
/** @description Forbidden */
|
|
14360
|
+
403: {
|
|
14361
|
+
headers: {
|
|
14362
|
+
[name: string]: unknown;
|
|
14363
|
+
};
|
|
14364
|
+
content?: never;
|
|
14365
|
+
};
|
|
14366
|
+
/** @description Not Found */
|
|
14367
|
+
404: {
|
|
14368
|
+
headers: {
|
|
14369
|
+
[name: string]: unknown;
|
|
14370
|
+
};
|
|
14371
|
+
content?: never;
|
|
14372
|
+
};
|
|
14373
|
+
/** @description Conflict */
|
|
14374
|
+
409: {
|
|
14375
|
+
headers: {
|
|
14376
|
+
[name: string]: unknown;
|
|
14377
|
+
};
|
|
14378
|
+
content: {
|
|
14379
|
+
"application/problem+json": components["schemas"]["ProblemDetails"];
|
|
14380
|
+
};
|
|
14381
|
+
};
|
|
14382
|
+
};
|
|
14383
|
+
};
|
|
14384
|
+
ResumeTenant: {
|
|
14385
|
+
parameters: {
|
|
14386
|
+
query?: never;
|
|
14387
|
+
header?: never;
|
|
14388
|
+
path: {
|
|
14389
|
+
tenantKey: string;
|
|
14390
|
+
};
|
|
14391
|
+
cookie?: never;
|
|
14392
|
+
};
|
|
14393
|
+
requestBody?: never;
|
|
14394
|
+
responses: {
|
|
14395
|
+
/** @description OK */
|
|
14396
|
+
200: {
|
|
14397
|
+
headers: {
|
|
14398
|
+
[name: string]: unknown;
|
|
14399
|
+
};
|
|
14400
|
+
content: {
|
|
14401
|
+
"application/json": components["schemas"]["TenantResponse"];
|
|
14402
|
+
};
|
|
14403
|
+
};
|
|
14404
|
+
/** @description Forbidden */
|
|
14405
|
+
403: {
|
|
14406
|
+
headers: {
|
|
14407
|
+
[name: string]: unknown;
|
|
14408
|
+
};
|
|
14409
|
+
content?: never;
|
|
14410
|
+
};
|
|
14411
|
+
/** @description Not Found */
|
|
14412
|
+
404: {
|
|
14413
|
+
headers: {
|
|
14414
|
+
[name: string]: unknown;
|
|
14415
|
+
};
|
|
14416
|
+
content?: never;
|
|
14417
|
+
};
|
|
14418
|
+
/** @description Conflict */
|
|
14419
|
+
409: {
|
|
14420
|
+
headers: {
|
|
14421
|
+
[name: string]: unknown;
|
|
14422
|
+
};
|
|
14423
|
+
content: {
|
|
14424
|
+
"application/problem+json": components["schemas"]["ProblemDetails"];
|
|
14425
|
+
};
|
|
14426
|
+
};
|
|
14427
|
+
};
|
|
14428
|
+
};
|
|
13986
14429
|
GetPublicBranding: {
|
|
13987
14430
|
parameters: {
|
|
13988
14431
|
query?: never;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@insurance-broker/api-client",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.42.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,
|