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

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

/**
 * User Management API Functions
 * Handles user invitation, member list retrieval and deletion functionality
 */
import type { InviteMemberParams, InviteMemberResponse, LoginApp, GetInviteMemberListParams, GetInviteMemberListResponse, DeleteMemberParams, DeleteMemberResponse } from '../types';
/**
 * Invite a member to the fleet with specified role
 * Sends invitation email and initiates registration process (3-day validity)
 *
 * @param params - Invitation parameters (email and user_token from AuthStore if not provided)
 * @returns Promise with invitation response
 */
export declare function inviteMember(params: Omit<InviteMemberParams, 'email' | 'user_token'> & {
    email?: string;
    user_token?: string;
}): Promise<InviteMemberResponse>;
/**
 * Invite a SubMaster to the fleet
 * Convenience function for inviting SubMaster role
 *
 * @param guestEmail - Email address to invite as SubMaster
 * @param loginApp - Login application (default: 'fleeta')
 * @returns Promise with invitation response
 */
export declare function inviteSubMaster(guestEmail: string, loginApp?: LoginApp): Promise<InviteMemberResponse>;
/**
 * Invite a User to the fleet
 * Convenience function for inviting User role
 *
 * @param guestEmail - Email address to invite as User
 * @param loginApp - Login application (default: 'fleeta')
 * @returns Promise with invitation response
 */
export declare function inviteUser(guestEmail: string, loginApp?: LoginApp): Promise<InviteMemberResponse>;
/**
 * Get list of invited members for the fleet
 * Retrieves information about all invited members with optional filtering and pagination
 *
 * @param params - Query parameters (email and user_token from AuthStore if not provided)
 * @returns Promise with invited member list response
 */
export declare function getInviteMemberList(params?: Omit<GetInviteMemberListParams, 'email' | 'user_token'> & {
    email?: string;
    user_token?: string;
}): Promise<GetInviteMemberListResponse>;
/**
 * Delete a member from the fleet
 * Removes member account and associated data based on user type
 *
 * @param params - Deletion parameters (email and user_token from AuthStore if not provided)
 * @returns Promise with deletion response
 */
export declare function deleteMember(params: Omit<DeleteMemberParams, 'email' | 'user_token'> & {
    email?: string;
    user_token?: string;
}): Promise<DeleteMemberResponse>;
//# sourceMappingURL=userManagement.d.ts.map