@spytecgps/nova-orm 1.2.23 → 1.2.24

package/dist/repositories/users/getUsersInfoWithActivationInfo.js

@@ -1,11 +1,11 @@
-export const getUsersInfoWithActivationInfo = async (novaDataSource, params, logger) => {
-    if (!params?.filters?.userId) {
-        logger.warn({ params }, 'UsersRepository::getUsersInfoWithActivationInfo - missing required parameters');
-        return null;
-    }
-    // Force the query to run on master or slave
-    const dbQueryRunner = novaDataSource.createQueryRunnerFromParams(params);
-    return novaDataSource.safeQuery(async (_dataSource, queryRunner) => {
+export const getUsersInfoWithActivationInfo = async (novaDataSource, params, logger) => {
+    if (!params?.filters?.userId) {
+        logger.warn({ params }, 'UsersRepository::getUsersInfoWithActivationInfo - missing required parameters');
+        return null;
+    }
+    // Force the query to run on master or slave
+    const dbQueryRunner = novaDataSource.createQueryRunnerFromParams(params);
+    return novaDataSource.safeQuery(async (_dataSource, queryRunner) => {
         const query = `
         SELECT 
             subQuery.*,
@@ -82,20 +82,20 @@ export const getUsersInfoWithActivationInfo = async (novaDataSource, params, log
             WHERE as1.location IS NOT NULL AND as1.location <> '' AND d.status = 'A'
             GROUP BY as1.location, d.clientId
         ) AS asd ON asd.clientId = subQuery.clientId
-      `;
-        const queryResult = await queryRunner.query(query, [params.filters.userId]);
-        if (!queryResult?.length) {
-            return null;
-        }
-        const result = {
-            ...queryResult[0],
-            userId: queryResult[0].userId,
-            activationMeetingScheduled: queryResult[0].activationMeetingScheduled === 1,
-            amazonUSA: queryResult[0].amazonUSA === 1,
-            amazonCanada: queryResult[0].amazonCanada === 1,
-            amazonMexico: queryResult[0].amazonMexico === 1,
-        };
-        return result;
-    }, 'UsersRepository::getUsersInfoWithActivationInfo', dbQueryRunner);
-};
+      `;
+        const queryResult = await queryRunner.query(query, [params.filters.userId]);
+        if (!queryResult?.length) {
+            return null;
+        }
+        const result = {
+            ...queryResult[0],
+            userId: queryResult[0].userId,
+            activationMeetingScheduled: queryResult[0].activationMeetingScheduled === 1,
+            amazonUSA: queryResult[0].amazonUSA === 1,
+            amazonCanada: queryResult[0].amazonCanada === 1,
+            amazonMexico: queryResult[0].amazonMexico === 1,
+        };
+        return result;
+    }, 'UsersRepository::getUsersInfoWithActivationInfo', dbQueryRunner);
+};
 //# sourceMappingURL=getUsersInfoWithActivationInfo.js.map

package/dist/repositories/users/getUsersInfoWithDevicesInfo.d.ts

@@ -1,4 +1,4 @@
-import { NovaDataSource } from '../../novaDataSource';
-import { Logger } from '../../types/logger';
-import { GetUsersInfoWithDevicesInfoParams, UserInfoWithDevicesInfo } from '../../types/user';
-export declare const getUsersInfoWithDevicesInfo: (novaDataSource: NovaDataSource, params: GetUsersInfoWithDevicesInfoParams, logger: Logger) => Promise<UserInfoWithDevicesInfo[]>;
+import { NovaDataSource } from '../../novaDataSource';
+import { Logger } from '../../types/logger';
+import { GetUsersInfoWithDevicesInfoParams, UserInfoWithDevicesInfo } from '../../types/user';
+export declare const getUsersInfoWithDevicesInfo: (novaDataSource: NovaDataSource, params: GetUsersInfoWithDevicesInfoParams, logger: Logger) => Promise<UserInfoWithDevicesInfo[]>;

package/dist/repositories/users/getUsersInfoWithDevicesInfo.js

@@ -1,59 +1,59 @@
-import { Device, User } from '../../entities';
-import { Enums } from '../../types';
-import { binaryBufferToUuidString } from '../../utils/uuidHelpers';
-export const getUsersInfoWithDevicesInfo = async (novaDataSource, params, logger) => {
-    if (!params?.filters?.userName) {
-        logger.warn({ params }, 'UsersRepository::getUsersInfoWithDevicesInfo - missing required parameters');
-        return [];
-    }
-    // Force the query to run on master or slave
-    const dbQueryRunner = novaDataSource.createQueryRunnerFromParams(params);
-    return novaDataSource.safeQuery(async (dataSource, queryRunner) => {
-        const usersRepository = dataSource.getRepository(User);
-        const queryBuilder = usersRepository
-            .createQueryBuilder('user')
-            .innerJoin(Device, 'device', 'device.clientId = user.clientId and device.status = :status', {
-            status: Enums.DeviceStatus.Active,
-        })
-            .where('LOWER(user.userName) = LOWER(:userName)', {
-            userName: params.filters.userName.trim(),
-        })
-            .orderBy('user.email', 'ASC')
-            .select([
-            'user.id as userId',
-            'user.firstName as firstName',
-            'user.lastName as lastName',
-            'user.email as email',
-            'user.userName as userName',
-            'device.imei as imei',
-            'device.name as deviceName',
-        ]);
-        if (queryRunner) {
-            queryBuilder.setQueryRunner(queryRunner);
-        }
-        const queryResult = await queryBuilder.getRawMany();
-        const result = [];
-        const userIds = [];
-        queryResult.forEach(row => {
-            const userId = binaryBufferToUuidString(row.userId);
-            if (!userIds.includes(userId)) {
-                userIds.push(userId);
-                result.push({
-                    userId,
-                    firstName: row.firstName,
-                    lastName: row.lastName,
-                    email: row.email,
-                    userName: row.userName,
-                    devices: [],
-                });
-            }
-            const userIndex = result.findIndex(user => user.userId === userId);
-            result[userIndex].devices.push({
-                imei: row.imei,
-                name: row.deviceName,
-            });
-        });
-        return result;
-    }, 'UsersRepository::getUsersInfoWithDevicesInfo', dbQueryRunner);
-};
+import { Device, User } from '../../entities';
+import { Enums } from '../../types';
+import { binaryBufferToUuidString } from '../../utils/uuidHelpers';
+export const getUsersInfoWithDevicesInfo = async (novaDataSource, params, logger) => {
+    if (!params?.filters?.userName) {
+        logger.warn({ params }, 'UsersRepository::getUsersInfoWithDevicesInfo - missing required parameters');
+        return [];
+    }
+    // Force the query to run on master or slave
+    const dbQueryRunner = novaDataSource.createQueryRunnerFromParams(params);
+    return novaDataSource.safeQuery(async (dataSource, queryRunner) => {
+        const usersRepository = dataSource.getRepository(User);
+        const queryBuilder = usersRepository
+            .createQueryBuilder('user')
+            .innerJoin(Device, 'device', 'device.clientId = user.clientId and device.status = :status', {
+            status: Enums.DeviceStatus.Active,
+        })
+            .where('LOWER(user.userName) = LOWER(:userName)', {
+            userName: params.filters.userName.trim(),
+        })
+            .orderBy('user.email', 'ASC')
+            .select([
+            'user.id as userId',
+            'user.firstName as firstName',
+            'user.lastName as lastName',
+            'user.email as email',
+            'user.userName as userName',
+            'device.imei as imei',
+            'device.name as deviceName',
+        ]);
+        if (queryRunner) {
+            queryBuilder.setQueryRunner(queryRunner);
+        }
+        const queryResult = await queryBuilder.getRawMany();
+        const result = [];
+        const userIds = [];
+        queryResult.forEach(row => {
+            const userId = binaryBufferToUuidString(row.userId);
+            if (!userIds.includes(userId)) {
+                userIds.push(userId);
+                result.push({
+                    userId,
+                    firstName: row.firstName,
+                    lastName: row.lastName,
+                    email: row.email,
+                    userName: row.userName,
+                    devices: [],
+                });
+            }
+            const userIndex = result.findIndex(user => user.userId === userId);
+            result[userIndex].devices.push({
+                imei: row.imei,
+                name: row.deviceName,
+            });
+        });
+        return result;
+    }, 'UsersRepository::getUsersInfoWithDevicesInfo', dbQueryRunner);
+};
 //# sourceMappingURL=getUsersInfoWithDevicesInfo.js.map

package/dist/repositories/users/getUsersWithRoles.d.ts

@@ -1,4 +1,4 @@
-import { NovaDataSource } from '../../novaDataSource';
-import { Logger } from '../../types/logger';
-import { GetUsersWithRolesParams, UserWithRole } from '../../types/user';
-export declare const getUsersWithRoles: (novaDataSource: NovaDataSource, params: GetUsersWithRolesParams, logger: Logger) => Promise<UserWithRole[]>;
+import { NovaDataSource } from '../../novaDataSource';
+import { Logger } from '../../types/logger';
+import { GetUsersWithRolesParams, UserWithRole } from '../../types/user';
+export declare const getUsersWithRoles: (novaDataSource: NovaDataSource, params: GetUsersWithRolesParams, logger: Logger) => Promise<UserWithRole[]>;

package/dist/repositories/users/getUsersWithRoles.js

@@ -1,40 +1,40 @@
-import { SecurityRole, User, UserSecurityRole } from '../../entities';
-import { mapRawEntityToEntity } from '../../utils/mapRawEntityToEntity';
-export const getUsersWithRoles = async (novaDataSource, params, logger) => {
-    if (!params?.filters?.clientId || (!params?.filters?.status && !params?.filters?.roleId)) {
-        logger.warn({ params }, 'UsersRepository::getUsersWithRoles - missing required parameters');
-        return [];
-    }
-    // Force the query to run on master or slave
-    const dbQueryRunner = novaDataSource.createQueryRunnerFromParams(params);
-    return novaDataSource.safeQuery(async (dataSource, queryRunner) => {
-        const usersRepository = dataSource.getRepository(User);
-        let queryBuilder = usersRepository
-            .createQueryBuilder('user')
-            .innerJoin(UserSecurityRole, 'userSecurityRole', 'userSecurityRole.userId = user.id')
-            .innerJoin(SecurityRole, 'securityRole', 'securityRole.id = userSecurityRole.securityRoleId')
-            .where('user.clientId = :clientId', {
-            clientId: params.filters.clientId,
-        });
-        if (queryRunner) {
-            queryBuilder = queryBuilder.setQueryRunner(queryRunner);
-        }
-        if (params.filters.roleId) {
-            queryBuilder = queryBuilder.andWhere('securityRole.id = :roleId', {
-                roleId: params.filters.roleId,
-            });
-        }
-        if (params.filters.status) {
-            queryBuilder = queryBuilder.andWhere('user.status = :status', {
-                status: params.filters.status,
-            });
-        }
-        queryBuilder = queryBuilder
-            .addSelect('securityRole.name', 'role')
-            .addSelect('securityRole.id', 'roleId');
-        const usersWithRole = await queryBuilder.getRawMany();
-        const result = usersWithRole.map(item => mapRawEntityToEntity(item, 'user_'));
-        return result;
-    }, 'UsersRepository::getUsersWithRoles', dbQueryRunner);
-};
+import { SecurityRole, User, UserSecurityRole } from '../../entities';
+import { mapRawEntityToEntity } from '../../utils/mapRawEntityToEntity';
+export const getUsersWithRoles = async (novaDataSource, params, logger) => {
+    if (!params?.filters?.clientId || (!params?.filters?.status && !params?.filters?.roleId)) {
+        logger.warn({ params }, 'UsersRepository::getUsersWithRoles - missing required parameters');
+        return [];
+    }
+    // Force the query to run on master or slave
+    const dbQueryRunner = novaDataSource.createQueryRunnerFromParams(params);
+    return novaDataSource.safeQuery(async (dataSource, queryRunner) => {
+        const usersRepository = dataSource.getRepository(User);
+        let queryBuilder = usersRepository
+            .createQueryBuilder('user')
+            .innerJoin(UserSecurityRole, 'userSecurityRole', 'userSecurityRole.userId = user.id')
+            .innerJoin(SecurityRole, 'securityRole', 'securityRole.id = userSecurityRole.securityRoleId')
+            .where('user.clientId = :clientId', {
+            clientId: params.filters.clientId,
+        });
+        if (queryRunner) {
+            queryBuilder = queryBuilder.setQueryRunner(queryRunner);
+        }
+        if (params.filters.roleId) {
+            queryBuilder = queryBuilder.andWhere('securityRole.id = :roleId', {
+                roleId: params.filters.roleId,
+            });
+        }
+        if (params.filters.status) {
+            queryBuilder = queryBuilder.andWhere('user.status = :status', {
+                status: params.filters.status,
+            });
+        }
+        queryBuilder = queryBuilder
+            .addSelect('securityRole.name', 'role')
+            .addSelect('securityRole.id', 'roleId');
+        const usersWithRole = await queryBuilder.getRawMany();
+        const result = usersWithRole.map(item => mapRawEntityToEntity(item, 'user_'));
+        return result;
+    }, 'UsersRepository::getUsersWithRoles', dbQueryRunner);
+};
 //# sourceMappingURL=getUsersWithRoles.js.map

package/dist/repositories/users/index.d.ts

@@ -1,154 +1,154 @@
-import { User } from '../../entities/user';
-import { CreateUserParams, DeleteAccountParams, DeleteUserParams, GetUserByIdParams, GetUserClientRelatedEntitiesCountParams, GetUserInfoWithActivationInfoParams, GetUserInfoWithAmazonDevicesInfoParams, GetUsersConfigurationByImeiParams, GetUsersDataParams, GetUsersIdsByPhoneAndCountryCodeParams, GetUsersInfoWithDevicesInfoParams, GetUsersParams, GetUsersWithRolesParams, UpdateUserParams, UserClientRelatedEntitiesCountResult, UserData, UserInfoWithActivationInfo, UserInfoWithAmazonDevicesInfo, UserInfoWithDevicesInfo, UserWithRole } from '../../types/user';
-import { BaseRepository } from '../baseRepository';
-export declare class UsersRepository extends BaseRepository {
-    /**
-     * Get user by id
-     * @param {GetUserByIdParams} params containing information to get a user by id
-     * - filters.id: The user id
-     * @returns The user information
-     */
-    getUserById(params: GetUserByIdParams): Promise<User>;
-    /**
-     * Get users with filters
-     * @param {GetUsersParams} params containing information to get users with filters
-     * - filters.clientId: The client id to obtain all users from that client
-     * - filters.email: The user email to obtain all users with that email (lower case and trimmed comparison)
-     * - filters.userName: The userName to obtain all users with that userName (lower case and trimmed comparison, using userName and preferredUserName fields)
-     * - filters.search: Search test to obtain all users with that search text (lower case and trimmed comparison, using userName, preferredUserName, email and id fields)
-     * @returns The user information
-     */
-    getUsers(params: GetUsersParams): Promise<User[]>;
-    /**
-     * Get user data by imei
-     * @param  {GetUsersConfigurationByImeiParams} params containing information to get a device by imei
-     * - filters.imei: The imei of the device
-     */
-    getUsersConfigurationByImei(params: GetUsersConfigurationByImeiParams): Promise<User[]>;
-    /**
-     * Get user ids by phone and country code
-     * @param  {GetUsersIdsByPhoneAndCountryCodeParams} params containing information to get a user by phone and country code
-     * - filters.phone: The phone of the user. If the phone parameter is in the format +[internationalDirectDialing][phone], the +[internationalDirectDialing] should correspond to the internationalDirectDialing in the user's profile
-     * - filters.countryCode: The country code of the user (US, MX, etc)
-     */
-    getUsersIdsByPhoneAndCountryCode(params: GetUsersIdsByPhoneAndCountryCodeParams): Promise<string[]>;
-    /**
-     * Get users with roles
-     * @param  {GetUsersWithRolesParams} params containing information to get users with roles
-     * - filters.clientId: The client id to obtain all users from that client
-     * - filters.roleId: The role id to obtain all users with that role, optional
-     * - filters.status: The status to obtain all users with that status, optional
-     * roleId or status must be provided
-     * @returns The user information with the role name
-     */
-    getUsersWithRoles(params: GetUsersWithRolesParams): Promise<UserWithRole[]>;
-    /**
-     * Create a new user
-     * @param  {CreateUserParams} params containing information to create a new user
-     * id: the user id, required
-     * firstName: the first name, required
-     * lastName: the last name, required
-     * companyName: the company name, optional
-     * telephone: the phone number, optional
-     * street: the street from the user's address, optional
-     * postalCode: the postal code from the user's address, optional
-     * city: the city from the user's address, optional
-     * region: the region from the user's address, optional
-     * email: the email, required
-     * userName: the user name, required
-     * preferredUserName: the preferred user name, optional
-     * status: the status, optional. If not provided, the default value is 'A' (active)
-     * clientId: the client id, required
-     * pinCode: the pin code, optional
-     * isAdmin: whether the user is administrator, optional. If not provided, the default value is false
-     * countryId: the country id, optional
-     * telephoneCountryId: the country id corresponding to the phone number, optional
-     * dataSourceTypeId?: the data source type id, optional
-     * emailVerified: whether the email is verified, optional. If not provided, the default value is true
-     * @returns The created user
-     */
-    createUser(params: CreateUserParams): Promise<User>;
-    /**
-     * Delete a user
-     * @param  {DeleteUserParams} params containing information to delete a user
-     * id: the user id, required
-     * @returns Whether the user was deleted or not
-     */
-    deleteUser(params: DeleteUserParams): Promise<boolean>;
-    /**
-     * Update a user
-     * @param  {UpdateUserParams} params containing information to update a user
-     * At least one filter must be provided:
-     * filters.userId: the user id to filter the users to update, optional
-     * filters.email: the user email to filter the users to update, optional
-     * filters.statusList: a list of status to filter the users to update, optional
-     * At least one value must be provided:
-     * values.firstName: the first name, optional
-     * values.lastName: the last name, optional
-     * values.companyName: the company name, optional
-     * values.telephone: the phone number, optional
-     * values.street: the street from the user's address, optional
-     * values.postalCode: the postal code from the user's address, optional
-     * values.city: the city from the user's address, optional
-     * values.region: the region from the user's address, optional
-     * values.email: the email, optional
-     * values.userName: the user name, optional
-     * values.preferredUserName: the preferred user name, optional
-     * values.status: the status, optional
-     * values.isAdmin: whether the user is administrator, optional
-     * values.countryId: the country id, optional
-     * values.countryCode: the country alpha2 code to find the countryId, optional (if countryId is provided, countryCode is ignored)
-     * values.telephoneCountryId: the country id corresponding to the phone number, optional
-     * values.telephoneCountryCode: the country alpha2 code to find the telephoneCountryId, optional (if telephoneCountryId is provided, telephoneCountryCode is ignored)
-     * values.dataSourceTypeId?: the data source type id, optional
-     * values.emailVerified: whether the email is verified, optional
-     * values.latitude: the latitude, optional
-     * values.longitude: the longitude, optional
-     * values.lastLoginAt: the last login date, optional
-     * @returns Whether the user was updated or not
-     */
-    updateUser(params: UpdateUserParams): Promise<boolean>;
-    /**
-     * Get users data
-     * @param  {GetUsersDataParams} params containing information to get users data
-     * - filters.imei: The imei of the device to obtain users configurations
-     * @returns The array of users data
-     */
-    getUsersData(params: GetUsersDataParams): Promise<UserData[]>;
-    /**
-     * Delete an account
-     * @param  {DeleteAccountParams} params containing information to delete an account
-     * - filters.userId: The user id to delete the account
-     * - filters.clientId: The client id to delete the account
-     * @returns Whether the account was deleted or not
-     */
-    deleteAccount(params: DeleteAccountParams): Promise<boolean>;
-    /**
-     * Get user client related entities count
-     * @param  {GetUserClientRelatedEntitiesCountParams} params containing information to get user client related entities count
-     * - filters.userId: The user id to get the count of related entities
-     * @returns The user client related entities count
-     */
-    getUserClientRelatedEntitiesCount(params: GetUserClientRelatedEntitiesCountParams): Promise<UserClientRelatedEntitiesCountResult>;
-    /**
-     * Get users info with devices info
-     * @param  {GetUsersInfoWithDevicesInfoParams} params containing information to get users info with devices info
-     * - filters.userName: The user name to obtain all users with that user name (lower case and trimmed comparison)
-     * @returns The user information with the devices info
-     */
-    getUsersInfoWithDevicesInfo(params: GetUsersInfoWithDevicesInfoParams): Promise<UserInfoWithDevicesInfo[]>;
-    /**
-     * Get user info with amazon devices info
-     * @param  {GetUserInfoWithAmazonDevicesInfoParams} params containing information to get user info with amazon devices
-     * - filters.userId: The user id to obtain the user info with amazon devices
-     * @returns The user information with the amazon devices
-     */
-    getUserInfoWithAmazonDevicesInfo(params: GetUserInfoWithAmazonDevicesInfoParams): Promise<UserInfoWithAmazonDevicesInfo>;
-    /**
-     * Get users info with activation info
-     * @param  {GetUserInfoWithActivationInfoParams} params containing information to get users info with activation info
-     * - filters.userId: The user id to obtain the user info with activation info
-     * @returns The user information with the activation info
-     */
-    getUsersInfoWithActivationInfo(params: GetUserInfoWithActivationInfoParams): Promise<UserInfoWithActivationInfo>;
-}
+import { User } from '../../entities/user';
+import { CreateUserParams, DeleteAccountParams, DeleteUserParams, GetUserByIdParams, GetUserClientRelatedEntitiesCountParams, GetUserInfoWithActivationInfoParams, GetUserInfoWithAmazonDevicesInfoParams, GetUsersConfigurationByImeiParams, GetUsersDataParams, GetUsersIdsByPhoneAndCountryCodeParams, GetUsersInfoWithDevicesInfoParams, GetUsersParams, GetUsersWithRolesParams, UpdateUserParams, UserClientRelatedEntitiesCountResult, UserData, UserInfoWithActivationInfo, UserInfoWithAmazonDevicesInfo, UserInfoWithDevicesInfo, UserWithRole } from '../../types/user';
+import { BaseRepository } from '../baseRepository';
+export declare class UsersRepository extends BaseRepository {
+    /**
+     * Get user by id
+     * @param {GetUserByIdParams} params containing information to get a user by id
+     * - filters.id: The user id
+     * @returns The user information
+     */
+    getUserById(params: GetUserByIdParams): Promise<User>;
+    /**
+     * Get users with filters
+     * @param {GetUsersParams} params containing information to get users with filters
+     * - filters.clientId: The client id to obtain all users from that client
+     * - filters.email: The user email to obtain all users with that email (lower case and trimmed comparison)
+     * - filters.userName: The userName to obtain all users with that userName (lower case and trimmed comparison, using userName and preferredUserName fields)
+     * - filters.search: Search test to obtain all users with that search text (lower case and trimmed comparison, using userName, preferredUserName, email and id fields)
+     * @returns The user information
+     */
+    getUsers(params: GetUsersParams): Promise<User[]>;
+    /**
+     * Get user data by imei
+     * @param  {GetUsersConfigurationByImeiParams} params containing information to get a device by imei
+     * - filters.imei: The imei of the device
+     */
+    getUsersConfigurationByImei(params: GetUsersConfigurationByImeiParams): Promise<User[]>;
+    /**
+     * Get user ids by phone and country code
+     * @param  {GetUsersIdsByPhoneAndCountryCodeParams} params containing information to get a user by phone and country code
+     * - filters.phone: The phone of the user. If the phone parameter is in the format +[internationalDirectDialing][phone], the +[internationalDirectDialing] should correspond to the internationalDirectDialing in the user's profile
+     * - filters.countryCode: The country code of the user (US, MX, etc)
+     */
+    getUsersIdsByPhoneAndCountryCode(params: GetUsersIdsByPhoneAndCountryCodeParams): Promise<string[]>;
+    /**
+     * Get users with roles
+     * @param  {GetUsersWithRolesParams} params containing information to get users with roles
+     * - filters.clientId: The client id to obtain all users from that client
+     * - filters.roleId: The role id to obtain all users with that role, optional
+     * - filters.status: The status to obtain all users with that status, optional
+     * roleId or status must be provided
+     * @returns The user information with the role name
+     */
+    getUsersWithRoles(params: GetUsersWithRolesParams): Promise<UserWithRole[]>;
+    /**
+     * Create a new user
+     * @param  {CreateUserParams} params containing information to create a new user
+     * id: the user id, required
+     * firstName: the first name, required
+     * lastName: the last name, required
+     * companyName: the company name, optional
+     * telephone: the phone number, optional
+     * street: the street from the user's address, optional
+     * postalCode: the postal code from the user's address, optional
+     * city: the city from the user's address, optional
+     * region: the region from the user's address, optional
+     * email: the email, required
+     * userName: the user name, required
+     * preferredUserName: the preferred user name, optional
+     * status: the status, optional. If not provided, the default value is 'A' (active)
+     * clientId: the client id, required
+     * pinCode: the pin code, optional
+     * isAdmin: whether the user is administrator, optional. If not provided, the default value is false
+     * countryId: the country id, optional
+     * telephoneCountryId: the country id corresponding to the phone number, optional
+     * dataSourceTypeId?: the data source type id, optional
+     * emailVerified: whether the email is verified, optional. If not provided, the default value is true
+     * @returns The created user
+     */
+    createUser(params: CreateUserParams): Promise<User>;
+    /**
+     * Delete a user
+     * @param  {DeleteUserParams} params containing information to delete a user
+     * id: the user id, required
+     * @returns Whether the user was deleted or not
+     */
+    deleteUser(params: DeleteUserParams): Promise<boolean>;
+    /**
+     * Update a user
+     * @param  {UpdateUserParams} params containing information to update a user
+     * At least one filter must be provided:
+     * filters.userId: the user id to filter the users to update, optional
+     * filters.email: the user email to filter the users to update, optional
+     * filters.statusList: a list of status to filter the users to update, optional
+     * At least one value must be provided:
+     * values.firstName: the first name, optional
+     * values.lastName: the last name, optional
+     * values.companyName: the company name, optional
+     * values.telephone: the phone number, optional
+     * values.street: the street from the user's address, optional
+     * values.postalCode: the postal code from the user's address, optional
+     * values.city: the city from the user's address, optional
+     * values.region: the region from the user's address, optional
+     * values.email: the email, optional
+     * values.userName: the user name, optional
+     * values.preferredUserName: the preferred user name, optional
+     * values.status: the status, optional
+     * values.isAdmin: whether the user is administrator, optional
+     * values.countryId: the country id, optional
+     * values.countryCode: the country alpha2 code to find the countryId, optional (if countryId is provided, countryCode is ignored)
+     * values.telephoneCountryId: the country id corresponding to the phone number, optional
+     * values.telephoneCountryCode: the country alpha2 code to find the telephoneCountryId, optional (if telephoneCountryId is provided, telephoneCountryCode is ignored)
+     * values.dataSourceTypeId?: the data source type id, optional
+     * values.emailVerified: whether the email is verified, optional
+     * values.latitude: the latitude, optional
+     * values.longitude: the longitude, optional
+     * values.lastLoginAt: the last login date, optional
+     * @returns Whether the user was updated or not
+     */
+    updateUser(params: UpdateUserParams): Promise<boolean>;
+    /**
+     * Get users data
+     * @param  {GetUsersDataParams} params containing information to get users data
+     * - filters.imei: The imei of the device to obtain users configurations
+     * @returns The array of users data
+     */
+    getUsersData(params: GetUsersDataParams): Promise<UserData[]>;
+    /**
+     * Delete an account
+     * @param  {DeleteAccountParams} params containing information to delete an account
+     * - filters.userId: The user id to delete the account
+     * - filters.clientId: The client id to delete the account
+     * @returns Whether the account was deleted or not
+     */
+    deleteAccount(params: DeleteAccountParams): Promise<boolean>;
+    /**
+     * Get user client related entities count
+     * @param  {GetUserClientRelatedEntitiesCountParams} params containing information to get user client related entities count
+     * - filters.userId: The user id to get the count of related entities
+     * @returns The user client related entities count
+     */
+    getUserClientRelatedEntitiesCount(params: GetUserClientRelatedEntitiesCountParams): Promise<UserClientRelatedEntitiesCountResult>;
+    /**
+     * Get users info with devices info
+     * @param  {GetUsersInfoWithDevicesInfoParams} params containing information to get users info with devices info
+     * - filters.userName: The user name to obtain all users with that user name (lower case and trimmed comparison)
+     * @returns The user information with the devices info
+     */
+    getUsersInfoWithDevicesInfo(params: GetUsersInfoWithDevicesInfoParams): Promise<UserInfoWithDevicesInfo[]>;
+    /**
+     * Get user info with amazon devices info
+     * @param  {GetUserInfoWithAmazonDevicesInfoParams} params containing information to get user info with amazon devices
+     * - filters.userId: The user id to obtain the user info with amazon devices
+     * @returns The user information with the amazon devices
+     */
+    getUserInfoWithAmazonDevicesInfo(params: GetUserInfoWithAmazonDevicesInfoParams): Promise<UserInfoWithAmazonDevicesInfo>;
+    /**
+     * Get users info with activation info
+     * @param  {GetUserInfoWithActivationInfoParams} params containing information to get users info with activation info
+     * - filters.userId: The user id to obtain the user info with activation info
+     * @returns The user information with the activation info
+     */
+    getUsersInfoWithActivationInfo(params: GetUserInfoWithActivationInfoParams): Promise<UserInfoWithActivationInfo>;
+}