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

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

/**
 * Group Device Management API Functions
 * Handles device assignment and removal from groups
 */
import type { AddDevicesToGroupParams, AddDevicesToGroupResponse, DeviceGroupAssignment, RemoveDevicesFromGroupParams, RemoveDevicesFromGroupResponse, DeviceGroupRemoval, GetGroupDevicesParams, GetGroupDevicesResponse } from '../types';
/**
 * Add devices to group (Master privilege only)
 * Assigns one or more devices to specific groups
 *
 * @param params - Device assignment parameters (Email and UserToken from AuthStore if not provided)
 * @returns Promise with device assignment response
 */
export declare function addDevicesToGroup(params: Omit<AddDevicesToGroupParams, 'Email' | 'UserToken'> & {
    Email?: string;
    UserToken?: string;
}): Promise<AddDevicesToGroupResponse>;
/**
 * Add a single device to a group
 * Convenience function for adding one device to a group
 *
 * @param psn - Device PSN to add
 * @param groupId - Group management ID
 * @param groupName - Group name
 * @returns Promise with device assignment response
 */
export declare function addSingleDeviceToGroup(psn: string, groupId: string, groupName: string): Promise<AddDevicesToGroupResponse>;
/**
 * Add multiple devices to groups
 * Convenience function for batch device assignments
 *
 * @param assignments - Array of device group assignments
 * @returns Promise with device assignment response
 */
export declare function addMultipleDevicesToGroups(assignments: DeviceGroupAssignment[]): Promise<AddDevicesToGroupResponse>;
/**
 * Remove devices from group (Master privilege only)
 * Removes one or more devices from specific groups
 *
 * @param params - Device removal parameters (Email and UserToken from AuthStore if not provided)
 * @returns Promise with device removal response
 */
export declare function removeDevicesFromGroup(params: Omit<RemoveDevicesFromGroupParams, 'Email' | 'UserToken'> & {
    Email?: string;
    UserToken?: string;
}): Promise<RemoveDevicesFromGroupResponse>;
/**
 * Remove a single device from a group
 * Convenience function for removing one device from a group
 *
 * @param psn - Device PSN to remove
 * @param groupId - Group management ID
 * @param groupName - Group name
 * @returns Promise with device removal response
 */
export declare function removeSingleDeviceFromGroup(psn: string, groupId: string, groupName: string): Promise<RemoveDevicesFromGroupResponse>;
/**
 * Remove multiple devices from groups
 * Convenience function for batch device removals
 *
 * @param removals - Array of device group removals
 * @returns Promise with device removal response
 */
export declare function removeMultipleDevicesFromGroups(removals: DeviceGroupRemoval[]): Promise<RemoveDevicesFromGroupResponse>;
/**
 * Get group devices information
 * Retrieves all groups with assigned devices and users (Master sees all, SubMaster sees assigned groups only)
 *
 * @param params - Group devices parameters (Email and UserToken from AuthStore if not provided)
 * @returns Promise with group devices response
 */
export declare function getGroupDevices(params?: Omit<GetGroupDevicesParams, 'Email' | 'UserToken'> & {
    Email?: string;
    UserToken?: string;
}): Promise<GetGroupDevicesResponse>;
//# sourceMappingURL=groupDevices.d.ts.map