@orbis-systems/orbis-api-clients 0.2.0 → 0.2.2
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/index.d.ts +108 -108
- package/dist/index.d.ts.map +1 -1
- package/dist/index.esm.js +1 -1
- package/dist/index.esm.js.map +1 -1
- package/dist/index.js +1 -1
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -267,7 +267,7 @@ export interface InsightArticlesRequest {
|
|
|
267
267
|
symbols?: string;
|
|
268
268
|
tag?: string;
|
|
269
269
|
tag_group?: string;
|
|
270
|
-
type?:
|
|
270
|
+
type?: InsightArticlesRequestTypeEnum;
|
|
271
271
|
}
|
|
272
272
|
export interface InsightAssetAllocationBreakdown {
|
|
273
273
|
breakdown: string;
|
|
@@ -449,7 +449,7 @@ export interface InsightCreateRegionRequest {
|
|
|
449
449
|
regions?: InsightRegion[];
|
|
450
450
|
}
|
|
451
451
|
export interface InsightCryptoLogoConvertedRequest {
|
|
452
|
-
conversion?:
|
|
452
|
+
conversion?: InsightCryptoLogoConvertedRequestConversionEnum;
|
|
453
453
|
symbol?: string;
|
|
454
454
|
}
|
|
455
455
|
export interface InsightCryptoLogosResponse {
|
|
@@ -1359,8 +1359,8 @@ export interface InsightLatestAnalystRatingsOnStockResponse {
|
|
|
1359
1359
|
url: string;
|
|
1360
1360
|
}
|
|
1361
1361
|
export interface InsightLessAndMore {
|
|
1362
|
-
less_than
|
|
1363
|
-
more_than
|
|
1362
|
+
less_than?: number;
|
|
1363
|
+
more_than?: number;
|
|
1364
1364
|
}
|
|
1365
1365
|
export interface InsightLiabilities {
|
|
1366
1366
|
debt_ratio: number;
|
|
@@ -1440,9 +1440,9 @@ export interface InsightMomentumRatioGraphResponse {
|
|
|
1440
1440
|
export interface InsightMostPopularTagsRequest {
|
|
1441
1441
|
/** (REQUIRE) */
|
|
1442
1442
|
language?: string;
|
|
1443
|
-
time?:
|
|
1443
|
+
time?: InsightMostPopularTagsRequestTimeEnum;
|
|
1444
1444
|
/** (REQUIRE) */
|
|
1445
|
-
type?:
|
|
1445
|
+
type?: InsightMostPopularTagsRequestTypeEnum;
|
|
1446
1446
|
}
|
|
1447
1447
|
export interface InsightMover {
|
|
1448
1448
|
company_name: string;
|
|
@@ -1572,7 +1572,7 @@ export interface InsightNewsfeedRequest {
|
|
|
1572
1572
|
released_before?: number;
|
|
1573
1573
|
symbol?: string;
|
|
1574
1574
|
tag?: string;
|
|
1575
|
-
type?:
|
|
1575
|
+
type?: InsightNewsfeedRequestTypeEnum;
|
|
1576
1576
|
with_tag_group?: string;
|
|
1577
1577
|
}
|
|
1578
1578
|
export interface InsightOptionData {
|
|
@@ -1597,7 +1597,7 @@ export interface InsightOptionValues {
|
|
|
1597
1597
|
}
|
|
1598
1598
|
export interface InsightOrdering {
|
|
1599
1599
|
/** @default "asc" */
|
|
1600
|
-
direction:
|
|
1600
|
+
direction: InsightOrderingDirectionEnum;
|
|
1601
1601
|
/**
|
|
1602
1602
|
* Sort direction:
|
|
1603
1603
|
* * asc - Ascending, from A to Z.
|
|
@@ -1640,7 +1640,7 @@ export interface InsightPerformingExpertsRatings {
|
|
|
1640
1640
|
ticker: string;
|
|
1641
1641
|
}
|
|
1642
1642
|
export interface InsightPeriodFilter {
|
|
1643
|
-
type?:
|
|
1643
|
+
type?: InsightPeriodFilterTypeEnum;
|
|
1644
1644
|
value?: number;
|
|
1645
1645
|
}
|
|
1646
1646
|
export interface InsightPortfoliosRequest {
|
|
@@ -1785,7 +1785,7 @@ export interface InsightSearchArticleRequest {
|
|
|
1785
1785
|
language?: string;
|
|
1786
1786
|
/** (REQUIRE) */
|
|
1787
1787
|
s?: string;
|
|
1788
|
-
type?:
|
|
1788
|
+
type?: InsightSearchArticleRequestTypeEnum;
|
|
1789
1789
|
}
|
|
1790
1790
|
export interface InsightSeasonalityEntry {
|
|
1791
1791
|
april: InsightTickerSeasonality;
|
|
@@ -1969,7 +1969,7 @@ export interface InsightSymbolIndustries {
|
|
|
1969
1969
|
sub_industry: string;
|
|
1970
1970
|
}
|
|
1971
1971
|
export interface InsightSymbolLogoConvertedRequest {
|
|
1972
|
-
conversion?:
|
|
1972
|
+
conversion?: InsightSymbolLogoConvertedRequestConversionEnum;
|
|
1973
1973
|
symbol?: string;
|
|
1974
1974
|
}
|
|
1975
1975
|
export interface InsightSymbolLogosResponse {
|
|
@@ -2261,11 +2261,11 @@ export interface InsightEquityDataResponse {
|
|
|
2261
2261
|
volume: number;
|
|
2262
2262
|
yest_close_px: number;
|
|
2263
2263
|
}
|
|
2264
|
-
export enum
|
|
2264
|
+
export enum InsightArticlesRequestTypeEnum {
|
|
2265
2265
|
Education = "education",
|
|
2266
2266
|
NonEducation = "non-education"
|
|
2267
2267
|
}
|
|
2268
|
-
export enum
|
|
2268
|
+
export enum InsightCryptoLogoConvertedRequestConversionEnum {
|
|
2269
2269
|
Original = "original",
|
|
2270
2270
|
Default = "default",
|
|
2271
2271
|
Normal = "normal",
|
|
@@ -2275,39 +2275,39 @@ export enum InsightInsightCryptoLogoConvertedRequestConversionEnum {
|
|
|
2275
2275
|
SquareStrictOrNormal = "square_strict_or_normal",
|
|
2276
2276
|
BestMatch = "best_match"
|
|
2277
2277
|
}
|
|
2278
|
-
export enum
|
|
2278
|
+
export enum InsightMostPopularTagsRequestTimeEnum {
|
|
2279
2279
|
Week = "week",
|
|
2280
2280
|
Month = "month",
|
|
2281
2281
|
Year = "year"
|
|
2282
2282
|
}
|
|
2283
2283
|
/** (REQUIRE) */
|
|
2284
|
-
export enum
|
|
2284
|
+
export enum InsightMostPopularTagsRequestTypeEnum {
|
|
2285
2285
|
Symbol = "symbol",
|
|
2286
2286
|
Primary = "primary",
|
|
2287
2287
|
Tags = "tags"
|
|
2288
2288
|
}
|
|
2289
|
-
export enum
|
|
2289
|
+
export enum InsightNewsfeedRequestTypeEnum {
|
|
2290
2290
|
Education = "education",
|
|
2291
2291
|
NonEducation = "non-education"
|
|
2292
2292
|
}
|
|
2293
2293
|
/** @default "asc" */
|
|
2294
|
-
export enum
|
|
2294
|
+
export enum InsightOrderingDirectionEnum {
|
|
2295
2295
|
Asc = "asc",
|
|
2296
2296
|
Desc = "desc"
|
|
2297
2297
|
}
|
|
2298
|
-
export enum
|
|
2298
|
+
export enum InsightPeriodFilterTypeEnum {
|
|
2299
2299
|
Day = "day",
|
|
2300
2300
|
Week = "week",
|
|
2301
2301
|
Month = "month",
|
|
2302
2302
|
Year = "year"
|
|
2303
2303
|
}
|
|
2304
|
-
export enum
|
|
2304
|
+
export enum InsightSearchArticleRequestTypeEnum {
|
|
2305
2305
|
All = "all",
|
|
2306
2306
|
Tag = "tag",
|
|
2307
2307
|
Primary = "primary",
|
|
2308
2308
|
Symbol = "symbol"
|
|
2309
2309
|
}
|
|
2310
|
-
export enum
|
|
2310
|
+
export enum InsightSymbolLogoConvertedRequestConversionEnum {
|
|
2311
2311
|
Original = "original",
|
|
2312
2312
|
Default = "default",
|
|
2313
2313
|
Normal = "normal",
|
|
@@ -2745,12 +2745,12 @@ export interface InsightIncludeExcludeV2 {
|
|
|
2745
2745
|
include: string[];
|
|
2746
2746
|
}
|
|
2747
2747
|
export interface InsightLessAndMoreV2 {
|
|
2748
|
-
less_than
|
|
2749
|
-
more_than
|
|
2748
|
+
less_than?: number;
|
|
2749
|
+
more_than?: number;
|
|
2750
2750
|
}
|
|
2751
2751
|
export interface InsightOrderingV2 {
|
|
2752
2752
|
/** @default "asc" */
|
|
2753
|
-
direction:
|
|
2753
|
+
direction: InsightOrderingV2DirectionEnumV2;
|
|
2754
2754
|
/**
|
|
2755
2755
|
* Sort direction:
|
|
2756
2756
|
* * asc - Ascending, from A to Z.
|
|
@@ -2814,7 +2814,7 @@ export interface InsightStockScreenerResponseV2 {
|
|
|
2814
2814
|
details: InsightStockScreenerQuoteV2[];
|
|
2815
2815
|
}
|
|
2816
2816
|
/** @default "asc" */
|
|
2817
|
-
export enum
|
|
2817
|
+
export enum InsightOrderingV2DirectionEnumV2 {
|
|
2818
2818
|
Asc = "asc",
|
|
2819
2819
|
Desc = "desc"
|
|
2820
2820
|
}
|
|
@@ -2936,21 +2936,21 @@ export class Ipos<HandleError extends boolean = boolean> {
|
|
|
2936
2936
|
/**
|
|
2937
2937
|
* @description get recent ipos info
|
|
2938
2938
|
* @tags Ipos
|
|
2939
|
-
* @name
|
|
2939
|
+
* @name PostRecent
|
|
2940
2940
|
* @summary get recent ipos info
|
|
2941
2941
|
* @request POST:/ipos/recent
|
|
2942
2942
|
* @secure
|
|
2943
2943
|
*/
|
|
2944
|
-
|
|
2944
|
+
postRecent(recentIPODto: InsightRecentIPOListRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
|
|
2945
2945
|
/**
|
|
2946
2946
|
* @description get upcoming ipos info
|
|
2947
2947
|
* @tags Ipos
|
|
2948
|
-
* @name
|
|
2948
|
+
* @name GetUpcoming
|
|
2949
2949
|
* @summary get upcoming ipos info
|
|
2950
2950
|
* @request GET:/ipos/upcoming
|
|
2951
2951
|
* @secure
|
|
2952
2952
|
*/
|
|
2953
|
-
|
|
2953
|
+
getUpcoming(query: {
|
|
2954
2954
|
/** how many records to return. Max value is 50 */
|
|
2955
2955
|
limit: number;
|
|
2956
2956
|
/** how many records to skip */
|
|
@@ -4187,7 +4187,7 @@ export interface MiddlewareWatchlistEntryDto {
|
|
|
4187
4187
|
* Default to `equity` if not provided
|
|
4188
4188
|
* @default "equity"
|
|
4189
4189
|
*/
|
|
4190
|
-
type?:
|
|
4190
|
+
type?: MiddlewareWatchlistEntryDtoTypeEnum;
|
|
4191
4191
|
symbol: string;
|
|
4192
4192
|
}
|
|
4193
4193
|
export interface MiddlewareWatchlistDto {
|
|
@@ -4260,7 +4260,7 @@ export interface MiddlewareAppVersionDto {
|
|
|
4260
4260
|
* Default to `equity` if not provided
|
|
4261
4261
|
* @default "equity"
|
|
4262
4262
|
*/
|
|
4263
|
-
export enum
|
|
4263
|
+
export enum MiddlewareWatchlistEntryDtoTypeEnum {
|
|
4264
4264
|
Equity = "equity",
|
|
4265
4265
|
Option = "option",
|
|
4266
4266
|
Crypto = "crypto",
|
|
@@ -20346,7 +20346,7 @@ export interface UmaAuthFormDto {
|
|
|
20346
20346
|
logo_path?: string;
|
|
20347
20347
|
redirect_url: string;
|
|
20348
20348
|
reset_password_link_template?: string;
|
|
20349
|
-
reset_password_type:
|
|
20349
|
+
reset_password_type: UmaAuthFormDtoResetPasswordTypeEnum;
|
|
20350
20350
|
slug: string;
|
|
20351
20351
|
}
|
|
20352
20352
|
export interface UmaAuthFormSerializer {
|
|
@@ -20361,7 +20361,7 @@ export interface UmaAuthFormSerializer {
|
|
|
20361
20361
|
logo_path: string;
|
|
20362
20362
|
redirect_url: string;
|
|
20363
20363
|
reset_password_link_template: string;
|
|
20364
|
-
reset_password_type:
|
|
20364
|
+
reset_password_type: UmaAuthFormSerializerResetPasswordTypeEnum;
|
|
20365
20365
|
slug: string;
|
|
20366
20366
|
updated_at: string;
|
|
20367
20367
|
}
|
|
@@ -20401,7 +20401,7 @@ export interface UmaB2BResetPasswordDto {
|
|
|
20401
20401
|
export interface UmaB2BSendContactChangeCodeDto {
|
|
20402
20402
|
/** @maxLength 255 */
|
|
20403
20403
|
contact: string;
|
|
20404
|
-
type:
|
|
20404
|
+
type: UmaB2BSendContactChangeCodeDtoTypeEnum;
|
|
20405
20405
|
}
|
|
20406
20406
|
export interface UmaB2BUploadAvatarSerializer {
|
|
20407
20407
|
big_avatar_path: string;
|
|
@@ -20462,15 +20462,15 @@ export interface UmaB2CResetPasswordDto {
|
|
|
20462
20462
|
contact?: string;
|
|
20463
20463
|
/** @maxLength 100 */
|
|
20464
20464
|
new_password: string;
|
|
20465
|
-
reset_type:
|
|
20465
|
+
reset_type: UmaB2CResetPasswordDtoResetTypeEnum;
|
|
20466
20466
|
}
|
|
20467
20467
|
export interface UmaB2CSendContactChangeCodeDto {
|
|
20468
20468
|
/** @maxLength 255 */
|
|
20469
20469
|
contact: string;
|
|
20470
|
-
type:
|
|
20470
|
+
type: UmaB2CSendContactChangeCodeDtoTypeEnum;
|
|
20471
20471
|
}
|
|
20472
20472
|
export interface UmaB2CSendVerificationCodeDto {
|
|
20473
|
-
code_type:
|
|
20473
|
+
code_type: UmaB2CSendVerificationCodeDtoCodeTypeEnum;
|
|
20474
20474
|
contact: string;
|
|
20475
20475
|
}
|
|
20476
20476
|
export interface UmaB2CUserSettingsSerializer {
|
|
@@ -20654,13 +20654,13 @@ export interface UmaCreateEndpointDto {
|
|
|
20654
20654
|
is_active?: boolean;
|
|
20655
20655
|
is_public?: boolean;
|
|
20656
20656
|
metadata?: UmaEndpointMetadataDto;
|
|
20657
|
-
method:
|
|
20657
|
+
method: UmaCreateEndpointDtoMethodEnum;
|
|
20658
20658
|
/** @min 1 */
|
|
20659
20659
|
microservice_id: number;
|
|
20660
20660
|
required_permissions?: number[];
|
|
20661
20661
|
/** @maxLength 255 */
|
|
20662
20662
|
route: string;
|
|
20663
|
-
type?:
|
|
20663
|
+
type?: UmaCreateEndpointDtoTypeEnum;
|
|
20664
20664
|
}
|
|
20665
20665
|
export interface UmaCreateFirmDto {
|
|
20666
20666
|
allow_b2c_email_notifications?: boolean;
|
|
@@ -20687,7 +20687,7 @@ export interface UmaCreateIdentityProviderDto {
|
|
|
20687
20687
|
priority: number;
|
|
20688
20688
|
/** @maxLength 1000 */
|
|
20689
20689
|
redirect_url?: string;
|
|
20690
|
-
type:
|
|
20690
|
+
type: UmaCreateIdentityProviderDtoTypeEnum;
|
|
20691
20691
|
}
|
|
20692
20692
|
export interface UmaCreateMicroserviceDto {
|
|
20693
20693
|
domains?: UmaMicroserviceDomainDto[];
|
|
@@ -20701,14 +20701,14 @@ export interface UmaCreateMicroserviceDto {
|
|
|
20701
20701
|
slug: string;
|
|
20702
20702
|
}
|
|
20703
20703
|
export interface UmaCreatePermissionDto {
|
|
20704
|
-
assignment_group:
|
|
20704
|
+
assignment_group: UmaCreatePermissionDtoAssignmentGroupEnum;
|
|
20705
20705
|
metadata?: UmaPermissionMetadata;
|
|
20706
20706
|
microservice_id?: number;
|
|
20707
20707
|
/** @maxLength 1000 */
|
|
20708
20708
|
permission: string;
|
|
20709
20709
|
}
|
|
20710
20710
|
export interface UmaCreateRoleDto {
|
|
20711
|
-
assignment_group?:
|
|
20711
|
+
assignment_group?: UmaCreateRoleDtoAssignmentGroupEnum;
|
|
20712
20712
|
/** @min 0 */
|
|
20713
20713
|
firm_id?: number;
|
|
20714
20714
|
microservice_id: number;
|
|
@@ -20741,7 +20741,7 @@ export interface UmaCreateSecretNoteDto {
|
|
|
20741
20741
|
max_view_count: number;
|
|
20742
20742
|
name?: string;
|
|
20743
20743
|
note_params: Record<string, string>;
|
|
20744
|
-
type:
|
|
20744
|
+
type: UmaCreateSecretNoteDtoTypeEnum;
|
|
20745
20745
|
}
|
|
20746
20746
|
export interface UmaCreateTagDto {
|
|
20747
20747
|
name: string;
|
|
@@ -20790,7 +20790,7 @@ export interface UmaEndpointMetadataDto {
|
|
|
20790
20790
|
skip_email_verification_check?: boolean;
|
|
20791
20791
|
skip_mfa_enabled_check?: boolean;
|
|
20792
20792
|
skip_phone_verification_check?: boolean;
|
|
20793
|
-
user_type?:
|
|
20793
|
+
user_type?: UmaEndpointMetadataDtoUserTypeEnum;
|
|
20794
20794
|
}
|
|
20795
20795
|
export interface UmaEndpointMetadataSerializer {
|
|
20796
20796
|
admin_ui_permission_key: string;
|
|
@@ -20805,7 +20805,7 @@ export interface UmaEndpointSerializer {
|
|
|
20805
20805
|
is_active: boolean;
|
|
20806
20806
|
is_public: boolean;
|
|
20807
20807
|
metadata: UmaEndpointMetadataSerializer;
|
|
20808
|
-
method:
|
|
20808
|
+
method: UmaEndpointSerializerMethodEnum;
|
|
20809
20809
|
microservice: UmaMicroserviceSerializer;
|
|
20810
20810
|
microservice_id: number;
|
|
20811
20811
|
required_permissions: UmaPermissionSerializer[];
|
|
@@ -20969,7 +20969,7 @@ export interface UmaGetB2CUsersListFiltersDto {
|
|
|
20969
20969
|
permission_names?: string[];
|
|
20970
20970
|
phone_verified?: boolean;
|
|
20971
20971
|
role_ids?: number[];
|
|
20972
|
-
show_only?:
|
|
20972
|
+
show_only?: UmaGetB2CUsersListFiltersDtoShowOnlyEnum;
|
|
20973
20973
|
}
|
|
20974
20974
|
export interface UmaGetBranchesListDto {
|
|
20975
20975
|
count_branch_admins?: boolean;
|
|
@@ -21008,7 +21008,7 @@ export interface UmaGetFirmsListDto {
|
|
|
21008
21008
|
}
|
|
21009
21009
|
export interface UmaGetFirmsListFiltersDto {
|
|
21010
21010
|
ids?: number[];
|
|
21011
|
-
statuses?:
|
|
21011
|
+
statuses?: UmaGetFirmsListFiltersDtoStatusesEnum;
|
|
21012
21012
|
tag_ids?: number[];
|
|
21013
21013
|
}
|
|
21014
21014
|
export interface UmaGetIdentityProvidersListDto {
|
|
@@ -21020,7 +21020,7 @@ export interface UmaGetIdentityProvidersListDto {
|
|
|
21020
21020
|
export interface UmaGetIdentityProvidersListFiltersDto {
|
|
21021
21021
|
firm_ids?: number[];
|
|
21022
21022
|
ids?: number[];
|
|
21023
|
-
types?:
|
|
21023
|
+
types?: UmaGetIdentityProvidersListFiltersDtoTypesEnum[];
|
|
21024
21024
|
}
|
|
21025
21025
|
export interface UmaGetMicroservicesListDto {
|
|
21026
21026
|
filters?: UmaGetMicroservicesListFiltersDto;
|
|
@@ -21101,7 +21101,7 @@ export interface UmaGetUsersListFiltersDto {
|
|
|
21101
21101
|
permission_names?: string[];
|
|
21102
21102
|
phone_verified?: boolean;
|
|
21103
21103
|
role_ids?: number[];
|
|
21104
|
-
show_only?:
|
|
21104
|
+
show_only?: UmaGetUsersListFiltersDtoShowOnlyEnum;
|
|
21105
21105
|
}
|
|
21106
21106
|
export interface UmaGetWatchmenInstancesDto {
|
|
21107
21107
|
pagination: UmaPaginationDto;
|
|
@@ -21111,7 +21111,7 @@ export interface UmaGetWatchmenInstancesDto {
|
|
|
21111
21111
|
export interface UmaGetWebAuthnLoginChallengeDto {
|
|
21112
21112
|
/** @maxLength 255 */
|
|
21113
21113
|
email: string;
|
|
21114
|
-
user_type?:
|
|
21114
|
+
user_type?: UmaGetWebAuthnLoginChallengeDtoUserTypeEnum;
|
|
21115
21115
|
}
|
|
21116
21116
|
export interface UmaIdentityProviderSerializer {
|
|
21117
21117
|
auth_url: string;
|
|
@@ -21123,7 +21123,7 @@ export interface UmaIdentityProviderSerializer {
|
|
|
21123
21123
|
id: number;
|
|
21124
21124
|
priority: number;
|
|
21125
21125
|
redirect_url: string;
|
|
21126
|
-
type:
|
|
21126
|
+
type: UmaIdentityProviderSerializerTypeEnum;
|
|
21127
21127
|
updated_at: string;
|
|
21128
21128
|
}
|
|
21129
21129
|
export interface UmaImageDimensionsSerializer {
|
|
@@ -21146,7 +21146,7 @@ export interface UmaInitOAuthLoginSerializer {
|
|
|
21146
21146
|
export interface UmaLinkWatchmenUserToUmaDto {
|
|
21147
21147
|
/** @min 1 */
|
|
21148
21148
|
uma_user_id: number;
|
|
21149
|
-
uma_user_type:
|
|
21149
|
+
uma_user_type: UmaLinkWatchmenUserToUmaDtoUmaUserTypeEnum;
|
|
21150
21150
|
watchmen_instance_slug: string;
|
|
21151
21151
|
/** @min 1 */
|
|
21152
21152
|
watchmen_user_id: number;
|
|
@@ -21231,7 +21231,7 @@ export interface UmaPermissionMetadataSerializer {
|
|
|
21231
21231
|
is_microservice_global: boolean;
|
|
21232
21232
|
}
|
|
21233
21233
|
export interface UmaPermissionSerializer {
|
|
21234
|
-
assignment_group:
|
|
21234
|
+
assignment_group: UmaPermissionSerializerAssignmentGroupEnum;
|
|
21235
21235
|
created_at: string;
|
|
21236
21236
|
/** @example 1 */
|
|
21237
21237
|
id: number;
|
|
@@ -21288,7 +21288,7 @@ export interface UmaResetPasswordSettingsSerializer {
|
|
|
21288
21288
|
export interface UmaRevokeUserSessionsDto {
|
|
21289
21289
|
/** @min 1 */
|
|
21290
21290
|
user_id: number;
|
|
21291
|
-
user_type:
|
|
21291
|
+
user_type: UmaRevokeUserSessionsDtoUserTypeEnum;
|
|
21292
21292
|
}
|
|
21293
21293
|
export interface UmaRoleSerializer {
|
|
21294
21294
|
assignment_group: UmaPermissionAG;
|
|
@@ -21318,7 +21318,7 @@ export interface UmaSecretNoteSerializer {
|
|
|
21318
21318
|
id: string;
|
|
21319
21319
|
name: string;
|
|
21320
21320
|
note_params: Record<string, string>;
|
|
21321
|
-
type:
|
|
21321
|
+
type: UmaSecretNoteSerializerTypeEnum;
|
|
21322
21322
|
views_left: number;
|
|
21323
21323
|
}
|
|
21324
21324
|
export interface UmaSendB2BMfaCodeDto {
|
|
@@ -21329,7 +21329,7 @@ export interface UmaSendB2BMfaCodeDto {
|
|
|
21329
21329
|
* @example "test@gmail.com"
|
|
21330
21330
|
*/
|
|
21331
21331
|
email: string;
|
|
21332
|
-
type:
|
|
21332
|
+
type: UmaSendB2BMfaCodeDtoTypeEnum;
|
|
21333
21333
|
}
|
|
21334
21334
|
export interface UmaSendB2CMfaCodeDto {
|
|
21335
21335
|
/** @maxLength 255 */
|
|
@@ -21339,17 +21339,17 @@ export interface UmaSendB2CMfaCodeDto {
|
|
|
21339
21339
|
* @example "test@gmail.com"
|
|
21340
21340
|
*/
|
|
21341
21341
|
login: string;
|
|
21342
|
-
type:
|
|
21342
|
+
type: UmaSendB2CMfaCodeDtoTypeEnum;
|
|
21343
21343
|
}
|
|
21344
21344
|
export interface UmaSendB2CResetPasswordCodeDto {
|
|
21345
21345
|
auth_form_slug: string;
|
|
21346
|
-
code_type?:
|
|
21346
|
+
code_type?: UmaSendB2CResetPasswordCodeDtoCodeTypeEnum;
|
|
21347
21347
|
contact: string;
|
|
21348
|
-
reset_type:
|
|
21348
|
+
reset_type: UmaSendB2CResetPasswordCodeDtoResetTypeEnum;
|
|
21349
21349
|
}
|
|
21350
21350
|
export interface UmaSendResetPasswordCodeDto {
|
|
21351
21351
|
contact: string;
|
|
21352
|
-
type:
|
|
21352
|
+
type: UmaSendResetPasswordCodeDtoTypeEnum;
|
|
21353
21353
|
}
|
|
21354
21354
|
export interface UmaSendVerificationCodeForSecretNoteDto {
|
|
21355
21355
|
/** @maxLength 255 */
|
|
@@ -21437,7 +21437,7 @@ export interface UmaTagSerializer {
|
|
|
21437
21437
|
updated_at: string;
|
|
21438
21438
|
}
|
|
21439
21439
|
export interface UmaTenantSettingDto {
|
|
21440
|
-
label:
|
|
21440
|
+
label: UmaTenantSettingDtoLabelEnum;
|
|
21441
21441
|
value: string;
|
|
21442
21442
|
}
|
|
21443
21443
|
export enum UmaTenantSettingLabel {
|
|
@@ -21466,7 +21466,7 @@ export interface UmaUpdateAPIKeysDto {
|
|
|
21466
21466
|
export interface UmaUpdateAuthAppDto {
|
|
21467
21467
|
/** @maxLength 255 */
|
|
21468
21468
|
name: string;
|
|
21469
|
-
status:
|
|
21469
|
+
status: UmaUpdateAuthAppDtoStatusEnum;
|
|
21470
21470
|
}
|
|
21471
21471
|
export interface UmaUpdateB2BUserDto {
|
|
21472
21472
|
allow_feedback?: boolean;
|
|
@@ -21552,13 +21552,13 @@ export interface UmaUpdateEndpointDto {
|
|
|
21552
21552
|
is_active?: boolean;
|
|
21553
21553
|
is_public?: boolean;
|
|
21554
21554
|
metadata?: UmaEndpointMetadataDto;
|
|
21555
|
-
method:
|
|
21555
|
+
method: UmaUpdateEndpointDtoMethodEnum;
|
|
21556
21556
|
/** @min 1 */
|
|
21557
21557
|
microservice_id: number;
|
|
21558
21558
|
required_permissions?: number[];
|
|
21559
21559
|
/** @maxLength 255 */
|
|
21560
21560
|
route: string;
|
|
21561
|
-
type?:
|
|
21561
|
+
type?: UmaUpdateEndpointDtoTypeEnum;
|
|
21562
21562
|
updated_at: string;
|
|
21563
21563
|
}
|
|
21564
21564
|
export interface UmaUpdateFirmDto {
|
|
@@ -21569,7 +21569,7 @@ export interface UmaUpdateFirmDto {
|
|
|
21569
21569
|
name: string;
|
|
21570
21570
|
/** @maxLength 255 */
|
|
21571
21571
|
slug: string;
|
|
21572
|
-
status:
|
|
21572
|
+
status: UmaUpdateFirmDtoStatusEnum;
|
|
21573
21573
|
twilio_creds?: UmaFirmTwilioCredsDto;
|
|
21574
21574
|
updated_at: string;
|
|
21575
21575
|
}
|
|
@@ -21588,7 +21588,7 @@ export interface UmaUpdateIdentityProviderDto {
|
|
|
21588
21588
|
priority: number;
|
|
21589
21589
|
/** @maxLength 1000 */
|
|
21590
21590
|
redirect_url?: string;
|
|
21591
|
-
type:
|
|
21591
|
+
type: UmaUpdateIdentityProviderDtoTypeEnum;
|
|
21592
21592
|
updated_at: string;
|
|
21593
21593
|
}
|
|
21594
21594
|
export interface UmaUpdateMicroserviceDto {
|
|
@@ -21604,7 +21604,7 @@ export interface UmaUpdateMicroserviceDto {
|
|
|
21604
21604
|
updated_at: string;
|
|
21605
21605
|
}
|
|
21606
21606
|
export interface UmaUpdatePermissionDto {
|
|
21607
|
-
assignment_group?:
|
|
21607
|
+
assignment_group?: UmaUpdatePermissionDtoAssignmentGroupEnum;
|
|
21608
21608
|
metadata?: UmaPermissionMetadata;
|
|
21609
21609
|
microservice_id?: number;
|
|
21610
21610
|
/** @maxLength 1000 */
|
|
@@ -21668,7 +21668,7 @@ export interface UmaUpsertUserDto {
|
|
|
21668
21668
|
phone?: string;
|
|
21669
21669
|
rep_code?: string;
|
|
21670
21670
|
roles: number[];
|
|
21671
|
-
type:
|
|
21671
|
+
type: UmaUpsertUserDtoTypeEnum;
|
|
21672
21672
|
}
|
|
21673
21673
|
export interface UmaUpsertUsersDto {
|
|
21674
21674
|
/** @maxItems 100 */
|
|
@@ -21712,7 +21712,7 @@ export interface UmaVerificationSettingsSerializer {
|
|
|
21712
21712
|
}
|
|
21713
21713
|
export interface UmaVerifyContactDto {
|
|
21714
21714
|
code: string;
|
|
21715
|
-
code_type:
|
|
21715
|
+
code_type: UmaVerifyContactDtoCodeTypeEnum;
|
|
21716
21716
|
contact: string;
|
|
21717
21717
|
}
|
|
21718
21718
|
export interface UmaVerifyWatchmenAuthTokenDto {
|
|
@@ -21848,34 +21848,34 @@ export interface UmaWatchmenInstanceMutationSerializer {
|
|
|
21848
21848
|
status: number;
|
|
21849
21849
|
watchmen_instance: UmaWatchmenInstanceSerializer;
|
|
21850
21850
|
}
|
|
21851
|
-
export enum
|
|
21851
|
+
export enum UmaAuthFormDtoResetPasswordTypeEnum {
|
|
21852
21852
|
ByContactCode = "by_contact_code",
|
|
21853
21853
|
ByEmailLink = "by_email_link"
|
|
21854
21854
|
}
|
|
21855
|
-
export enum
|
|
21855
|
+
export enum UmaAuthFormSerializerResetPasswordTypeEnum {
|
|
21856
21856
|
ByContactCode = "by_contact_code",
|
|
21857
21857
|
ByEmailLink = "by_email_link"
|
|
21858
21858
|
}
|
|
21859
|
-
export enum
|
|
21859
|
+
export enum UmaB2BSendContactChangeCodeDtoTypeEnum {
|
|
21860
21860
|
Email = "email",
|
|
21861
21861
|
Voice = "voice",
|
|
21862
21862
|
Sms = "sms"
|
|
21863
21863
|
}
|
|
21864
|
-
export enum
|
|
21864
|
+
export enum UmaB2CResetPasswordDtoResetTypeEnum {
|
|
21865
21865
|
ByContactCode = "by_contact_code",
|
|
21866
21866
|
ByEmailLink = "by_email_link"
|
|
21867
21867
|
}
|
|
21868
|
-
export enum
|
|
21868
|
+
export enum UmaB2CSendContactChangeCodeDtoTypeEnum {
|
|
21869
21869
|
Email = "email",
|
|
21870
21870
|
Voice = "voice",
|
|
21871
21871
|
Sms = "sms"
|
|
21872
21872
|
}
|
|
21873
|
-
export enum
|
|
21873
|
+
export enum UmaB2CSendVerificationCodeDtoCodeTypeEnum {
|
|
21874
21874
|
Email = "email",
|
|
21875
21875
|
Voice = "voice",
|
|
21876
21876
|
Sms = "sms"
|
|
21877
21877
|
}
|
|
21878
|
-
export enum
|
|
21878
|
+
export enum UmaCreateEndpointDtoMethodEnum {
|
|
21879
21879
|
POST = "POST",
|
|
21880
21880
|
PUT = "PUT",
|
|
21881
21881
|
DELETE = "DELETE",
|
|
@@ -21883,31 +21883,31 @@ export enum UmaUmaCreateEndpointDtoMethodEnum {
|
|
|
21883
21883
|
PATCH = "PATCH",
|
|
21884
21884
|
ALL = "ALL"
|
|
21885
21885
|
}
|
|
21886
|
-
export enum
|
|
21886
|
+
export enum UmaCreateEndpointDtoTypeEnum {
|
|
21887
21887
|
Regular = "regular",
|
|
21888
21888
|
DisplayOnly = "display_only"
|
|
21889
21889
|
}
|
|
21890
|
-
export enum
|
|
21890
|
+
export enum UmaCreateIdentityProviderDtoTypeEnum {
|
|
21891
21891
|
Okta = "okta"
|
|
21892
21892
|
}
|
|
21893
|
-
export enum
|
|
21893
|
+
export enum UmaCreatePermissionDtoAssignmentGroupEnum {
|
|
21894
21894
|
Regular = "regular",
|
|
21895
21895
|
Superadmin = "superadmin",
|
|
21896
21896
|
B2BOnly = "b2b_only"
|
|
21897
21897
|
}
|
|
21898
|
-
export enum
|
|
21898
|
+
export enum UmaCreateRoleDtoAssignmentGroupEnum {
|
|
21899
21899
|
Regular = "regular",
|
|
21900
21900
|
Superadmin = "superadmin",
|
|
21901
21901
|
B2BOnly = "b2b_only"
|
|
21902
21902
|
}
|
|
21903
|
-
export enum
|
|
21903
|
+
export enum UmaCreateSecretNoteDtoTypeEnum {
|
|
21904
21904
|
Password = "password"
|
|
21905
21905
|
}
|
|
21906
|
-
export enum
|
|
21906
|
+
export enum UmaEndpointMetadataDtoUserTypeEnum {
|
|
21907
21907
|
B2B = "b2b",
|
|
21908
21908
|
B2C = "b2c"
|
|
21909
21909
|
}
|
|
21910
|
-
export enum
|
|
21910
|
+
export enum UmaEndpointSerializerMethodEnum {
|
|
21911
21911
|
POST = "POST",
|
|
21912
21912
|
PUT = "PUT",
|
|
21913
21913
|
DELETE = "DELETE",
|
|
@@ -21915,82 +21915,82 @@ export enum UmaUmaEndpointSerializerMethodEnum {
|
|
|
21915
21915
|
PATCH = "PATCH",
|
|
21916
21916
|
ALL = "ALL"
|
|
21917
21917
|
}
|
|
21918
|
-
export enum
|
|
21918
|
+
export enum UmaGetB2CUsersListFiltersDtoShowOnlyEnum {
|
|
21919
21919
|
Admin = "admin",
|
|
21920
21920
|
BranchAdmin = "branch_admin",
|
|
21921
21921
|
Compliance = "compliance"
|
|
21922
21922
|
}
|
|
21923
|
-
export enum
|
|
21923
|
+
export enum UmaGetFirmsListFiltersDtoStatusesEnum {
|
|
21924
21924
|
InProgress = "in_progress",
|
|
21925
21925
|
Active = "active",
|
|
21926
21926
|
Suspended = "suspended",
|
|
21927
21927
|
Deleted = "deleted"
|
|
21928
21928
|
}
|
|
21929
|
-
export enum
|
|
21929
|
+
export enum UmaGetIdentityProvidersListFiltersDtoTypesEnum {
|
|
21930
21930
|
Okta = "okta"
|
|
21931
21931
|
}
|
|
21932
|
-
export enum
|
|
21932
|
+
export enum UmaGetUsersListFiltersDtoShowOnlyEnum {
|
|
21933
21933
|
Admin = "admin",
|
|
21934
21934
|
BranchAdmin = "branch_admin",
|
|
21935
21935
|
Compliance = "compliance"
|
|
21936
21936
|
}
|
|
21937
|
-
export enum
|
|
21937
|
+
export enum UmaGetWebAuthnLoginChallengeDtoUserTypeEnum {
|
|
21938
21938
|
B2B = "b2b",
|
|
21939
21939
|
B2C = "b2c"
|
|
21940
21940
|
}
|
|
21941
|
-
export enum
|
|
21941
|
+
export enum UmaIdentityProviderSerializerTypeEnum {
|
|
21942
21942
|
Okta = "okta"
|
|
21943
21943
|
}
|
|
21944
|
-
export enum
|
|
21944
|
+
export enum UmaLinkWatchmenUserToUmaDtoUmaUserTypeEnum {
|
|
21945
21945
|
B2B = "b2b",
|
|
21946
21946
|
B2C = "b2c"
|
|
21947
21947
|
}
|
|
21948
|
-
export enum
|
|
21948
|
+
export enum UmaPermissionSerializerAssignmentGroupEnum {
|
|
21949
21949
|
Regular = "regular",
|
|
21950
21950
|
Chiefadmin = "chiefadmin",
|
|
21951
21951
|
Superadmin = "superadmin"
|
|
21952
21952
|
}
|
|
21953
|
-
export enum
|
|
21953
|
+
export enum UmaRevokeUserSessionsDtoUserTypeEnum {
|
|
21954
21954
|
B2B = "b2b",
|
|
21955
21955
|
B2C = "b2c"
|
|
21956
21956
|
}
|
|
21957
|
-
export enum
|
|
21957
|
+
export enum UmaSecretNoteSerializerTypeEnum {
|
|
21958
21958
|
Password = "password"
|
|
21959
21959
|
}
|
|
21960
|
-
export enum
|
|
21960
|
+
export enum UmaSendB2BMfaCodeDtoTypeEnum {
|
|
21961
21961
|
Email = "email",
|
|
21962
21962
|
Voice = "voice",
|
|
21963
21963
|
Sms = "sms"
|
|
21964
21964
|
}
|
|
21965
|
-
export enum
|
|
21965
|
+
export enum UmaSendB2CMfaCodeDtoTypeEnum {
|
|
21966
21966
|
Email = "email",
|
|
21967
21967
|
Voice = "voice",
|
|
21968
21968
|
Sms = "sms"
|
|
21969
21969
|
}
|
|
21970
|
-
export enum
|
|
21970
|
+
export enum UmaSendB2CResetPasswordCodeDtoCodeTypeEnum {
|
|
21971
21971
|
Email = "email",
|
|
21972
21972
|
Voice = "voice",
|
|
21973
21973
|
Sms = "sms"
|
|
21974
21974
|
}
|
|
21975
|
-
export enum
|
|
21975
|
+
export enum UmaSendB2CResetPasswordCodeDtoResetTypeEnum {
|
|
21976
21976
|
ByContactCode = "by_contact_code",
|
|
21977
21977
|
ByEmailLink = "by_email_link"
|
|
21978
21978
|
}
|
|
21979
|
-
export enum
|
|
21979
|
+
export enum UmaSendResetPasswordCodeDtoTypeEnum {
|
|
21980
21980
|
Email = "email",
|
|
21981
21981
|
Voice = "voice",
|
|
21982
21982
|
Sms = "sms"
|
|
21983
21983
|
}
|
|
21984
|
-
export enum
|
|
21984
|
+
export enum UmaTenantSettingDtoLabelEnum {
|
|
21985
21985
|
StorePasswordHistoryForDays = "store_password_history_for_days",
|
|
21986
21986
|
ResetPasswordIfUserInactiveForDays = "reset_password_if_user_inactive_for_days",
|
|
21987
21987
|
PeriodicallyResetPasswordAfterDays = "periodically_reset_password_after_days"
|
|
21988
21988
|
}
|
|
21989
|
-
export enum
|
|
21989
|
+
export enum UmaUpdateAuthAppDtoStatusEnum {
|
|
21990
21990
|
Active = "active",
|
|
21991
21991
|
Disabled = "disabled"
|
|
21992
21992
|
}
|
|
21993
|
-
export enum
|
|
21993
|
+
export enum UmaUpdateEndpointDtoMethodEnum {
|
|
21994
21994
|
POST = "POST",
|
|
21995
21995
|
PUT = "PUT",
|
|
21996
21996
|
DELETE = "DELETE",
|
|
@@ -21998,29 +21998,29 @@ export enum UmaUmaUpdateEndpointDtoMethodEnum {
|
|
|
21998
21998
|
PATCH = "PATCH",
|
|
21999
21999
|
ALL = "ALL"
|
|
22000
22000
|
}
|
|
22001
|
-
export enum
|
|
22001
|
+
export enum UmaUpdateEndpointDtoTypeEnum {
|
|
22002
22002
|
Regular = "regular",
|
|
22003
22003
|
DisplayOnly = "display_only"
|
|
22004
22004
|
}
|
|
22005
|
-
export enum
|
|
22005
|
+
export enum UmaUpdateFirmDtoStatusEnum {
|
|
22006
22006
|
InProgress = "in_progress",
|
|
22007
22007
|
Active = "active",
|
|
22008
22008
|
Suspended = "suspended",
|
|
22009
22009
|
Deleted = "deleted"
|
|
22010
22010
|
}
|
|
22011
|
-
export enum
|
|
22011
|
+
export enum UmaUpdateIdentityProviderDtoTypeEnum {
|
|
22012
22012
|
Okta = "okta"
|
|
22013
22013
|
}
|
|
22014
|
-
export enum
|
|
22014
|
+
export enum UmaUpdatePermissionDtoAssignmentGroupEnum {
|
|
22015
22015
|
Regular = "regular",
|
|
22016
22016
|
Superadmin = "superadmin",
|
|
22017
22017
|
B2BOnly = "b2b_only"
|
|
22018
22018
|
}
|
|
22019
|
-
export enum
|
|
22019
|
+
export enum UmaUpsertUserDtoTypeEnum {
|
|
22020
22020
|
B2B = "b2b",
|
|
22021
22021
|
B2C = "b2c"
|
|
22022
22022
|
}
|
|
22023
|
-
export enum
|
|
22023
|
+
export enum UmaVerifyContactDtoCodeTypeEnum {
|
|
22024
22024
|
Email = "email",
|
|
22025
22025
|
Voice = "voice",
|
|
22026
22026
|
Sms = "sms"
|
|
@@ -23377,13 +23377,13 @@ export class WatchmenInstances<HandleError extends boolean = boolean> {
|
|
|
23377
23377
|
declare class _B2BAuth1<HandleError extends boolean = boolean> extends B2BAuth<HandleError> {
|
|
23378
23378
|
basicLogin(basicLoginParams: UmaBasicB2BLoginDto, headers?: {
|
|
23379
23379
|
'Debug-Token'?: string;
|
|
23380
|
-
}, config?: RequestConfig<HandleError> | undefined): Promise<
|
|
23380
|
+
}, config?: RequestConfig<HandleError> | undefined): Promise<ClientResponse<UmaBasicB2BLoginSerializer, HandleError>>;
|
|
23381
23381
|
}
|
|
23382
23382
|
declare class _B2CAuth1<HandleError extends boolean = boolean> extends B2CAuth<HandleError> {
|
|
23383
23383
|
basicLogin(basicLoginParams: UmaBasicB2CLoginDto, headers?: {
|
|
23384
23384
|
BRANCH?: string;
|
|
23385
23385
|
FIRM?: string;
|
|
23386
|
-
}, config?: RequestConfig<HandleError> | undefined): Promise<
|
|
23386
|
+
}, config?: RequestConfig<HandleError> | undefined): Promise<ClientResponse<UmaB2CLoginResultSerializer, HandleError>>;
|
|
23387
23387
|
}
|
|
23388
23388
|
export interface UmaClientConfig<HandleError extends boolean = boolean> extends JwtClientConfig<HandleError> {
|
|
23389
23389
|
firmId: string;
|