@spytecgps/nova-orm 1.2.13 → 1.2.14

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

@@ -1,331 +1,331 @@
-import { ClientDeviceSetting, Device, DeviceChangesHistory, DeviceCustomConfiguration, DeviceReplacement, DeviceType, IccidStatus, ImeiIccidCarrier, ServiceProviderProduct } from '../../entities';
-import { AddDeviceChangesHistoryParams, AllImeisAreActiveForClientParams, CanceledDeviceWithActiveSimCard, CarrierStatus, CreateClientDeviceSettingParams, CreateDeviceParams, CreateDeviceReplacementParams, CreateDeviceTypeParams, CreateImeiIccidCarrierParams, DeleteDeviceParams, DevicesCountByStatus, DeviceTypeModelWithDeviceCount, DeviceWithUsersInfo, GenerateIdentifierKeyParams, GetCanceledDevicesWithActiveSimCardsParams, GetCarrierStatusUpdatedBeforeParams, GetClientDeviceSettingParams, GetClientDeviceSettingsParams, GetDeviceChangesHistoryAssignedToValuesByClientParams, GetDeviceChangesHistoryParams, GetDeviceCustomConfigParams, GetDeviceParams, GetDevicesCountByStatusParams, GetDevicesParams, GetDeviceTypeByImeiParams, GetDeviceTypesModelsOrderedByDeviceCountParams, GetDeviceTypesParams, GetDeviceWithUsersInfoParams, GetFilteredImeisWithStatusParams, GetIccidStatusParams, GetImeiIccidCarrierParams, GetImeiIccidCarriersParams, GetServiceProviderProductParams, UpdateClientDeviceSettingParams, UpdateDeviceParams, UpdateDeviceTypeParams, UpdateIccidStatusParams, UpdateImeiIccidCarrierParams, UpsertDeviceCustomConfigParams, UpsertIccidStatusParams } from '../../types/devices';
-import { BaseRepository2 } from './../baseRepository';
-export declare class DevicesRepository extends BaseRepository2 {
-    /**
-     * Get device with filters
-     * @param  {GetDeviceParams} params containing information to get a device with filters
-     * - filters.imei: The imei of the device
-     * - filters.id: The id of the device
-     * - projectionOptions.withDeviceType: Whether to get the device type object
-     * - projectionOptions.withIccidCarrier: Whether to get the iccid carrier object
-     */
-    getDevice(params: GetDeviceParams): Promise<Device>;
-    /**
-     * Get devices by type id
-     * @param  {GetDevicesParams} params containing information to get devices by type id
-     * - filters.deviceTypeId: The device type id
-     * - filters.status: The device status
-     * - filters.clientId: The client id
-     * - filters.imeiList: The imei list
-     * - projectionOptions.withDeviceType: Whether to get the device type object
-     * - projectionOptions.withIccidCarrier: Whether to get the iccid carrier object
-     */
-    getDevices(params: GetDevicesParams): Promise<Device[]>;
-    /**
-     * Check if all imeis are active for a client
-     * @param  {AllImeisAreActiveForClientParams} params containing information to check if all imeis are active for a client
-     * - imeis: The imeis to check
-     * - clientId: The client id
-     * @returns {Promise<boolean>} Whether all imeis are active for a client
-     */
-    allImeisAreActiveForClient(params: AllImeisAreActiveForClientParams): Promise<boolean>;
-    /**
-     * Get filtered imeis with status
-     * @param  {GetFilteredImeisWithStatusParams} params containing information to get filtered imeis with status
-     * - filters.imeiList: The imei list to filter
-     * - filters.status: The device status
-     * @returns {Promise<string>} The imei list filtered by status
-     */
-    getFilteredImeisWithStatus(params: GetFilteredImeisWithStatusParams): Promise<string[]>;
-    /**
-     * Create device
-     * @param  {CreateDeviceParams} params containing information to create a device
-     * - identifier: The device identifier
-     * - imei: The imei of the device
-     * - clientId: The client id
-     * - deviceTypeId: The device type id
-     * - iccid: The iccid of the device
-     * - name: The name of the device
-     * - color: The color of the device
-     * - icon: The icon of the device
-     * - status: The status of the device
-     * - forward: Whether to forward the device
-     * - description: The description of the device
-     * - dataSourceTypeId: The data source type id of the device
-     * - assetCategoryId: The asset category id of the device
-     * - usageRegion: The usage region of the device
-     * - createdBy: The user who created the device
-     *
-     * @returns {Promise<Device>} The created device
-     */
-    createDevice(params: CreateDeviceParams): Promise<Device>;
-    /**
-     * Update device
-     * @param  {UpdateDeviceParams} params containing information to update a device
-     * - filters.imei: The imei of the device
-     * - filters.status: The status of the device
-     * - filters.clientId: The client id
-     * - values.clientId: The client id
-     * - values.deviceTypeId: The device type id
-     * - values.iccid: The iccid of the device
-     * - values.name: The name of the device
-     * - values.color: The color of the device
-     * - values.icon: The icon of the device
-     * - values.status: The status of the device
-     * - values.forward: Whether to forward the device
-     * - values.description: The description of the device
-     * - values.dataSourceTypeId: The data source type id of the device
-     * - values.assetCategoryId: The asset category id of the device
-     * - values.usageRegion: The usage region of the device
-     * - values.modifiedBy: The user who updated the device
-     * @returns {Promise<boolean>} Whether the device was updated
-     */
-    updateDevice(params: UpdateDeviceParams): Promise<boolean>;
-    /**
-     * Delete device
-     * @param  {DeleteDeviceParams} params containing information to delete a device
-     * - filters.imei: The imei of the device
-     *
-     * @returns {Promise<boolean>} Whether the device was deleted
-     */
-    deleteDevice(params: DeleteDeviceParams): Promise<boolean>;
-    /**
-     * Generate device identifier key from device type and device identifier
-     * @param  {GenerateIdentifierKeyParams} params containing information to generate a device identifier key
-     * - deviceTypeId: The device type id
-     * - deviceIdentifier: The device identifier
-     * @returns {Promise<string>} The generated device identifier key
-     */
-    generateDeviceIdentifierKey(params: GenerateIdentifierKeyParams): Promise<string>;
-    /**
-     * Get device types
-     * @param  {GetDeviceTypesParams} params containing information to get device types
-     * - filters.onlyWithRelatedIccidCarrier: Whether to get only device types with iccid carrier
-     */
-    getDeviceTypes(params: GetDeviceTypesParams): Promise<DeviceType[]>;
-    /**
-     * Get ImeiIccidCarrier
-     * @param  {GetImeiIccidCarrierParams} params containing information to get the ImeiIccidCarrier
-     * - filters.imei: The imei of the device
-     * - filters.iccid: The iccid of the device
-     * @returns {Promise<ImeiIccidCarrier>} The imei iccid carrier
-     */
-    getImeiIccidCarrier(params: GetImeiIccidCarrierParams): Promise<ImeiIccidCarrier>;
-    /**
-     * Get DeviceTypeByImei
-     * @param  {GetDeviceTypeByImeiParams} params containing information to get the device type by imei
-     * - filters.imei: The imei of the device
-     * @returns {Promise<DeviceType>} The device type record of an imei
-     */
-    getDeviceTypeByImei(params: GetDeviceTypeByImeiParams): Promise<DeviceType>;
-    /**
-     * Get ImeiIccidCarriers from a list of imeis
-     * @param  {GetImeiIccidCarriersParams} params containing information to get the ImeiIccidCarriers
-     * - filters.imeis: The imeis of the devices
-     * @returns {Promise<ImeiIccidCarrier[]>} The imei iccid carriers
-     */
-    getImeiIccidCarriers(params: GetImeiIccidCarriersParams): Promise<ImeiIccidCarrier[]>;
-    /**
-     * Update the ImeiIccidCarrier
-     * @param  {UpdateImeiIccidCarrierParams} params containing information to update the ImeiIccidCarrier
-     * - filters.imei: The imei of the device to update
-     * - filters.iccid: The iccid of the device to update
-     * - values.carrierId: The carrier id
-     * - values.phone: The phone or MSISDN of the device
-     * - values.deviceTypeId: The device type id
-     * - values.serviceProviderProductId: The service provider product id
-     * - values.isValid: Whether the imei iccid carrier is valid
-     * - values.realModel: The real model of the device
-     * - values.po: The purchase order number of the device
-     * - values.outOfInventory: Whether the device is out of inventory
-     * - values.apn: The apn of the device
-     *
-     * @returns {Promise<boolean>} Whether the imei iccid carrier was updated
-     */
-    updateImeiIccidCarrier(params: UpdateImeiIccidCarrierParams): Promise<boolean>;
-    /**
-     * Get a ClientDeviceSetting
-     * @param  {GetClientDeviceSettingParams} params containing information to get a ClientDeviceSetting
-     * - filters.imei: The imei of the device
-     * - filters.clientId: The client id
-     * @returns {Promise<ClientDeviceSetting>} The ClientDeviceSetting
-     */
-    getClientDeviceSetting(params: GetClientDeviceSettingParams): Promise<ClientDeviceSetting>;
-    /**
-     * Get a list of ClientDeviceSettings with filters
-     * @param  {GetClientDeviceSettingsParams} params containing information to get ClientDeviceSettings
-     * - filters.clientId: The client id
-     * @returns {Promise<ClientDeviceSetting[]>} An array of ClientDeviceSettings matching the filters
-     */
-    getClientDeviceSettings(params: GetClientDeviceSettingsParams): Promise<ClientDeviceSetting[]>;
-    /**
-     * Create a ClientDeviceSetting
-     * @param  {CreateClientDeviceSettingParams} params containing information to create a ClientDeviceSetting
-     * - values.imei: The imei of the device
-     * - values.clientId: The client id
-     * - values.generateTrips: Whether to generate trips
-     * - values.movingPingFrequency: The moving ping frequency
-     * - values.stoppedPingFrequency: The stopped ping frequency
-     * - values.fixedStatus: The fixed status
-     * - values.stopThresholdMinutes: The threshold in minutes to consider that the device is stopped
-     * - values.offlineThresholdMinutes: The threshold in minutes to consider that the device is offline
-     * - values.movementThresholdSpeed: The threshold for the speed to consider that the device is moving
-     * - values.externalBatteryInformation: The external battery information
-     * @returns {Promise<ClientDeviceSetting>} The created ClientDeviceSetting
-     */
-    createClientDeviceSetting(params: CreateClientDeviceSettingParams): Promise<ClientDeviceSetting>;
-    /**
-     * Update a ClientDeviceSetting
-     * @param  {UpdateClientDeviceSettingParams} params containing information to update a ClientDeviceSetting
-     * - filters.imei: The imei of the device
-     * - filters.clientId: The client id
-     * - values.generateTrips: Whether to generate trips
-     * - values.movingPingFrequency: The moving ping frequency
-     * - values.stoppedPingFrequency: The stopped ping frequency
-     * - values.fixedStatus: The fixed status
-     * - values.stopThresholdMinutes: The threshold in minutes to consider that the device is stopped
-     * - values.offlineThresholdMinutes: The threshold in minutes to consider that the device is offline
-     * - values.movementThresholdSpeed: The threshold for the speed to consider that the device is moving
-     * - values.externalBatteryInformation: The external battery information
-     * @returns {Promise<boolean>} Whether the ClientDeviceSetting was updated
-     */
-    updateClientDeviceSetting(params: UpdateClientDeviceSettingParams): Promise<boolean>;
-    /**
-     * Get a list of DeviceTypeModel with the count of associated devices, ordered by device count
-     * @param  {GetDeviceTypesModelsOrderedByDeviceCountParams} params containing information to get DeviceTypeModelWithDeviceCount
-     * - filters.deviceStatus: The device status to filter by, optional. If not provided, all devices will be counted
-     */
-    getDeviceTypesModelsOrderedByDeviceCount(params: GetDeviceTypesModelsOrderedByDeviceCountParams): Promise<DeviceTypeModelWithDeviceCount[]>;
-    /**
-     * Get the device custom configuration
-     * @param {GetDeviceCustomConfigParams} params containing information to get the device custom configuration
-     *  - filters.clientId: The client id
-     *  - filters.imei: The imei of the device
-     *  - filters.po: The purchase order number of the device
-     * @returns The device custom configurations if found, empty array otherwise
-     */
-    getDeviceCustomConfigs(params: GetDeviceCustomConfigParams): Promise<DeviceCustomConfiguration[]>;
-    /**
-     * Upsert device custom configurations for activation
-     * @param {UpsertDeviceCustomConfigParams[]} params containing information to upsert device custom configurations
-     * - id: The id of the device custom configuration, optional
-     * - clientId: The client id. Required
-     * - deviceTypeId: The device type id. Required
-     * - imei: The imei of the device. Optional
-     * - po: The purchase order number of the device. Optional
-     * - configFileUrl: The url of the configuration file. Optional
-     * - skipActivationDefaults: Whether to skip activation defaults. Optional
-     * @returns Whether the device custom configurations were upserted or not
-     */
-    upsertDeviceCustomConfigs(params: UpsertDeviceCustomConfigParams[]): Promise<boolean>;
-    /**
-     * Create a device replacement
-     * @param  {CreateDeviceReplacementParams} params containing information to create a device replacement
-     * - id: The id of the device replacement, optional
-     * - imeiOld: The old imei of the device, required
-     * - imeiNew: The new imei of the device, required
-     * - iccidOld: The old iccid of the device, required
-     * - iccidNew: The new iccid of the device, required
-     * - userId: The user id, required
-     * - clientId: The client id, required
-     * @returns {Promise<DeviceReplacement>} The created device replacement
-     */
-    createDeviceReplacement(params: CreateDeviceReplacementParams): Promise<DeviceReplacement>;
-    /**
-     * Get the iccid status for a given iccid
-     * @param  {GetIccidStatusParams} params containing information to get the iccid status
-     * - filters.iccid: The iccid of the device
-     * @returns The iccid status
-     */
-    getIccidStatus(params: GetIccidStatusParams): Promise<IccidStatus>;
-    /**
-     * Update the iccid status for a given iccid
-     * @param  {UpdateIccidStatusParams} params containing information to update the iccid status
-     * - filters.iccid: The iccid of the device
-     * - values.status: The status of the iccid
-     * - values.processing: Whether the iccid is processing
-     * - values.carrierFound: Whether the carrier was found
-     * @returns Whether the iccid status was updated
-     */
-    updateIccidStatus(params: UpdateIccidStatusParams): Promise<boolean>;
-    /**
-     * Get the canceled devices with active sim cards
-     * @param  {GetCanceledDevicesWithActiveSimCardsParams} params containing information to get the canceled devices with active sim cards
-     * - filters.lastAnalyzedDeviceId: The last analyzed device id
-     * - pagingOptions.limit: The amount of devices to get
-     * @returns The canceled devices with active sim cards
-     */
-    getCanceledDevicesWithActiveSimCards(params: GetCanceledDevicesWithActiveSimCardsParams): Promise<CanceledDeviceWithActiveSimCard[]>;
-    /**
-     * Get the carrier status for all devices updated before a given date
-     * @param  {GetCarrierStatusUpdatedBeforeParams} params containing information to get the carrier status
-     * - filters.beforeDate: The date to compare
-     * - pagingOptions.limit: The amount of devices to get
-     * @returns The carrier status for devices updated before a given date
-     */
-    getCarrierStatusUpdatedBefore(params: GetCarrierStatusUpdatedBeforeParams): Promise<CarrierStatus[]>;
-    /**
-     * Upsert the iccid status for a given iccid
-     * @param  {UpsertIccidStatusParams} params containing information to upsert the iccid status
-     * - iccid: The iccid of the device
-     * - status: The status of the iccid
-     * - carrierFound: The carrier found
-     * @returns Whether the iccid status was upserted
-     */
-    upsertIccidStatus(params: UpsertIccidStatusParams): Promise<boolean>;
-    /**
-     * Get device with users info
-     * @param  {GetDeviceWithUsersInfoParams} params containing information to get device with users info
-     * - filters.imei: The imei of the device
-     * @returns The device with users info
-     */
-    getDeviceWithUsersInfo(params: GetDeviceWithUsersInfoParams): Promise<DeviceWithUsersInfo[]>;
-    /**
-     * Create a device type
-     * @param  {CreateDeviceTypeParams} params containing information to create a device type
-     * @returns {Promise<DeviceType>} The created device type
-     */
-    createDeviceType(params: CreateDeviceTypeParams): Promise<DeviceType>;
-    /**
-     * Update a device type
-     * @param  {UpdateDeviceTypeParams} params containing information to update a device type
-     * - filters.id: The id of the device type
-     * - values: The values to update. At least one field is required
-     * @returns {Promise<boolean>} Whether the device type was updated
-     */
-    updateDeviceType(params: UpdateDeviceTypeParams): Promise<boolean>;
-    /**
-     * Get the count of devices by status
-     * @param  {GetDevicesCountByStatusParams} params containing information to get the count of devices by status
-     * - filters.clientId: The client id
-     * @returns {Promise<DevicesCountByStatus>} The count of devices by statuses
-     */
-    getDevicesCountByStatus(params: GetDevicesCountByStatusParams): Promise<DevicesCountByStatus[]>;
-    /**
-     * Get a service provider product
-     * @param  {GetServiceProviderProductParams} params containing information to get a service provider product
-     * - filters.id: The id of the service provider product
-     * @returns {Promise<ServiceProviderProduct>} The service provider product
-     */
-    getServiceProviderProduct(params: GetServiceProviderProductParams): Promise<ServiceProviderProduct>;
-    createImeiIccidCarrier(params: CreateImeiIccidCarrierParams): Promise<ImeiIccidCarrier | null>;
-    /**
-     * Get the unique assigned to values from the device changes history by client
-     * @param params containing information to get the unique assigned to values from the device changes history by client
-     * @returns The unique assigned to values from the device changes history by client
-     */
-    getDeviceChangesHistoryAssignedToValuesByClient(params: GetDeviceChangesHistoryAssignedToValuesByClientParams): Promise<string[]>;
-    /**
-     * Get the device changes history
-     * @param params containing information to get the device changes history
-     * @returns The device changes history
-     */
-    getDeviceChangesHistory(params: GetDeviceChangesHistoryParams): Promise<DeviceChangesHistory[]>;
-    /**
-     * Will add a new record to the device changes history table and update the endDate of the previous record if it exists
-     * @param params containing information to add a new record to the device changes history table
-     * @returns The new device changes history
-     */
-    addDeviceChangesHistory(params: AddDeviceChangesHistoryParams): Promise<DeviceChangesHistory>;
-}
+import { ClientDeviceSetting, Device, DeviceChangesHistory, DeviceCustomConfiguration, DeviceReplacement, DeviceType, IccidStatus, ImeiIccidCarrier, ServiceProviderProduct } from '../../entities';
+import { AddDeviceChangesHistoryParams, AllImeisAreActiveForClientParams, CanceledDeviceWithActiveSimCard, CarrierStatus, CreateClientDeviceSettingParams, CreateDeviceParams, CreateDeviceReplacementParams, CreateDeviceTypeParams, CreateImeiIccidCarrierParams, DeleteDeviceParams, DevicesCountByStatus, DeviceTypeModelWithDeviceCount, DeviceWithUsersInfo, GenerateIdentifierKeyParams, GetCanceledDevicesWithActiveSimCardsParams, GetCarrierStatusUpdatedBeforeParams, GetClientDeviceSettingParams, GetClientDeviceSettingsParams, GetDeviceChangesHistoryAssignedToValuesByClientParams, GetDeviceChangesHistoryParams, GetDeviceCustomConfigParams, GetDeviceParams, GetDevicesCountByStatusParams, GetDevicesParams, GetDeviceTypeByImeiParams, GetDeviceTypesModelsOrderedByDeviceCountParams, GetDeviceTypesParams, GetDeviceWithUsersInfoParams, GetFilteredImeisWithStatusParams, GetIccidStatusParams, GetImeiIccidCarrierParams, GetImeiIccidCarriersParams, GetServiceProviderProductParams, UpdateClientDeviceSettingParams, UpdateDeviceParams, UpdateDeviceTypeParams, UpdateIccidStatusParams, UpdateImeiIccidCarrierParams, UpsertDeviceCustomConfigParams, UpsertIccidStatusParams } from '../../types/devices';
+import { BaseRepository2 } from './../baseRepository';
+export declare class DevicesRepository extends BaseRepository2 {
+    /**
+     * Get device with filters
+     * @param  {GetDeviceParams} params containing information to get a device with filters
+     * - filters.imei: The imei of the device
+     * - filters.id: The id of the device
+     * - projectionOptions.withDeviceType: Whether to get the device type object
+     * - projectionOptions.withIccidCarrier: Whether to get the iccid carrier object
+     */
+    getDevice(params: GetDeviceParams): Promise<Device>;
+    /**
+     * Get devices by type id
+     * @param  {GetDevicesParams} params containing information to get devices by type id
+     * - filters.deviceTypeId: The device type id
+     * - filters.status: The device status
+     * - filters.clientId: The client id
+     * - filters.imeiList: The imei list
+     * - projectionOptions.withDeviceType: Whether to get the device type object
+     * - projectionOptions.withIccidCarrier: Whether to get the iccid carrier object
+     */
+    getDevices(params: GetDevicesParams): Promise<Device[]>;
+    /**
+     * Check if all imeis are active for a client
+     * @param  {AllImeisAreActiveForClientParams} params containing information to check if all imeis are active for a client
+     * - imeis: The imeis to check
+     * - clientId: The client id
+     * @returns {Promise<boolean>} Whether all imeis are active for a client
+     */
+    allImeisAreActiveForClient(params: AllImeisAreActiveForClientParams): Promise<boolean>;
+    /**
+     * Get filtered imeis with status
+     * @param  {GetFilteredImeisWithStatusParams} params containing information to get filtered imeis with status
+     * - filters.imeiList: The imei list to filter
+     * - filters.status: The device status
+     * @returns {Promise<string>} The imei list filtered by status
+     */
+    getFilteredImeisWithStatus(params: GetFilteredImeisWithStatusParams): Promise<string[]>;
+    /**
+     * Create device
+     * @param  {CreateDeviceParams} params containing information to create a device
+     * - identifier: The device identifier
+     * - imei: The imei of the device
+     * - clientId: The client id
+     * - deviceTypeId: The device type id
+     * - iccid: The iccid of the device
+     * - name: The name of the device
+     * - color: The color of the device
+     * - icon: The icon of the device
+     * - status: The status of the device
+     * - forward: Whether to forward the device
+     * - description: The description of the device
+     * - dataSourceTypeId: The data source type id of the device
+     * - assetCategoryId: The asset category id of the device
+     * - usageRegion: The usage region of the device
+     * - createdBy: The user who created the device
+     *
+     * @returns {Promise<Device>} The created device
+     */
+    createDevice(params: CreateDeviceParams): Promise<Device>;
+    /**
+     * Update device
+     * @param  {UpdateDeviceParams} params containing information to update a device
+     * - filters.imei: The imei of the device
+     * - filters.status: The status of the device
+     * - filters.clientId: The client id
+     * - values.clientId: The client id
+     * - values.deviceTypeId: The device type id
+     * - values.iccid: The iccid of the device
+     * - values.name: The name of the device
+     * - values.color: The color of the device
+     * - values.icon: The icon of the device
+     * - values.status: The status of the device
+     * - values.forward: Whether to forward the device
+     * - values.description: The description of the device
+     * - values.dataSourceTypeId: The data source type id of the device
+     * - values.assetCategoryId: The asset category id of the device
+     * - values.usageRegion: The usage region of the device
+     * - values.modifiedBy: The user who updated the device
+     * @returns {Promise<boolean>} Whether the device was updated
+     */
+    updateDevice(params: UpdateDeviceParams): Promise<boolean>;
+    /**
+     * Delete device
+     * @param  {DeleteDeviceParams} params containing information to delete a device
+     * - filters.imei: The imei of the device
+     *
+     * @returns {Promise<boolean>} Whether the device was deleted
+     */
+    deleteDevice(params: DeleteDeviceParams): Promise<boolean>;
+    /**
+     * Generate device identifier key from device type and device identifier
+     * @param  {GenerateIdentifierKeyParams} params containing information to generate a device identifier key
+     * - deviceTypeId: The device type id
+     * - deviceIdentifier: The device identifier
+     * @returns {Promise<string>} The generated device identifier key
+     */
+    generateDeviceIdentifierKey(params: GenerateIdentifierKeyParams): Promise<string>;
+    /**
+     * Get device types
+     * @param  {GetDeviceTypesParams} params containing information to get device types
+     * - filters.onlyWithRelatedIccidCarrier: Whether to get only device types with iccid carrier
+     */
+    getDeviceTypes(params: GetDeviceTypesParams): Promise<DeviceType[]>;
+    /**
+     * Get ImeiIccidCarrier
+     * @param  {GetImeiIccidCarrierParams} params containing information to get the ImeiIccidCarrier
+     * - filters.imei: The imei of the device
+     * - filters.iccid: The iccid of the device
+     * @returns {Promise<ImeiIccidCarrier>} The imei iccid carrier
+     */
+    getImeiIccidCarrier(params: GetImeiIccidCarrierParams): Promise<ImeiIccidCarrier>;
+    /**
+     * Get DeviceTypeByImei
+     * @param  {GetDeviceTypeByImeiParams} params containing information to get the device type by imei
+     * - filters.imei: The imei of the device
+     * @returns {Promise<DeviceType>} The device type record of an imei
+     */
+    getDeviceTypeByImei(params: GetDeviceTypeByImeiParams): Promise<DeviceType>;
+    /**
+     * Get ImeiIccidCarriers from a list of imeis
+     * @param  {GetImeiIccidCarriersParams} params containing information to get the ImeiIccidCarriers
+     * - filters.imeis: The imeis of the devices
+     * @returns {Promise<ImeiIccidCarrier[]>} The imei iccid carriers
+     */
+    getImeiIccidCarriers(params: GetImeiIccidCarriersParams): Promise<ImeiIccidCarrier[]>;
+    /**
+     * Update the ImeiIccidCarrier
+     * @param  {UpdateImeiIccidCarrierParams} params containing information to update the ImeiIccidCarrier
+     * - filters.imei: The imei of the device to update
+     * - filters.iccid: The iccid of the device to update
+     * - values.carrierId: The carrier id
+     * - values.phone: The phone or MSISDN of the device
+     * - values.deviceTypeId: The device type id
+     * - values.serviceProviderProductId: The service provider product id
+     * - values.isValid: Whether the imei iccid carrier is valid
+     * - values.realModel: The real model of the device
+     * - values.po: The purchase order number of the device
+     * - values.outOfInventory: Whether the device is out of inventory
+     * - values.apn: The apn of the device
+     *
+     * @returns {Promise<boolean>} Whether the imei iccid carrier was updated
+     */
+    updateImeiIccidCarrier(params: UpdateImeiIccidCarrierParams): Promise<boolean>;
+    /**
+     * Get a ClientDeviceSetting
+     * @param  {GetClientDeviceSettingParams} params containing information to get a ClientDeviceSetting
+     * - filters.imei: The imei of the device
+     * - filters.clientId: The client id
+     * @returns {Promise<ClientDeviceSetting>} The ClientDeviceSetting
+     */
+    getClientDeviceSetting(params: GetClientDeviceSettingParams): Promise<ClientDeviceSetting>;
+    /**
+     * Get a list of ClientDeviceSettings with filters
+     * @param  {GetClientDeviceSettingsParams} params containing information to get ClientDeviceSettings
+     * - filters.clientId: The client id
+     * @returns {Promise<ClientDeviceSetting[]>} An array of ClientDeviceSettings matching the filters
+     */
+    getClientDeviceSettings(params: GetClientDeviceSettingsParams): Promise<ClientDeviceSetting[]>;
+    /**
+     * Create a ClientDeviceSetting
+     * @param  {CreateClientDeviceSettingParams} params containing information to create a ClientDeviceSetting
+     * - values.imei: The imei of the device
+     * - values.clientId: The client id
+     * - values.generateTrips: Whether to generate trips
+     * - values.movingPingFrequency: The moving ping frequency
+     * - values.stoppedPingFrequency: The stopped ping frequency
+     * - values.fixedStatus: The fixed status
+     * - values.stopThresholdMinutes: The threshold in minutes to consider that the device is stopped
+     * - values.offlineThresholdMinutes: The threshold in minutes to consider that the device is offline
+     * - values.movementThresholdSpeed: The threshold for the speed to consider that the device is moving
+     * - values.externalBatteryInformation: The external battery information
+     * @returns {Promise<ClientDeviceSetting>} The created ClientDeviceSetting
+     */
+    createClientDeviceSetting(params: CreateClientDeviceSettingParams): Promise<ClientDeviceSetting>;
+    /**
+     * Update a ClientDeviceSetting
+     * @param  {UpdateClientDeviceSettingParams} params containing information to update a ClientDeviceSetting
+     * - filters.imei: The imei of the device
+     * - filters.clientId: The client id
+     * - values.generateTrips: Whether to generate trips
+     * - values.movingPingFrequency: The moving ping frequency
+     * - values.stoppedPingFrequency: The stopped ping frequency
+     * - values.fixedStatus: The fixed status
+     * - values.stopThresholdMinutes: The threshold in minutes to consider that the device is stopped
+     * - values.offlineThresholdMinutes: The threshold in minutes to consider that the device is offline
+     * - values.movementThresholdSpeed: The threshold for the speed to consider that the device is moving
+     * - values.externalBatteryInformation: The external battery information
+     * @returns {Promise<boolean>} Whether the ClientDeviceSetting was updated
+     */
+    updateClientDeviceSetting(params: UpdateClientDeviceSettingParams): Promise<boolean>;
+    /**
+     * Get a list of DeviceTypeModel with the count of associated devices, ordered by device count
+     * @param  {GetDeviceTypesModelsOrderedByDeviceCountParams} params containing information to get DeviceTypeModelWithDeviceCount
+     * - filters.deviceStatus: The device status to filter by, optional. If not provided, all devices will be counted
+     */
+    getDeviceTypesModelsOrderedByDeviceCount(params: GetDeviceTypesModelsOrderedByDeviceCountParams): Promise<DeviceTypeModelWithDeviceCount[]>;
+    /**
+     * Get the device custom configuration
+     * @param {GetDeviceCustomConfigParams} params containing information to get the device custom configuration
+     *  - filters.clientId: The client id
+     *  - filters.imei: The imei of the device
+     *  - filters.po: The purchase order number of the device
+     * @returns The device custom configurations if found, empty array otherwise
+     */
+    getDeviceCustomConfigs(params: GetDeviceCustomConfigParams): Promise<DeviceCustomConfiguration[]>;
+    /**
+     * Upsert device custom configurations for activation
+     * @param {UpsertDeviceCustomConfigParams[]} params containing information to upsert device custom configurations
+     * - id: The id of the device custom configuration, optional
+     * - clientId: The client id. Required
+     * - deviceTypeId: The device type id. Required
+     * - imei: The imei of the device. Optional
+     * - po: The purchase order number of the device. Optional
+     * - configFileUrl: The url of the configuration file. Optional
+     * - skipActivationDefaults: Whether to skip activation defaults. Optional
+     * @returns Whether the device custom configurations were upserted or not
+     */
+    upsertDeviceCustomConfigs(params: UpsertDeviceCustomConfigParams[]): Promise<boolean>;
+    /**
+     * Create a device replacement
+     * @param  {CreateDeviceReplacementParams} params containing information to create a device replacement
+     * - id: The id of the device replacement, optional
+     * - imeiOld: The old imei of the device, required
+     * - imeiNew: The new imei of the device, required
+     * - iccidOld: The old iccid of the device, required
+     * - iccidNew: The new iccid of the device, required
+     * - userId: The user id, required
+     * - clientId: The client id, required
+     * @returns {Promise<DeviceReplacement>} The created device replacement
+     */
+    createDeviceReplacement(params: CreateDeviceReplacementParams): Promise<DeviceReplacement>;
+    /**
+     * Get the iccid status for a given iccid
+     * @param  {GetIccidStatusParams} params containing information to get the iccid status
+     * - filters.iccid: The iccid of the device
+     * @returns The iccid status
+     */
+    getIccidStatus(params: GetIccidStatusParams): Promise<IccidStatus>;
+    /**
+     * Update the iccid status for a given iccid
+     * @param  {UpdateIccidStatusParams} params containing information to update the iccid status
+     * - filters.iccid: The iccid of the device
+     * - values.status: The status of the iccid
+     * - values.processing: Whether the iccid is processing
+     * - values.carrierFound: Whether the carrier was found
+     * @returns Whether the iccid status was updated
+     */
+    updateIccidStatus(params: UpdateIccidStatusParams): Promise<boolean>;
+    /**
+     * Get the canceled devices with active sim cards
+     * @param  {GetCanceledDevicesWithActiveSimCardsParams} params containing information to get the canceled devices with active sim cards
+     * - filters.lastAnalyzedDeviceId: The last analyzed device id
+     * - pagingOptions.limit: The amount of devices to get
+     * @returns The canceled devices with active sim cards
+     */
+    getCanceledDevicesWithActiveSimCards(params: GetCanceledDevicesWithActiveSimCardsParams): Promise<CanceledDeviceWithActiveSimCard[]>;
+    /**
+     * Get the carrier status for all devices updated before a given date
+     * @param  {GetCarrierStatusUpdatedBeforeParams} params containing information to get the carrier status
+     * - filters.beforeDate: The date to compare
+     * - pagingOptions.limit: The amount of devices to get
+     * @returns The carrier status for devices updated before a given date
+     */
+    getCarrierStatusUpdatedBefore(params: GetCarrierStatusUpdatedBeforeParams): Promise<CarrierStatus[]>;
+    /**
+     * Upsert the iccid status for a given iccid
+     * @param  {UpsertIccidStatusParams} params containing information to upsert the iccid status
+     * - iccid: The iccid of the device
+     * - status: The status of the iccid
+     * - carrierFound: The carrier found
+     * @returns Whether the iccid status was upserted
+     */
+    upsertIccidStatus(params: UpsertIccidStatusParams): Promise<boolean>;
+    /**
+     * Get device with users info
+     * @param  {GetDeviceWithUsersInfoParams} params containing information to get device with users info
+     * - filters.imei: The imei of the device
+     * @returns The device with users info
+     */
+    getDeviceWithUsersInfo(params: GetDeviceWithUsersInfoParams): Promise<DeviceWithUsersInfo[]>;
+    /**
+     * Create a device type
+     * @param  {CreateDeviceTypeParams} params containing information to create a device type
+     * @returns {Promise<DeviceType>} The created device type
+     */
+    createDeviceType(params: CreateDeviceTypeParams): Promise<DeviceType>;
+    /**
+     * Update a device type
+     * @param  {UpdateDeviceTypeParams} params containing information to update a device type
+     * - filters.id: The id of the device type
+     * - values: The values to update. At least one field is required
+     * @returns {Promise<boolean>} Whether the device type was updated
+     */
+    updateDeviceType(params: UpdateDeviceTypeParams): Promise<boolean>;
+    /**
+     * Get the count of devices by status
+     * @param  {GetDevicesCountByStatusParams} params containing information to get the count of devices by status
+     * - filters.clientId: The client id
+     * @returns {Promise<DevicesCountByStatus>} The count of devices by statuses
+     */
+    getDevicesCountByStatus(params: GetDevicesCountByStatusParams): Promise<DevicesCountByStatus[]>;
+    /**
+     * Get a service provider product
+     * @param  {GetServiceProviderProductParams} params containing information to get a service provider product
+     * - filters.id: The id of the service provider product
+     * @returns {Promise<ServiceProviderProduct>} The service provider product
+     */
+    getServiceProviderProduct(params: GetServiceProviderProductParams): Promise<ServiceProviderProduct>;
+    createImeiIccidCarrier(params: CreateImeiIccidCarrierParams): Promise<ImeiIccidCarrier | null>;
+    /**
+     * Get the unique assigned to values from the device changes history by client
+     * @param params containing information to get the unique assigned to values from the device changes history by client
+     * @returns The unique assigned to values from the device changes history by client
+     */
+    getDeviceChangesHistoryAssignedToValuesByClient(params: GetDeviceChangesHistoryAssignedToValuesByClientParams): Promise<string[]>;
+    /**
+     * Get the device changes history
+     * @param params containing information to get the device changes history
+     * @returns The device changes history
+     */
+    getDeviceChangesHistory(params: GetDeviceChangesHistoryParams): Promise<DeviceChangesHistory[]>;
+    /**
+     * Will add a new record to the device changes history table and update the endDate of the previous record if it exists
+     * @param params containing information to add a new record to the device changes history table
+     * @returns The new device changes history
+     */
+    addDeviceChangesHistory(params: AddDeviceChangesHistoryParams): Promise<DeviceChangesHistory>;
+}