revbits-cip-integration/dist/base.cip.d.ts

This package will integrate CIP with any product

import { HttpCreateBulkNotificationsRequest, HttpCreateBulkNotificationsResponse, HttpCreateNotificationRequest, HttpCreateNotificationResponse, HttpDeleteNotificationResponse, HttpGetAllNotificationsRequest, HttpGetAllNotificationsResponse, HttpGetAllPlatformsNotificationsRequest, HttpGetAllPlatformsNotificationsResponse, HttpGetAllPlatformsUnreadNotificationsCountRequest, HttpGetAllPlatformsUnreadNotificationsCountResponse, HttpGetOneNotificationResponse, HttpGetPlatformsConfigResponse, HttpGetUserAccessConfigResponse, HttpReadNotificationResponse, UpdateBulkNotificationsDataRequest, UpdateBulkNotificationsDataResponse } from './interfaces/notification.interface';
import { HttpDeletePermissionResponse, HttpDeletePlatformPermissionsResponse, HttpGetAllPermissionsResponse, HttpGetOnePermissionResponse, HttpSyncPermissionsRequest, HttpSyncPermissionsResponse } from './interfaces/permission.interface';
import { HttpCheckRolesExistenceByIdsResponse, HttpCheckRolesExistenceByNamesResponse, HttpCreateBulkRolesRequest, HttpCreateBulkRolesResponse, HttpCreateRoleRequest, HttpCreateRoleResponse, HttpDeleteRoleResponse, HttpGetAllRolesRequest, HttpGetAllRolesResponse, HttpGetOneRoleResponse, HttpUpdateBulkRolesRequest, HttpUpdateBulkRolesResponse, HttpUpdateRoleRequest, HttpUpdateRoleResponse } from './interfaces/role.interface';
import { SOCKET_CALLBACK } from './interfaces/socket.interface';
import { CIP_OPTIONS, CURSOR_CALLBACK, PLATFORM } from './interfaces/types.type';
import { Actor, HttpCheckUsersExistenceByIdsResponse, HttpCheckUsersExistenceByUsernamesResponse, HttpCreateBulkUsersRequest, HttpCreateBulkUsersResponse, HttpCreateInventoryRequest, HttpCreateInventoryResponse, HttpCreateUserRequest, HttpCreateUserResponse, HttpDashboardUpdateResponse, HttpDeleteUserResponse, HttpGetAllUsersRequest, HttpGetAllUsersResponse, HttpGetCipUrlsConfigResponse, HttpGetOneUserResponse, HttpLogoutResponse, HttpRestoreUserResponse, HttpUpdateBulkUsersRequest, HttpUpdateBulkUsersResponse, HttpUpdateUserRequest, HttpUpdateUserResponse, HttpUploadUserAvatarResponse } from './interfaces/user.interface';
export declare abstract class BaseCIP {
    protected cipBaseUrl: string;
    protected cipSocketPostfix: string;
    protected platform: PLATFORM;
    protected platformPrivKey: string;
    protected options: CIP_OPTIONS;
    protected socketCallback: SOCKET_CALLBACK | null | undefined;
    constructor(cipBaseUrl: string, cipSocketPostfix: string, platform: PLATFORM, platformPrivKey: string, options: CIP_OPTIONS, socketCallback: SOCKET_CALLBACK | null | undefined);
    private getUserApi;
    private getRoleApi;
    private getPermissionApi;
    private getNotificationApi;
    getUsers(requestData: HttpGetAllUsersRequest, actor?: Actor | null | undefined): Promise<HttpGetAllUsersResponse>;
    getIteratedUsers(cb: CURSOR_CALLBACK, requestData: HttpGetAllUsersRequest, actor?: Actor | null | undefined): Promise<void>;
    getUser(id: string, actor?: Actor | null | undefined): Promise<HttpGetOneUserResponse>;
    getUserByUsername(username: string, actor?: Actor | null | undefined): Promise<HttpGetOneUserResponse>;
    createUser(requestData: HttpCreateUserRequest, actor?: Actor | null | undefined): Promise<HttpCreateUserResponse>;
    createBulkUsers(requestData: HttpCreateBulkUsersRequest, actor?: Actor | null | undefined): Promise<HttpCreateBulkUsersResponse>;
    updateUser(requestData: HttpUpdateUserRequest, actor?: Actor | null | undefined): Promise<HttpUpdateUserResponse>;
    updateBulkUsers(requestData: HttpUpdateBulkUsersRequest, actor?: Actor | null | undefined): Promise<HttpUpdateBulkUsersResponse>;
    uploadAvatar(filePath: string, actor?: Actor | null | undefined): Promise<HttpUploadUserAvatarResponse>;
    deleteUser(id: string, actor?: Actor | null | undefined): Promise<HttpDeleteUserResponse>;
    checkUsersExistenceByUsernames(usernames: Array<string>, actor?: Actor | null | undefined): Promise<HttpCheckUsersExistenceByUsernamesResponse>;
    checkUsersExistenceByIds(ids: Array<string>, actor?: Actor | null | undefined): Promise<HttpCheckUsersExistenceByIdsResponse>;
    restoreUser(id: string, actor?: Actor | null | undefined): Promise<HttpRestoreUserResponse>;
    getCipUrlsConfig(actor?: Actor | null | undefined): Promise<HttpGetCipUrlsConfigResponse>;
    createInventory(data: HttpCreateInventoryRequest, actor?: Actor | null | undefined): Promise<HttpCreateInventoryResponse>;
    getRoles(requestData: HttpGetAllRolesRequest, actor?: Actor | null | undefined): Promise<HttpGetAllRolesResponse>;
    getIteratedRoles(cb: CURSOR_CALLBACK, requestData: HttpGetAllRolesRequest, actor?: Actor | null | undefined): Promise<void>;
    getRole(id: string, actor?: Actor | null | undefined): Promise<HttpGetOneRoleResponse>;
    createRole(requestData: HttpCreateRoleRequest, actor?: Actor | null | undefined): Promise<HttpCreateRoleResponse>;
    createBulkRoles(requestData: HttpCreateBulkRolesRequest, actor?: Actor | null | undefined): Promise<HttpCreateBulkRolesResponse>;
    updateRole(requestData: HttpUpdateRoleRequest, actor?: Actor | null | undefined): Promise<HttpUpdateRoleResponse>;
    updateBulkRoles(requestData: HttpUpdateBulkRolesRequest, actor?: Actor | null | undefined): Promise<HttpUpdateBulkRolesResponse>;
    deleteRole(id: string, actor?: Actor | null | undefined): Promise<HttpDeleteRoleResponse>;
    checkRolesExistenceByNames(names: Array<string>, actor?: Actor | null | undefined): Promise<HttpCheckRolesExistenceByNamesResponse>;
    checkRolesExistenceByIds(ids: Array<string>, actor?: Actor | null | undefined): Promise<HttpCheckRolesExistenceByIdsResponse>;
    getPermissions(actor?: Actor | null | undefined): Promise<HttpGetAllPermissionsResponse>;
    getPermission(key: string, actor?: Actor | null | undefined): Promise<HttpGetOnePermissionResponse>;
    syncPermissions(data: HttpSyncPermissionsRequest, actor?: Actor | null | undefined): Promise<HttpSyncPermissionsResponse>;
    deletePermission(key: string, actor?: Actor | null | undefined): Promise<HttpDeletePermissionResponse>;
    deletePlatformPermissions(actor?: Actor | null | undefined): Promise<HttpDeletePlatformPermissionsResponse>;
    getNotifications(requestData: HttpGetAllNotificationsRequest | undefined, actor?: Actor | null | undefined): Promise<HttpGetAllNotificationsResponse>;
    getNotification(platformNotificationId: string, actor?: Actor | null | undefined): Promise<HttpGetOneNotificationResponse>;
    createNotification(requestData: HttpCreateNotificationRequest, actor?: Actor | null | undefined): Promise<HttpCreateNotificationResponse>;
    createBulkNotifications(requestData: HttpCreateBulkNotificationsRequest, actor?: Actor | null | undefined): Promise<HttpCreateBulkNotificationsResponse>;
    updateBulkNotificationsData(requestData: UpdateBulkNotificationsDataRequest, actor?: Actor | null | undefined): Promise<UpdateBulkNotificationsDataResponse>;
    readNotification(platformNotificationId: string, appname: string, actor: Actor): Promise<HttpReadNotificationResponse>;
    deleteNotification(platformNotificationId: string, appname: string, actor?: Actor | null | undefined): Promise<HttpDeleteNotificationResponse>;
    getPlatformsConfig(actor?: Actor | null | undefined): Promise<HttpGetPlatformsConfigResponse>;
    getUserAccessConfig(actor?: Actor | null | undefined): Promise<HttpGetUserAccessConfigResponse>;
    getAllPlatformsNotifications(data: HttpGetAllPlatformsNotificationsRequest, actor?: Actor | null | undefined): Promise<HttpGetAllPlatformsNotificationsResponse>;
    getAllPlatformsUnreadNotificationsCount(data: HttpGetAllPlatformsUnreadNotificationsCountRequest, actor?: Actor | null | undefined): Promise<HttpGetAllPlatformsUnreadNotificationsCountResponse>;
    logout(actor?: Actor | null | undefined): Promise<HttpLogoutResponse>;
    updateDashboard(actor?: Actor | null | undefined): Promise<HttpDashboardUpdateResponse>;
    private validateParams;
}