@insurance-broker/api-client 1.40.0 → 1.41.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 +367 -0
- package/package.json +1 -1
package/dist/schema.d.ts
CHANGED
|
@@ -2935,6 +2935,42 @@ export interface paths {
|
|
|
2935
2935
|
/** How the broker presents itself: mark, colours and support contacts. */
|
|
2936
2936
|
get: operations["GetTenantBranding"];
|
|
2937
2937
|
put?: never;
|
|
2938
|
+
/** Replaces the broker's mark, colours and support channels wholesale. */
|
|
2939
|
+
post: operations["RebrandTenant"];
|
|
2940
|
+
delete?: never;
|
|
2941
|
+
options?: never;
|
|
2942
|
+
head?: never;
|
|
2943
|
+
patch?: never;
|
|
2944
|
+
trace?: never;
|
|
2945
|
+
};
|
|
2946
|
+
"/api/v1/tenant/profile": {
|
|
2947
|
+
parameters: {
|
|
2948
|
+
query?: never;
|
|
2949
|
+
header?: never;
|
|
2950
|
+
path?: never;
|
|
2951
|
+
cookie?: never;
|
|
2952
|
+
};
|
|
2953
|
+
/** The broker's licence, addresses and business contacts. */
|
|
2954
|
+
get: operations["GetTenantProfile"];
|
|
2955
|
+
put?: never;
|
|
2956
|
+
/** Replaces the broker's licence, addresses and business contacts wholesale. */
|
|
2957
|
+
post: operations["DescribeTenant"];
|
|
2958
|
+
delete?: never;
|
|
2959
|
+
options?: never;
|
|
2960
|
+
head?: never;
|
|
2961
|
+
patch?: never;
|
|
2962
|
+
trace?: never;
|
|
2963
|
+
};
|
|
2964
|
+
"/api/v1/tenant/legal-text": {
|
|
2965
|
+
parameters: {
|
|
2966
|
+
query?: never;
|
|
2967
|
+
header?: never;
|
|
2968
|
+
path?: never;
|
|
2969
|
+
cookie?: never;
|
|
2970
|
+
};
|
|
2971
|
+
/** The version of each piece of customer-facing legal text now in force. */
|
|
2972
|
+
get: operations["GetTenantLegalTexts"];
|
|
2973
|
+
put?: never;
|
|
2938
2974
|
post?: never;
|
|
2939
2975
|
delete?: never;
|
|
2940
2976
|
options?: never;
|
|
@@ -2942,6 +2978,24 @@ export interface paths {
|
|
|
2942
2978
|
patch?: never;
|
|
2943
2979
|
trace?: never;
|
|
2944
2980
|
};
|
|
2981
|
+
"/api/v1/tenant/legal-text/{kind}/versions": {
|
|
2982
|
+
parameters: {
|
|
2983
|
+
query?: never;
|
|
2984
|
+
header?: never;
|
|
2985
|
+
path?: never;
|
|
2986
|
+
cookie?: never;
|
|
2987
|
+
};
|
|
2988
|
+
/** Every version of one piece of legal text, newest first. */
|
|
2989
|
+
get: operations["GetTenantLegalTextVersions"];
|
|
2990
|
+
put?: never;
|
|
2991
|
+
/** Publishes the next version of one piece of customer-facing legal text. */
|
|
2992
|
+
post: operations["PublishTenantLegalText"];
|
|
2993
|
+
delete?: never;
|
|
2994
|
+
options?: never;
|
|
2995
|
+
head?: never;
|
|
2996
|
+
patch?: never;
|
|
2997
|
+
trace?: never;
|
|
2998
|
+
};
|
|
2945
2999
|
"/api/v1/tenant/entitlements": {
|
|
2946
3000
|
parameters: {
|
|
2947
3001
|
query?: never;
|
|
@@ -2976,6 +3030,23 @@ export interface paths {
|
|
|
2976
3030
|
patch?: never;
|
|
2977
3031
|
trace?: never;
|
|
2978
3032
|
};
|
|
3033
|
+
"/api/v1/tenant/rename": {
|
|
3034
|
+
parameters: {
|
|
3035
|
+
query?: never;
|
|
3036
|
+
header?: never;
|
|
3037
|
+
path?: never;
|
|
3038
|
+
cookie?: never;
|
|
3039
|
+
};
|
|
3040
|
+
get?: never;
|
|
3041
|
+
put?: never;
|
|
3042
|
+
/** Changes what the broker is called. Its key never moves. */
|
|
3043
|
+
post: operations["RenameTenant"];
|
|
3044
|
+
delete?: never;
|
|
3045
|
+
options?: never;
|
|
3046
|
+
head?: never;
|
|
3047
|
+
patch?: never;
|
|
3048
|
+
trace?: never;
|
|
3049
|
+
};
|
|
2979
3050
|
"/api/v1/platform/tenants/{tenantKey}/integration-credentials": {
|
|
2980
3051
|
parameters: {
|
|
2981
3052
|
query?: never;
|
|
@@ -4854,6 +4925,16 @@ export interface components {
|
|
|
4854
4925
|
/** Format: uuid */
|
|
4855
4926
|
branchId: null | string;
|
|
4856
4927
|
};
|
|
4928
|
+
DescribeTenantRequest: {
|
|
4929
|
+
regulatorName: null | string;
|
|
4930
|
+
licenceNumber: null | string;
|
|
4931
|
+
/** Format: date */
|
|
4932
|
+
licenceExpiresOn: null | string;
|
|
4933
|
+
registeredAddress: null | string;
|
|
4934
|
+
postalAddress: null | string;
|
|
4935
|
+
contactEmail: null | string;
|
|
4936
|
+
contactPhone: null | string;
|
|
4937
|
+
};
|
|
4857
4938
|
DocumentTemplateResponse: {
|
|
4858
4939
|
/** Format: uuid */
|
|
4859
4940
|
id: string;
|
|
@@ -5302,6 +5383,16 @@ export interface components {
|
|
|
5302
5383
|
releaseReason: null | string;
|
|
5303
5384
|
isOpen: boolean;
|
|
5304
5385
|
};
|
|
5386
|
+
LegalTextResponse: {
|
|
5387
|
+
/** Format: uuid */
|
|
5388
|
+
id: string;
|
|
5389
|
+
kind: string;
|
|
5390
|
+
/** Format: int32 */
|
|
5391
|
+
version: number | string;
|
|
5392
|
+
body: string;
|
|
5393
|
+
/** Format: date-time */
|
|
5394
|
+
publishedAtUtc: string;
|
|
5395
|
+
};
|
|
5305
5396
|
NotifyClaimRequest: {
|
|
5306
5397
|
/** Format: uuid */
|
|
5307
5398
|
policyId: string;
|
|
@@ -5799,6 +5890,9 @@ export interface components {
|
|
|
5799
5890
|
primaryColour: null | string;
|
|
5800
5891
|
secondaryColour: null | string;
|
|
5801
5892
|
};
|
|
5893
|
+
PublishLegalTextRequest: {
|
|
5894
|
+
body: string;
|
|
5895
|
+
};
|
|
5802
5896
|
QuotationPageOfComparisonSchemaVersionResponse: {
|
|
5803
5897
|
items: components["schemas"]["ComparisonSchemaVersionResponse"][];
|
|
5804
5898
|
nextCursor: null | string;
|
|
@@ -5951,6 +6045,14 @@ export interface components {
|
|
|
5951
6045
|
/** Format: uuid */
|
|
5952
6046
|
formSubmissionId: null | string;
|
|
5953
6047
|
};
|
|
6048
|
+
RebrandTenantRequest: {
|
|
6049
|
+
logoUrl: null | string;
|
|
6050
|
+
primaryColour: null | string;
|
|
6051
|
+
secondaryColour: null | string;
|
|
6052
|
+
supportEmail: null | string;
|
|
6053
|
+
supportPhone: null | string;
|
|
6054
|
+
websiteUrl: null | string;
|
|
6055
|
+
};
|
|
5954
6056
|
ReclassifyProductRequest: {
|
|
5955
6057
|
/** Format: uuid */
|
|
5956
6058
|
categoryId: null | string;
|
|
@@ -6040,6 +6142,10 @@ export interface components {
|
|
|
6040
6142
|
name: string;
|
|
6041
6143
|
description: null | string;
|
|
6042
6144
|
};
|
|
6145
|
+
RenameTenantRequest: {
|
|
6146
|
+
name: string;
|
|
6147
|
+
legalName: null | string;
|
|
6148
|
+
};
|
|
6043
6149
|
RenewalCaseDetailResponse: {
|
|
6044
6150
|
case: components["schemas"]["RenewalCaseSummaryResponse"];
|
|
6045
6151
|
/** Format: uuid */
|
|
@@ -6427,6 +6533,16 @@ export interface components {
|
|
|
6427
6533
|
supportPhone: null | string;
|
|
6428
6534
|
websiteUrl: null | string;
|
|
6429
6535
|
};
|
|
6536
|
+
TenantProfileResponse: {
|
|
6537
|
+
regulatorName: null | string;
|
|
6538
|
+
licenceNumber: null | string;
|
|
6539
|
+
/** Format: date */
|
|
6540
|
+
licenceExpiresOn: null | string;
|
|
6541
|
+
registeredAddress: null | string;
|
|
6542
|
+
postalAddress: null | string;
|
|
6543
|
+
contactEmail: null | string;
|
|
6544
|
+
contactPhone: null | string;
|
|
6545
|
+
};
|
|
6430
6546
|
TenantSettingsResponse: {
|
|
6431
6547
|
/** Format: uuid */
|
|
6432
6548
|
id: string;
|
|
@@ -13390,6 +13506,208 @@ export interface operations {
|
|
|
13390
13506
|
};
|
|
13391
13507
|
};
|
|
13392
13508
|
};
|
|
13509
|
+
RebrandTenant: {
|
|
13510
|
+
parameters: {
|
|
13511
|
+
query?: never;
|
|
13512
|
+
header?: never;
|
|
13513
|
+
path?: never;
|
|
13514
|
+
cookie?: never;
|
|
13515
|
+
};
|
|
13516
|
+
requestBody: {
|
|
13517
|
+
content: {
|
|
13518
|
+
"application/json": components["schemas"]["RebrandTenantRequest"];
|
|
13519
|
+
};
|
|
13520
|
+
};
|
|
13521
|
+
responses: {
|
|
13522
|
+
/** @description OK */
|
|
13523
|
+
200: {
|
|
13524
|
+
headers: {
|
|
13525
|
+
[name: string]: unknown;
|
|
13526
|
+
};
|
|
13527
|
+
content: {
|
|
13528
|
+
"application/json": components["schemas"]["TenantBrandingResponse"];
|
|
13529
|
+
};
|
|
13530
|
+
};
|
|
13531
|
+
/** @description Bad Request */
|
|
13532
|
+
400: {
|
|
13533
|
+
headers: {
|
|
13534
|
+
[name: string]: unknown;
|
|
13535
|
+
};
|
|
13536
|
+
content: {
|
|
13537
|
+
"application/problem+json": components["schemas"]["ProblemDetails"];
|
|
13538
|
+
};
|
|
13539
|
+
};
|
|
13540
|
+
/** @description Forbidden */
|
|
13541
|
+
403: {
|
|
13542
|
+
headers: {
|
|
13543
|
+
[name: string]: unknown;
|
|
13544
|
+
};
|
|
13545
|
+
content?: never;
|
|
13546
|
+
};
|
|
13547
|
+
};
|
|
13548
|
+
};
|
|
13549
|
+
GetTenantProfile: {
|
|
13550
|
+
parameters: {
|
|
13551
|
+
query?: never;
|
|
13552
|
+
header?: never;
|
|
13553
|
+
path?: never;
|
|
13554
|
+
cookie?: never;
|
|
13555
|
+
};
|
|
13556
|
+
requestBody?: never;
|
|
13557
|
+
responses: {
|
|
13558
|
+
/** @description OK */
|
|
13559
|
+
200: {
|
|
13560
|
+
headers: {
|
|
13561
|
+
[name: string]: unknown;
|
|
13562
|
+
};
|
|
13563
|
+
content: {
|
|
13564
|
+
"application/json": components["schemas"]["TenantProfileResponse"];
|
|
13565
|
+
};
|
|
13566
|
+
};
|
|
13567
|
+
};
|
|
13568
|
+
};
|
|
13569
|
+
DescribeTenant: {
|
|
13570
|
+
parameters: {
|
|
13571
|
+
query?: never;
|
|
13572
|
+
header?: never;
|
|
13573
|
+
path?: never;
|
|
13574
|
+
cookie?: never;
|
|
13575
|
+
};
|
|
13576
|
+
requestBody: {
|
|
13577
|
+
content: {
|
|
13578
|
+
"application/json": components["schemas"]["DescribeTenantRequest"];
|
|
13579
|
+
};
|
|
13580
|
+
};
|
|
13581
|
+
responses: {
|
|
13582
|
+
/** @description OK */
|
|
13583
|
+
200: {
|
|
13584
|
+
headers: {
|
|
13585
|
+
[name: string]: unknown;
|
|
13586
|
+
};
|
|
13587
|
+
content: {
|
|
13588
|
+
"application/json": components["schemas"]["TenantProfileResponse"];
|
|
13589
|
+
};
|
|
13590
|
+
};
|
|
13591
|
+
/** @description Bad Request */
|
|
13592
|
+
400: {
|
|
13593
|
+
headers: {
|
|
13594
|
+
[name: string]: unknown;
|
|
13595
|
+
};
|
|
13596
|
+
content: {
|
|
13597
|
+
"application/problem+json": components["schemas"]["ProblemDetails"];
|
|
13598
|
+
};
|
|
13599
|
+
};
|
|
13600
|
+
/** @description Forbidden */
|
|
13601
|
+
403: {
|
|
13602
|
+
headers: {
|
|
13603
|
+
[name: string]: unknown;
|
|
13604
|
+
};
|
|
13605
|
+
content?: never;
|
|
13606
|
+
};
|
|
13607
|
+
};
|
|
13608
|
+
};
|
|
13609
|
+
GetTenantLegalTexts: {
|
|
13610
|
+
parameters: {
|
|
13611
|
+
query?: never;
|
|
13612
|
+
header?: never;
|
|
13613
|
+
path?: never;
|
|
13614
|
+
cookie?: never;
|
|
13615
|
+
};
|
|
13616
|
+
requestBody?: never;
|
|
13617
|
+
responses: {
|
|
13618
|
+
/** @description OK */
|
|
13619
|
+
200: {
|
|
13620
|
+
headers: {
|
|
13621
|
+
[name: string]: unknown;
|
|
13622
|
+
};
|
|
13623
|
+
content: {
|
|
13624
|
+
"application/json": components["schemas"]["LegalTextResponse"][];
|
|
13625
|
+
};
|
|
13626
|
+
};
|
|
13627
|
+
};
|
|
13628
|
+
};
|
|
13629
|
+
GetTenantLegalTextVersions: {
|
|
13630
|
+
parameters: {
|
|
13631
|
+
query?: never;
|
|
13632
|
+
header?: never;
|
|
13633
|
+
path: {
|
|
13634
|
+
kind: string;
|
|
13635
|
+
};
|
|
13636
|
+
cookie?: never;
|
|
13637
|
+
};
|
|
13638
|
+
requestBody?: never;
|
|
13639
|
+
responses: {
|
|
13640
|
+
/** @description OK */
|
|
13641
|
+
200: {
|
|
13642
|
+
headers: {
|
|
13643
|
+
[name: string]: unknown;
|
|
13644
|
+
};
|
|
13645
|
+
content: {
|
|
13646
|
+
"application/json": components["schemas"]["LegalTextResponse"][];
|
|
13647
|
+
};
|
|
13648
|
+
};
|
|
13649
|
+
/** @description Bad Request */
|
|
13650
|
+
400: {
|
|
13651
|
+
headers: {
|
|
13652
|
+
[name: string]: unknown;
|
|
13653
|
+
};
|
|
13654
|
+
content: {
|
|
13655
|
+
"application/problem+json": components["schemas"]["ProblemDetails"];
|
|
13656
|
+
};
|
|
13657
|
+
};
|
|
13658
|
+
};
|
|
13659
|
+
};
|
|
13660
|
+
PublishTenantLegalText: {
|
|
13661
|
+
parameters: {
|
|
13662
|
+
query?: never;
|
|
13663
|
+
header?: never;
|
|
13664
|
+
path: {
|
|
13665
|
+
kind: string;
|
|
13666
|
+
};
|
|
13667
|
+
cookie?: never;
|
|
13668
|
+
};
|
|
13669
|
+
requestBody: {
|
|
13670
|
+
content: {
|
|
13671
|
+
"application/json": components["schemas"]["PublishLegalTextRequest"];
|
|
13672
|
+
};
|
|
13673
|
+
};
|
|
13674
|
+
responses: {
|
|
13675
|
+
/** @description Created */
|
|
13676
|
+
201: {
|
|
13677
|
+
headers: {
|
|
13678
|
+
[name: string]: unknown;
|
|
13679
|
+
};
|
|
13680
|
+
content: {
|
|
13681
|
+
"application/json": components["schemas"]["LegalTextResponse"];
|
|
13682
|
+
};
|
|
13683
|
+
};
|
|
13684
|
+
/** @description Bad Request */
|
|
13685
|
+
400: {
|
|
13686
|
+
headers: {
|
|
13687
|
+
[name: string]: unknown;
|
|
13688
|
+
};
|
|
13689
|
+
content: {
|
|
13690
|
+
"application/problem+json": components["schemas"]["ProblemDetails"];
|
|
13691
|
+
};
|
|
13692
|
+
};
|
|
13693
|
+
/** @description Forbidden */
|
|
13694
|
+
403: {
|
|
13695
|
+
headers: {
|
|
13696
|
+
[name: string]: unknown;
|
|
13697
|
+
};
|
|
13698
|
+
content?: never;
|
|
13699
|
+
};
|
|
13700
|
+
/** @description Conflict */
|
|
13701
|
+
409: {
|
|
13702
|
+
headers: {
|
|
13703
|
+
[name: string]: unknown;
|
|
13704
|
+
};
|
|
13705
|
+
content: {
|
|
13706
|
+
"application/problem+json": components["schemas"]["ProblemDetails"];
|
|
13707
|
+
};
|
|
13708
|
+
};
|
|
13709
|
+
};
|
|
13710
|
+
};
|
|
13393
13711
|
GetTenantEntitlements: {
|
|
13394
13712
|
parameters: {
|
|
13395
13713
|
query?: never;
|
|
@@ -13432,6 +13750,55 @@ export interface operations {
|
|
|
13432
13750
|
};
|
|
13433
13751
|
};
|
|
13434
13752
|
};
|
|
13753
|
+
RenameTenant: {
|
|
13754
|
+
parameters: {
|
|
13755
|
+
query?: never;
|
|
13756
|
+
header?: never;
|
|
13757
|
+
path?: never;
|
|
13758
|
+
cookie?: never;
|
|
13759
|
+
};
|
|
13760
|
+
requestBody: {
|
|
13761
|
+
content: {
|
|
13762
|
+
"application/json": components["schemas"]["RenameTenantRequest"];
|
|
13763
|
+
};
|
|
13764
|
+
};
|
|
13765
|
+
responses: {
|
|
13766
|
+
/** @description OK */
|
|
13767
|
+
200: {
|
|
13768
|
+
headers: {
|
|
13769
|
+
[name: string]: unknown;
|
|
13770
|
+
};
|
|
13771
|
+
content: {
|
|
13772
|
+
"application/json": components["schemas"]["TenantSettingsResponse"];
|
|
13773
|
+
};
|
|
13774
|
+
};
|
|
13775
|
+
/** @description Bad Request */
|
|
13776
|
+
400: {
|
|
13777
|
+
headers: {
|
|
13778
|
+
[name: string]: unknown;
|
|
13779
|
+
};
|
|
13780
|
+
content: {
|
|
13781
|
+
"application/problem+json": components["schemas"]["ProblemDetails"];
|
|
13782
|
+
};
|
|
13783
|
+
};
|
|
13784
|
+
/** @description Forbidden */
|
|
13785
|
+
403: {
|
|
13786
|
+
headers: {
|
|
13787
|
+
[name: string]: unknown;
|
|
13788
|
+
};
|
|
13789
|
+
content?: never;
|
|
13790
|
+
};
|
|
13791
|
+
/** @description Conflict */
|
|
13792
|
+
409: {
|
|
13793
|
+
headers: {
|
|
13794
|
+
[name: string]: unknown;
|
|
13795
|
+
};
|
|
13796
|
+
content: {
|
|
13797
|
+
"application/problem+json": components["schemas"]["ProblemDetails"];
|
|
13798
|
+
};
|
|
13799
|
+
};
|
|
13800
|
+
};
|
|
13801
|
+
};
|
|
13435
13802
|
ListIntegrationCredentials: {
|
|
13436
13803
|
parameters: {
|
|
13437
13804
|
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.41.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,
|