@orbis-systems/orbis-api-clients 1.3.2 → 1.4.1

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 (37) hide show
  1. package/dist/aesmidas/index.d.ts +353 -166
  2. package/dist/aesmidas/index.d.ts.map +1 -1
  3. package/dist/aesmidas/index.esm.js +1 -1
  4. package/dist/aesmidas/index.esm.js.map +1 -1
  5. package/dist/aesmidas/index.js +1 -1
  6. package/dist/aesmidas/index.js.map +1 -1
  7. package/dist/bridgewise/index.d.ts +11749 -5934
  8. package/dist/bridgewise/index.d.ts.map +1 -1
  9. package/dist/bridgewise/index.esm.js +1 -1
  10. package/dist/bridgewise/index.esm.js.map +1 -1
  11. package/dist/bridgewise/index.js +1 -1
  12. package/dist/bridgewise/index.js.map +1 -1
  13. package/dist/insight/index.d.ts +131 -2
  14. package/dist/insight/index.d.ts.map +1 -1
  15. package/dist/insight/index.esm.js +1 -1
  16. package/dist/insight/index.esm.js.map +1 -1
  17. package/dist/insight/index.js +1 -1
  18. package/dist/insight/index.js.map +1 -1
  19. package/dist/middleware/index.d.ts +206 -52
  20. package/dist/middleware/index.d.ts.map +1 -1
  21. package/dist/middleware/index.esm.js +1 -1
  22. package/dist/middleware/index.esm.js.map +1 -1
  23. package/dist/middleware/index.js +1 -1
  24. package/dist/middleware/index.js.map +1 -1
  25. package/dist/orbis/index.d.ts +56 -50
  26. package/dist/orbis/index.d.ts.map +1 -1
  27. package/dist/orbis/index.esm.js +1 -1
  28. package/dist/orbis/index.esm.js.map +1 -1
  29. package/dist/orbis/index.js +1 -1
  30. package/dist/orbis/index.js.map +1 -1
  31. package/dist/uma/index.d.ts +981 -91
  32. package/dist/uma/index.d.ts.map +1 -1
  33. package/dist/uma/index.esm.js +1 -1
  34. package/dist/uma/index.esm.js.map +1 -1
  35. package/dist/uma/index.js +1 -1
  36. package/dist/uma/index.js.map +1 -1
  37. package/package.json +1 -1
@@ -114,6 +114,10 @@ export enum UmaCodeType {
114
114
  SMSCodeType = "sms",
115
115
  VoiceCodeType = "voice"
116
116
  }
117
+ export enum UmaB2CImpersonateResponseMode {
118
+ TokensImpersonateResponseMode = "tokens",
119
+ AuthCodeImpersonateResponseMode = "auth_code"
120
+ }
117
121
  export enum UmaUserType {
118
122
  B2BUserType = "b2b",
119
123
  SystemUserType = "system",
@@ -224,6 +228,8 @@ export enum UmaErrorCode {
224
228
  ThirdForbiddenErr = 4032,
225
229
  FourthForbiddenErr = 4033,
226
230
  FifthForbiddenErr = 4034,
231
+ AmbiguousFirmBranchErr = 4035,
232
+ DefaultRolesNotFoundErr = 4036,
227
233
  EntitiesChoiceNotAllowed = 4303,
228
234
  BodyParsingErr = 4403,
229
235
  UpdateOfOldEntityStateErr = 4503,
@@ -248,6 +254,7 @@ export enum UmaErrorCode {
248
254
  ForbiddenByFirmsStatusErr = 4292,
249
255
  NotAcceptableError = 4600,
250
256
  InternalServerErr = 5000,
257
+ BadGatewayErr = 5020,
251
258
  InvalidRequest = 6000
252
259
  }
253
260
  export enum UmaTokenType {
@@ -259,7 +266,6 @@ export enum UmaTokenOrigin {
259
266
  UserTokenOrigin = "user"
260
267
  }
261
268
  export enum UmaTokenGenerationMode {
262
- StandardTokenGenerationMode = "standard",
263
269
  MinifiedTokenGenerationMode = "minified"
264
270
  }
265
271
  export enum UmaResetPasswordType {
@@ -317,6 +323,47 @@ export interface UmaGetAdminAPIKeysSerializer {
317
323
  status: number;
318
324
  total_records: number;
319
325
  }
326
+ export interface UmaAIAssistantChatMutationSerializer {
327
+ chat: UmaAIAssistantChatSerializer;
328
+ status: number;
329
+ }
330
+ export interface UmaAIAssistantChatsListSerializer {
331
+ chats: UmaAIAssistantChatSerializer[];
332
+ status: number;
333
+ }
334
+ export interface UmaAIAssistantHistoryResultSerializer {
335
+ chat_id: number;
336
+ /** LockedForSeconds is the off-topic lock left on THIS chat only; other chats are unaffected. */
337
+ locked_for_seconds: number;
338
+ messages: UmaAIAssistantMessageSerializer[];
339
+ }
340
+ export interface UmaAIAssistantHistorySerializer {
341
+ history: UmaAIAssistantHistoryResultSerializer;
342
+ status: number;
343
+ }
344
+ export interface UmaAIAssistantQuestionLogDetailsSerializer {
345
+ messages: UmaAIAssistantMessageSerializer[];
346
+ question: UmaAIAssistantQuestionLogSerializer;
347
+ status: number;
348
+ }
349
+ export interface UmaAIAssistantQuestionLogListSerializer {
350
+ current_page: number;
351
+ pages_count: number;
352
+ question_log: UmaAIAssistantQuestionLogSerializer[];
353
+ status: number;
354
+ total_records: number;
355
+ }
356
+ export interface UmaAllowedEmailMutationSerializer {
357
+ allowed_email: UmaAllowedEmailSerializer;
358
+ status: number;
359
+ }
360
+ export interface UmaGetAllowedEmailsListSerializer {
361
+ allowed_emails_list: UmaAllowedEmailSerializer[];
362
+ current_page: number;
363
+ pages_count: number;
364
+ status: number;
365
+ total_records: number;
366
+ }
320
367
  export interface UmaAllowedOriginMutationSerializer {
321
368
  allowed_origin: UmaAllowedOriginSerializer;
322
369
  status: number;
@@ -428,6 +475,8 @@ export interface UmaGetCurrentB2CUserSerializer {
428
475
  status: number;
429
476
  }
430
477
  export interface UmaImpersonateResultSerializer {
478
+ auth_code: string;
479
+ state: string;
431
480
  status: number;
432
481
  tokens: UmaTokens;
433
482
  }
@@ -457,6 +506,17 @@ export interface UmaB2CUserSettingsChangeSerializer {
457
506
  settings: UmaB2CUserSettingsSerializer;
458
507
  status: number;
459
508
  }
509
+ export interface UmaBlockedEmailMutationSerializer {
510
+ blocked_email: UmaBlockedEmailSerializer;
511
+ status: number;
512
+ }
513
+ export interface UmaGetBlockedEmailsListSerializer {
514
+ blocked_emails_list: UmaBlockedEmailSerializer[];
515
+ current_page: number;
516
+ pages_count: number;
517
+ status: number;
518
+ total_records: number;
519
+ }
460
520
  export interface UmaBranchMutationSerializer {
461
521
  branch: UmaBranchAdminSerializer;
462
522
  status: number;
@@ -477,24 +537,32 @@ export interface UmaAccessControlProhibitionReason {
477
537
  export interface UmaClaims {
478
538
  '2fa_on'?: boolean;
479
539
  admin_of_firm_ids?: number[];
540
+ admin_of_firm_ids_new?: string[];
480
541
  aud?: string;
481
542
  branch_ids?: number[];
543
+ branch_ids_new?: string[];
482
544
  client_platform?: string;
483
545
  email_verif?: boolean;
484
546
  exp?: number;
485
547
  firm_ids?: number[];
548
+ firm_ids_new?: string[];
486
549
  gen_mode?: UmaTokenGenerationMode;
487
550
  have_access_to_all_firm_branches?: boolean;
488
551
  iat?: number;
489
552
  iss?: string;
490
553
  jti?: string;
491
554
  microservice_ids?: number[];
555
+ microservice_ids_new?: string[];
492
556
  nbf?: number;
493
557
  origin_id?: number;
558
+ origin_uuid?: string;
494
559
  pair_id?: string;
495
560
  permissions?: string[];
496
561
  phone_verif?: boolean;
562
+ region?: string;
563
+ regional_permissions?: Record<string, string[]>;
497
564
  sub?: string;
565
+ subject_uuid?: string;
498
566
  t_origin?: UmaTokenOrigin;
499
567
  t_type?: UmaTokenType;
500
568
  u_type?: UmaAuthUserType;
@@ -511,6 +579,17 @@ export interface UmaGetCountriesSerializer {
511
579
  countries: UmaCountrySerializer[];
512
580
  status: number;
513
581
  }
582
+ export interface UmaDefaultB2CRegistrationRoleMutationSerializer {
583
+ default_b2c_registration_role: UmaDefaultB2CRegistrationRoleSerializer;
584
+ status: number;
585
+ }
586
+ export interface UmaGetDefaultB2CRegistrationRolesListSerializer {
587
+ current_page: number;
588
+ default_b2c_registration_roles_list: UmaDefaultB2CRegistrationRoleSerializer[];
589
+ pages_count: number;
590
+ status: number;
591
+ total_records: number;
592
+ }
514
593
  export interface UmaEmailDomainMutationSerializer {
515
594
  email_domain: UmaEmailDomainSerializer;
516
595
  status: number;
@@ -534,12 +613,12 @@ export interface UmaGetEndpointsListSerializer {
534
613
  total_records: number;
535
614
  }
536
615
  export interface UmaFirmMutationSerializer {
537
- firm: UmaFirmSerializer;
616
+ firm: UmaFirmWithCredsSerializer;
538
617
  status: number;
539
618
  }
540
619
  export interface UmaGetFirmsListSerializer {
541
620
  current_page: number;
542
- firms_list: UmaFirmSerializer[];
621
+ firms_list: UmaFirmWithCredsSerializer[];
543
622
  pages_count: number;
544
623
  status: number;
545
624
  total_records: number;
@@ -605,6 +684,14 @@ export interface UmaPublicSettingsResponseSerializer {
605
684
  settings: UmaPublicSettingsSerializer;
606
685
  status: number;
607
686
  }
687
+ export interface UmaGetRegionSerializer {
688
+ region: UmaRegionSerializer;
689
+ status: number;
690
+ }
691
+ export interface UmaGetRegionsSerializer {
692
+ regions: UmaRegionSerializer[];
693
+ status: number;
694
+ }
608
695
  export interface UmaGetRolesListSerializer {
609
696
  current_page: number;
610
697
  pages_count: number;
@@ -676,6 +763,49 @@ export interface UmaGetTrustedDevicesListSerializer {
676
763
  total_records: number;
677
764
  trusted_devices_list: UmaTrustedDeviceSerializer[];
678
765
  }
766
+ export interface UmaAIAssistantAnswerSerializer {
767
+ answer_found: boolean;
768
+ category: string;
769
+ chat_id: number;
770
+ chat_name: string;
771
+ links: UmaAIAssistantLinkSerializer[];
772
+ locked_for_seconds: number;
773
+ message: string;
774
+ }
775
+ export interface UmaAIAssistantChatSerializer {
776
+ created_at: string;
777
+ id: number;
778
+ last_message_at: string;
779
+ locked_for_seconds: number;
780
+ name: string;
781
+ pinned: boolean;
782
+ pinned_at: string;
783
+ summary: string;
784
+ updated_at: string;
785
+ }
786
+ export interface UmaAIAssistantLinkSerializer {
787
+ key: string;
788
+ path: string;
789
+ title: string;
790
+ }
791
+ export interface UmaAIAssistantMessageSerializer {
792
+ answer_found: boolean;
793
+ category: string;
794
+ content: string;
795
+ created_at: string;
796
+ links: UmaAIAssistantLinkSerializer[];
797
+ role: string;
798
+ }
799
+ export interface UmaAIAssistantQuestionLogSerializer {
800
+ answered: boolean;
801
+ category: string;
802
+ chat_id: number;
803
+ chat_name: string;
804
+ created_at: string;
805
+ id: number;
806
+ question: string;
807
+ screen: string;
808
+ }
679
809
  export interface UmaAPIKeys {
680
810
  ac_same_as_for_user?: boolean;
681
811
  api_key?: string;
@@ -687,30 +817,37 @@ export interface UmaAPIKeys {
687
817
  microservices?: UmaMicroserviceSerializer[];
688
818
  name?: string;
689
819
  permissions?: UmaPermissionSerializer[];
820
+ region?: string;
690
821
  roles?: UmaRoleSerializer[];
691
822
  updated_at?: string;
823
+ uuid?: string;
692
824
  }
693
825
  export interface UmaAPIKeysB2BLoginDto {
694
826
  api_key?: string;
695
827
  api_secret?: string;
696
- token_generation_mode?: UmaTokenGenerationMode;
697
828
  }
698
829
  export interface UmaAccessBulkChangesInt {
699
830
  add?: number[];
700
831
  remove?: number[];
701
832
  }
833
+ export interface UmaAccessBulkChangesUuidUUID {
834
+ add?: string[];
835
+ remove?: string[];
836
+ }
702
837
  export interface UmaActionLogEntityFilterDto {
703
838
  entity_id?: number;
704
839
  entity_name?: string;
840
+ entity_uuid?: string;
705
841
  }
706
842
  export interface UmaActionLogSerializer {
707
843
  action_type: string;
708
844
  created_at: string;
709
845
  entity_id: number;
710
846
  entity_name: string;
847
+ entity_uuid: string;
711
848
  id: number;
712
849
  initiator: UmaUserSerializer;
713
- initiator_id: number;
850
+ initiator_id: string;
714
851
  new_state: Record<string, any>;
715
852
  prev_state: Record<string, any>;
716
853
  trigger_type: string;
@@ -732,10 +869,12 @@ export interface UmaAdminAPIKeySerializer {
732
869
  microservices: UmaMicroserviceSerializer[];
733
870
  name: string;
734
871
  permissions: UmaPermissionSerializer[];
872
+ region: string;
735
873
  roles: UmaRoleSerializer[];
736
874
  updated_at: string;
737
875
  user: UmaUserSerializer;
738
876
  user_type: string;
877
+ uuid: string;
739
878
  }
740
879
  export interface UmaAdminB2BUserSerializer {
741
880
  access_revoking_date: string;
@@ -762,8 +901,11 @@ export interface UmaAdminB2BUserSerializer {
762
901
  /** @example 1 */
763
902
  id: number;
764
903
  initiator_id: number;
904
+ initiator_uuid: string;
765
905
  is_delete_allowed: boolean;
766
906
  is_edit_allowed: boolean;
907
+ /** @example "2022-02-02T00:00:00Z" */
908
+ last_login_at: string;
767
909
  /** @example "Jenkins" */
768
910
  last_name: string;
769
911
  locale: UmaLocaleSerializer;
@@ -772,18 +914,19 @@ export interface UmaAdminB2BUserSerializer {
772
914
  mfa_enabled: boolean;
773
915
  microservices: UmaMicroserviceSerializer[];
774
916
  mode: string;
775
- permissions: UmaPermissionSerializer[];
917
+ permissions: UmaPermissionAccessSerializer[];
776
918
  /** @example "+123478844" */
777
919
  phone: string;
778
920
  /** @example true */
779
921
  phone_verified: boolean;
780
922
  primary_firm_id: number;
781
- rep_code: string;
782
- roles: UmaRoleSerializer[];
923
+ primary_firm_uuid: string;
924
+ region: string;
925
+ roles: UmaRoleAccessSerializer[];
783
926
  should_reset_password: boolean;
784
927
  small_avatar_url: string;
785
928
  status: UmaUserStatus;
786
- status_change_by_id: number;
929
+ status_change_by_id: string;
787
930
  status_change_notes: string;
788
931
  status_change_reason: UmaUserStatusChangeReasonSerializer;
789
932
  status_change_reason_id: number;
@@ -794,6 +937,7 @@ export interface UmaAdminB2BUserSerializer {
794
937
  /** @example "2022-02-02T00:00:00Z" */
795
938
  updated_at: string;
796
939
  username: string;
940
+ uuid: string;
797
941
  watchmen_user_links: UmaWatchmenUserLinkSerializer[];
798
942
  }
799
943
  export interface UmaAdminB2CUserSerializer {
@@ -821,8 +965,11 @@ export interface UmaAdminB2CUserSerializer {
821
965
  /** @example 1 */
822
966
  id: number;
823
967
  initiator_id: number;
968
+ initiator_uuid: string;
824
969
  is_delete_allowed: boolean;
825
970
  is_edit_allowed: boolean;
971
+ /** @example "2022-02-02T00:00:00Z" */
972
+ last_login_at: string;
826
973
  /** @example "Jenkins" */
827
974
  last_name: string;
828
975
  locale: UmaLocaleSerializer;
@@ -830,18 +977,19 @@ export interface UmaAdminB2CUserSerializer {
830
977
  /** @example true */
831
978
  mfa_enabled: boolean;
832
979
  microservices: UmaMicroserviceSerializer[];
833
- permissions: UmaPermissionSerializer[];
980
+ permissions: UmaPermissionAccessSerializer[];
834
981
  /** @example "+123478844" */
835
982
  phone: string;
836
983
  /** @example true */
837
984
  phone_verified: boolean;
838
985
  primary_firm_id: number;
839
- rep_code: string;
840
- roles: UmaRoleSerializer[];
986
+ primary_firm_uuid: string;
987
+ region: string;
988
+ roles: UmaRoleAccessSerializer[];
841
989
  should_reset_password: boolean;
842
990
  small_avatar_url: string;
843
991
  status: UmaUserStatus;
844
- status_change_by_id: number;
992
+ status_change_by_id: string;
845
993
  status_change_notes: string;
846
994
  status_change_reason: UmaUserStatusChangeReasonSerializer;
847
995
  status_change_reason_id: number;
@@ -849,21 +997,30 @@ export interface UmaAdminB2CUserSerializer {
849
997
  /** @example "2022-02-02T00:00:00Z" */
850
998
  updated_at: string;
851
999
  username: string;
1000
+ uuid: string;
852
1001
  watchmen_user_links: UmaWatchmenUserLinkSerializer[];
853
1002
  }
854
1003
  export interface UmaAdminCreateAPIKeyDto {
855
1004
  ac_same_as_for_user?: boolean;
1005
+ branch_uuids?: string[];
856
1006
  branches?: number[];
857
1007
  firms?: UmaFirmInfo[];
858
1008
  mfa_codes?: UmaMfaCodesDto;
859
1009
  name?: string;
1010
+ permission_uuids?: string[];
860
1011
  permissions?: number[];
1012
+ region?: string;
1013
+ regional_permissions?: UmaRegionalAccessDto[];
1014
+ regional_roles?: UmaRegionalAccessDto[];
1015
+ role_uuids?: string[];
861
1016
  roles?: number[];
862
1017
  user_id?: number;
1018
+ user_uuid?: string;
863
1019
  }
864
1020
  export interface UmaAdminDeleteAPIKeysDto {
865
1021
  ids?: number[];
866
1022
  mfa_codes?: UmaMfaCodesDto;
1023
+ uuids?: string[];
867
1024
  }
868
1025
  export interface UmaAdminGetAPIKeysListDto {
869
1026
  pagination?: UmaPaginationDto;
@@ -871,17 +1028,26 @@ export interface UmaAdminGetAPIKeysListDto {
871
1028
  sorts?: UmaSortDto[];
872
1029
  /** Optional: filter by specific user IDs */
873
1030
  user_ids?: number[];
1031
+ /** Optional: filter by specific user UUIDs */
1032
+ user_uuids?: string[];
874
1033
  }
875
1034
  export interface UmaAdminUpdateAPIKeyDto {
876
1035
  ac_same_as_for_user?: boolean;
1036
+ branch_uuids?: string[];
877
1037
  branches?: number[];
878
1038
  firms?: UmaFirmInfo[];
879
1039
  mfa_codes?: UmaMfaCodesDto;
880
1040
  name?: string;
1041
+ permission_uuids?: string[];
881
1042
  permissions?: number[];
1043
+ region?: string;
1044
+ regional_permissions?: UmaRegionalAccessDto[];
1045
+ regional_roles?: UmaRegionalAccessDto[];
1046
+ role_uuids?: string[];
882
1047
  roles?: number[];
883
1048
  updated_at?: string;
884
1049
  user_id?: number;
1050
+ user_uuid?: string;
885
1051
  }
886
1052
  export interface UmaAdminUserSerializer {
887
1053
  access_revoking_date: string;
@@ -907,8 +1073,11 @@ export interface UmaAdminUserSerializer {
907
1073
  /** @example 1 */
908
1074
  id: number;
909
1075
  initiator_id: number;
1076
+ initiator_uuid: string;
910
1077
  is_delete_allowed: boolean;
911
1078
  is_edit_allowed: boolean;
1079
+ /** @example "2022-02-02T00:00:00Z" */
1080
+ last_login_at: string;
912
1081
  /** @example "Jenkins" */
913
1082
  last_name: string;
914
1083
  locale: UmaLocaleSerializer;
@@ -916,18 +1085,19 @@ export interface UmaAdminUserSerializer {
916
1085
  /** @example true */
917
1086
  mfa_enabled: boolean;
918
1087
  microservices: UmaMicroserviceSerializer[];
919
- permissions: UmaPermissionSerializer[];
1088
+ permissions: UmaPermissionAccessSerializer[];
920
1089
  /** @example "+123478844" */
921
1090
  phone: string;
922
1091
  /** @example true */
923
1092
  phone_verified: boolean;
924
1093
  primary_firm_id: number;
925
- rep_code: string;
926
- roles: UmaRoleSerializer[];
1094
+ primary_firm_uuid: string;
1095
+ region: string;
1096
+ roles: UmaRoleAccessSerializer[];
927
1097
  should_reset_password: boolean;
928
1098
  small_avatar_url: string;
929
1099
  status: UmaUserStatus;
930
- status_change_by_id: number;
1100
+ status_change_by_id: string;
931
1101
  status_change_notes: string;
932
1102
  status_change_reason: UmaUserStatusChangeReasonSerializer;
933
1103
  status_change_reason_id: number;
@@ -935,8 +1105,27 @@ export interface UmaAdminUserSerializer {
935
1105
  /** @example "2022-02-02T00:00:00Z" */
936
1106
  updated_at: string;
937
1107
  username: string;
1108
+ uuid: string;
938
1109
  watchmen_user_links: UmaWatchmenUserLinkSerializer[];
939
1110
  }
1111
+ export interface UmaAllowedEmailDto {
1112
+ email?: string;
1113
+ firm_id?: number;
1114
+ firm_uuid?: string;
1115
+ }
1116
+ export interface UmaAllowedEmailSerializer {
1117
+ created_at: string;
1118
+ email: string;
1119
+ firm: UmaFirmSerializer;
1120
+ firm_id: number;
1121
+ firm_uuid: string;
1122
+ id: number;
1123
+ updated_at: string;
1124
+ }
1125
+ export interface UmaAllowedEmailsListFiltersDto {
1126
+ firm_ids?: number[];
1127
+ firm_uuids?: string[];
1128
+ }
940
1129
  export interface UmaAllowedOriginDto {
941
1130
  origin?: string;
942
1131
  }
@@ -964,8 +1153,10 @@ export interface UmaAuthAppsLimitsSerializer {
964
1153
  }
965
1154
  export interface UmaAuthFormDto {
966
1155
  branch_id?: number;
1156
+ branch_uuid?: string;
967
1157
  client_platform_slug?: string;
968
1158
  firm_id?: number;
1159
+ firm_uuid?: string;
969
1160
  logo_base_url?: string;
970
1161
  logo_path?: string;
971
1162
  redirect_url?: string;
@@ -976,10 +1167,12 @@ export interface UmaAuthFormDto {
976
1167
  export interface UmaAuthFormSerializer {
977
1168
  branch: UmaBranchSerializer;
978
1169
  branch_id: number;
1170
+ branch_uuid: string;
979
1171
  client_platform_slug: string;
980
1172
  created_at: string;
981
1173
  firm: UmaFirmSerializer;
982
1174
  firm_id: number;
1175
+ firm_uuid: string;
983
1176
  id: number;
984
1177
  logo_base_url: string;
985
1178
  logo_path: string;
@@ -991,10 +1184,10 @@ export interface UmaAuthFormSerializer {
991
1184
  }
992
1185
  export interface UmaAuthProviderUserBindingSerializer {
993
1186
  app_type: UmaAuthProviderAppType;
994
- b2b_user_id: number;
995
- b2c_user_id: number;
1187
+ b2b_user_id: string;
1188
+ b2c_user_id: string;
996
1189
  created_at: string;
997
- firm_id: number;
1190
+ firm_id: string;
998
1191
  id: number;
999
1192
  name: string;
1000
1193
  provider_user_id: string;
@@ -1030,7 +1223,6 @@ export interface UmaB2BResetPasswordDto {
1030
1223
  contact?: string;
1031
1224
  new_password?: string;
1032
1225
  old_password?: string;
1033
- token_generation_mode?: UmaTokenGenerationMode;
1034
1226
  }
1035
1227
  export interface UmaB2BSendContactChangeCodeDto {
1036
1228
  contact?: string;
@@ -1041,11 +1233,15 @@ export interface UmaB2BUploadAvatarSerializer {
1041
1233
  small_avatar_path: string;
1042
1234
  }
1043
1235
  export interface UmaB2BUserBulkAccessUpdateDto {
1236
+ branch_uuids?: UmaAccessBulkChangesUuidUUID;
1044
1237
  branches?: UmaAccessBulkChangesInt;
1045
1238
  firms?: UmaB2BUserFirmAccessChanges[];
1239
+ permission_uuids?: UmaAccessBulkChangesUuidUUID;
1046
1240
  permissions?: UmaAccessBulkChangesInt;
1241
+ role_uuids?: UmaAccessBulkChangesUuidUUID;
1047
1242
  roles?: UmaAccessBulkChangesInt;
1048
1243
  user_ids?: number[];
1244
+ user_uuids?: string[];
1049
1245
  }
1050
1246
  export interface UmaB2BUserFirmAccessChanges {
1051
1247
  add?: UmaFirmInfo[];
@@ -1053,6 +1249,7 @@ export interface UmaB2BUserFirmAccessChanges {
1053
1249
  }
1054
1250
  export interface UmaB2BUserSerializer {
1055
1251
  admin_of_firm_ids: number[];
1252
+ admin_of_firm_uuids: string[];
1056
1253
  allow_feedback: boolean;
1057
1254
  big_avatar_url: string;
1058
1255
  /** @example "2022-02-02T00:00:00Z" */
@@ -1071,7 +1268,10 @@ export interface UmaB2BUserSerializer {
1071
1268
  /** @example 1 */
1072
1269
  id: number;
1073
1270
  initiator_id: number;
1271
+ initiator_uuid: string;
1074
1272
  is_chief_admin: boolean;
1273
+ /** @example "2022-02-02T00:00:00Z" */
1274
+ last_login_at: string;
1075
1275
  /** @example "Jenkins" */
1076
1276
  last_name: string;
1077
1277
  locale: UmaLocaleSerializer;
@@ -1084,7 +1284,7 @@ export interface UmaB2BUserSerializer {
1084
1284
  phone: string;
1085
1285
  /** @example true */
1086
1286
  phone_verified: boolean;
1087
- rep_code: string;
1287
+ region: string;
1088
1288
  should_reset_password: boolean;
1089
1289
  small_avatar_url: string;
1090
1290
  theme: string;
@@ -1092,11 +1292,13 @@ export interface UmaB2BUserSerializer {
1092
1292
  /** @example "2022-02-02T00:00:00Z" */
1093
1293
  updated_at: string;
1094
1294
  username: string;
1295
+ uuid: string;
1095
1296
  watchmen_user_links: UmaWatchmenUserLinkSerializer[];
1096
1297
  }
1097
1298
  export interface UmaB2CImpersonateDto {
1098
- token_generation_mode?: UmaTokenGenerationMode;
1299
+ response_mode?: UmaB2CImpersonateResponseMode;
1099
1300
  user_id?: number;
1301
+ user_uuid?: string;
1100
1302
  }
1101
1303
  export interface UmaB2CInitOAuthResponse {
1102
1304
  data?: UmaInitOAuthLoginSerializer;
@@ -1106,7 +1308,6 @@ export interface UmaB2CRefreshDto {
1106
1308
  auth_form_slug?: string;
1107
1309
  refresh_token?: string;
1108
1310
  send_redirect?: boolean;
1109
- token_generation_mode?: UmaTokenGenerationMode;
1110
1311
  }
1111
1312
  export interface UmaB2CResetPasswordDto {
1112
1313
  auth_form_slug?: string;
@@ -1124,11 +1325,16 @@ export interface UmaB2CSendVerificationCodeDto {
1124
1325
  contact?: string;
1125
1326
  }
1126
1327
  export interface UmaB2CUserBulkAccessUpdateDto {
1328
+ branch_uuids?: UmaAccessBulkChangesUuidUUID;
1127
1329
  branches?: UmaAccessBulkChangesInt;
1128
1330
  firm_replace?: number;
1331
+ firm_replace_uuid?: string;
1332
+ permission_uuids?: UmaAccessBulkChangesUuidUUID;
1129
1333
  permissions?: UmaAccessBulkChangesInt;
1334
+ role_uuids?: UmaAccessBulkChangesUuidUUID;
1130
1335
  roles?: UmaAccessBulkChangesInt;
1131
1336
  user_ids?: number[];
1337
+ user_uuids?: string[];
1132
1338
  }
1133
1339
  export interface UmaB2CUserSettingsSerializer {
1134
1340
  email: string;
@@ -1148,7 +1354,6 @@ export interface UmaBasicB2BLoginDto {
1148
1354
  password?: string;
1149
1355
  /** @example true */
1150
1356
  remember_me?: boolean;
1151
- token_generation_mode?: UmaTokenGenerationMode;
1152
1357
  }
1153
1358
  export interface UmaBasicB2CLoginDto {
1154
1359
  auth_form_slug?: string;
@@ -1162,7 +1367,24 @@ export interface UmaBasicB2CLoginDto {
1162
1367
  /** @example true */
1163
1368
  remember_me?: boolean;
1164
1369
  send_redirect?: boolean;
1165
- token_generation_mode?: UmaTokenGenerationMode;
1370
+ }
1371
+ export interface UmaBlockedEmailDto {
1372
+ email?: string;
1373
+ firm_id?: number;
1374
+ firm_uuid?: string;
1375
+ }
1376
+ export interface UmaBlockedEmailSerializer {
1377
+ created_at: string;
1378
+ email: string;
1379
+ firm: UmaFirmSerializer;
1380
+ firm_id: number;
1381
+ firm_uuid: string;
1382
+ id: number;
1383
+ updated_at: string;
1384
+ }
1385
+ export interface UmaBlockedEmailsListFiltersDto {
1386
+ firm_ids?: number[];
1387
+ firm_uuids?: string[];
1166
1388
  }
1167
1389
  export interface UmaBranchAdminListItemSerializer {
1168
1390
  branch_admins_count: number;
@@ -1173,22 +1395,26 @@ export interface UmaBranchAdminListItemSerializer {
1173
1395
  firm: UmaFirmSerializer;
1174
1396
  /** @example 1 */
1175
1397
  firm_id: number;
1398
+ firm_uuid: string;
1176
1399
  /** @example 1 */
1177
1400
  id: number;
1178
1401
  is_delete_allowed: boolean;
1179
1402
  is_update_allowed: boolean;
1180
1403
  /** @example "New York" */
1181
1404
  name: string;
1405
+ region: string;
1182
1406
  retail_available_mfa_options: string[];
1183
1407
  retail_email_notifications_enabled: boolean;
1184
1408
  retail_email_verification_required: boolean;
1185
1409
  retail_login_enabled: boolean;
1186
1410
  retail_mfa_enabling_required: boolean;
1187
1411
  retail_phone_verification_required: boolean;
1412
+ settings: UmaTenantSettingSerializer[];
1188
1413
  /** @example "new-york" */
1189
1414
  slug: string;
1190
1415
  /** @example "2022-02-02T00:00:00Z" */
1191
1416
  updated_at: string;
1417
+ uuid: string;
1192
1418
  }
1193
1419
  export interface UmaBranchAdminSerializer {
1194
1420
  branch_admins_count: number;
@@ -1199,20 +1425,24 @@ export interface UmaBranchAdminSerializer {
1199
1425
  firm: UmaFirmSerializer;
1200
1426
  /** @example 1 */
1201
1427
  firm_id: number;
1428
+ firm_uuid: string;
1202
1429
  /** @example 1 */
1203
1430
  id: number;
1204
1431
  /** @example "New York" */
1205
1432
  name: string;
1433
+ region: string;
1206
1434
  retail_available_mfa_options: string[];
1207
1435
  retail_email_notifications_enabled: boolean;
1208
1436
  retail_email_verification_required: boolean;
1209
1437
  retail_login_enabled: boolean;
1210
1438
  retail_mfa_enabling_required: boolean;
1211
1439
  retail_phone_verification_required: boolean;
1440
+ settings: UmaTenantSettingSerializer[];
1212
1441
  /** @example "new-york" */
1213
1442
  slug: string;
1214
1443
  /** @example "2022-02-02T00:00:00Z" */
1215
1444
  updated_at: string;
1445
+ uuid: string;
1216
1446
  }
1217
1447
  export interface UmaBranchDtoCommon {
1218
1448
  code?: string;
@@ -1231,12 +1461,15 @@ export interface UmaBranchSerializer {
1231
1461
  code: string;
1232
1462
  /** @example 1 */
1233
1463
  firm_id: number;
1464
+ firm_uuid: string;
1234
1465
  /** @example 1 */
1235
1466
  id: number;
1236
1467
  /** @example "New York" */
1237
1468
  name: string;
1469
+ region: string;
1238
1470
  /** @example "new-york" */
1239
1471
  slug: string;
1472
+ uuid: string;
1240
1473
  }
1241
1474
  export interface UmaChangeUserStatusDto {
1242
1475
  new_status?: UmaUserStatus;
@@ -1256,17 +1489,24 @@ export interface UmaCountrySerializer {
1256
1489
  }
1257
1490
  export interface UmaCreateAPIKeysDto {
1258
1491
  ac_same_as_for_user?: boolean;
1492
+ branch_uuids?: string[];
1259
1493
  branches?: number[];
1260
1494
  firms?: UmaFirmInfo[];
1261
1495
  mfa_codes?: UmaMfaCodesDto;
1262
1496
  name?: string;
1497
+ permission_uuids?: string[];
1263
1498
  permissions?: number[];
1499
+ region?: string;
1500
+ regional_permissions?: UmaRegionalAccessDto[];
1501
+ regional_roles?: UmaRegionalAccessDto[];
1502
+ role_uuids?: string[];
1264
1503
  roles?: number[];
1265
1504
  }
1266
1505
  export interface UmaCreateB2BUserDto {
1267
1506
  access_revoking_date?: string;
1268
1507
  add_default_domain_permissions?: boolean;
1269
1508
  allow_feedback?: boolean;
1509
+ branch_uuids?: string[];
1270
1510
  branches?: number[];
1271
1511
  /** @example "test@gmail.com" */
1272
1512
  email?: string;
@@ -1276,11 +1516,16 @@ export interface UmaCreateB2BUserDto {
1276
1516
  last_name?: string;
1277
1517
  /** @example "TeStPaSS" */
1278
1518
  password?: string;
1519
+ permission_uuids?: string[];
1279
1520
  permissions?: number[];
1280
1521
  /** @example "+1231231234" */
1281
1522
  phone?: string;
1282
1523
  primary_firm_id?: number;
1283
- rep_code?: string;
1524
+ primary_firm_uuid?: string;
1525
+ region?: string;
1526
+ regional_permissions?: UmaRegionalAccessDto[];
1527
+ regional_roles?: UmaRegionalAccessDto[];
1528
+ role_uuids?: string[];
1284
1529
  roles?: number[];
1285
1530
  should_reset_password?: boolean;
1286
1531
  title?: string;
@@ -1291,19 +1536,24 @@ export interface UmaCreateB2BUserDto {
1291
1536
  export interface UmaCreateB2CUserDto {
1292
1537
  access_revoking_date?: string;
1293
1538
  allow_feedback?: boolean;
1539
+ branch_uuids?: string[];
1294
1540
  branches?: number[];
1295
1541
  /** @example "test@gmail.com" */
1296
1542
  email?: string;
1297
1543
  /** @example "main" */
1298
1544
  env?: UmaB2CUserEnv;
1299
1545
  firm_id?: number;
1546
+ firm_uuid?: string;
1300
1547
  first_name?: string;
1301
1548
  last_name?: string;
1302
1549
  /** @example "TeStPaSS" */
1303
1550
  password?: string;
1551
+ permission_uuids?: string[];
1304
1552
  permissions?: number[];
1305
1553
  /** @example "+1231231234" */
1306
1554
  phone?: string;
1555
+ region?: string;
1556
+ role_uuids?: string[];
1307
1557
  roles?: number[];
1308
1558
  username?: string;
1309
1559
  watchmen_user_links?: UmaWatchmenUserLinkDto[];
@@ -1311,6 +1561,7 @@ export interface UmaCreateB2CUserDto {
1311
1561
  export interface UmaCreateBranchDto {
1312
1562
  code?: string;
1313
1563
  firm_id?: number;
1564
+ firm_uuid?: string;
1314
1565
  name?: string;
1315
1566
  retail_available_auth_app_options?: UmaAuthAppType[];
1316
1567
  retail_email_notifications_enabled?: boolean;
@@ -1327,10 +1578,16 @@ export interface UmaCreateEndpointDto {
1327
1578
  metadata?: UmaEndpointMetadataDto;
1328
1579
  method?: UmaCreateEndpointDtoMethodEnum;
1329
1580
  microservice_id?: number;
1581
+ microservice_uuid?: string;
1582
+ required_permission_uuids?: string[];
1330
1583
  required_permissions?: number[];
1331
1584
  route?: string;
1332
1585
  type?: UmaCreateEndpointDtoTypeEnum;
1333
1586
  }
1587
+ export interface UmaCreateFeedbackDto {
1588
+ comment?: string;
1589
+ subject?: string;
1590
+ }
1334
1591
  export interface UmaCreateFirmDto {
1335
1592
  allow_b2c_email_notifications?: boolean;
1336
1593
  allow_b2c_multi_branch_registration?: boolean;
@@ -1343,7 +1600,9 @@ export interface UmaCreateFirmDto {
1343
1600
  name?: string;
1344
1601
  notes?: string;
1345
1602
  phone?: string;
1603
+ region?: string;
1346
1604
  slug?: string;
1605
+ zendesk_credentials?: UmaFirmZendeskCredsDto;
1347
1606
  }
1348
1607
  export interface UmaCreateIdentityProviderDto {
1349
1608
  auth_url?: string;
@@ -1351,6 +1610,7 @@ export interface UmaCreateIdentityProviderDto {
1351
1610
  client_secret?: string;
1352
1611
  company_domain?: string;
1353
1612
  firm_id?: number;
1613
+ firm_uuid?: string;
1354
1614
  priority?: number;
1355
1615
  redirect_url?: string;
1356
1616
  type?: UmaCreateIdentityProviderDtoTypeEnum;
@@ -1359,6 +1619,7 @@ export interface UmaCreateMicroserviceDto {
1359
1619
  description?: string;
1360
1620
  domains?: UmaMicroserviceDomainDto[];
1361
1621
  is_active?: boolean;
1622
+ is_globalized?: boolean;
1362
1623
  is_token_encoding_required?: boolean;
1363
1624
  is_visible_on_admin_sidebar?: boolean;
1364
1625
  logo_url?: string;
@@ -1369,13 +1630,18 @@ export interface UmaCreatePermissionDto {
1369
1630
  assignment_group?: UmaPermissionAG;
1370
1631
  metadata?: UmaPermissionMetadataDto;
1371
1632
  microservice_id?: number;
1633
+ microservice_uuid?: string;
1372
1634
  permission?: string;
1373
1635
  }
1374
1636
  export interface UmaCreateRoleDto {
1375
1637
  assignment_group?: UmaPermissionAG;
1376
1638
  firm_id?: number;
1639
+ firm_uuid?: string;
1377
1640
  microservice_id?: number;
1641
+ microservice_uuid?: string;
1378
1642
  name?: string;
1643
+ permission_can_assign_role_uuids?: string[];
1644
+ permission_uuids?: string[];
1379
1645
  permissions?: number[];
1380
1646
  permissions_can_assign_role?: number[];
1381
1647
  type_id?: number;
@@ -1400,6 +1666,7 @@ export interface UmaCreateSystemUserDto {
1400
1666
  access_revoking_date?: string;
1401
1667
  add_default_domain_permissions?: boolean;
1402
1668
  allow_feedback?: boolean;
1669
+ branch_uuids?: string[];
1403
1670
  branches?: number[];
1404
1671
  /** @example "test@gmail.com" */
1405
1672
  email?: string;
@@ -1408,11 +1675,16 @@ export interface UmaCreateSystemUserDto {
1408
1675
  has_access_to_all_firm_branches?: boolean;
1409
1676
  /** @example "TeStPaSS" */
1410
1677
  password?: string;
1678
+ permission_uuids?: string[];
1411
1679
  permissions?: number[];
1412
1680
  /** @example "+1231231234" */
1413
1681
  phone?: string;
1414
1682
  primary_firm_id?: number;
1415
- rep_code?: string;
1683
+ primary_firm_uuid?: string;
1684
+ region?: string;
1685
+ regional_permissions?: UmaRegionalAccessDto[];
1686
+ regional_roles?: UmaRegionalAccessDto[];
1687
+ role_uuids?: string[];
1416
1688
  roles?: number[];
1417
1689
  should_reset_password?: boolean;
1418
1690
  title?: string;
@@ -1431,9 +1703,30 @@ export interface UmaCreateYubicoOTPDto {
1431
1703
  name?: string;
1432
1704
  otp?: string;
1433
1705
  }
1706
+ export interface UmaDefaultB2CRegistrationRoleDto {
1707
+ branch_id?: number;
1708
+ branch_uuid?: string;
1709
+ firm_id?: number;
1710
+ firm_uuid?: string;
1711
+ role_id?: number;
1712
+ role_uuid?: string;
1713
+ }
1714
+ export interface UmaDefaultB2CRegistrationRoleSerializer {
1715
+ branch: UmaBranchSerializer;
1716
+ branch_id: number;
1717
+ branch_uuid: string;
1718
+ firm: UmaFirmSerializer;
1719
+ firm_id: number;
1720
+ firm_uuid: string;
1721
+ id: number;
1722
+ role: UmaRoleSerializer;
1723
+ role_id: number;
1724
+ role_uuid: string;
1725
+ }
1434
1726
  export interface UmaDeleteAPIKeysDto {
1435
1727
  ids?: number[];
1436
1728
  mfa_codes?: UmaMfaCodesDto;
1729
+ uuids?: string[];
1437
1730
  }
1438
1731
  export interface UmaDeleteByIDsDtoInt {
1439
1732
  ids?: number[];
@@ -1441,6 +1734,14 @@ export interface UmaDeleteByIDsDtoInt {
1441
1734
  export interface UmaDeleteByIDsDtoInt64 {
1442
1735
  ids?: number[];
1443
1736
  }
1737
+ export interface UmaDeleteByUUIDsDtoInt {
1738
+ ids?: number[];
1739
+ uuids?: string[];
1740
+ }
1741
+ export interface UmaDeleteByUUIDsDtoInt64 {
1742
+ ids?: number[];
1743
+ uuids?: string[];
1744
+ }
1444
1745
  export interface UmaDeleteSessionsDto {
1445
1746
  pair_ids?: string[];
1446
1747
  }
@@ -1448,12 +1749,19 @@ export interface UmaDeleteUsersDto {
1448
1749
  ids?: number[];
1449
1750
  notes?: string;
1450
1751
  reason_id?: number;
1752
+ uuids?: string[];
1451
1753
  }
1452
1754
  export interface UmaEmailDomainDto {
1755
+ branch_uuids?: string[];
1453
1756
  branches?: number[];
1454
1757
  domain?: string;
1455
1758
  firms?: UmaFirmInfo[];
1759
+ permission_uuids?: string[];
1456
1760
  permissions?: number[];
1761
+ region?: string;
1762
+ regional_permissions?: UmaRegionalAccessDto[];
1763
+ regional_roles?: UmaRegionalAccessDto[];
1764
+ role_uuids?: string[];
1457
1765
  roles?: number[];
1458
1766
  }
1459
1767
  export interface UmaEmailDomainSerializer {
@@ -1463,8 +1771,10 @@ export interface UmaEmailDomainSerializer {
1463
1771
  firms: UmaFirmAccessSerializer[];
1464
1772
  id: number;
1465
1773
  permissions: UmaPermissionSerializer[];
1774
+ region: string;
1466
1775
  roles: UmaRoleSerializer[];
1467
1776
  updated_at: string;
1777
+ uuid: string;
1468
1778
  }
1469
1779
  export interface UmaEndpointMetadataDto {
1470
1780
  admin_ui_permission_key?: string;
@@ -1490,10 +1800,16 @@ export interface UmaEndpointSerializer {
1490
1800
  method: UmaEndpointSerializerMethodEnum;
1491
1801
  microservice: UmaMicroserviceSerializer;
1492
1802
  microservice_id: number;
1803
+ microservice_uuid: string;
1493
1804
  required_permissions: UmaPermissionSerializer[];
1494
1805
  route: string;
1495
1806
  type: UmaEndpointType;
1496
1807
  updated_at: string;
1808
+ uuid: string;
1809
+ }
1810
+ export interface UmaExchangeB2CImpersonateAuthCodeDto {
1811
+ auth_code?: string;
1812
+ state?: string;
1497
1813
  }
1498
1814
  export interface UmaFinishOAuthLoginDto {
1499
1815
  authentication_code?: string;
@@ -1508,6 +1824,8 @@ export interface UmaFirmAccessSerializer {
1508
1824
  allow_b2c_email_notifications: boolean;
1509
1825
  allow_b2c_multi_branch_registration: boolean;
1510
1826
  b2b_users_count: number;
1827
+ b2c_access_token_expires_in_minutes: number;
1828
+ b2c_refresh_token_expires_in_hours: number;
1511
1829
  b2c_users_count: number;
1512
1830
  branches: UmaBranchSerializer[];
1513
1831
  branches_count: number;
@@ -1524,15 +1842,18 @@ export interface UmaFirmAccessSerializer {
1524
1842
  name: string;
1525
1843
  notes: string;
1526
1844
  phone: string;
1845
+ region: string;
1527
1846
  /** @example "viewtrade" */
1528
1847
  slug: string;
1529
1848
  status: string;
1530
1849
  tags: UmaTagSerializer[];
1531
1850
  /** @example "2022-02-02T00:00:00Z" */
1532
1851
  updated_at: string;
1852
+ uuid: string;
1533
1853
  }
1534
1854
  export interface UmaFirmInfo {
1535
1855
  firm_id?: number;
1856
+ firm_uuid?: string;
1536
1857
  have_access_to_all_firm_branches?: boolean;
1537
1858
  }
1538
1859
  export interface UmaFirmSerializer {
@@ -1540,6 +1861,39 @@ export interface UmaFirmSerializer {
1540
1861
  allow_b2c_email_notifications: boolean;
1541
1862
  allow_b2c_multi_branch_registration: boolean;
1542
1863
  b2b_users_count: number;
1864
+ b2c_access_token_expires_in_minutes: number;
1865
+ b2c_refresh_token_expires_in_hours: number;
1866
+ b2c_users_count: number;
1867
+ branches: UmaBranchSerializer[];
1868
+ branches_count: number;
1869
+ /** @example "2022-02-02T00:00:00Z" */
1870
+ created_at: string;
1871
+ email: string;
1872
+ /** @example 1 */
1873
+ id: number;
1874
+ is_emails_allowlist_enabled: boolean;
1875
+ is_emails_blocklist_enabled: boolean;
1876
+ last_status_change_at: string;
1877
+ /** @example "ViewTrade" */
1878
+ name: string;
1879
+ notes: string;
1880
+ phone: string;
1881
+ region: string;
1882
+ /** @example "viewtrade" */
1883
+ slug: string;
1884
+ status: string;
1885
+ tags: UmaTagSerializer[];
1886
+ /** @example "2022-02-02T00:00:00Z" */
1887
+ updated_at: string;
1888
+ uuid: string;
1889
+ }
1890
+ export interface UmaFirmWithCredsSerializer {
1891
+ admins_count: number;
1892
+ allow_b2c_email_notifications: boolean;
1893
+ allow_b2c_multi_branch_registration: boolean;
1894
+ b2b_users_count: number;
1895
+ b2c_access_token_expires_in_minutes: number;
1896
+ b2c_refresh_token_expires_in_hours: number;
1543
1897
  b2c_users_count: number;
1544
1898
  branches: UmaBranchSerializer[];
1545
1899
  branches_count: number;
@@ -1555,15 +1909,24 @@ export interface UmaFirmSerializer {
1555
1909
  name: string;
1556
1910
  notes: string;
1557
1911
  phone: string;
1912
+ region: string;
1558
1913
  /** @example "viewtrade" */
1559
1914
  slug: string;
1560
1915
  status: string;
1561
1916
  tags: UmaTagSerializer[];
1562
1917
  /** @example "2022-02-02T00:00:00Z" */
1563
1918
  updated_at: string;
1919
+ uuid: string;
1920
+ zendesk_credentials: UmaFirmZendeskCredsDto;
1921
+ }
1922
+ export interface UmaFirmZendeskCredsDto {
1923
+ client_id?: string;
1924
+ client_secret?: string;
1925
+ subdomain?: string;
1564
1926
  }
1565
1927
  export interface UmaGenerateWatchmenAuthTokenDto {
1566
1928
  branch_id?: number;
1929
+ branch_uuid?: string;
1567
1930
  }
1568
1931
  export interface UmaGeneratedEntityPDFSerializer {
1569
1932
  data: UmaPdfGenerationInfo;
@@ -1573,6 +1936,18 @@ export interface UmaGeneratedWatchmenTokenInfoSerializer {
1573
1936
  expires_at: number;
1574
1937
  token: string;
1575
1938
  }
1939
+ export interface UmaGetAIAssistantQuestionLogListDto {
1940
+ filters?: UmaGetAIAssistantQuestionLogListFiltersDto;
1941
+ pagination?: UmaPaginationDto;
1942
+ search?: string;
1943
+ sorts?: UmaSortDto[];
1944
+ }
1945
+ export interface UmaGetAIAssistantQuestionLogListFiltersDto {
1946
+ answered?: boolean;
1947
+ categories?: string[];
1948
+ date_from?: string;
1949
+ date_to?: string;
1950
+ }
1576
1951
  export interface UmaGetAPIKeysListDto {
1577
1952
  pagination?: UmaPaginationDto;
1578
1953
  search?: string;
@@ -1588,9 +1963,16 @@ export interface UmaGetActionLogsListFiltersDto {
1588
1963
  entities?: UmaActionLogEntityFilterDto[];
1589
1964
  ids?: number[];
1590
1965
  initiator_ids?: number[];
1966
+ initiator_uuids?: string[];
1591
1967
  show_only_fields_changes?: string[];
1592
1968
  trigger_types?: string[];
1593
1969
  }
1970
+ export interface UmaGetAllowedEmailsListDto {
1971
+ filters?: UmaAllowedEmailsListFiltersDto;
1972
+ pagination?: UmaPaginationDto;
1973
+ search?: string;
1974
+ sorts?: UmaSortDto[];
1975
+ }
1594
1976
  export interface UmaGetAllowedOriginsListDto {
1595
1977
  pagination?: UmaPaginationDto;
1596
1978
  search?: string;
@@ -1604,7 +1986,9 @@ export interface UmaGetAuthFormsListDto {
1604
1986
  }
1605
1987
  export interface UmaGetAuthFormsListFiltersDto {
1606
1988
  branch_ids?: number[];
1989
+ branch_uuids?: string[];
1607
1990
  firm_ids?: number[];
1991
+ firm_uuids?: string[];
1608
1992
  ids?: number[];
1609
1993
  }
1610
1994
  export interface UmaGetB2BUsersListDto {
@@ -1628,22 +2012,35 @@ export interface UmaGetB2CUsersListDto {
1628
2012
  }
1629
2013
  export interface UmaGetB2CUsersListFiltersDto {
1630
2014
  branch_ids?: number[];
2015
+ branch_uuids?: string[];
1631
2016
  email_verified?: boolean;
1632
2017
  firm_ids?: number[];
1633
2018
  firm_tag_ids?: number[];
2019
+ firm_uuids?: string[];
1634
2020
  ids?: number[];
1635
2021
  is_blocked?: boolean;
1636
2022
  microservice_ids?: number[];
2023
+ microservice_uuids?: string[];
1637
2024
  neither_verified?: boolean;
1638
2025
  permission_ids?: number[];
1639
2026
  permission_names?: string[];
2027
+ permission_uuids?: string[];
1640
2028
  phone_verified?: boolean;
2029
+ regions?: string[];
1641
2030
  role_ids?: number[];
2031
+ role_uuids?: string[];
1642
2032
  show_only?: UmaGetB2CUsersListFiltersDtoShowOnlyEnum;
1643
2033
  show_users_linked_to_watchmen?: boolean;
1644
2034
  status_change_reason_ids?: number[];
1645
2035
  statuses?: UmaUserStatus[];
1646
2036
  type?: UmaUserType;
2037
+ uuids?: string[];
2038
+ }
2039
+ export interface UmaGetBlockedEmailsListDto {
2040
+ filters?: UmaBlockedEmailsListFiltersDto;
2041
+ pagination?: UmaPaginationDto;
2042
+ search?: string;
2043
+ sorts?: UmaSortDto[];
1647
2044
  }
1648
2045
  export interface UmaGetBranchesListDto {
1649
2046
  count_branch_admins?: boolean;
@@ -1655,10 +2052,17 @@ export interface UmaGetBranchesListDto {
1655
2052
  }
1656
2053
  export interface UmaGetBranchesListFiltersDto {
1657
2054
  firm_ids?: number[];
2055
+ firm_uuids?: string[];
1658
2056
  ids?: number[];
2057
+ regions?: string[];
1659
2058
  retail_email_verification_required?: boolean;
1660
2059
  retail_login_enabled?: boolean;
1661
2060
  retail_phone_verification_required?: boolean;
2061
+ uuids?: string[];
2062
+ }
2063
+ export interface UmaGetDefaultB2CRegistrationRolesListDto {
2064
+ pagination?: UmaPaginationDto;
2065
+ sorts?: UmaSortDto[];
1662
2066
  }
1663
2067
  export interface UmaGetEmailDomainsListDto {
1664
2068
  filters?: any;
@@ -1677,6 +2081,8 @@ export interface UmaGetEndpointsListFiltersDto {
1677
2081
  is_public?: boolean;
1678
2082
  methods?: string[];
1679
2083
  microservice_ids?: number[];
2084
+ microservice_uuids?: string[];
2085
+ uuids?: string[];
1680
2086
  }
1681
2087
  export interface UmaGetFirmsListDto {
1682
2088
  count_admins?: boolean;
@@ -1691,8 +2097,10 @@ export interface UmaGetFirmsListDto {
1691
2097
  }
1692
2098
  export interface UmaGetFirmsListFiltersDto {
1693
2099
  ids?: number[];
2100
+ regions?: string[];
1694
2101
  statuses?: UmaGetFirmsListFiltersDtoStatusesEnum;
1695
2102
  tag_ids?: number[];
2103
+ uuids?: string[];
1696
2104
  }
1697
2105
  export interface UmaGetIdentityProvidersListDto {
1698
2106
  filters?: UmaGetIdentityProvidersListFiltersDto;
@@ -1702,6 +2110,7 @@ export interface UmaGetIdentityProvidersListDto {
1702
2110
  }
1703
2111
  export interface UmaGetIdentityProvidersListFiltersDto {
1704
2112
  firm_ids?: number[];
2113
+ firm_uuids?: string[];
1705
2114
  ids?: number[];
1706
2115
  types?: UmaGetIdentityProvidersListFiltersDtoTypesEnum[];
1707
2116
  }
@@ -1714,6 +2123,7 @@ export interface UmaGetMicroservicesListDto {
1714
2123
  export interface UmaGetMicroservicesListFiltersDto {
1715
2124
  ids?: number[];
1716
2125
  slugs?: string[];
2126
+ uuids?: string[];
1717
2127
  }
1718
2128
  export interface UmaGetOAuth2BindingsListDto {
1719
2129
  pagination?: UmaPaginationDto;
@@ -1731,6 +2141,8 @@ export interface UmaGetPermissionsListFiltersDto {
1731
2141
  assignment_groups?: UmaPermissionAG[];
1732
2142
  ids?: number[];
1733
2143
  microservice_ids?: number[];
2144
+ microservice_uuids?: string[];
2145
+ uuids?: string[];
1734
2146
  }
1735
2147
  export interface UmaGetRoleTypesListDto {
1736
2148
  filters?: UmaGetRoleTypesListFiltersDto;
@@ -1751,6 +2163,8 @@ export interface UmaGetRolesListFiltersDto {
1751
2163
  assignment_groups?: UmaPermissionAG[];
1752
2164
  ids?: number[];
1753
2165
  microservice_ids?: number[];
2166
+ microservice_uuids?: string[];
2167
+ role_uuids?: string[];
1754
2168
  type_ids?: number[];
1755
2169
  }
1756
2170
  export interface UmaGetSecretNoteDto {
@@ -1776,6 +2190,7 @@ export interface UmaGetTrustedDevicesListDto {
1776
2190
  export interface UmaGetUserDetailsDto {
1777
2191
  access_token?: string;
1778
2192
  generation_type?: UmaUserDetailsGenerationType;
2193
+ show_global_claims?: boolean;
1779
2194
  }
1780
2195
  export interface UmaGetUserStatusChangeReasonsDto {
1781
2196
  filters?: UmaGetUserStatusChangeReasonsListFiltersDto;
@@ -1788,25 +2203,33 @@ export interface UmaGetUserStatusChangeReasonsListFiltersDto {
1788
2203
  }
1789
2204
  export interface UmaGetUsersListFiltersDto {
1790
2205
  branch_ids?: number[];
2206
+ branch_uuids?: string[];
1791
2207
  email_verified?: boolean;
1792
2208
  firm_ids?: number[];
1793
2209
  firm_tag_ids?: number[];
2210
+ firm_uuids?: string[];
1794
2211
  ids?: number[];
1795
2212
  microservice_ids?: number[];
2213
+ microservice_uuids?: string[];
1796
2214
  neither_verified?: boolean;
1797
2215
  permission_ids?: number[];
1798
2216
  permission_names?: string[];
2217
+ permission_uuids?: string[];
1799
2218
  phone_verified?: boolean;
2219
+ regions?: string[];
1800
2220
  role_ids?: number[];
2221
+ role_uuids?: string[];
1801
2222
  show_only?: UmaGetUsersListFiltersDtoShowOnlyEnum;
1802
2223
  show_users_linked_to_watchmen?: boolean;
1803
2224
  status_change_reason_ids?: number[];
1804
2225
  statuses?: UmaUserStatus[];
1805
2226
  type?: UmaUserType;
2227
+ uuids?: string[];
1806
2228
  }
1807
2229
  export interface UmaGetVerifiedContactChangeCodeDto {
1808
2230
  type?: UmaCodeType;
1809
2231
  user_id?: number;
2232
+ user_uuid?: string;
1810
2233
  }
1811
2234
  export interface UmaGetWatchmenInstancesDto {
1812
2235
  pagination?: UmaPaginationDto;
@@ -1824,6 +2247,7 @@ export interface UmaIdentityProviderSerializer {
1824
2247
  company_domain: string;
1825
2248
  created_at: string;
1826
2249
  firm_id: number;
2250
+ firm_uuid: string;
1827
2251
  id: number;
1828
2252
  priority: number;
1829
2253
  redirect_url: string;
@@ -1851,6 +2275,7 @@ export interface UmaLinkWatchmenUserToUmaDto {
1851
2275
  branch_slug_or_code?: string;
1852
2276
  uma_user_id?: number;
1853
2277
  uma_user_type?: UmaAuthUserType;
2278
+ uma_user_uuid?: string;
1854
2279
  watchmen_instance_slug?: string;
1855
2280
  watchmen_user_id?: number;
1856
2281
  watchmen_username?: string;
@@ -1881,6 +2306,7 @@ export interface UmaMicroserviceAccessSerializer {
1881
2306
  /** @example 1 */
1882
2307
  id: number;
1883
2308
  is_active: boolean;
2309
+ is_globalized: boolean;
1884
2310
  is_token_encoding_required: boolean;
1885
2311
  is_visible_on_admin_sidebar: boolean;
1886
2312
  logo_url: string;
@@ -1895,6 +2321,7 @@ export interface UmaMicroserviceDomainDto {
1895
2321
  /** @example "/insights-api" */
1896
2322
  public_path_prefix?: string;
1897
2323
  watchmen_instance_id?: number;
2324
+ watchmen_instance_uuid?: string;
1898
2325
  }
1899
2326
  export interface UmaMicroserviceDomainSerializer {
1900
2327
  /** @example "internal.com" */
@@ -1905,6 +2332,7 @@ export interface UmaMicroserviceDomainSerializer {
1905
2332
  public_path_prefix: string;
1906
2333
  watchmen_instance: UmaWatchmenInstanceSerializer;
1907
2334
  watchmen_instance_id: number;
2335
+ watchmen_instance_uuid: string;
1908
2336
  }
1909
2337
  export interface UmaMicroserviceSerializer {
1910
2338
  created_at: string;
@@ -1913,6 +2341,7 @@ export interface UmaMicroserviceSerializer {
1913
2341
  /** @example 1 */
1914
2342
  id: number;
1915
2343
  is_active: boolean;
2344
+ is_globalized: boolean;
1916
2345
  is_token_encoding_required: boolean;
1917
2346
  is_visible_on_admin_sidebar: boolean;
1918
2347
  logo_url: string;
@@ -1920,6 +2349,7 @@ export interface UmaMicroserviceSerializer {
1920
2349
  parent_id: number;
1921
2350
  slug: string;
1922
2351
  updated_at: string;
2352
+ uuid: string;
1923
2353
  }
1924
2354
  export interface UmaOptionalPaginationDto {
1925
2355
  page?: number;
@@ -1928,6 +2358,7 @@ export interface UmaOptionalPaginationDto {
1928
2358
  export interface UmaPartialUpdateB2BUserDto {
1929
2359
  access_revoking_date?: string;
1930
2360
  allow_feedback?: boolean;
2361
+ branch_uuids?: string[];
1931
2362
  branches?: number[];
1932
2363
  /** @example "test@gmail.com" */
1933
2364
  email?: string;
@@ -1937,11 +2368,15 @@ export interface UmaPartialUpdateB2BUserDto {
1937
2368
  last_name?: string;
1938
2369
  /** @example "TeStPaSS" */
1939
2370
  password?: string;
2371
+ permission_uuids?: string[];
1940
2372
  permissions?: number[];
1941
2373
  /** @example "+1231231234" */
1942
2374
  phone?: string;
1943
2375
  primary_firm_id?: number;
1944
- rep_code?: string;
2376
+ primary_firm_uuid?: string;
2377
+ regional_permissions?: UmaRegionalAccessDto[];
2378
+ regional_roles?: UmaRegionalAccessDto[];
2379
+ role_uuids?: string[];
1945
2380
  roles?: number[];
1946
2381
  should_reset_password?: boolean;
1947
2382
  title?: string;
@@ -1952,19 +2387,23 @@ export interface UmaPartialUpdateB2BUserDto {
1952
2387
  export interface UmaPartialUpdateB2CUserDto {
1953
2388
  access_revoking_date?: string;
1954
2389
  allow_feedback?: boolean;
2390
+ branch_uuids?: string[];
1955
2391
  branches?: number[];
1956
2392
  /** @example "test@gmail.com" */
1957
2393
  email?: string;
1958
2394
  email_code?: string;
1959
2395
  firm_id?: number;
2396
+ firm_uuid?: string;
1960
2397
  first_name?: string;
1961
2398
  last_name?: string;
1962
2399
  /** @example "TeStPaSS" */
1963
2400
  password?: string;
2401
+ permission_uuids?: string[];
1964
2402
  permissions?: number[];
1965
2403
  /** @example "+1231231234" */
1966
2404
  phone?: string;
1967
2405
  phone_code?: string;
2406
+ role_uuids?: string[];
1968
2407
  roles?: number[];
1969
2408
  username?: string;
1970
2409
  watchmen_user_links?: UmaWatchmenUserLinkDto[];
@@ -1975,6 +2414,8 @@ export interface UmaPartialUpdateEndpointDto {
1975
2414
  metadata?: UmaEndpointMetadataDto;
1976
2415
  method?: UmaPartialUpdateEndpointDtoMethodEnum;
1977
2416
  microservice_id?: number;
2417
+ microservice_uuid?: string;
2418
+ required_permission_uuids?: string[];
1978
2419
  required_permissions?: number[];
1979
2420
  route?: string;
1980
2421
  type?: UmaPartialUpdateEndpointDtoTypeEnum;
@@ -1993,11 +2434,13 @@ export interface UmaPartialUpdateFirmDto {
1993
2434
  phone?: string;
1994
2435
  slug?: string;
1995
2436
  status?: UmaPartialUpdateFirmDtoStatusEnum;
2437
+ zendesk_credentials?: UmaFirmZendeskCredsDto;
1996
2438
  }
1997
2439
  export interface UmaPartialUpdateMicroserviceDto {
1998
2440
  description?: string;
1999
2441
  domains?: UmaMicroserviceDomainDto[];
2000
2442
  is_active?: boolean;
2443
+ is_globalized?: boolean;
2001
2444
  is_token_encoding_required?: boolean;
2002
2445
  is_visible_on_admin_sidebar?: boolean;
2003
2446
  logo_url?: string;
@@ -2007,10 +2450,13 @@ export interface UmaPartialUpdateMicroserviceDto {
2007
2450
  export interface UmaPartialUpdatePermissionDto {
2008
2451
  metadata?: UmaPermissionMetadataDto;
2009
2452
  microservice_id?: number;
2453
+ microservice_uuid?: string;
2010
2454
  permission?: string;
2011
2455
  }
2012
2456
  export interface UmaPartialUpdateRoleDto {
2013
2457
  name?: string;
2458
+ permission_can_assign_role_uuids?: string[];
2459
+ permission_uuids?: string[];
2014
2460
  permissions?: number[];
2015
2461
  permissions_can_assign_role?: number[];
2016
2462
  type_id?: number;
@@ -2018,6 +2464,7 @@ export interface UmaPartialUpdateRoleDto {
2018
2464
  export interface UmaPartialUpdateSystemUserDto {
2019
2465
  access_revoking_date?: string;
2020
2466
  allow_feedback?: boolean;
2467
+ branch_uuids?: string[];
2021
2468
  branches?: number[];
2022
2469
  /** @example "test@gmail.com" */
2023
2470
  email?: string;
@@ -2026,11 +2473,15 @@ export interface UmaPartialUpdateSystemUserDto {
2026
2473
  has_access_to_all_firm_branches?: boolean;
2027
2474
  /** @example "TeStPaSS" */
2028
2475
  password?: string;
2476
+ permission_uuids?: string[];
2029
2477
  permissions?: number[];
2030
2478
  /** @example "+1231231234" */
2031
2479
  phone?: string;
2032
2480
  primary_firm_id?: number;
2033
- rep_code?: string;
2481
+ primary_firm_uuid?: string;
2482
+ regional_permissions?: UmaRegionalAccessDto[];
2483
+ regional_roles?: UmaRegionalAccessDto[];
2484
+ role_uuids?: string[];
2034
2485
  roles?: number[];
2035
2486
  should_reset_password?: boolean;
2036
2487
  title?: string;
@@ -2041,6 +2492,20 @@ export interface UmaPdfGenerationInfo {
2041
2492
  pdf_generated_at?: string;
2042
2493
  pdf_url?: string;
2043
2494
  }
2495
+ export interface UmaPermissionAccessSerializer {
2496
+ assignment_group: UmaPermissionAccessSerializerAssignmentGroupEnum;
2497
+ created_at: string;
2498
+ /** @example 1 */
2499
+ id: number;
2500
+ metadata: UmaPermissionMetadataSerializer;
2501
+ microservice: UmaMicroserviceSerializer;
2502
+ microservice_id: number;
2503
+ microservice_uuid: string;
2504
+ permission: string;
2505
+ region: string;
2506
+ updated_at: string;
2507
+ uuid: string;
2508
+ }
2044
2509
  export interface UmaPermissionMetadataDto {
2045
2510
  entities?: Record<string, UmaEntityAccessType>;
2046
2511
  entities_new?: UmaEntityData[];
@@ -2060,8 +2525,10 @@ export interface UmaPermissionSerializer {
2060
2525
  metadata: UmaPermissionMetadataSerializer;
2061
2526
  microservice: UmaMicroserviceSerializer;
2062
2527
  microservice_id: number;
2528
+ microservice_uuid: string;
2063
2529
  permission: string;
2064
2530
  updated_at: string;
2531
+ uuid: string;
2065
2532
  }
2066
2533
  export interface UmaPublicSettingsSerializer {
2067
2534
  action_logs: UmaActionLogsSettingsSerializer;
@@ -2076,7 +2543,17 @@ export interface UmaPublicSettingsSerializer {
2076
2543
  }
2077
2544
  export interface UmaRefreshDto {
2078
2545
  refresh_token?: string;
2079
- token_generation_mode?: UmaTokenGenerationMode;
2546
+ }
2547
+ export interface UmaRegionSerializer {
2548
+ country_code: string;
2549
+ created_at: string;
2550
+ is_global: boolean;
2551
+ name: string;
2552
+ updated_at: string;
2553
+ }
2554
+ export interface UmaRegionalAccessDto {
2555
+ id?: string;
2556
+ region?: string;
2080
2557
  }
2081
2558
  export interface UmaRegisterDto {
2082
2559
  /** @example "test@gmail.com" */
@@ -2097,19 +2574,42 @@ export interface UmaResetPasswordSettingsSerializer {
2097
2574
  export interface UmaResetRateLimitsDto {
2098
2575
  user_id?: number;
2099
2576
  user_type?: UmaAuthUserType;
2577
+ user_uuid?: string;
2100
2578
  }
2101
2579
  export interface UmaRevokeUserSessionsDto {
2102
2580
  user_id?: number;
2103
2581
  user_type?: UmaRevokeUserSessionsDtoUserTypeEnum;
2582
+ user_uuid?: string;
2583
+ }
2584
+ export interface UmaRoleAccessSerializer {
2585
+ assignment_group: UmaPermissionAG;
2586
+ created_at: string;
2587
+ firm: UmaFirmSerializer;
2588
+ firm_id: string;
2589
+ id: number;
2590
+ microservice: UmaMicroserviceSerializer;
2591
+ microservice_id: number;
2592
+ microservice_uuid: string;
2593
+ name: string;
2594
+ pdf_generated_at: string;
2595
+ pdf_url: string;
2596
+ permissions: UmaPermissionSerializer[];
2597
+ permissions_can_assign_role: UmaPermissionSerializer[];
2598
+ region: string;
2599
+ type: UmaRoleTypeSerializer;
2600
+ type_id: number;
2601
+ updated_at: string;
2602
+ uuid: string;
2104
2603
  }
2105
2604
  export interface UmaRoleSerializer {
2106
2605
  assignment_group: UmaPermissionAG;
2107
2606
  created_at: string;
2108
2607
  firm: UmaFirmSerializer;
2109
- firm_id: number;
2608
+ firm_id: string;
2110
2609
  id: number;
2111
2610
  microservice: UmaMicroserviceSerializer;
2112
2611
  microservice_id: number;
2612
+ microservice_uuid: string;
2113
2613
  name: string;
2114
2614
  pdf_generated_at: string;
2115
2615
  pdf_url: string;
@@ -2118,6 +2618,7 @@ export interface UmaRoleSerializer {
2118
2618
  type: UmaRoleTypeSerializer;
2119
2619
  type_id: number;
2120
2620
  updated_at: string;
2621
+ uuid: string;
2121
2622
  }
2122
2623
  export interface UmaRoleTypeSerializer {
2123
2624
  color: string;
@@ -2153,6 +2654,13 @@ export interface UmaSendB2CResetPasswordCodeDto {
2153
2654
  contact?: string;
2154
2655
  reset_type?: UmaResetPasswordType;
2155
2656
  }
2657
+ export interface UmaSendMessageDto {
2658
+ chat_id?: number;
2659
+ context?: string;
2660
+ /** @minLength 1 */
2661
+ message: string;
2662
+ screen?: string;
2663
+ }
2156
2664
  export interface UmaSendResetPasswordCodeDto {
2157
2665
  contact?: string;
2158
2666
  type?: UmaSendResetPasswordCodeDtoTypeEnum;
@@ -2216,6 +2724,7 @@ export interface UmaTOTPSerializer {
2216
2724
  }
2217
2725
  export interface UmaTablePresetSerializer {
2218
2726
  b2b_user_id: number;
2727
+ b2b_user_uuid: string;
2219
2728
  id: number;
2220
2729
  presets: object;
2221
2730
  table_name: string;
@@ -2230,6 +2739,14 @@ export interface UmaTenantSettingDto {
2230
2739
  label?: UmaTenantSettingDtoLabelEnum;
2231
2740
  value?: string;
2232
2741
  }
2742
+ export interface UmaTenantSettingSerializer {
2743
+ branch_id: string;
2744
+ created_at: string;
2745
+ id: number;
2746
+ label: string;
2747
+ updated_at: string;
2748
+ value: string;
2749
+ }
2233
2750
  export interface UmaTokens {
2234
2751
  access_expires_at?: number;
2235
2752
  access_token?: string;
@@ -2239,9 +2756,9 @@ export interface UmaTokens {
2239
2756
  }
2240
2757
  export interface UmaTrustedDeviceSerializer {
2241
2758
  b2b_user: UmaAdminUserSerializer;
2242
- b2b_user_id: number;
2759
+ b2b_user_id: string;
2243
2760
  b2c_user: UmaAdminB2CUserSerializer;
2244
- b2c_user_id: number;
2761
+ b2c_user_id: string;
2245
2762
  created_at: string;
2246
2763
  device_id: string;
2247
2764
  device_name: string;
@@ -2252,11 +2769,16 @@ export interface UmaTrustedDeviceSerializer {
2252
2769
  }
2253
2770
  export interface UmaUpdateAPIKeysDto {
2254
2771
  ac_same_as_for_user?: boolean;
2772
+ branch_uuids?: string[];
2255
2773
  branches?: number[];
2256
2774
  firms?: UmaFirmInfo[];
2257
2775
  mfa_codes?: UmaMfaCodesDto;
2258
2776
  name?: string;
2777
+ permission_uuids?: string[];
2259
2778
  permissions?: number[];
2779
+ regional_permissions?: UmaRegionalAccessDto[];
2780
+ regional_roles?: UmaRegionalAccessDto[];
2781
+ role_uuids?: string[];
2260
2782
  roles?: number[];
2261
2783
  updated_at?: string;
2262
2784
  }
@@ -2267,6 +2789,7 @@ export interface UmaUpdateAuthAppDto {
2267
2789
  export interface UmaUpdateB2BUserDto {
2268
2790
  access_revoking_date?: string;
2269
2791
  allow_feedback?: boolean;
2792
+ branch_uuids?: string[];
2270
2793
  branches?: number[];
2271
2794
  /** @example "test@gmail.com" */
2272
2795
  email?: string;
@@ -2276,11 +2799,15 @@ export interface UmaUpdateB2BUserDto {
2276
2799
  last_name?: string;
2277
2800
  /** @example "TeStPaSS" */
2278
2801
  password?: string;
2802
+ permission_uuids?: string[];
2279
2803
  permissions?: number[];
2280
2804
  /** @example "+1231231234" */
2281
2805
  phone?: string;
2282
2806
  primary_firm_id?: number;
2283
- rep_code?: string;
2807
+ primary_firm_uuid?: string;
2808
+ regional_permissions?: UmaRegionalAccessDto[];
2809
+ regional_roles?: UmaRegionalAccessDto[];
2810
+ role_uuids?: string[];
2284
2811
  roles?: number[];
2285
2812
  should_reset_password?: boolean;
2286
2813
  title?: string;
@@ -2292,19 +2819,23 @@ export interface UmaUpdateB2BUserDto {
2292
2819
  export interface UmaUpdateB2CUserDto {
2293
2820
  access_revoking_date?: string;
2294
2821
  allow_feedback?: boolean;
2822
+ branch_uuids?: string[];
2295
2823
  branches?: number[];
2296
2824
  /** @example "test@gmail.com" */
2297
2825
  email?: string;
2298
2826
  email_code?: string;
2299
2827
  firm_id?: number;
2828
+ firm_uuid?: string;
2300
2829
  first_name?: string;
2301
2830
  last_name?: string;
2302
2831
  /** @example "TeStPaSS" */
2303
2832
  password?: string;
2833
+ permission_uuids?: string[];
2304
2834
  permissions?: number[];
2305
2835
  /** @example "+1231231234" */
2306
2836
  phone?: string;
2307
2837
  phone_code?: string;
2838
+ role_uuids?: string[];
2308
2839
  roles?: number[];
2309
2840
  updated_at?: string;
2310
2841
  username?: string;
@@ -2323,12 +2854,19 @@ export interface UmaUpdateBranchDto {
2323
2854
  slug?: string;
2324
2855
  updated_at?: string;
2325
2856
  }
2857
+ export interface UmaUpdateChatDto {
2858
+ /** @maxLength 255 */
2859
+ name?: string;
2860
+ pinned?: boolean;
2861
+ }
2326
2862
  export interface UmaUpdateEndpointDto {
2327
2863
  is_active?: boolean;
2328
2864
  is_public?: boolean;
2329
2865
  metadata?: UmaEndpointMetadataDto;
2330
2866
  method?: UmaUpdateEndpointDtoMethodEnum;
2331
2867
  microservice_id?: number;
2868
+ microservice_uuid?: string;
2869
+ required_permission_uuids?: string[];
2332
2870
  required_permissions?: number[];
2333
2871
  route?: string;
2334
2872
  type?: UmaUpdateEndpointDtoTypeEnum;
@@ -2349,6 +2887,7 @@ export interface UmaUpdateFirmDto {
2349
2887
  slug?: string;
2350
2888
  status?: UmaUpdateFirmDtoStatusEnum;
2351
2889
  updated_at?: string;
2890
+ zendesk_credentials?: UmaFirmZendeskCredsDto;
2352
2891
  }
2353
2892
  export interface UmaUpdateIdentityProviderDto {
2354
2893
  auth_url?: string;
@@ -2356,6 +2895,7 @@ export interface UmaUpdateIdentityProviderDto {
2356
2895
  client_secret?: string;
2357
2896
  company_domain?: string;
2358
2897
  firm_id?: number;
2898
+ firm_uuid?: string;
2359
2899
  priority?: number;
2360
2900
  redirect_url?: string;
2361
2901
  type?: UmaUpdateIdentityProviderDtoTypeEnum;
@@ -2365,6 +2905,7 @@ export interface UmaUpdateMicroserviceDto {
2365
2905
  description?: string;
2366
2906
  domains?: UmaMicroserviceDomainDto[];
2367
2907
  is_active?: boolean;
2908
+ is_globalized?: boolean;
2368
2909
  is_token_encoding_required?: boolean;
2369
2910
  is_visible_on_admin_sidebar?: boolean;
2370
2911
  logo_url?: string;
@@ -2375,11 +2916,14 @@ export interface UmaUpdateMicroserviceDto {
2375
2916
  export interface UmaUpdatePermissionDto {
2376
2917
  metadata?: UmaPermissionMetadataDto;
2377
2918
  microservice_id?: number;
2919
+ microservice_uuid?: string;
2378
2920
  permission?: string;
2379
2921
  updated_at?: string;
2380
2922
  }
2381
2923
  export interface UmaUpdateRoleDto {
2382
2924
  name?: string;
2925
+ permission_can_assign_role_uuids?: string[];
2926
+ permission_uuids?: string[];
2383
2927
  permissions?: number[];
2384
2928
  permissions_can_assign_role?: number[];
2385
2929
  type_id?: number;
@@ -2393,6 +2937,7 @@ export interface UmaUpdateRoleTypeDto {
2393
2937
  export interface UmaUpdateSystemUserDto {
2394
2938
  access_revoking_date?: string;
2395
2939
  allow_feedback?: boolean;
2940
+ branch_uuids?: string[];
2396
2941
  branches?: number[];
2397
2942
  /** @example "test@gmail.com" */
2398
2943
  email?: string;
@@ -2401,11 +2946,15 @@ export interface UmaUpdateSystemUserDto {
2401
2946
  has_access_to_all_firm_branches?: boolean;
2402
2947
  /** @example "TeStPaSS" */
2403
2948
  password?: string;
2949
+ permission_uuids?: string[];
2404
2950
  permissions?: number[];
2405
2951
  /** @example "+1231231234" */
2406
2952
  phone?: string;
2407
2953
  primary_firm_id?: number;
2408
- rep_code?: string;
2954
+ primary_firm_uuid?: string;
2955
+ regional_permissions?: UmaRegionalAccessDto[];
2956
+ regional_roles?: UmaRegionalAccessDto[];
2957
+ role_uuids?: string[];
2409
2958
  roles?: number[];
2410
2959
  should_reset_password?: boolean;
2411
2960
  title?: string;
@@ -2446,6 +2995,9 @@ export interface UmaUserSerializer {
2446
2995
  /** @example 1 */
2447
2996
  id: number;
2448
2997
  initiator_id: number;
2998
+ initiator_uuid: string;
2999
+ /** @example "2022-02-02T00:00:00Z" */
3000
+ last_login_at: string;
2449
3001
  /** @example "Jenkins" */
2450
3002
  last_name: string;
2451
3003
  locale: UmaLocaleSerializer;
@@ -2456,12 +3008,13 @@ export interface UmaUserSerializer {
2456
3008
  phone: string;
2457
3009
  /** @example true */
2458
3010
  phone_verified: boolean;
2459
- rep_code: string;
3011
+ region: string;
2460
3012
  should_reset_password: boolean;
2461
3013
  small_avatar_url: string;
2462
3014
  /** @example "2022-02-02T00:00:00Z" */
2463
3015
  updated_at: string;
2464
3016
  username: string;
3017
+ uuid: string;
2465
3018
  watchmen_user_links: UmaWatchmenUserLinkSerializer[];
2466
3019
  }
2467
3020
  export interface UmaUserStatusChangeReasonSerializer {
@@ -2494,23 +3047,27 @@ export interface UmaWatchmenInstanceSerializer {
2494
3047
  created_at: string;
2495
3048
  id: number;
2496
3049
  name: string;
3050
+ region: string;
2497
3051
  slug: string;
2498
3052
  updated_at: string;
2499
3053
  url: string;
3054
+ uuid: string;
2500
3055
  }
2501
3056
  export interface UmaWatchmenUserLinkDto {
2502
3057
  branch_id?: number;
3058
+ branch_uuid?: string;
2503
3059
  watchmen_instance_id?: number;
3060
+ watchmen_instance_uuid?: string;
2504
3061
  watchmen_user_id?: number;
2505
3062
  }
2506
3063
  export interface UmaWatchmenUserLinkSerializer {
2507
3064
  branch: UmaBranchSerializer;
2508
- branch_id: number;
3065
+ branch_id: string;
2509
3066
  created_at: string;
2510
3067
  id: number;
2511
3068
  updated_at: string;
2512
3069
  watchmen_instance: UmaWatchmenInstanceSerializer;
2513
- watchmen_instance_id: number;
3070
+ watchmen_instance_id: string;
2514
3071
  watchmen_user_id: number;
2515
3072
  }
2516
3073
  export interface UmaWebAuthnAssertionResponse {
@@ -2722,6 +3279,11 @@ export enum UmaPartialUpdateFirmDtoStatusEnum {
2722
3279
  Suspended = "suspended",
2723
3280
  Deleted = "deleted"
2724
3281
  }
3282
+ export enum UmaPermissionAccessSerializerAssignmentGroupEnum {
3283
+ Regular = "regular",
3284
+ Chiefadmin = "chiefadmin",
3285
+ Superadmin = "superadmin"
3286
+ }
2725
3287
  export enum UmaPermissionSerializerAssignmentGroupEnum {
2726
3288
  Regular = "regular",
2727
3289
  Chiefadmin = "chiefadmin",
@@ -2809,7 +3371,10 @@ export class AdminApiKeys<HandleError extends boolean = boolean, Format extends
2809
3371
  * @request POST:/v1/admin/api-keys
2810
3372
  * @secure
2811
3373
  */
2812
- create(createApiKey: UmaAdminCreateAPIKeyDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaAdminAPIKeysMutationSerializer, HandleError, Format>>;
3374
+ create(createApiKey: UmaAdminCreateAPIKeyDto, headers?: {
3375
+ /** If true and caller has multi-region access, include firms/branches from all regions instead of only the current region */
3376
+ 'X-ALL-REGIONS'?: string;
3377
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaAdminAPIKeysMutationSerializer, HandleError, Format>>;
2813
3378
  /**
2814
3379
  * @description Delete any API Keys by IDs. Only accessible to chiefadmin.
2815
3380
  * @tags admin_api_keys
@@ -2827,7 +3392,10 @@ export class AdminApiKeys<HandleError extends boolean = boolean, Format extends
2827
3392
  * @request POST:/v1/admin/api-keys/list
2828
3393
  * @secure
2829
3394
  */
2830
- get(apiKeys: UmaAdminGetAPIKeysListDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaGetAdminAPIKeysSerializer, HandleError, Format>>;
3395
+ get(apiKeys: UmaAdminGetAPIKeysListDto, headers?: {
3396
+ /** If true and caller has multi-region access, include firms/branches from all regions instead of only the current region */
3397
+ 'X-ALL-REGIONS'?: string;
3398
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaGetAdminAPIKeysSerializer, HandleError, Format>>;
2831
3399
  /**
2832
3400
  * @description Get any API Key by id. Only accessible to chiefadmin.
2833
3401
  * @tags admin_api_keys
@@ -2836,7 +3404,10 @@ export class AdminApiKeys<HandleError extends boolean = boolean, Format extends
2836
3404
  * @request GET:/v1/admin/api-keys/{id}
2837
3405
  * @secure
2838
3406
  */
2839
- getById(id: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaAdminAPIKeysMutationSerializer, HandleError, Format>>;
3407
+ getById(id: number, headers?: {
3408
+ /** If true and caller has multi-region access, include firms/branches from all regions instead of only the current region */
3409
+ 'X-ALL-REGIONS'?: string;
3410
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaAdminAPIKeysMutationSerializer, HandleError, Format>>;
2840
3411
  /**
2841
3412
  * @description Update any API Key Record. Only accessible to chiefadmin.
2842
3413
  * @tags admin_api_keys
@@ -2845,7 +3416,139 @@ export class AdminApiKeys<HandleError extends boolean = boolean, Format extends
2845
3416
  * @request PUT:/v1/admin/api-keys/{id}
2846
3417
  * @secure
2847
3418
  */
2848
- update(id: number, apiKey: UmaAdminUpdateAPIKeyDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaAdminAPIKeysMutationSerializer, HandleError, Format>>;
3419
+ update(id: number, apiKey: UmaAdminUpdateAPIKeyDto, headers?: {
3420
+ /** If true and caller has multi-region access, include firms/branches from all regions instead of only the current region */
3421
+ 'X-ALL-REGIONS'?: string;
3422
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaAdminAPIKeysMutationSerializer, HandleError, Format>>;
3423
+ }
3424
+ export class AiAssistant<HandleError extends boolean = boolean, Format extends CaseFormat = CaseFormat.Original> {
3425
+ protected readonly apiClient: JwtClient<HandleError, Format>;
3426
+ constructor(apiClient: JwtClient<HandleError, Format>);
3427
+ /**
3428
+ * @description Send a question to the AI assistant and stream back an answer grounded in the knowledge base as Server-Sent Events: one or more `chunk` events with partial text, followed by one `done` event with the full answer. Pass chat_id to continue an existing chat (e.g. one reopened from the chats list); omit it to start a new chat. Pass context for extra frontend-supplied context (e.g. the page the user is on) that should inform the answer without being treated as part of the user's message or stored in chat history. A locked_for_seconds in the done event locks only the chat identified by chat_id in the same event. When the answer points at an ODB page, the page is linked inline in the answer text as markdown and also listed in links - every link is resolved from a known frontend route; routes whose path carries :placeholders are never linked.
3429
+ * @tags ai_assistant
3430
+ * @name Send
3431
+ * @summary Ask AI Assistant a Question
3432
+ * @request POST:/v1/ai-assistant/ask
3433
+ * @secure
3434
+ */
3435
+ send(sendMessage: UmaSendMessageDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaAIAssistantAnswerSerializer, HandleError, Format>>;
3436
+ /**
3437
+ * @description List the current user's AI assistant chats, most recently active first. Each chat carries its own locked_for_seconds - an off-topic lock applies to the chat it was triggered in and to no other.
3438
+ * @tags ai_assistant
3439
+ * @name List
3440
+ * @summary List AI Assistant Chats
3441
+ * @request GET:/v1/ai-assistant/chats
3442
+ * @secure
3443
+ */
3444
+ list(config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaAIAssistantChatsListSerializer, HandleError, Format>>;
3445
+ /**
3446
+ * @description Soft-delete one of the current user's AI assistant chats. The chat is hidden from the user but retained in storage.
3447
+ * @tags ai_assistant
3448
+ * @name Delete
3449
+ * @summary Delete AI Assistant Chat By ID
3450
+ * @request DELETE:/v1/ai-assistant/chats/{id}
3451
+ * @secure
3452
+ */
3453
+ delete(id: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError, Format>>;
3454
+ /**
3455
+ * @description Partially update one of the current user's AI assistant chats: rename it (name) and/or pin it to the top of the chats list (pinned). Fields left out keep their current values. Pinned chats are returned first by GET /chats, most recently pinned first, and are never cut off by the chats list limit. Re-pinning an already pinned chat keeps its original pin position.
3456
+ * @tags ai_assistant
3457
+ * @name Update
3458
+ * @summary Update AI Assistant Chat
3459
+ * @request PATCH:/v1/ai-assistant/chats/{id}
3460
+ * @secure
3461
+ */
3462
+ update(id: number, updateChat: UmaUpdateChatDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaAIAssistantChatMutationSerializer, HandleError, Format>>;
3463
+ /**
3464
+ * @description Get the message history of one of the current user's past AI assistant chats. locked_for_seconds is the off-topic lock left on this chat only - it never applies to the user's other chats.
3465
+ * @tags ai_assistant
3466
+ * @name GetHistory
3467
+ * @summary Get AI Assistant Chat History By ID
3468
+ * @request GET:/v1/ai-assistant/chats/{id}/messages
3469
+ * @secure
3470
+ */
3471
+ getHistory(id: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaAIAssistantHistorySerializer, HandleError, Format>>;
3472
+ /**
3473
+ * @description Get the message history of the current user's most recently active AI assistant chat. Returns an empty list when the user has no chats yet. Each message carries the links its answer pointed at, resolved against the current frontend routes. locked_for_seconds is the off-topic lock left on that chat only - it never applies to the user's other chats.
3474
+ * @tags ai_assistant
3475
+ * @name GetHistory2
3476
+ * @summary Get AI Assistant Conversation History
3477
+ * @request GET:/v1/ai-assistant/messages
3478
+ * @originalName getHistory
3479
+ * @duplicate
3480
+ * @secure
3481
+ */
3482
+ getHistory2(config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaAIAssistantHistorySerializer, HandleError, Format>>;
3483
+ /**
3484
+ * @description List AI Assistant Question Log
3485
+ * @tags ai_assistant
3486
+ * @name List2
3487
+ * @summary List AI Assistant Question Log
3488
+ * @request POST:/v1/ai-assistant/question-log/list
3489
+ * @originalName list
3490
+ * @duplicate
3491
+ * @secure
3492
+ */
3493
+ list2(getQuestionLog: UmaGetAIAssistantQuestionLogListDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaAIAssistantQuestionLogListSerializer, HandleError, Format>>;
3494
+ /**
3495
+ * @description Get the details of a single AI Assistant Question Log entry together with the full chat history of the session it belongs to
3496
+ * @tags ai_assistant
3497
+ * @name GetDetails
3498
+ * @summary Get AI Assistant Question Log Details
3499
+ * @request GET:/v1/ai-assistant/question-log/{id}
3500
+ * @secure
3501
+ */
3502
+ getDetails(id: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaAIAssistantQuestionLogDetailsSerializer, HandleError, Format>>;
3503
+ }
3504
+ export class AllowedEmails<HandleError extends boolean = boolean, Format extends CaseFormat = CaseFormat.Original> {
3505
+ protected readonly apiClient: JwtClient<HandleError, Format>;
3506
+ constructor(apiClient: JwtClient<HandleError, Format>);
3507
+ /**
3508
+ * @description Create Allowed Email
3509
+ * @tags allowed_emails
3510
+ * @name Create
3511
+ * @summary Create Allowed Email
3512
+ * @request POST:/v1/allowed-emails
3513
+ * @secure
3514
+ */
3515
+ create(allowedEmailDto: UmaAllowedEmailDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaAllowedEmailMutationSerializer, HandleError, Format>>;
3516
+ /**
3517
+ * @description Delete allowed emails
3518
+ * @tags allowed_emails
3519
+ * @name DeleteMany
3520
+ * @summary Delete allowed emails
3521
+ * @request DELETE:/v1/allowed-emails
3522
+ * @secure
3523
+ */
3524
+ deleteMany(deleteAllowedEmailsDto: UmaDeleteByIDsDtoInt, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError, Format>>;
3525
+ /**
3526
+ * @description Get allowed emails with pagination
3527
+ * @tags allowed_emails
3528
+ * @name Get
3529
+ * @summary Get allowed emails with pagination
3530
+ * @request POST:/v1/allowed-emails/list
3531
+ * @secure
3532
+ */
3533
+ get(allowedEmailsListDto: UmaGetAllowedEmailsListDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaGetAllowedEmailsListSerializer, HandleError, Format>>;
3534
+ /**
3535
+ * @description Get Allowed Email by id
3536
+ * @tags allowed_emails
3537
+ * @name GetById
3538
+ * @summary Get Allowed Email by id
3539
+ * @request GET:/v1/allowed-emails/{id}
3540
+ * @secure
3541
+ */
3542
+ getById(id: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaAllowedEmailMutationSerializer, HandleError, Format>>;
3543
+ /**
3544
+ * @description Update Allowed Email
3545
+ * @tags allowed_emails
3546
+ * @name Update
3547
+ * @summary Update Allowed Email
3548
+ * @request PUT:/v1/allowed-emails/{id}
3549
+ * @secure
3550
+ */
3551
+ update(id: number, allowedEmailDto: UmaAllowedEmailDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaAllowedEmailMutationSerializer, HandleError, Format>>;
2849
3552
  }
2850
3553
  export class AllowedOrigins<HandleError extends boolean = boolean, Format extends CaseFormat = CaseFormat.Original> {
2851
3554
  protected readonly apiClient: JwtClient<HandleError, Format>;
@@ -2916,7 +3619,10 @@ export class ApiKeys<HandleError extends boolean = boolean, Format extends CaseF
2916
3619
  * @request GET:/v1/b2b/api-keys/{id}
2917
3620
  * @secure
2918
3621
  */
2919
- getById(id: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaAPIKeysMutationSerializer, HandleError, Format>>;
3622
+ getById(id: number, headers?: {
3623
+ /** If true and caller has multi-region access, include firms/branches from all regions instead of only the current region */
3624
+ 'X-ALL-REGIONS'?: string;
3625
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaAPIKeysMutationSerializer, HandleError, Format>>;
2920
3626
  /**
2921
3627
  * @description Create API Key & API Secret Pair. API Secret won't be accessible for read after that
2922
3628
  * @tags api_keys
@@ -2925,7 +3631,10 @@ export class ApiKeys<HandleError extends boolean = boolean, Format extends CaseF
2925
3631
  * @request POST:/v2/b2b/api-keys
2926
3632
  * @secure
2927
3633
  */
2928
- create(createApiKeys: UmaCreateAPIKeysDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaAPIKeysMutationSerializer, HandleError, Format>>;
3634
+ create(createApiKeys: UmaCreateAPIKeysDto, headers?: {
3635
+ /** If true and caller has multi-region access, include firms/branches from all regions instead of only the current region */
3636
+ 'X-ALL-REGIONS'?: string;
3637
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaAPIKeysMutationSerializer, HandleError, Format>>;
2929
3638
  /**
2930
3639
  * @description Get API Keys info(would return API Keys without secrets)
2931
3640
  * @tags api_keys
@@ -2934,7 +3643,10 @@ export class ApiKeys<HandleError extends boolean = boolean, Format extends CaseF
2934
3643
  * @request POST:/v2/b2b/api-keys/list
2935
3644
  * @secure
2936
3645
  */
2937
- get(apiKeys: UmaGetAPIKeysListDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaGetAPIKeysSerializer, HandleError, Format>>;
3646
+ get(apiKeys: UmaGetAPIKeysListDto, headers?: {
3647
+ /** If true and caller has multi-region access, include firms/branches from all regions instead of only the current region */
3648
+ 'X-ALL-REGIONS'?: string;
3649
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaGetAPIKeysSerializer, HandleError, Format>>;
2938
3650
  /**
2939
3651
  * @description Update API Key Record
2940
3652
  * @tags api_keys
@@ -2943,7 +3655,10 @@ export class ApiKeys<HandleError extends boolean = boolean, Format extends CaseF
2943
3655
  * @request PUT:/v2/b2b/api-keys/{id}
2944
3656
  * @secure
2945
3657
  */
2946
- update(id: number, apiKeys: UmaUpdateAPIKeysDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaAPIKeysMutationSerializer, HandleError, Format>>;
3658
+ update(id: number, apiKeys: UmaUpdateAPIKeysDto, headers?: {
3659
+ /** If true and caller has multi-region access, include firms/branches from all regions instead of only the current region */
3660
+ 'X-ALL-REGIONS'?: string;
3661
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaAPIKeysMutationSerializer, HandleError, Format>>;
2947
3662
  }
2948
3663
  export class AuthApps<HandleError extends boolean = boolean, Format extends CaseFormat = CaseFormat.Original> {
2949
3664
  protected readonly apiClient: JwtClient<HandleError, Format>;
@@ -3203,7 +3918,10 @@ export class B2BUsers<HandleError extends boolean = boolean, Format extends Case
3203
3918
  * @request GET:/v1/users/b2b/{id}
3204
3919
  * @secure
3205
3920
  */
3206
- getById(id: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaB2BUserSerializer, HandleError, Format>>;
3921
+ getById(id: string, headers?: {
3922
+ /** If true and caller has multi-region access, include firms/branches from all regions instead of only the current region */
3923
+ 'X-ALL-REGIONS'?: string;
3924
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaB2BUserSerializer, HandleError, Format>>;
3207
3925
  /**
3208
3926
  * @description Update B2B User (partial updates supported)
3209
3927
  * @tags b2b_users
@@ -3212,7 +3930,10 @@ export class B2BUsers<HandleError extends boolean = boolean, Format extends Case
3212
3930
  * @request PATCH:/v1/users/b2b/{id}
3213
3931
  * @secure
3214
3932
  */
3215
- partialUpdate(id: number, createB2BUserNew: UmaPartialUpdateB2BUserDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaB2BUserSerializer, HandleError, Format>>;
3933
+ partialUpdate(id: string, createB2BUserNew: UmaPartialUpdateB2BUserDto, headers?: {
3934
+ /** If true and caller has multi-region access, include firms/branches from all regions instead of only the current region */
3935
+ 'X-ALL-REGIONS'?: string;
3936
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaB2BUserSerializer, HandleError, Format>>;
3216
3937
  /**
3217
3938
  * @description Generate B2B User PDF
3218
3939
  * @tags b2b_users
@@ -3221,7 +3942,7 @@ export class B2BUsers<HandleError extends boolean = boolean, Format extends Case
3221
3942
  * @request POST:/v1/users/b2b/{id}/generate-as-pdf
3222
3943
  * @secure
3223
3944
  */
3224
- generateAsPdf(id: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaGeneratedEntityPDFSerializer, HandleError, Format>>;
3945
+ generateAsPdf(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaGeneratedEntityPDFSerializer, HandleError, Format>>;
3225
3946
  /**
3226
3947
  * @description Change B2B User status
3227
3948
  * @tags b2b_users
@@ -3230,7 +3951,7 @@ export class B2BUsers<HandleError extends boolean = boolean, Format extends Case
3230
3951
  * @request PATCH:/v1/users/b2b/{id}/status
3231
3952
  * @secure
3232
3953
  */
3233
- changeStatus(id: number, changeUserStatus: UmaChangeUserStatusDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError, Format>>;
3954
+ changeStatus(id: string, changeUserStatus: UmaChangeUserStatusDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError, Format>>;
3234
3955
  /**
3235
3956
  * @description Create B2B User
3236
3957
  * @tags b2b_users
@@ -3239,7 +3960,10 @@ export class B2BUsers<HandleError extends boolean = boolean, Format extends Case
3239
3960
  * @request POST:/v2/users/b2b
3240
3961
  * @secure
3241
3962
  */
3242
- create(createB2BUser: UmaCreateB2BUserDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaB2BUserSerializer, HandleError, Format>>;
3963
+ create(createB2BUser: UmaCreateB2BUserDto, headers?: {
3964
+ /** If true and caller has multi-region access, include firms/branches from all regions instead of only the current region */
3965
+ 'X-ALL-REGIONS'?: string;
3966
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaB2BUserSerializer, HandleError, Format>>;
3243
3967
  /**
3244
3968
  * @description Get B2B users with pagination
3245
3969
  * @tags b2b_users
@@ -3248,7 +3972,10 @@ export class B2BUsers<HandleError extends boolean = boolean, Format extends Case
3248
3972
  * @request POST:/v2/users/b2b/list
3249
3973
  * @secure
3250
3974
  */
3251
- get(getB2BUsers: UmaGetB2BUsersListDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaGetUsersListSerializerTypesAdminB2BUserSerializer, HandleError, Format>>;
3975
+ get(getB2BUsers: UmaGetB2BUsersListDto, headers?: {
3976
+ /** If true and caller has multi-region access, include firms/branches from all regions instead of only the current region */
3977
+ 'X-ALL-REGIONS'?: string;
3978
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaGetUsersListSerializerTypesAdminB2BUserSerializer, HandleError, Format>>;
3252
3979
  /**
3253
3980
  * @description Update B2B User
3254
3981
  * @tags b2b_users
@@ -3257,7 +3984,10 @@ export class B2BUsers<HandleError extends boolean = boolean, Format extends Case
3257
3984
  * @request PUT:/v2/users/b2b/{id}
3258
3985
  * @secure
3259
3986
  */
3260
- update(id: number, createB2BUserNew: UmaUpdateB2BUserDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaB2BUserSerializer, HandleError, Format>>;
3987
+ update(id: string, createB2BUserNew: UmaUpdateB2BUserDto, headers?: {
3988
+ /** If true and caller has multi-region access, include firms/branches from all regions instead of only the current region */
3989
+ 'X-ALL-REGIONS'?: string;
3990
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaB2BUserSerializer, HandleError, Format>>;
3261
3991
  }
3262
3992
  export class B2BUserSettings<HandleError extends boolean = boolean, Format extends CaseFormat = CaseFormat.Original> {
3263
3993
  protected readonly apiClient: JwtClient<HandleError, Format>;
@@ -3387,7 +4117,7 @@ export class B2CAuth<HandleError extends boolean = boolean, Format extends CaseF
3387
4117
  */
3388
4118
  finishGoogleLogin(finishOAuthLoginDto: UmaFinishOAuthLoginDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaB2CLoginResultSerializer, HandleError, Format>>;
3389
4119
  /**
3390
- * @description Impersonate B2C user
4120
+ * @description Impersonate B2C user. By default returns tokens directly; when response_mode is "auth_code", returns a one-time auth_code together with a state identifier instead, to be exchanged for tokens via /v1/auth/b2c/login/impersonate/exchange-code. Multiple auth_codes can be valid for the same user at the same time
3391
4121
  * @tags b2c_auth
3392
4122
  * @name ImpersonateLogin
3393
4123
  * @summary Impersonate B2C user
@@ -3395,6 +4125,14 @@ export class B2CAuth<HandleError extends boolean = boolean, Format extends CaseF
3395
4125
  * @secure
3396
4126
  */
3397
4127
  impersonateLogin(b2cImpersonate: UmaB2CImpersonateDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaImpersonateResultSerializer, HandleError, Format>>;
4128
+ /**
4129
+ * @description Exchange a one-time auth_code and its state (issued by /v1/auth/b2c/login/impersonate with response_mode=auth_code) for the impersonated user's tokens
4130
+ * @tags b2c_auth
4131
+ * @name ExchangeImpersonateAuthCode
4132
+ * @summary Exchange B2C impersonate auth_code for tokens
4133
+ * @request POST:/v1/auth/b2c/login/impersonate/exchange-code
4134
+ */
4135
+ exchangeImpersonateAuthCode(exchangeAuthCode: UmaExchangeB2CImpersonateAuthCodeDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaImpersonateResultSerializer, HandleError, Format>>;
3398
4136
  /**
3399
4137
  * @description logout from B2C user session
3400
4138
  * @tags b2c_auth
@@ -3542,6 +4280,51 @@ export class B2CUsers<HandleError extends boolean = boolean, Format extends Case
3542
4280
  * @secure
3543
4281
  */
3544
4282
  getVerifiedContactChangeCode(getVerifiedContactChangeCodeDto: UmaGetVerifiedContactChangeCodeDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError, Format>>;
4283
+ /**
4284
+ * @description Create a default role assigned to B2C users during registration
4285
+ * @tags b2c_users
4286
+ * @name CreateDefaultRegistrationRole
4287
+ * @summary Create Default B2C Registration Role
4288
+ * @request POST:/v1/users/b2c/default-registration-roles
4289
+ * @secure
4290
+ */
4291
+ createDefaultRegistrationRole(defaultB2CRegistrationRoleDto: UmaDefaultB2CRegistrationRoleDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaDefaultB2CRegistrationRoleMutationSerializer, HandleError, Format>>;
4292
+ /**
4293
+ * @description Delete default B2C registration roles by IDs
4294
+ * @tags b2c_users
4295
+ * @name DeleteDefaultRegistrationRoles
4296
+ * @summary Delete Default B2C Registration Roles
4297
+ * @request DELETE:/v1/users/b2c/default-registration-roles
4298
+ * @secure
4299
+ */
4300
+ deleteDefaultRegistrationRoles(deleteDefaultB2CRegistrationRoles: UmaDeleteByIDsDtoInt, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError, Format>>;
4301
+ /**
4302
+ * @description Get paginated list of default roles assigned to B2C users during registration
4303
+ * @tags b2c_users
4304
+ * @name GetDefaultRegistrationRolesList
4305
+ * @summary Get Default B2C Registration Roles List
4306
+ * @request POST:/v1/users/b2c/default-registration-roles/list
4307
+ * @secure
4308
+ */
4309
+ getDefaultRegistrationRolesList(getDefaultB2CRegistrationRolesList: UmaGetDefaultB2CRegistrationRolesListDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaGetDefaultB2CRegistrationRolesListSerializer, HandleError, Format>>;
4310
+ /**
4311
+ * @description Get default B2C registration role by id
4312
+ * @tags b2c_users
4313
+ * @name GetDefaultRegistrationRoleById
4314
+ * @summary Get Default B2C Registration Role by ID
4315
+ * @request GET:/v1/users/b2c/default-registration-roles/{id}
4316
+ * @secure
4317
+ */
4318
+ getDefaultRegistrationRoleById(id: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaDefaultB2CRegistrationRoleMutationSerializer, HandleError, Format>>;
4319
+ /**
4320
+ * @description Update default B2C registration role
4321
+ * @tags b2c_users
4322
+ * @name UpdateDefaultRegistrationRole
4323
+ * @summary Update Default B2C Registration Role
4324
+ * @request PUT:/v1/users/b2c/default-registration-roles/{id}
4325
+ * @secure
4326
+ */
4327
+ updateDefaultRegistrationRole(id: number, defaultB2CRegistrationRoleDto: UmaDefaultB2CRegistrationRoleDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaDefaultB2CRegistrationRoleMutationSerializer, HandleError, Format>>;
3545
4328
  /**
3546
4329
  * @description Get B2C User by id
3547
4330
  * @tags b2c_users
@@ -3550,7 +4333,7 @@ export class B2CUsers<HandleError extends boolean = boolean, Format extends Case
3550
4333
  * @request GET:/v1/users/b2c/{id}
3551
4334
  * @secure
3552
4335
  */
3553
- getById(id: number, headers?: {
4336
+ getById(id: string, headers?: {
3554
4337
  /** Specify format of response. Possible values: `full` (default), `shortened` */
3555
4338
  'X-Accept'?: string;
3556
4339
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaB2CUserSerializer, HandleError, Format>>;
@@ -3562,7 +4345,7 @@ export class B2CUsers<HandleError extends boolean = boolean, Format extends Case
3562
4345
  * @request PUT:/v1/users/b2c/{id}
3563
4346
  * @secure
3564
4347
  */
3565
- update(id: number, createB2BUser: UmaUpdateB2CUserDto, headers?: {
4348
+ update(id: string, createB2BUser: UmaUpdateB2CUserDto, headers?: {
3566
4349
  /** Specify format of response. Possible values: `full` (default), `shortened` */
3567
4350
  'X-Accept'?: string;
3568
4351
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaB2CUserSerializer, HandleError, Format>>;
@@ -3574,7 +4357,7 @@ export class B2CUsers<HandleError extends boolean = boolean, Format extends Case
3574
4357
  * @request PATCH:/v1/users/b2c/{id}
3575
4358
  * @secure
3576
4359
  */
3577
- partialUpdate(id: number, createB2BUser: UmaPartialUpdateB2CUserDto, headers?: {
4360
+ partialUpdate(id: string, createB2BUser: UmaPartialUpdateB2CUserDto, headers?: {
3578
4361
  /** Specify format of response. Possible values: `full` (default), `shortened` */
3579
4362
  'X-Accept'?: string;
3580
4363
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaB2CUserSerializer, HandleError, Format>>;
@@ -3586,7 +4369,7 @@ export class B2CUsers<HandleError extends boolean = boolean, Format extends Case
3586
4369
  * @request POST:/v1/users/b2c/{id}/generate-as-pdf
3587
4370
  * @secure
3588
4371
  */
3589
- generateAsPdf(id: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaGeneratedEntityPDFSerializer, HandleError, Format>>;
4372
+ generateAsPdf(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaGeneratedEntityPDFSerializer, HandleError, Format>>;
3590
4373
  /**
3591
4374
  * @description Change B2C User status
3592
4375
  * @tags b2c_users
@@ -3595,7 +4378,7 @@ export class B2CUsers<HandleError extends boolean = boolean, Format extends Case
3595
4378
  * @request PATCH:/v1/users/b2c/{id}/status
3596
4379
  * @secure
3597
4380
  */
3598
- changeStatus(id: number, changeUserStatus: UmaChangeUserStatusDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError, Format>>;
4381
+ changeStatus(id: string, changeUserStatus: UmaChangeUserStatusDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError, Format>>;
3599
4382
  /**
3600
4383
  * @description Get B2C users with pagination
3601
4384
  * @tags b2c_users
@@ -3698,6 +4481,55 @@ export class B2CUserSettings<HandleError extends boolean = boolean, Format exten
3698
4481
  */
3699
4482
  getOAuthBindings(getOAuth2BindingsListDto: UmaGetOAuth2BindingsListDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaAuthProviderUserBindingsResponse, HandleError, Format>>;
3700
4483
  }
4484
+ export class BlockedEmails<HandleError extends boolean = boolean, Format extends CaseFormat = CaseFormat.Original> {
4485
+ protected readonly apiClient: JwtClient<HandleError, Format>;
4486
+ constructor(apiClient: JwtClient<HandleError, Format>);
4487
+ /**
4488
+ * @description Create Blocked Email
4489
+ * @tags blocked_emails
4490
+ * @name Create
4491
+ * @summary Create Blocked Email
4492
+ * @request POST:/v1/blocked-emails
4493
+ * @secure
4494
+ */
4495
+ create(blockedEmailDto: UmaBlockedEmailDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaBlockedEmailMutationSerializer, HandleError, Format>>;
4496
+ /**
4497
+ * @description Delete blocked emails
4498
+ * @tags blocked_emails
4499
+ * @name DeleteMany
4500
+ * @summary Delete blocked emails
4501
+ * @request DELETE:/v1/blocked-emails
4502
+ * @secure
4503
+ */
4504
+ deleteMany(deleteBlockedEmailsDto: UmaDeleteByIDsDtoInt, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError, Format>>;
4505
+ /**
4506
+ * @description Get blocked emails with pagination
4507
+ * @tags blocked_emails
4508
+ * @name Get
4509
+ * @summary Get blocked emails with pagination
4510
+ * @request POST:/v1/blocked-emails/list
4511
+ * @secure
4512
+ */
4513
+ get(blockedEmailsListDto: UmaGetBlockedEmailsListDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaGetBlockedEmailsListSerializer, HandleError, Format>>;
4514
+ /**
4515
+ * @description Get Blocked Email by id
4516
+ * @tags blocked_emails
4517
+ * @name GetById
4518
+ * @summary Get Blocked Email by id
4519
+ * @request GET:/v1/blocked-emails/{id}
4520
+ * @secure
4521
+ */
4522
+ getById(id: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaBlockedEmailMutationSerializer, HandleError, Format>>;
4523
+ /**
4524
+ * @description Update Blocked Email
4525
+ * @tags blocked_emails
4526
+ * @name Update
4527
+ * @summary Update Blocked Email
4528
+ * @request PUT:/v1/blocked-emails/{id}
4529
+ * @secure
4530
+ */
4531
+ update(id: number, blockedEmailDto: UmaBlockedEmailDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaBlockedEmailMutationSerializer, HandleError, Format>>;
4532
+ }
3701
4533
  export class Branches<HandleError extends boolean = boolean, Format extends CaseFormat = CaseFormat.Original> {
3702
4534
  protected readonly apiClient: JwtClient<HandleError, Format>;
3703
4535
  constructor(apiClient: JwtClient<HandleError, Format>);
@@ -3718,7 +4550,7 @@ export class Branches<HandleError extends boolean = boolean, Format extends Case
3718
4550
  * @request DELETE:/v1/branches
3719
4551
  * @secure
3720
4552
  */
3721
- deleteMany(deleteBranches: UmaDeleteByIDsDtoInt, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError, Format>>;
4553
+ deleteMany(deleteBranches: UmaDeleteByUUIDsDtoInt, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError, Format>>;
3722
4554
  /**
3723
4555
  * @description Get Branch by id
3724
4556
  * @tags branches
@@ -3745,7 +4577,7 @@ export class Branches<HandleError extends boolean = boolean, Format extends Case
3745
4577
  * @request PATCH:/v1/branches/{id}
3746
4578
  * @secure
3747
4579
  */
3748
- partialUpdate(id: number, partialUpdateBranch: UmaBranchDtoCommon, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaBranchMutationSerializer, HandleError, Format>>;
4580
+ partialUpdate(id: string, partialUpdateBranch: UmaBranchDtoCommon, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaBranchMutationSerializer, HandleError, Format>>;
3749
4581
  /**
3750
4582
  * @description Get Branches with pagination
3751
4583
  * @tags branches
@@ -3788,7 +4620,7 @@ export class EmailDomains<HandleError extends boolean = boolean, Format extends
3788
4620
  * @request DELETE:/v1/email-domains
3789
4621
  * @secure
3790
4622
  */
3791
- deleteMany(deleteEmailDomainsDto: UmaDeleteByIDsDtoInt, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError, Format>>;
4623
+ deleteMany(deleteEmailDomainsDto: UmaDeleteByUUIDsDtoInt, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError, Format>>;
3792
4624
  /**
3793
4625
  * @description Get emailDomains with pagination
3794
4626
  * @tags email_domains
@@ -3837,7 +4669,7 @@ export class Endpoints<HandleError extends boolean = boolean, Format extends Cas
3837
4669
  * @request DELETE:/v1/b2b/endpoints
3838
4670
  * @secure
3839
4671
  */
3840
- deleteMany(deleteEndpointsDto: UmaDeleteByIDsDtoInt, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError, Format>>;
4672
+ deleteMany(deleteEndpointsDto: UmaDeleteByUUIDsDtoInt, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError, Format>>;
3841
4673
  /**
3842
4674
  * @description Get Endpoint by id
3843
4675
  * @tags endpoints
@@ -3875,6 +4707,19 @@ export class Endpoints<HandleError extends boolean = boolean, Format extends Cas
3875
4707
  */
3876
4708
  get(endpointDto: UmaGetEndpointsListDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaGetEndpointsListSerializer, HandleError, Format>>;
3877
4709
  }
4710
+ export class Feedback<HandleError extends boolean = boolean, Format extends CaseFormat = CaseFormat.Original> {
4711
+ protected readonly apiClient: JwtClient<HandleError, Format>;
4712
+ constructor(apiClient: JwtClient<HandleError, Format>);
4713
+ /**
4714
+ * @description Send the user's feedback to the Zendesk account configured for their firm. The Zendesk OAuth credentials are kept on the firm, so the client application never has to store them. `subject` is optional, up to 255 characters. `comment` is required, up to ZENDESK_MAX_COMMENT_LENGTH characters (2000 by default).
4715
+ * @tags feedback
4716
+ * @name Create
4717
+ * @summary Send Feedback
4718
+ * @request POST:/v1/feedback
4719
+ * @secure
4720
+ */
4721
+ create(createFeedback: UmaCreateFeedbackDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError, Format>>;
4722
+ }
3878
4723
  export class Firms<HandleError extends boolean = boolean, Format extends CaseFormat = CaseFormat.Original> {
3879
4724
  protected readonly apiClient: JwtClient<HandleError, Format>;
3880
4725
  constructor(apiClient: JwtClient<HandleError, Format>);
@@ -3895,9 +4740,9 @@ export class Firms<HandleError extends boolean = boolean, Format extends CaseFor
3895
4740
  * @request DELETE:/v1/firms
3896
4741
  * @secure
3897
4742
  */
3898
- deleteMany(deleteFirms: UmaDeleteByIDsDtoInt, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError, Format>>;
4743
+ deleteMany(deleteFirms: UmaDeleteByUUIDsDtoInt, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError, Format>>;
3899
4744
  /**
3900
- * @description Get Firm by id
4745
+ * @description Get Firm by id, uuid or slug
3901
4746
  * @tags firms
3902
4747
  * @name GetById
3903
4748
  * @summary Get Firm by id
@@ -4014,7 +4859,7 @@ export class Microservices<HandleError extends boolean = boolean, Format extends
4014
4859
  * @request DELETE:/v1/b2b/microservices
4015
4860
  * @secure
4016
4861
  */
4017
- deleteMany(deleteMicroservices: UmaDeleteByIDsDtoInt, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError, Format>>;
4862
+ deleteMany(deleteMicroservices: UmaDeleteByUUIDsDtoInt, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError, Format>>;
4018
4863
  /**
4019
4864
  * @description Get Microservice by id
4020
4865
  * @tags microservices
@@ -4023,7 +4868,7 @@ export class Microservices<HandleError extends boolean = boolean, Format extends
4023
4868
  * @request GET:/v1/b2b/microservices/{id}
4024
4869
  * @secure
4025
4870
  */
4026
- getById(id: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaMicroserviceMutationSerializer, HandleError, Format>>;
4871
+ getById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaMicroserviceMutationSerializer, HandleError, Format>>;
4027
4872
  /**
4028
4873
  * @description Update microservice record
4029
4874
  * @tags microservices
@@ -4032,7 +4877,7 @@ export class Microservices<HandleError extends boolean = boolean, Format extends
4032
4877
  * @request PUT:/v1/b2b/microservices/{id}
4033
4878
  * @secure
4034
4879
  */
4035
- update(id: number, microserviceDto: UmaUpdateMicroserviceDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaMicroserviceMutationSerializer, HandleError, Format>>;
4880
+ update(id: string, microserviceDto: UmaUpdateMicroserviceDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaMicroserviceMutationSerializer, HandleError, Format>>;
4036
4881
  /**
4037
4882
  * @description Update microservice record (partial updates supported)
4038
4883
  * @tags microservices
@@ -4041,7 +4886,7 @@ export class Microservices<HandleError extends boolean = boolean, Format extends
4041
4886
  * @request PATCH:/v1/b2b/microservices/{id}
4042
4887
  * @secure
4043
4888
  */
4044
- partialUpdate(id: number, microserviceDto: UmaPartialUpdateMicroserviceDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaMicroserviceMutationSerializer, HandleError, Format>>;
4889
+ partialUpdate(id: string, microserviceDto: UmaPartialUpdateMicroserviceDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaMicroserviceMutationSerializer, HandleError, Format>>;
4045
4890
  /**
4046
4891
  * @description Get microservices with pagination
4047
4892
  * @tags microservices
@@ -4072,7 +4917,7 @@ export class Permissions<HandleError extends boolean = boolean, Format extends C
4072
4917
  * @request DELETE:/v1/permissions
4073
4918
  * @secure
4074
4919
  */
4075
- deleteMany(deletePermissions: UmaDeleteByIDsDtoInt, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError, Format>>;
4920
+ deleteMany(deletePermissions: UmaDeleteByUUIDsDtoInt, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError, Format>>;
4076
4921
  /**
4077
4922
  * @description Get Permission by id
4078
4923
  * @tags permissions
@@ -4081,7 +4926,7 @@ export class Permissions<HandleError extends boolean = boolean, Format extends C
4081
4926
  * @request GET:/v1/permissions/{id}
4082
4927
  * @secure
4083
4928
  */
4084
- getById(id: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaPermissionMutationSerializer, HandleError, Format>>;
4929
+ getById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaPermissionMutationSerializer, HandleError, Format>>;
4085
4930
  /**
4086
4931
  * @description Update Permission
4087
4932
  * @tags permissions
@@ -4090,7 +4935,7 @@ export class Permissions<HandleError extends boolean = boolean, Format extends C
4090
4935
  * @request PUT:/v1/permissions/{id}
4091
4936
  * @secure
4092
4937
  */
4093
- update(id: number, updatePermission: UmaUpdatePermissionDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaPermissionMutationSerializer, HandleError, Format>>;
4938
+ update(id: string, updatePermission: UmaUpdatePermissionDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaPermissionMutationSerializer, HandleError, Format>>;
4094
4939
  /**
4095
4940
  * @description Partial Update Permission
4096
4941
  * @tags permissions
@@ -4099,7 +4944,7 @@ export class Permissions<HandleError extends boolean = boolean, Format extends C
4099
4944
  * @request PATCH:/v1/permissions/{id}
4100
4945
  * @secure
4101
4946
  */
4102
- partialUpdate(id: number, partialUpdatePermission: UmaPartialUpdatePermissionDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaPermissionMutationSerializer, HandleError, Format>>;
4947
+ partialUpdate(id: string, partialUpdatePermission: UmaPartialUpdatePermissionDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaPermissionMutationSerializer, HandleError, Format>>;
4103
4948
  /**
4104
4949
  * @description Get Permissions with pagination
4105
4950
  * @tags permissions
@@ -4127,6 +4972,28 @@ export class PublicSettings<HandleError extends boolean = boolean, Format extend
4127
4972
  FIRM?: string;
4128
4973
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaPublicSettingsResponseSerializer, HandleError, Format>>;
4129
4974
  }
4975
+ export class Regions<HandleError extends boolean = boolean, Format extends CaseFormat = CaseFormat.Original> {
4976
+ protected readonly apiClient: JwtClient<HandleError, Format>;
4977
+ constructor(apiClient: JwtClient<HandleError, Format>);
4978
+ /**
4979
+ * @description Get Regions list
4980
+ * @tags regions
4981
+ * @name Get
4982
+ * @summary Get Regions list
4983
+ * @request GET:/v1/admin/regions
4984
+ * @secure
4985
+ */
4986
+ get(config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaGetRegionsSerializer, HandleError, Format>>;
4987
+ /**
4988
+ * @description Get Region by name
4989
+ * @tags regions
4990
+ * @name GetByName
4991
+ * @summary Get Region by name
4992
+ * @request GET:/v1/admin/regions/{name}
4993
+ * @secure
4994
+ */
4995
+ getByName(name: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaGetRegionSerializer, HandleError, Format>>;
4996
+ }
4130
4997
  export class Roles<HandleError extends boolean = boolean, Format extends CaseFormat = CaseFormat.Original> {
4131
4998
  protected readonly apiClient: JwtClient<HandleError, Format>;
4132
4999
  constructor(apiClient: JwtClient<HandleError, Format>);
@@ -4147,7 +5014,7 @@ export class Roles<HandleError extends boolean = boolean, Format extends CaseFor
4147
5014
  * @request DELETE:/v1/roles
4148
5015
  * @secure
4149
5016
  */
4150
- deleteMany(deleteRoles: UmaDeleteByIDsDtoInt, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError, Format>>;
5017
+ deleteMany(deleteRoles: UmaDeleteByUUIDsDtoInt, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError, Format>>;
4151
5018
  /**
4152
5019
  * @description Get Role by id
4153
5020
  * @tags roles
@@ -4156,7 +5023,7 @@ export class Roles<HandleError extends boolean = boolean, Format extends CaseFor
4156
5023
  * @request GET:/v1/roles/{id}
4157
5024
  * @secure
4158
5025
  */
4159
- getById(id: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaRoleMutationSerializer, HandleError, Format>>;
5026
+ getById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaRoleMutationSerializer, HandleError, Format>>;
4160
5027
  /**
4161
5028
  * @description Update Role
4162
5029
  * @tags roles
@@ -4165,7 +5032,7 @@ export class Roles<HandleError extends boolean = boolean, Format extends CaseFor
4165
5032
  * @request PUT:/v1/roles/{id}
4166
5033
  * @secure
4167
5034
  */
4168
- update(id: number, updateRole: UmaUpdateRoleDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaRoleMutationSerializer, HandleError, Format>>;
5035
+ update(id: string, updateRole: UmaUpdateRoleDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaRoleMutationSerializer, HandleError, Format>>;
4169
5036
  /**
4170
5037
  * @description Partial Update Role. Only the fields provided in the body will be updated.
4171
5038
  * @tags roles
@@ -4174,7 +5041,7 @@ export class Roles<HandleError extends boolean = boolean, Format extends CaseFor
4174
5041
  * @request PATCH:/v1/roles/{id}
4175
5042
  * @secure
4176
5043
  */
4177
- partialUpdate(id: number, updateRole: UmaPartialUpdateRoleDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaRoleMutationSerializer, HandleError, Format>>;
5044
+ partialUpdate(id: string, updateRole: UmaPartialUpdateRoleDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaRoleMutationSerializer, HandleError, Format>>;
4178
5045
  /**
4179
5046
  * @description Generate Role PDF
4180
5047
  * @tags roles
@@ -4183,7 +5050,7 @@ export class Roles<HandleError extends boolean = boolean, Format extends CaseFor
4183
5050
  * @request POST:/v1/roles/{id}/generate-as-pdf
4184
5051
  * @secure
4185
5052
  */
4186
- generateAsPdf(id: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaGeneratedEntityPDFSerializer, HandleError, Format>>;
5053
+ generateAsPdf(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaGeneratedEntityPDFSerializer, HandleError, Format>>;
4187
5054
  /**
4188
5055
  * @description Get Roles with pagination
4189
5056
  * @tags roles
@@ -4305,7 +5172,10 @@ export class SystemUsers<HandleError extends boolean = boolean, Format extends C
4305
5172
  * @request POST:/v1/users/system
4306
5173
  * @secure
4307
5174
  */
4308
- create(createSystemUser: UmaCreateSystemUserDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaSystemUserSerializer, HandleError, Format>>;
5175
+ create(createSystemUser: UmaCreateSystemUserDto, headers?: {
5176
+ /** If true and caller has multi-region access, include firms/branches from all regions instead of only the current region */
5177
+ 'X-ALL-REGIONS'?: string;
5178
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaSystemUserSerializer, HandleError, Format>>;
4309
5179
  /**
4310
5180
  * @description Delete System user by id
4311
5181
  * @tags system_users
@@ -4314,7 +5184,7 @@ export class SystemUsers<HandleError extends boolean = boolean, Format extends C
4314
5184
  * @request DELETE:/v1/users/system
4315
5185
  * @secure
4316
5186
  */
4317
- deleteMany(deleteSystemUsers: UmaDeleteByIDsDtoInt64, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError, Format>>;
5187
+ deleteMany(deleteSystemUsers: UmaDeleteUsersDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError, Format>>;
4318
5188
  /**
4319
5189
  * @description Bulk-update access (roles, permissions, branches, firms) for multiple system users
4320
5190
  * @tags system_users
@@ -4332,7 +5202,10 @@ export class SystemUsers<HandleError extends boolean = boolean, Format extends C
4332
5202
  * @request POST:/v1/users/system/list
4333
5203
  * @secure
4334
5204
  */
4335
- get(getSystemUsers: UmaGetB2BUsersListDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaGetSystemUsersListSerializer, HandleError, Format>>;
5205
+ get(getSystemUsers: UmaGetB2BUsersListDto, headers?: {
5206
+ /** If true and caller has multi-region access, include firms/branches from all regions instead of only the current region */
5207
+ 'X-ALL-REGIONS'?: string;
5208
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaGetSystemUsersListSerializer, HandleError, Format>>;
4336
5209
  /**
4337
5210
  * @description Get System User by id
4338
5211
  * @tags system_users
@@ -4341,7 +5214,10 @@ export class SystemUsers<HandleError extends boolean = boolean, Format extends C
4341
5214
  * @request GET:/v1/users/system/{id}
4342
5215
  * @secure
4343
5216
  */
4344
- getById(id: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaSystemUserSerializer, HandleError, Format>>;
5217
+ getById(id: string, headers?: {
5218
+ /** If true and caller has multi-region access, include firms/branches from all regions instead of only the current region */
5219
+ 'X-ALL-REGIONS'?: string;
5220
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaSystemUserSerializer, HandleError, Format>>;
4345
5221
  /**
4346
5222
  * @description Update System User
4347
5223
  * @tags system_users
@@ -4350,7 +5226,10 @@ export class SystemUsers<HandleError extends boolean = boolean, Format extends C
4350
5226
  * @request PUT:/v1/users/system/{id}
4351
5227
  * @secure
4352
5228
  */
4353
- update(id: number, updateSystemUser: UmaUpdateSystemUserDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaSystemUserSerializer, HandleError, Format>>;
5229
+ update(id: string, updateSystemUser: UmaUpdateSystemUserDto, headers?: {
5230
+ /** If true and caller has multi-region access, include firms/branches from all regions instead of only the current region */
5231
+ 'X-ALL-REGIONS'?: string;
5232
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaSystemUserSerializer, HandleError, Format>>;
4354
5233
  /**
4355
5234
  * @description Partial Update System User
4356
5235
  * @tags system_users
@@ -4359,7 +5238,10 @@ export class SystemUsers<HandleError extends boolean = boolean, Format extends C
4359
5238
  * @request PATCH:/v1/users/system/{id}
4360
5239
  * @secure
4361
5240
  */
4362
- partialUpdate(id: number, updateSystemUser: UmaPartialUpdateSystemUserDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaSystemUserSerializer, HandleError, Format>>;
5241
+ partialUpdate(id: string, updateSystemUser: UmaPartialUpdateSystemUserDto, headers?: {
5242
+ /** If true and caller has multi-region access, include firms/branches from all regions instead of only the current region */
5243
+ 'X-ALL-REGIONS'?: string;
5244
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaSystemUserSerializer, HandleError, Format>>;
4363
5245
  /**
4364
5246
  * @description Generate System User PDF
4365
5247
  * @tags system_users
@@ -4368,7 +5250,7 @@ export class SystemUsers<HandleError extends boolean = boolean, Format extends C
4368
5250
  * @request POST:/v1/users/system/{id}/generate-as-pdf
4369
5251
  * @secure
4370
5252
  */
4371
- generateAsPdf(id: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaGeneratedEntityPDFSerializer, HandleError, Format>>;
5253
+ generateAsPdf(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaGeneratedEntityPDFSerializer, HandleError, Format>>;
4372
5254
  /**
4373
5255
  * @description Change System User status
4374
5256
  * @tags system_users
@@ -4377,7 +5259,7 @@ export class SystemUsers<HandleError extends boolean = boolean, Format extends C
4377
5259
  * @request PATCH:/v1/users/system/{id}/status
4378
5260
  * @secure
4379
5261
  */
4380
- changeStatus(id: number, changeUserStatus: UmaChangeUserStatusDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError, Format>>;
5262
+ changeStatus(id: string, changeUserStatus: UmaChangeUserStatusDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError, Format>>;
4381
5263
  }
4382
5264
  export class TablePresets<HandleError extends boolean = boolean, Format extends CaseFormat = CaseFormat.Original> {
4383
5265
  protected readonly apiClient: JwtClient<HandleError, Format>;
@@ -4483,7 +5365,10 @@ export class UserDetails<HandleError extends boolean = boolean, Format extends C
4483
5365
  * @request POST:/v1/users/details/show
4484
5366
  * @secure
4485
5367
  */
4486
- getUserDetails(getUserDetailsDto: UmaGetUserDetailsDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaGetUserDetailsSerializer, HandleError, Format>>;
5368
+ getUserDetails(getUserDetailsDto: UmaGetUserDetailsDto, headers?: {
5369
+ /** If true and caller has multi-region access, include B2B firms/branches from all regions instead of only the current region */
5370
+ 'X-ALL-REGIONS'?: string;
5371
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaGetUserDetailsSerializer, HandleError, Format>>;
4487
5372
  /**
4488
5373
  * @description Revoke user sessions by JWT-token
4489
5374
  * @tags user_details
@@ -4567,7 +5452,7 @@ export class WatchmenInstances<HandleError extends boolean = boolean, Format ext
4567
5452
  * @request DELETE:/v1/watchmen-instances
4568
5453
  * @secure
4569
5454
  */
4570
- deleteMany(deleteWatchmenInstances: UmaDeleteByIDsDtoInt64, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError, Format>>;
5455
+ deleteMany(deleteWatchmenInstances: UmaDeleteByUUIDsDtoInt64, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError, Format>>;
4571
5456
  /**
4572
5457
  * @description Get Watchmen Instances with pagination. Available sort fields are `id, name, slug, url, created_at, updated_at`. Search is performed by `name, url, slug` fields.
4573
5458
  * @tags watchmen_instances
@@ -4585,7 +5470,7 @@ export class WatchmenInstances<HandleError extends boolean = boolean, Format ext
4585
5470
  * @request GET:/v1/watchmen-instances/{id}
4586
5471
  * @secure
4587
5472
  */
4588
- getById(id: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaWatchmenInstanceMutationSerializer, HandleError, Format>>;
5473
+ getById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaWatchmenInstanceMutationSerializer, HandleError, Format>>;
4589
5474
  /**
4590
5475
  * @description Update Watchmen Instance
4591
5476
  * @tags watchmen_instances
@@ -4594,7 +5479,7 @@ export class WatchmenInstances<HandleError extends boolean = boolean, Format ext
4594
5479
  * @request PUT:/v1/watchmen-instances/{id}
4595
5480
  * @secure
4596
5481
  */
4597
- update(id: number, updateWatchmenInstance: UmaUpdateWatchmenInstanceDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaWatchmenInstanceMutationSerializer, HandleError, Format>>;
5482
+ update(id: string, updateWatchmenInstance: UmaUpdateWatchmenInstanceDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaWatchmenInstanceMutationSerializer, HandleError, Format>>;
4598
5483
  }
4599
5484
  declare class _B2BAuth1<HandleError extends boolean = boolean, Format extends CaseFormat = CaseFormat.Original> extends B2BAuth<HandleError, Format> {
4600
5485
  basicLogin(...params: Parameters<B2BAuth<HandleError, Format>['basicLogin']>): Promise<ClientResponse<_UmaBasicB2BLoginSerializer1, HandleError, Format>>;
@@ -4616,6 +5501,8 @@ export class UmaApi<HandleError extends boolean = false, Format extends CaseForm
4616
5501
  readonly config: UmaClientConfig<HandleError, Format>;
4617
5502
  actionLog: ActionLogs<HandleError, Format>;
4618
5503
  adminApiKeys: AdminApiKeys<HandleError, Format>;
5504
+ aiAssistant: AiAssistant<HandleError, Format>;
5505
+ allowedEmails: AllowedEmails<HandleError, Format>;
4619
5506
  allowedOrigins: AllowedOrigins<HandleError, Format>;
4620
5507
  apiKeys: ApiKeys<HandleError, Format>;
4621
5508
  authApps: AuthApps<HandleError, Format>;
@@ -4626,16 +5513,19 @@ export class UmaApi<HandleError extends boolean = false, Format extends CaseForm
4626
5513
  b2cAuth: _B2CAuth1<HandleError, Format>;
4627
5514
  b2cUserSettings: B2CUserSettings<HandleError, Format>;
4628
5515
  b2cUsers: B2CUsers<HandleError, Format>;
5516
+ blockedEmails: BlockedEmails<HandleError, Format>;
4629
5517
  branches: Branches<HandleError, Format>;
4630
5518
  countries: Countries<HandleError, Format>;
4631
5519
  emailDomains: EmailDomains<HandleError, Format>;
4632
5520
  endpoints: Endpoints<HandleError, Format>;
5521
+ feedback: Feedback<HandleError, Format>;
4633
5522
  firms: Firms<HandleError, Format>;
4634
5523
  identityProviders: IdentityProviders<HandleError, Format>;
4635
5524
  locales: Locales<HandleError, Format>;
4636
5525
  microservices: Microservices<HandleError, Format>;
4637
5526
  permissions: Permissions<HandleError, Format>;
4638
5527
  publicSettings: PublicSettings<HandleError, Format>;
5528
+ regions: Regions<HandleError, Format>;
4639
5529
  roleTypes: RoleTypes<HandleError, Format>;
4640
5530
  roles: Roles<HandleError, Format>;
4641
5531
  secretNotes: SecretNotes<HandleError, Format>;