@orbis-systems/orbis-api-clients 0.4.4 → 0.5.0

package/dist/uma/index.d.ts

@@ -1,7 +1,7 @@
 import { AxiosError, AxiosInstance, AxiosRequestConfig, HttpStatusCode } from "axios";
 interface BaseClientConfig<HandleError extends boolean = boolean> {
     baseUrl: string;
-    errorHandling?: HandleError;
+    handleError?: HandleError;
     storage?: Storage;
     defaultHeaders?: Record<string, string>;
     defaultSecure?: boolean;
@@ -18,6 +18,7 @@ enum ContentType {
 type RequestConfig<Body = unknown> = AxiosRequestConfig<Body> & {
     secure?: boolean;
     contentType?: ContentType;
+    handleError?: boolean;
 };
 type ResponseStatus = {
     status: HttpStatusCode | -1;
@@ -52,7 +53,7 @@ declare abstract class BaseClient<HandleError extends boolean = boolean, AuthDat
     setAuthData(data: AuthData | null): void;
     getAuthData(): AuthData | null;
     getConfig(): BaseClientConfig<HandleError>;
-    abstract prepareAuthRequestConfig(): Pick<RequestConfig<any>, 'headers' | 'data' | 'params'>;
+    protected abstract prepareAuthRequestConfig(): Promise<Pick<RequestConfig<any>, 'headers' | 'data' | 'params'>>;
 }
 declare class BaseApi<HandleError extends boolean = boolean, ApiClient extends BaseClient<HandleError> = BaseClient<HandleError>> {
     protected readonly apiClient: ApiClient;
@@ -61,18 +62,19 @@ declare class BaseApi<HandleError extends boolean = boolean, ApiClient extends B
 }
 interface JwtClientConfig<HandleError extends boolean = boolean> extends BaseClientConfig<HandleError> {
     authSchema?: string;
+    autoRenewToken?: boolean;
 }
 interface JwtAuthData {
     accessToken: string;
-    refreshToken: string;
+    refreshToken?: string;
 }
-declare class JwtClient<HandleError extends boolean = boolean> extends BaseClient<HandleError, JwtAuthData> {
+declare class JwtClient<HandleError extends boolean = boolean, AuthData extends JwtAuthData = JwtAuthData> extends BaseClient<HandleError, AuthData> {
     protected readonly config: JwtClientConfig<HandleError>;
     constructor(config: JwtClientConfig<HandleError>);
     getConfig(): JwtClientConfig<HandleError>;
-    prepareAuthRequestConfig(): Pick<RequestConfig<any>, 'headers' | 'data' | 'params'>;
-    scheduleTokenRenewal(renewTokenCallback: () => Promise<JwtAuthData>): void;
-    cancelTokenRenewal(): void;
+    setRenewTokenCallback(renewTokenCallback: () => Promise<AuthData>): void;
+    protected prepareAuthRequestConfig(): Promise<Pick<RequestConfig<any>, 'headers' | 'data' | 'params'>>;
+    renewToken(): Promise<void>;
 }
 export interface UmaGetActionLogsSerializer {
     action_logs: UmaActionLogSerializer[];
@@ -168,10 +170,12 @@ export interface UmaB2CLoginResultSerializer {
     login_basic: UmaBasicLoginResultSerializer;
     phone_verification_needed: boolean;
     redirect_to: string;
+    should_enable_mfa: boolean;
     status: number;
 }
 export interface UmaGetCurrentB2CUserSerializer {
     current_user: UmaUserSerializer;
+    should_enable_mfa: boolean;
     status: number;
 }
 export interface UmaRefreshResultSerializer {
@@ -407,6 +411,10 @@ export enum UmaUserStatus {
     BlockedUserStatus = "blocked",
     ArchivedUserStatus = "archived"
 }
+export enum UmaUserType {
+    B2BUserType = "b2b",
+    SystemUserType = "system"
+}
 export interface UmaPublicSettingsResponseSerializer {
     settings: UmaPublicSettingsSerializer;
     status: number;
@@ -445,6 +453,17 @@ export interface UmaGetSessionsListSerializer {
     sessions: UmaSessionSerializer[];
     status: number;
 }
+export interface UmaGetSystemUsersListSerializer {
+    current_page: number;
+    pages_count: number;
+    status: number;
+    system_users_list: UmaAdminB2BUserSerializer[];
+    total_records: number;
+}
+export interface UmaSystemUserSerializer {
+    status: number;
+    system_user: UmaAdminB2BUserSerializer;
+}
 export interface UmaTablePresetResponseSerializer {
     status: number;
     table_preset: UmaTablePresetSerializer;
@@ -544,6 +563,7 @@ export interface UmaAdminB2BUserSerializer {
     status_change_reason_id: number;
     status_changed_at: string;
     theme: string;
+    type: string;
     /** @example "2022-02-02T00:00:00Z" */
     updated_at: string;
     username: string;
@@ -945,6 +965,7 @@ export interface UmaCreateB2BUserDto {
     /** @minItems 1 */
     roles: number[];
     should_reset_password?: boolean;
+    type?: string;
     /** @maxLength 255 */
     username?: string;
     watchmen_user_links?: UmaWatchmenUserLinkDto[];
@@ -1176,10 +1197,10 @@ export interface UmaFinishTOTPRegistrationDto {
 export interface UmaFirmAccessSerializer {
     admins_count: number;
     allow_b2c_email_notifications: boolean;
-    branches: UmaBranchSerializer[];
-    branches_count: number;
     b2b_users_count: number;
     b2c_users_count: number;
+    branches: UmaBranchSerializer[];
+    branches_count: number;
     /** @example "2022-02-02T00:00:00Z" */
     created_at: string;
     have_access_to_all_firm_branches: boolean;
@@ -1213,10 +1234,10 @@ export interface UmaFirmMailgunCredsDto {
 export interface UmaFirmSerializer {
     admins_count: number;
     allow_b2c_email_notifications: boolean;
-    branches: UmaBranchSerializer[];
-    branches_count: number;
     b2b_users_count: number;
     b2c_users_count: number;
+    branches: UmaBranchSerializer[];
+    branches_count: number;
     /** @example "2022-02-02T00:00:00Z" */
     created_at: string;
     /** @example 1 */
@@ -1244,10 +1265,10 @@ export interface UmaFirmTwilioCredsDto {
 export interface UmaFirmWithCredsSerializer {
     admins_count: number;
     allow_b2c_email_notifications: boolean;
-    branches: UmaBranchSerializer[];
-    branches_count: number;
     b2b_users_count: number;
     b2c_users_count: number;
+    branches: UmaBranchSerializer[];
+    branches_count: number;
     /** @example "2022-02-02T00:00:00Z" */
     created_at: string;
     /** @example 1 */
@@ -1315,6 +1336,7 @@ export interface UmaGetB2CUsersListDto {
     sorts?: UmaSortDto[];
 }
 export interface UmaGetB2CUsersListFiltersDto {
+    Type?: UmaGetB2CUsersListFiltersDtoTypeEnum;
     branch_ids?: number[];
     email_verified?: boolean;
     firm_ids?: number[];
@@ -1361,9 +1383,9 @@ export interface UmaGetEndpointsListFiltersDto {
 }
 export interface UmaGetFirmsListDto {
     count_admins?: boolean;
-    count_branches?: boolean;
     count_b2b_users?: boolean;
     count_b2c_users?: boolean;
+    count_branches?: boolean;
     filters?: UmaGetFirmsListFiltersDto;
     pagination?: UmaPaginationDto;
     search?: string;
@@ -1463,6 +1485,7 @@ export interface UmaGetUserStatusChangeReasonsListFiltersDto {
     types: string[];
 }
 export interface UmaGetUsersListFiltersDto {
+    Type?: UmaGetUsersListFiltersDtoTypeEnum;
     branch_ids?: number[];
     email_verified?: boolean;
     firm_ids?: number[];
@@ -1669,6 +1692,12 @@ export interface UmaRegisterDto {
 export interface UmaResetPasswordSettingsSerializer {
     expires_in_minutes: number;
 }
+export interface UmaResetRateLimitsDto {
+    /** @min 1 */
+    user_id: number;
+    /** @minLength 1 */
+    user_type: UmaAuthUserType;
+}
 export interface UmaRevokeUserSessionsDto {
     /** @min 1 */
     user_id: number;
@@ -1880,6 +1909,7 @@ export interface UmaUpdateB2BUserDto {
     /** @minItems 1 */
     roles: number[];
     should_reset_password?: boolean;
+    type?: string;
     updated_at: string;
     /** @maxLength 255 */
     username?: string;
@@ -2332,6 +2362,10 @@ export enum UmaEndpointSerializerMethodEnum {
     PATCH = "PATCH",
     ALL = "ALL"
 }
+export enum UmaGetB2CUsersListFiltersDtoTypeEnum {
+    B2B = "b2b",
+    System = "system"
+}
 export enum UmaGetB2CUsersListFiltersDtoShowOnlyEnum {
     Admin = "admin",
     BranchAdmin = "branch_admin",
@@ -2346,6 +2380,10 @@ export enum UmaGetFirmsListFiltersDtoStatusesEnum {
 export enum UmaGetIdentityProvidersListFiltersDtoTypesEnum {
     Okta = "okta"
 }
+export enum UmaGetUsersListFiltersDtoTypeEnum {
+    B2B = "b2b",
+    System = "system"
+}
 export enum UmaGetUsersListFiltersDtoShowOnlyEnum {
     Admin = "admin",
     BranchAdmin = "branch_admin",
@@ -3627,6 +3665,64 @@ export class Sessions<HandleError extends boolean = boolean> {
      */
     deleteCurrentUserSessions(deleteSessions: UmaDeleteSessionsDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
 }
+export class SystemUsers<HandleError extends boolean = boolean> {
+    protected readonly apiClient: JwtClient<HandleError>;
+    constructor(apiClient: JwtClient<HandleError>);
+    /**
+     * @description Create System User
+     * @tags system_users
+     * @name Create
+     * @summary Create System User
+     * @request POST:/v1/users/system
+     * @secure
+     */
+    create(createSystemUser: UmaCreateB2BUserDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaSystemUserSerializer, HandleError>>;
+    /**
+     * @description Delete System user by id
+     * @tags system_users
+     * @name DeleteMany
+     * @summary Delete System user by id
+     * @request DELETE:/v1/users/system
+     * @secure
+     */
+    deleteMany(deleteSystemUsers: UmaDeleteByIDsDtoInt64, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
+    /**
+     * @description Get System users with pagination
+     * @tags System_users
+     * @name Get
+     * @summary Get System users with pagination
+     * @request POST:/v1/users/system/list
+     * @secure
+     */
+    get(getSystemUsers: UmaGetB2BUsersListDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaGetSystemUsersListSerializer, HandleError>>;
+    /**
+     * @description Get System User by id
+     * @tags system_users
+     * @name GetById
+     * @summary Get System User by id
+     * @request GET:/v1/users/system/{id}
+     * @secure
+     */
+    getById(id: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaSystemUserSerializer, HandleError>>;
+    /**
+     * @description Update System User
+     * @tags system_users
+     * @name Update
+     * @summary Update System User
+     * @request PUT:/v1/users/system/{id}
+     * @secure
+     */
+    update(id: number, updateSystemUser: UmaUpdateB2BUserDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaSystemUserSerializer, HandleError>>;
+    /**
+     * @description Change System User status
+     * @tags system_users
+     * @name ChangeStatus
+     * @summary Change System User status
+     * @request PATCH:/v1/users/system/{id}/status
+     * @secure
+     */
+    changeStatus(id: number, changeUserStatus: UmaChangeUserStatusDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
+}
 export class TablePresets<HandleError extends boolean = boolean> {
     protected readonly apiClient: JwtClient<HandleError>;
     constructor(apiClient: JwtClient<HandleError>);
@@ -3723,6 +3819,15 @@ export class UserDetails<HandleError extends boolean = boolean> {
 export class UsersCommon<HandleError extends boolean = boolean> {
     protected readonly apiClient: JwtClient<HandleError>;
     constructor(apiClient: JwtClient<HandleError>);
+    /**
+     * @description Reset B2B/B2C user rate limits
+     * @tags users_common
+     * @name ResetRateLimits
+     * @summary Reset rate limits
+     * @request PATCH:/v1/users/rate-limits/reset
+     * @secure
+     */
+    resetRateLimits(resetRateLimitsDto: UmaResetRateLimitsDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
     /**
      * @description Get user status change reasons list
      * @tags users_common
@@ -3815,12 +3920,26 @@ export class WatchmenInstances<HandleError extends boolean = boolean> {
 }
 declare class _B2BAuth1<HandleError extends boolean = boolean> extends B2BAuth<HandleError> {
     constructor(apiClient: JwtClient<HandleError>);
+    /**
+     * @description Login B2B user by email/password.
+     * @tags b2b_auth
+     * @name BasicLogin
+     * @summary Login B2B user by email/password
+     * @request POST:/v1/auth/b2b/login/basic
+     */
     basicLogin(basicLoginParams: UmaBasicB2BLoginDto, headers?: {
         'Debug-Token'?: string;
     }, config?: RequestConfig<HandleError> | undefined): Promise<ClientResponse<UmaBasicB2BLoginSerializer, HandleError>>;
 }
 declare class _B2CAuth1<HandleError extends boolean = boolean> extends B2CAuth<HandleError> {
     constructor(apiClient: JwtClient<HandleError>);
+    /**
+     * @description Login B2C user by email/password.
+     * @tags b2c_auth
+     * @name BasicLogin
+     * @summary Login B2C user by email/password
+     * @request POST:/v1/auth/b2c/login/basic
+     */
     basicLogin(basicLoginParams: UmaBasicB2CLoginDto, headers?: {
         BRANCH?: string;
         FIRM?: string;