fleeta-api-lib/dist/lib/users/api/userPermissions.d.ts

A comprehensive library for fleet management applications - API, Auth, Device management

/**
+ * User Permissions API Functions
+ * Handles user permission inquiry functionality
+ */
import type { GetUserPermissionsParams, GetUserPermissionsResponse, GetTargetUserPermissionsParams, GetTargetUserPermissionsResponse, SetTargetUserPermissionsResponse, UserPermissions } from '../types';
/**
 * Get master permissions for the authenticated user
 * Retrieves all permissions and access rights for the current user
 *
 * @param params - Permission query parameters (email and user_token from AuthStore if not provided)
 * @returns Promise with master permissions response
 */
export declare function getMasterPermissions(params?: Omit<GetUserPermissionsParams, 'email' | 'user_token'> & {
    email?: string;
    user_token?: string;
}): Promise<GetUserPermissionsResponse>;
/**
 * Get user permissions for SubMaster and Users
 * Retrieves permissions and access rights for SubMaster and User roles
 *
 * @param params - Permission query parameters (email and user_token from AuthStore if not provided)
 * @returns Promise with user permissions response
 */
export declare function getUserPermissions(params?: Omit<GetUserPermissionsParams, 'email' | 'user_token'> & {
    email?: string;
    user_token?: string;
}): Promise<GetUserPermissionsResponse>;
/**
 * Get target user permissions (Master queries SubMaster/User permissions)
 * Allows Master to check permissions of specific SubMaster or User
 *
 * @param params - Target permission query parameters (email and user_token from AuthStore if not provided)
 * @returns Promise with target user permissions response
 */
export declare function getTargetUserPermissions(params: Omit<GetTargetUserPermissionsParams, 'email' | 'user_token'> & {
    email?: string;
    user_token?: string;
}): Promise<GetTargetUserPermissionsResponse>;
/**
 * Set target user permissions (Master sets SubMaster/User permissions)
 * Allows Master to configure permissions for specific SubMaster or User
 *
 * @param params - Target permission set parameters (email and user_token from AuthStore if not provided)
 * @returns Promise with target user permissions set response
 */
export declare function setTargetUserPermissions(params: Omit<import('../types').SetTargetUserPermissionsParams, 'email' | 'user_token'> & {
    email?: string;
    user_token?: string;
}): Promise<SetTargetUserPermissionsResponse>;
/**
 * Check if user has specific permission
 * Convenience function to check a single permission
 *
 * @param permissionKey - Permission key to check
 * @param userType - User type to check permissions for (default: 'master')
 * @returns Promise with boolean result
 */
export declare function hasPermission(permissionKey: keyof UserPermissions, userType?: 'master' | 'user'): Promise<boolean>;
/**
 * Check if permissions API is ready (authentication configured)
 * @returns True if authentication is configured
 */
export declare function isPermissionsApiReady(): boolean;
//# sourceMappingURL=userPermissions.d.ts.map