@orbis-systems/orbis-api-clients 0.5.2 → 0.6.0

package/dist/uma/index.d.ts

@@ -7,6 +7,7 @@ interface BaseClientConfig<HandleError extends boolean = boolean> {
     defaultHeaders?: Record<string, string>;
     defaultSecure?: boolean;
     authDataStorageKey?: string;
+    withCredentials?: boolean;
     onAxiosError?: (error: AxiosError) => void;
     onError?: (error: unknown) => void;
 }
@@ -385,6 +386,21 @@ export interface UmaPermissionMutationSerializer {
     permission: UmaPermissionSerializer;
     status: number;
 }
+export enum UmaActionTrigger {
+    B2BUserTrigger = "b2b_user",
+    OwnerUserTrigger = "owner_user",
+    RegularMigrationsTrigger = "regular_migrations",
+    DataMigrationsTrigger = "data_migrations"
+}
+export enum UmaActionType {
+    CreateAction = "create",
+    UpdateAction = "update",
+    DeleteAction = "delete",
+    ResetPasswordAction = "reset_password",
+    RegistrationAction = "registration",
+    SettingsChangeAction = "settings_change",
+    AvatarChangeAction = "avatar_change"
+}
 export enum UmaAuthProviderAppType {
     GoogleOAuth2Provider = "google-oauth2",
     AppleIDOAuth2Provider = "apple-id"
@@ -401,6 +417,19 @@ export interface UmaEntityData {
     name?: string;
     value?: UmaEntityAccessType;
 }
+export enum UmaEntityName {
+    B2BUsersEntity = "b2b_users",
+    B2CUsersEntity = "b2c_users",
+    RolesEntity = "roles",
+    RoleTypesEntity = "role_types",
+    PermissionsEntity = "permissions",
+    MicroservicesEntity = "microservices",
+    IdentityProvidersEntity = "identity_providers",
+    FirmsEntity = "firms",
+    EndpointsEntity = "endpoints",
+    BranchesEntity = "branches",
+    APIKeysEntity = "api_keys"
+}
 export enum UmaPermissionAG {
     ChiefadminPermissionAG = "chiefadmin",
     SuperadminPermissionAG = "superadmin",
@@ -414,7 +443,8 @@ export enum UmaUserStatus {
 }
 export enum UmaUserType {
     B2BUserType = "b2b",
-    SystemUserType = "system"
+    SystemUserType = "system",
+    B2CUserType = "b2c"
 }
 export interface UmaPublicSettingsResponseSerializer {
     settings: UmaPublicSettingsSerializer;
@@ -484,6 +514,10 @@ export interface UmaTagMutationSerializer {
     status: number;
     tag: UmaTagSerializer;
 }
+export interface UmaGetTrustedDevicesListSerializer {
+    status: number;
+    trusted_devices_list: UmaTrustedDeviceSerializer[];
+}
 export interface UmaAPIKeys {
     ac_same_as_for_user?: boolean;
     api_key?: string;
@@ -521,6 +555,11 @@ export interface UmaActionLogSerializer {
     trigger_type: string;
     updated_at: string;
 }
+export interface UmaActionLogsSettingsSerializer {
+    action_triggers: UmaActionTrigger[];
+    action_types: UmaActionType[];
+    entity_names: UmaEntityName[];
+}
 export interface UmaAdminB2BUserSerializer {
     allow_feedback: boolean;
     big_avatar_url: string;
@@ -564,7 +603,7 @@ export interface UmaAdminB2BUserSerializer {
     status_change_reason_id: number;
     status_changed_at: string;
     theme: string;
-    type: string;
+    type: UmaUserType;
     /** @example "2022-02-02T00:00:00Z" */
     updated_at: string;
     username: string;
@@ -966,7 +1005,7 @@ export interface UmaCreateB2BUserDto {
     /** @minItems 1 */
     roles: number[];
     should_reset_password?: boolean;
-    type?: string;
+    type?: UmaUserType;
     /** @maxLength 255 */
     username?: string;
     watchmen_user_links?: UmaWatchmenUserLinkDto[];
@@ -1033,11 +1072,17 @@ export interface UmaCreateEndpointDto {
 }
 export interface UmaCreateFirmDto {
     allow_b2c_email_notifications?: boolean;
+    /** @maxLength 255 */
+    email?: string;
     firm_tags?: number[];
     mailgun_creds?: UmaFirmMailgunCredsDto;
     /** @maxLength 255 */
     name: string;
     /** @maxLength 255 */
+    notes?: string;
+    /** @maxLength 255 */
+    phone?: string;
+    /** @maxLength 255 */
     slug: string;
     twilio_creds?: UmaFirmTwilioCredsDto;
 }
@@ -1112,6 +1157,36 @@ export interface UmaCreateSecretNoteDto {
     note_params: Record<string, string>;
     type: UmaCreateSecretNoteDtoTypeEnum;
 }
+export interface UmaCreateSystemUserDto {
+    add_default_domain_permissions?: boolean;
+    allow_feedback?: boolean;
+    branches?: number[];
+    /**
+     * @maxLength 255
+     * @example "test@gmail.com"
+     */
+    email?: string;
+    /** @minItems 1 */
+    firms: UmaFirmInfo[];
+    /** @maxLength 255 */
+    first_name: string;
+    has_access_to_all_firm_branches?: boolean;
+    /** @example "TeStPaSS" */
+    password: string;
+    permissions?: number[];
+    /**
+     * @maxLength 255
+     * @example "+1231231234"
+     */
+    phone?: string;
+    primary_firm_id?: number;
+    rep_code?: string;
+    /** @minItems 1 */
+    roles: number[];
+    should_reset_password?: boolean;
+    type?: UmaUserType;
+    watchmen_user_links?: UmaWatchmenUserLinkDto[];
+}
 export interface UmaCreateTagDto {
     name: string;
 }
@@ -1204,12 +1279,15 @@ export interface UmaFirmAccessSerializer {
     branches_count: number;
     /** @example "2022-02-02T00:00:00Z" */
     created_at: string;
+    email: string;
     have_access_to_all_firm_branches: boolean;
     /** @example 1 */
     id: number;
     last_status_change_at: string;
     /** @example "ViewTrade" */
     name: string;
+    notes: string;
+    phone: string;
     /** @example "viewtrade" */
     slug: string;
     status: string;
@@ -1241,11 +1319,14 @@ export interface UmaFirmSerializer {
     branches_count: number;
     /** @example "2022-02-02T00:00:00Z" */
     created_at: string;
+    email: string;
     /** @example 1 */
     id: number;
     last_status_change_at: string;
     /** @example "ViewTrade" */
     name: string;
+    notes: string;
+    phone: string;
     /** @example "viewtrade" */
     slug: string;
     status: string;
@@ -1272,12 +1353,15 @@ export interface UmaFirmWithCredsSerializer {
     branches_count: number;
     /** @example "2022-02-02T00:00:00Z" */
     created_at: string;
+    email: string;
     /** @example 1 */
     id: number;
     last_status_change_at: string;
     mailgun_creds: UmaFirmMailgunCredsDto;
     /** @example "ViewTrade" */
     name: string;
+    notes: string;
+    phone: string;
     /** @example "viewtrade" */
     slug: string;
     status: string;
@@ -1290,6 +1374,10 @@ export interface UmaGenerateWatchmenAuthTokenDto {
     /** @min 1 */
     branch_id?: number;
 }
+export interface UmaGeneratedEntityPDFSerializer {
+    data: UmaPdfGenerationInfo;
+    status: number;
+}
 export interface UmaGeneratedWatchmenTokenInfoSerializer {
     expires_at: number;
     token: string;
@@ -1337,7 +1425,6 @@ export interface UmaGetB2CUsersListDto {
     sorts?: UmaSortDto[];
 }
 export interface UmaGetB2CUsersListFiltersDto {
-    Type?: UmaGetB2CUsersListFiltersDtoTypeEnum;
     branch_ids?: number[];
     email_verified?: boolean;
     firm_ids?: number[];
@@ -1354,6 +1441,7 @@ export interface UmaGetB2CUsersListFiltersDto {
     show_users_linked_to_watchmen?: boolean;
     status_change_reason_ids?: number[];
     statuses?: UmaUserStatus[];
+    type?: UmaUserType;
 }
 export interface UmaGetBranchesListDto {
     count_branch_admins?: boolean;
@@ -1473,6 +1561,12 @@ export interface UmaGetTotpQRDto {
     digits: number;
     name?: string;
 }
+export interface UmaGetTrustedDevicesListDto {
+    pagination?: UmaPaginationDto;
+    search?: string;
+    search_fields?: string[];
+    sorts?: UmaSortDto[];
+}
 export interface UmaGetUserDetailsDto {
     access_token: string;
 }
@@ -1486,7 +1580,6 @@ export interface UmaGetUserStatusChangeReasonsListFiltersDto {
     types: string[];
 }
 export interface UmaGetUsersListFiltersDto {
-    Type?: UmaGetUsersListFiltersDtoTypeEnum;
     branch_ids?: number[];
     email_verified?: boolean;
     firm_ids?: number[];
@@ -1502,6 +1595,7 @@ export interface UmaGetUsersListFiltersDto {
     show_users_linked_to_watchmen?: boolean;
     status_change_reason_ids?: number[];
     statuses?: UmaUserStatus[];
+    type?: UmaUserType;
 }
 export interface UmaGetWatchmenInstancesDto {
     pagination: UmaPaginationDto;
@@ -1627,6 +1721,10 @@ export interface UmaOptionalPaginationDto {
      */
     size?: number;
 }
+export interface UmaPdfGenerationInfo {
+    pdf_generated_at?: string;
+    pdf_url?: string;
+}
 export interface UmaPermissionMetadataDto {
     entities?: Record<string, UmaEntityAccessType>;
     entities_new?: UmaEntityData[];
@@ -1650,6 +1748,7 @@ export interface UmaPermissionSerializer {
     updated_at: string;
 }
 export interface UmaPublicSettingsSerializer {
+    action_logs: UmaActionLogsSettingsSerializer;
     auth_apps_limits: UmaAuthAppsLimitsSerializer;
     avatar: UmaAvatarSettingsSerializer;
     b2c_mfa_options: UmaAuthAppType[];
@@ -1713,6 +1812,8 @@ export interface UmaRoleSerializer {
     microservice: UmaMicroserviceSerializer;
     microservice_id: number;
     name: string;
+    pdf_generated_at: string;
+    pdf_url: string;
     permissions: UmaPermissionSerializer[];
     permissions_can_assign_role: UmaPermissionSerializer[];
     type: UmaRoleTypeSerializer;
@@ -1792,6 +1893,8 @@ export interface UmaSetB2BUserSettingsDto {
      */
     email: string;
     email_change_code?: string;
+    enable_email_mfa?: boolean;
+    enable_phone_mfa?: boolean;
     /** @maxLength 255 */
     first_name: string;
     /** @maxLength 255 */
@@ -1866,6 +1969,19 @@ export interface UmaTokens {
     refresh_expires_at?: number;
     refresh_token?: string;
 }
+export interface UmaTrustedDeviceSerializer {
+    b2b_user: UmaAdminUserSerializer;
+    b2b_user_id: number;
+    b2c_user: UmaAdminB2CUserSerializer;
+    b2c_user_id: number;
+    created_at: string;
+    device_id: string;
+    device_name: string;
+    id: number;
+    last_used_at: string;
+    os_name: string;
+    updated_at: string;
+}
 export interface UmaUpdateAPIKeysDto {
     ac_same_as_for_user?: boolean;
     branches?: number[];
@@ -1910,7 +2026,7 @@ export interface UmaUpdateB2BUserDto {
     /** @minItems 1 */
     roles: number[];
     should_reset_password?: boolean;
-    type?: string;
+    type?: UmaUserType;
     updated_at: string;
     /** @maxLength 255 */
     username?: string;
@@ -1979,11 +2095,17 @@ export interface UmaUpdateEndpointDto {
 }
 export interface UmaUpdateFirmDto {
     allow_b2c_email_notifications?: boolean;
+    /** @maxLength 255 */
+    email?: string;
     firm_tags?: number[];
     mailgun_creds?: UmaFirmMailgunCredsDto;
     /** @maxLength 255 */
     name: string;
     /** @maxLength 255 */
+    notes?: string;
+    /** @maxLength 255 */
+    phone?: string;
+    /** @maxLength 255 */
     slug: string;
     status: UmaUpdateFirmDtoStatusEnum;
     twilio_creds?: UmaFirmTwilioCredsDto;
@@ -2043,6 +2165,36 @@ export interface UmaUpdateRoleTypeDto {
     type: string;
     updated_at: string;
 }
+export interface UmaUpdateSystemUserDto {
+    allow_feedback?: boolean;
+    branches?: number[];
+    /**
+     * @maxLength 255
+     * @example "test@gmail.com"
+     */
+    email?: string;
+    /** @minItems 1 */
+    firms: UmaFirmInfo[];
+    /** @maxLength 255 */
+    first_name: string;
+    has_access_to_all_firm_branches?: boolean;
+    /** @example "TeStPaSS" */
+    password?: string;
+    permissions?: number[];
+    /**
+     * @maxLength 255
+     * @example "+1231231234"
+     */
+    phone?: string;
+    primary_firm_id?: number;
+    rep_code?: string;
+    /** @minItems 1 */
+    roles: number[];
+    should_reset_password?: boolean;
+    type?: UmaUserType;
+    updated_at: string;
+    watchmen_user_links?: UmaWatchmenUserLinkDto[];
+}
 export interface UmaUpdateTagDto {
     name: string;
     updated_at: string;
@@ -2363,10 +2515,6 @@ export enum UmaEndpointSerializerMethodEnum {
     PATCH = "PATCH",
     ALL = "ALL"
 }
-export enum UmaGetB2CUsersListFiltersDtoTypeEnum {
-    B2B = "b2b",
-    System = "system"
-}
 export enum UmaGetB2CUsersListFiltersDtoShowOnlyEnum {
     Admin = "admin",
     BranchAdmin = "branch_admin",
@@ -2381,10 +2529,6 @@ export enum UmaGetFirmsListFiltersDtoStatusesEnum {
 export enum UmaGetIdentityProvidersListFiltersDtoTypesEnum {
     Okta = "okta"
 }
-export enum UmaGetUsersListFiltersDtoTypeEnum {
-    B2B = "b2b",
-    System = "system"
-}
 export enum UmaGetUsersListFiltersDtoShowOnlyEnum {
     Admin = "admin",
     BranchAdmin = "branch_admin",
@@ -2775,6 +2919,15 @@ export class B2BUsers<HandleError extends boolean = boolean> {
      * @secure
      */
     getById(id: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaB2BUserSerializer, HandleError>>;
+    /**
+     * @description Generate B2B User PDF
+     * @tags b2b_users
+     * @name GenerateAsPdf
+     * @summary Generate B2B User PDF
+     * @request POST:/v1/users/b2b/{id}/generate-as-pdf
+     * @secure
+     */
+    generateAsPdf(id: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaGeneratedEntityPDFSerializer, HandleError>>;
     /**
      * @description Change B2B User status
      * @tags b2b_users
@@ -3063,6 +3216,15 @@ export class B2CUsers<HandleError extends boolean = boolean> {
      * @secure
      */
     update(id: number, createB2BUser: UmaUpdateB2CUserDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaB2CUserSerializer, HandleError>>;
+    /**
+     * @description Generate B2C User PDF
+     * @tags b2c_users
+     * @name GenerateAsPdf
+     * @summary Generate B2C User PDF
+     * @request POST:/v1/users/b2c/{id}/generate-as-pdf
+     * @secure
+     */
+    generateAsPdf(id: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaGeneratedEntityPDFSerializer, HandleError>>;
     /**
      * @description Change B2C User status
      * @tags b2c_users
@@ -3086,7 +3248,7 @@ export class B2CUserSettings<HandleError extends boolean = boolean> {
     protected readonly apiClient: JwtClient<HandleError>;
     constructor(apiClient: JwtClient<HandleError>);
     /**
-     * @description Set B2C User Settings
+     * @description Set B2C User Settings (test)
      * @tags b2c_user_settings
      * @name SetUserSettings
      * @summary Set B2C User Settings
@@ -3556,6 +3718,15 @@ export class Roles<HandleError extends boolean = boolean> {
      * @secure
      */
     update(id: number, updateRole: UmaUpdateRoleDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaRoleMutationSerializer, HandleError>>;
+    /**
+     * @description Generate Role PDF
+     * @tags roles
+     * @name GenerateAsPdf
+     * @summary Generate Role PDF
+     * @request POST:/v1/roles/{id}/generate-as-pdf
+     * @secure
+     */
+    generateAsPdf(id: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaGeneratedEntityPDFSerializer, HandleError>>;
     /**
      * @description Get Roles with pagination
      * @tags roles
@@ -3677,7 +3848,7 @@ export class SystemUsers<HandleError extends boolean = boolean> {
      * @request POST:/v1/users/system
      * @secure
      */
-    create(createSystemUser: UmaCreateB2BUserDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaSystemUserSerializer, HandleError>>;
+    create(createSystemUser: UmaCreateSystemUserDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaSystemUserSerializer, HandleError>>;
     /**
      * @description Delete System user by id
      * @tags system_users
@@ -3713,7 +3884,16 @@ export class SystemUsers<HandleError extends boolean = boolean> {
      * @request PUT:/v1/users/system/{id}
      * @secure
      */
-    update(id: number, updateSystemUser: UmaUpdateB2BUserDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaSystemUserSerializer, HandleError>>;
+    update(id: number, updateSystemUser: UmaUpdateSystemUserDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaSystemUserSerializer, HandleError>>;
+    /**
+     * @description Generate System User PDF
+     * @tags system_users
+     * @name GenerateAsPdf
+     * @summary Generate System User PDF
+     * @request POST:/v1/users/system/{id}/generate-as-pdf
+     * @secure
+     */
+    generateAsPdf(id: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaGeneratedEntityPDFSerializer, HandleError>>;
     /**
      * @description Change System User status
      * @tags system_users
@@ -3795,6 +3975,28 @@ export class Tags<HandleError extends boolean = boolean> {
      */
     update(id: number, updateTagDto: UmaUpdateTagDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaTagMutationSerializer, HandleError>>;
 }
+export class TrustedDevices<HandleError extends boolean = boolean> {
+    protected readonly apiClient: JwtClient<HandleError>;
+    constructor(apiClient: JwtClient<HandleError>);
+    /**
+     * @description Delete trusted devices
+     * @tags trusted_devices
+     * @name DeleteMany
+     * @summary Delete trusted devices
+     * @request DELETE:/v1/auth/trusted-devices
+     * @secure
+     */
+    deleteMany(deleteTrustedDevicesDto: UmaDeleteByIDsDtoInt64, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
+    /**
+     * @description Get trusted devices
+     * @tags trusted_devices
+     * @name Get
+     * @summary Get trusted devices
+     * @request POST:/v1/auth/trusted-devices/list
+     * @secure
+     */
+    get(getTrustedDevicesListDto: UmaGetTrustedDevicesListDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaGetTrustedDevicesListSerializer, HandleError>>;
+}
 export class UserDetails<HandleError extends boolean = boolean> {
     protected readonly apiClient: JwtClient<HandleError>;
     constructor(apiClient: JwtClient<HandleError>);
@@ -3974,8 +4176,10 @@ export class UmaApi<HandleError extends boolean = false> extends BaseApi<HandleE
     roleTypes: RoleTypes<HandleError>;
     secretNotes: SecretNotes<HandleError>;
     sessions: Sessions<HandleError>;
+    systemUsers: SystemUsers<HandleError>;
     tablePresets: TablePresets<HandleError>;
     tags: Tags<HandleError>;
+    trustedDevices: TrustedDevices<HandleError>;
     userDetails: UserDetails<HandleError>;
     usersCommon: UsersCommon<HandleError>;
     watchmenAuth: WatchmenAuth<HandleError>;