fleeta-api-lib/dist/lib/group/api/groupMembers.d.ts

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

/**
 * Group Member Management API Functions
 * Handles SubMaster assignment and removal from groups
 */
import type { AssignSubMasterToGroupParams, AssignSubMasterToGroupResponse, UnassignSubMasterFromGroupParams, UnassignSubMasterFromGroupResponse, GetGroupUsersParams, GetGroupUsersResponse, AssignUserToDeviceParams, AssignUserToDeviceResponse, UnassignUserFromDeviceParams, UnassignUserFromDeviceResponse } from '../types';
/**
 * Assign SubMaster to a specific group (Master privilege only)
 * Assigns an existing SubMaster to manage a specific group
 *
 * @param params - SubMaster assignment parameters (email and user_token from AuthStore if not provided)
 * @returns Promise with SubMaster assignment response
 */
export declare function assignSubMasterToGroup(params: Omit<AssignSubMasterToGroupParams, 'email' | 'user_token'> & {
    email?: string;
    user_token?: string;
}): Promise<AssignSubMasterToGroupResponse>;
/**
 * Unassign SubMaster from a specific group (Master privilege only)
 * Removes an existing SubMaster from managing a specific group
 *
 * @param params - SubMaster unassignment parameters (email and user_token from AuthStore if not provided)
 * @returns Promise with SubMaster unassignment response
 */
export declare function unassignSubMasterFromGroup(params: Omit<UnassignSubMasterFromGroupParams, 'email' | 'user_token'> & {
    email?: string;
    user_token?: string;
}): Promise<UnassignSubMasterFromGroupResponse>;
/**
 * Get list of users available for dashcam allocation
 * Retrieves invited users that are not yet assigned to any dashcam in groups
 * Used for assigning users to specific dashcams within groups
 *
 * @param params - Group users query parameters (Email and UserToken from AuthStore if not provided)
 * @returns Promise with group users response
 */
export declare function getGroupUsers(params?: Omit<GetGroupUsersParams, 'Email' | 'UserToken'> & {
    Email?: string;
    UserToken?: string;
}): Promise<GetGroupUsersResponse>;
/**
 * Assign user to specific device within a group
 * Assigns invited users to specific devices for access control
 * Used for granular user-device assignment within groups
 *
 * @param params - User allocation parameters (Email and UserToken from AuthStore if not provided)
 * @returns Promise with user assignment response
 */
export declare function assignUserToDevice(params: Omit<AssignUserToDeviceParams, 'Email' | 'UserToken'> & {
    Email?: string;
    UserToken?: string;
}): Promise<AssignUserToDeviceResponse>;
/**
 * Unassign user from specific device within a group
 * Removes assigned user from specific device access control
 * Used for removing user-device assignment within groups
 *
 * @param params - User deallocation parameters (Email and UserToken from AuthStore if not provided)
 * @returns Promise with user unassignment response
 */
export declare function unassignUserFromDevice(params: Omit<UnassignUserFromDeviceParams, 'Email' | 'UserToken'> & {
    Email?: string;
    UserToken?: string;
}): Promise<UnassignUserFromDeviceResponse>;
//# sourceMappingURL=groupMembers.d.ts.map