@spytecgps/nova-orm 1.2.34 → 1.2.35

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>;
+}