@spytecgps/nova-orm 1.2.15-rc8 → 1.2.16

package/dist/types/devices.d.ts

@@ -1,407 +1,408 @@
-import { BaseSelectQueryParams, OptionalReportPagination } from './common';
-import { DeviceStatus } from './enums';
-export interface GetDeviceParams extends BaseSelectQueryParams {
-    filters: {
-        id?: number;
-        imei?: string;
-    };
-    projectionOptions?: {
-        withDeviceType?: boolean;
-        withIccidCarrier?: boolean;
-        withClientDeviceSettings?: boolean;
-    };
-}
-export interface GetDevicesParams extends OptionalReportPagination {
-    filters: {
-        deviceTypeId?: number;
-        status?: DeviceStatus;
-        clientId?: number;
-        imeiList?: string[];
-        tagIdList?: number[];
-    };
-    projectionOptions?: {
-        withDeviceType?: boolean;
-        withIccidCarrier?: boolean;
-        withClientDeviceSettings?: boolean;
-        withSecurityGroupTag?: boolean;
-    };
-    sortOptions?: {
-        sortField?: 'name';
-        sortOrder?: 'ASC' | 'DESC';
-    };
-}
-export interface AllImeisAreActiveForClientParams extends BaseSelectQueryParams {
-    imeiList: string[];
-    clientId: number;
-}
-export interface GetFilteredImeisWithStatusParams extends BaseSelectQueryParams {
-    filters: {
-        imeiList: string[];
-        status: DeviceStatus;
-    };
-}
-export interface GetDeviceTypeByImeiParams extends BaseSelectQueryParams {
-    filters: {
-        imei: string;
-    };
-}
-export interface CreateDeviceParams {
-    id?: number;
-    imei: string;
-    clientId: number;
-    deviceTypeId: number;
-    identifier?: string;
-    iccid?: string;
-    name?: string;
-    color?: string;
-    icon?: string;
-    status?: string;
-    forward?: boolean;
-    description?: string;
-    dataSourceTypeId?: number;
-    assetCategoryId?: number;
-    usageRegion?: string;
-    createdBy?: string;
-    btmac?: string;
-    serialNumber?: string;
-    assignedTo?: string;
-}
-export declare const oneRequiredUpdateDeviceParamsValue: string[];
-export interface UpdateDeviceParams {
-    filters: {
-        imei: string;
-        status?: DeviceStatus;
-        clientId?: number;
-    };
-    values: {
-        clientId?: number;
-        deviceTypeId?: number;
-        iccid?: string;
-        name?: string;
-        color?: string;
-        icon?: string;
-        status?: DeviceStatus;
-        forward?: boolean;
-        description?: string;
-        dataSourceTypeId?: number;
-        assetCategoryId?: number;
-        usageRegion?: string;
-        modifiedBy?: string;
-        btmac?: string;
-        assignedTo?: string;
-    };
-}
-export interface DeleteDeviceParams {
-    filters: {
-        imei: string;
-    };
-}
-export interface GenerateIdentifierKeyParams {
-    deviceTypeId: number;
-    deviceIdentifier: string;
-}
-export interface GetDeviceTypesParams extends BaseSelectQueryParams {
-    filters: {
-        deviceTypeIdList?: number[];
-        brand?: string;
-        model?: string;
-        onlyWithRelatedIccidCarrier?: boolean;
-        modelFamily?: string;
-        supported?: boolean;
-        activatable?: boolean;
-    };
-}
-export interface GetImeiIccidCarrierParams extends BaseSelectQueryParams {
-    filters: {
-        imei?: string;
-        iccid?: string;
-    };
-}
-export interface GetImeiIccidCarriersParams extends BaseSelectQueryParams {
-    filters: {
-        imeiList: string[];
-    };
-}
-export declare const requiredImeiIccidCarrierFields: string[];
-export interface CreateImeiIccidCarrierParams {
-    imei: string;
-    iccid: string;
-    deviceTypeId: number;
-    serviceProviderProductId: number;
-    carrier: number;
-    createdAt?: Date;
-    isValid?: boolean;
-    outOfInventory?: boolean;
-    phone?: string;
-    model?: string;
-    realModel?: string;
-    po?: string;
-    apn?: string;
-    itsEsim?: boolean;
-    btmac?: string;
-}
-export interface UpdateImeiIccidCarrierParams {
-    filters: {
-        imei?: string;
-        iccid?: string;
-    };
-    values: {
-        carrier?: number;
-        phone?: string;
-        deviceTypeId?: number;
-        serviceProviderProductId?: number;
-        isValid?: boolean;
-        model?: string;
-        realModel?: string;
-        po?: string;
-        outOfInventory?: boolean;
-        apn?: string;
-        itsEsim?: boolean;
-        btmac?: string;
-    };
-}
-export interface GetClientDeviceSettingParams extends BaseSelectQueryParams {
-    filters: {
-        imei: string;
-        clientId: number;
-    };
-}
-export interface GetClientDeviceSettingsParams extends BaseSelectQueryParams {
-    filters: {
-        clientId: number;
-    };
-}
-export interface CreateClientDeviceSettingParams {
-    id?: number;
-    imei: string;
-    clientId: number;
-    generateTrips?: boolean;
-    movingPingFrequency?: number;
-    stoppedPingFrequency?: number;
-    fixedStatus?: string;
-    stopThresholdMinutes?: number;
-    offlineThresholdMinutes?: number;
-    movementThresholdSpeed?: number;
-    externalBatteryInformation?: boolean;
-    reportingMode?: string;
-}
-export interface UpdateClientDeviceSettingParams {
-    filters: {
-        imei: string;
-        clientId: number;
-    };
-    values: {
-        generateTrips?: boolean;
-        movingPingFrequency?: number;
-        stoppedPingFrequency?: number;
-        fixedStatus?: string;
-        stopThresholdMinutes?: number;
-        offlineThresholdMinutes?: number;
-        movementThresholdSpeed?: number;
-        externalBatteryInformation?: boolean;
-        reportingMode?: string;
-    };
-}
-export interface GetDeviceTypesModelsOrderedByDeviceCountParams extends BaseSelectQueryParams {
-    filters: {
-        deviceStatus?: DeviceStatus;
-    };
-}
-export interface DeviceTypeModelWithDeviceCount {
-    id: number;
-    model: string;
-    protocol: string;
-    protocolMatch: string;
-    deviceCount: number;
-}
-export interface GetDeviceCustomConfigParams extends BaseSelectQueryParams {
-    filters: {
-        clientId?: number;
-        deviceTypeId?: number;
-        imei?: string;
-        po?: string;
-    };
-}
-export interface UpsertDeviceCustomConfigParams {
-    id?: number;
-    clientId?: number;
-    deviceTypeId?: number;
-    imei?: string;
-    po?: string;
-    configFileUrl?: string;
-    skipActivationDefaults?: boolean;
-}
-export interface CreateDeviceReplacementParams {
-    id?: number;
-    imeiOld: string;
-    iccidOld: string;
-    imeiNew: string;
-    iccidNew: string;
-    userId: string;
-    clientId: number;
-}
-export interface GetIccidStatusParams extends BaseSelectQueryParams {
-    filters: {
-        iccid: string;
-    };
-}
-export interface UpdateIccidStatusParams {
-    filters: {
-        iccid: string;
-    };
-    values: {
-        status?: string;
-        processing?: boolean;
-        carrierFound?: number;
-    };
-}
-export interface GetCanceledDevicesWithActiveSimCardsParams extends BaseSelectQueryParams {
-    filters: {
-        lastAnalyzedDeviceId: number;
-    };
-    pagingOptions: {
-        limit: number;
-    };
-}
-export interface CanceledDeviceWithActiveSimCard {
-    imei: string;
-    iccid: string;
-    clientId: number;
-    carrier: string;
-    deviceId: number;
-}
-export interface GetCarrierStatusUpdatedBeforeParams extends BaseSelectQueryParams {
-    filters: {
-        beforeDate: Date;
-    };
-    pagingOptions: {
-        limit: number;
-    };
-}
-export interface CarrierStatus {
-    iccid: string;
-    status?: string;
-    processing?: boolean;
-    carrierFound?: number;
-    modifiedAt?: Date;
-    carrier?: number;
-}
-export interface UpsertIccidStatusParams {
-    values: {
-        iccid: string;
-        status?: string | null;
-        carrierFound?: number | null;
-    };
-    options?: {
-        updateProcessing: boolean;
-    };
-}
-export interface GetDeviceWithUsersInfoParams extends BaseSelectQueryParams {
-    filters: {
-        imei: string;
-    };
-}
-export interface DeviceWithUsersInfo {
-    clientName: string;
-    username: string;
-    email: string;
-    latestPositionCreatedAt: Date;
-    latestPositionActualDate: Date;
-    latestPositionLatitude: number;
-    latestPositionLongitude: number;
-    latestPositionOdometer: number;
-    latestPositionSpeed: number;
-    deviceStatus: DeviceStatus;
-    alertName: string;
-    alertValue: string;
-    smsNotification: boolean;
-    emailNotification: boolean;
-    servicePlan: string;
-    iccid: string;
-    deviceName: string;
-    roleName: string;
-    subscriptionId: string;
-}
-export interface CreateDeviceTypeParams {
-    id?: number;
-    brand: string;
-    model: string;
-    modelFamily: string;
-    identifierType: string;
-    description?: string;
-    tags?: string;
-    url?: string;
-    name?: string;
-    pictureUrl?: string;
-    userManualUrl?: string;
-    notes?: string;
-    supported?: boolean;
-    activatable?: boolean;
-    selfActivatable?: boolean;
-    port?: number;
-    protocolMatch?: string;
-    stage?: string;
-    landingPage?: string;
-    troubleshooting?: string;
-    protocol?: string;
-}
-export interface UpdateDeviceTypeParams {
-    filters: {
-        id: number;
-    };
-    values: {
-        brand: string;
-        model: string;
-        modelFamily: string;
-        identifierType: string;
-        description?: string;
-        tags?: string;
-        url?: string;
-        name?: string;
-        pictureUrl?: string;
-        userManualUrl?: string;
-        notes?: string;
-        supported?: boolean;
-        activatable?: boolean;
-        selfActivatable?: boolean;
-        port?: number;
-        protocolMatch?: string;
-        stage?: string;
-        landingPage?: string;
-        troubleshooting?: string;
-        protocol?: string;
-    };
-}
-export interface GetDevicesCountByStatusParams extends BaseSelectQueryParams {
-    filters: {
-        clientId: number;
-        tagIdList?: number[];
-    };
-}
-export interface DevicesCountByStatus {
-    status: DeviceStatus;
-    count: number;
-}
-export interface GetServiceProviderProductParams extends BaseSelectQueryParams {
-    filters: {
-        id: number;
-    };
-}
-export interface GetDeviceChangesHistoryParams extends BaseSelectQueryParams {
-    filters: {
-        clientId: number;
-        imeis?: string[];
-    };
-}
-export interface GetDeviceChangesHistoryAssignedToValuesByClientParams extends BaseSelectQueryParams {
-    filters: {
-        clientId: number;
-    };
-}
-export declare const requiredAddDeviceChangesHistoryParams: string[];
-export interface AddDeviceChangesHistoryParams {
-    clientId: number;
-    imei: string;
-    assignedTo: string;
-    action?: 'create' | 'update';
-}
+import { BaseSelectQueryParams, OptionalReportPagination } from './common';
+import { DeviceStatus } from './enums';
+export interface GetDeviceParams extends BaseSelectQueryParams {
+    filters: {
+        id?: number;
+        imei?: string;
+    };
+    projectionOptions?: {
+        withDeviceType?: boolean;
+        withIccidCarrier?: boolean;
+        withClientDeviceSettings?: boolean;
+    };
+}
+export interface GetDevicesParams extends OptionalReportPagination {
+    filters: {
+        deviceTypeId?: number;
+        status?: DeviceStatus;
+        clientId?: number;
+        imeiList?: string[];
+        tagIdList?: number[];
+    };
+    projectionOptions?: {
+        withDeviceType?: boolean;
+        withIccidCarrier?: boolean;
+        withClientDeviceSettings?: boolean;
+        withSecurityGroupTag?: boolean;
+        withDevicePairing?: boolean;
+    };
+    sortOptions?: {
+        sortField?: 'name';
+        sortOrder?: 'ASC' | 'DESC';
+    };
+}
+export interface AllImeisAreActiveForClientParams extends BaseSelectQueryParams {
+    imeiList: string[];
+    clientId: number;
+}
+export interface GetFilteredImeisWithStatusParams extends BaseSelectQueryParams {
+    filters: {
+        imeiList: string[];
+        status: DeviceStatus;
+    };
+}
+export interface GetDeviceTypeByImeiParams extends BaseSelectQueryParams {
+    filters: {
+        imei: string;
+    };
+}
+export interface CreateDeviceParams {
+    id?: number;
+    imei: string;
+    clientId: number;
+    deviceTypeId: number;
+    identifier?: string;
+    iccid?: string;
+    name?: string;
+    color?: string;
+    icon?: string;
+    status?: string;
+    forward?: boolean;
+    description?: string;
+    dataSourceTypeId?: number;
+    assetCategoryId?: number;
+    usageRegion?: string;
+    createdBy?: string;
+    btmac?: string;
+    serialNumber?: string;
+    assignedTo?: string;
+}
+export declare const oneRequiredUpdateDeviceParamsValue: string[];
+export interface UpdateDeviceParams {
+    filters: {
+        imei: string;
+        status?: DeviceStatus;
+        clientId?: number;
+    };
+    values: {
+        clientId?: number;
+        deviceTypeId?: number;
+        iccid?: string;
+        name?: string;
+        color?: string;
+        icon?: string;
+        status?: DeviceStatus;
+        forward?: boolean;
+        description?: string;
+        dataSourceTypeId?: number;
+        assetCategoryId?: number;
+        usageRegion?: string;
+        modifiedBy?: string;
+        btmac?: string;
+        assignedTo?: string;
+    };
+}
+export interface DeleteDeviceParams {
+    filters: {
+        imei: string;
+    };
+}
+export interface GenerateIdentifierKeyParams {
+    deviceTypeId: number;
+    deviceIdentifier: string;
+}
+export interface GetDeviceTypesParams extends BaseSelectQueryParams {
+    filters: {
+        deviceTypeIdList?: number[];
+        brand?: string;
+        model?: string;
+        onlyWithRelatedIccidCarrier?: boolean;
+        modelFamily?: string;
+        supported?: boolean;
+        activatable?: boolean;
+    };
+}
+export interface GetImeiIccidCarrierParams extends BaseSelectQueryParams {
+    filters: {
+        imei?: string;
+        iccid?: string;
+    };
+}
+export interface GetImeiIccidCarriersParams extends BaseSelectQueryParams {
+    filters: {
+        imeiList: string[];
+    };
+}
+export declare const requiredImeiIccidCarrierFields: string[];
+export interface CreateImeiIccidCarrierParams {
+    imei: string;
+    iccid: string;
+    deviceTypeId: number;
+    serviceProviderProductId: number;
+    carrier: number;
+    createdAt?: Date;
+    isValid?: boolean;
+    outOfInventory?: boolean;
+    phone?: string;
+    model?: string;
+    realModel?: string;
+    po?: string;
+    apn?: string;
+    itsEsim?: boolean;
+    btmac?: string;
+}
+export interface UpdateImeiIccidCarrierParams {
+    filters: {
+        imei?: string;
+        iccid?: string;
+    };
+    values: {
+        carrier?: number;
+        phone?: string;
+        deviceTypeId?: number;
+        serviceProviderProductId?: number;
+        isValid?: boolean;
+        model?: string;
+        realModel?: string;
+        po?: string;
+        outOfInventory?: boolean;
+        apn?: string;
+        itsEsim?: boolean;
+        btmac?: string;
+    };
+}
+export interface GetClientDeviceSettingParams extends BaseSelectQueryParams {
+    filters: {
+        imei: string;
+        clientId: number;
+    };
+}
+export interface GetClientDeviceSettingsParams extends BaseSelectQueryParams {
+    filters: {
+        clientId: number;
+    };
+}
+export interface CreateClientDeviceSettingParams {
+    id?: number;
+    imei: string;
+    clientId: number;
+    generateTrips?: boolean;
+    movingPingFrequency?: number;
+    stoppedPingFrequency?: number;
+    fixedStatus?: string;
+    stopThresholdMinutes?: number;
+    offlineThresholdMinutes?: number;
+    movementThresholdSpeed?: number;
+    externalBatteryInformation?: boolean;
+    reportingMode?: string;
+}
+export interface UpdateClientDeviceSettingParams {
+    filters: {
+        imei: string;
+        clientId: number;
+    };
+    values: {
+        generateTrips?: boolean;
+        movingPingFrequency?: number;
+        stoppedPingFrequency?: number;
+        fixedStatus?: string;
+        stopThresholdMinutes?: number;
+        offlineThresholdMinutes?: number;
+        movementThresholdSpeed?: number;
+        externalBatteryInformation?: boolean;
+        reportingMode?: string;
+    };
+}
+export interface GetDeviceTypesModelsOrderedByDeviceCountParams extends BaseSelectQueryParams {
+    filters: {
+        deviceStatus?: DeviceStatus;
+    };
+}
+export interface DeviceTypeModelWithDeviceCount {
+    id: number;
+    model: string;
+    protocol: string;
+    protocolMatch: string;
+    deviceCount: number;
+}
+export interface GetDeviceCustomConfigParams extends BaseSelectQueryParams {
+    filters: {
+        clientId?: number;
+        deviceTypeId?: number;
+        imei?: string;
+        po?: string;
+    };
+}
+export interface UpsertDeviceCustomConfigParams {
+    id?: number;
+    clientId?: number;
+    deviceTypeId?: number;
+    imei?: string;
+    po?: string;
+    configFileUrl?: string;
+    skipActivationDefaults?: boolean;
+}
+export interface CreateDeviceReplacementParams {
+    id?: number;
+    imeiOld: string;
+    iccidOld: string;
+    imeiNew: string;
+    iccidNew: string;
+    userId: string;
+    clientId: number;
+}
+export interface GetIccidStatusParams extends BaseSelectQueryParams {
+    filters: {
+        iccid: string;
+    };
+}
+export interface UpdateIccidStatusParams {
+    filters: {
+        iccid: string;
+    };
+    values: {
+        status?: string;
+        processing?: boolean;
+        carrierFound?: number;
+    };
+}
+export interface GetCanceledDevicesWithActiveSimCardsParams extends BaseSelectQueryParams {
+    filters: {
+        lastAnalyzedDeviceId: number;
+    };
+    pagingOptions: {
+        limit: number;
+    };
+}
+export interface CanceledDeviceWithActiveSimCard {
+    imei: string;
+    iccid: string;
+    clientId: number;
+    carrier: string;
+    deviceId: number;
+}
+export interface GetCarrierStatusUpdatedBeforeParams extends BaseSelectQueryParams {
+    filters: {
+        beforeDate: Date;
+    };
+    pagingOptions: {
+        limit: number;
+    };
+}
+export interface CarrierStatus {
+    iccid: string;
+    status?: string;
+    processing?: boolean;
+    carrierFound?: number;
+    modifiedAt?: Date;
+    carrier?: number;
+}
+export interface UpsertIccidStatusParams {
+    values: {
+        iccid: string;
+        status?: string | null;
+        carrierFound?: number | null;
+    };
+    options?: {
+        updateProcessing: boolean;
+    };
+}
+export interface GetDeviceWithUsersInfoParams extends BaseSelectQueryParams {
+    filters: {
+        imei: string;
+    };
+}
+export interface DeviceWithUsersInfo {
+    clientName: string;
+    username: string;
+    email: string;
+    latestPositionCreatedAt: Date;
+    latestPositionActualDate: Date;
+    latestPositionLatitude: number;
+    latestPositionLongitude: number;
+    latestPositionOdometer: number;
+    latestPositionSpeed: number;
+    deviceStatus: DeviceStatus;
+    alertName: string;
+    alertValue: string;
+    smsNotification: boolean;
+    emailNotification: boolean;
+    servicePlan: string;
+    iccid: string;
+    deviceName: string;
+    roleName: string;
+    subscriptionId: string;
+}
+export interface CreateDeviceTypeParams {
+    id?: number;
+    brand: string;
+    model: string;
+    modelFamily: string;
+    identifierType: string;
+    description?: string;
+    tags?: string;
+    url?: string;
+    name?: string;
+    pictureUrl?: string;
+    userManualUrl?: string;
+    notes?: string;
+    supported?: boolean;
+    activatable?: boolean;
+    selfActivatable?: boolean;
+    port?: number;
+    protocolMatch?: string;
+    stage?: string;
+    landingPage?: string;
+    troubleshooting?: string;
+    protocol?: string;
+}
+export interface UpdateDeviceTypeParams {
+    filters: {
+        id: number;
+    };
+    values: {
+        brand: string;
+        model: string;
+        modelFamily: string;
+        identifierType: string;
+        description?: string;
+        tags?: string;
+        url?: string;
+        name?: string;
+        pictureUrl?: string;
+        userManualUrl?: string;
+        notes?: string;
+        supported?: boolean;
+        activatable?: boolean;
+        selfActivatable?: boolean;
+        port?: number;
+        protocolMatch?: string;
+        stage?: string;
+        landingPage?: string;
+        troubleshooting?: string;
+        protocol?: string;
+    };
+}
+export interface GetDevicesCountByStatusParams extends BaseSelectQueryParams {
+    filters: {
+        clientId: number;
+        tagIdList?: number[];
+    };
+}
+export interface DevicesCountByStatus {
+    status: DeviceStatus;
+    count: number;
+}
+export interface GetServiceProviderProductParams extends BaseSelectQueryParams {
+    filters: {
+        id: number;
+    };
+}
+export interface GetDeviceChangesHistoryParams extends BaseSelectQueryParams {
+    filters: {
+        clientId: number;
+        imeis?: string[];
+    };
+}
+export interface GetDeviceChangesHistoryAssignedToValuesByClientParams extends BaseSelectQueryParams {
+    filters: {
+        clientId: number;
+    };
+}
+export declare const requiredAddDeviceChangesHistoryParams: string[];
+export interface AddDeviceChangesHistoryParams {
+    clientId: number;
+    imei: string;
+    assignedTo: string;
+    action?: 'create' | 'update';
+}