@spytecgps/nova-orm 0.0.58 → 0.0.60

package/dist/repositories/deviceBehaviors/createDeviceBehaviorTask.d.ts

@@ -0,0 +1,5 @@
+import { UserDeviceBehaviorTask } from '../../entities';
+import { NovaDataSource } from '../../novaDataSource';
+import { CreateDeviceBehaviorTaskParams } from '../../types/deviceBehaviors';
+import { Logger } from '../../types/logger';
+export declare const createDeviceBehaviorTask: (novaDataSource: NovaDataSource, params: CreateDeviceBehaviorTaskParams, logger: Logger) => Promise<UserDeviceBehaviorTask>;

package/dist/repositories/deviceBehaviors/getDeviceBehaviorTasks.d.ts

@@ -0,0 +1,5 @@
+import { UserDeviceBehaviorTask } from '../../entities';
+import { NovaDataSource } from '../../novaDataSource';
+import { GetDeviceBehaviorTasksParams } from '../../types/deviceBehaviors';
+import { Logger } from '../../types/logger';
+export declare const getDeviceBehaviorTasks: (novaDataSource: NovaDataSource, params: GetDeviceBehaviorTasksParams, logger: Logger) => Promise<UserDeviceBehaviorTask[]>;

package/dist/repositories/deviceBehaviors/getDeviceBehaviors.d.ts

@@ -0,0 +1,5 @@
+import { DeviceBehavior } from '../../entities';
+import { NovaDataSource } from '../../novaDataSource';
+import { GetDeviceBehaviorsParams } from '../../types/deviceBehaviors';
+import { Logger } from '../../types/logger';
+export declare const getDeviceBehaviors: (novaDataSource: NovaDataSource, params: GetDeviceBehaviorsParams, logger: Logger) => Promise<DeviceBehavior[]>;

package/dist/repositories/deviceBehaviors/getDeviceBehaviorsByIds.d.ts

@@ -0,0 +1,5 @@
+import { DeviceBehavior } from '../../entities';
+import { NovaDataSource } from '../../novaDataSource';
+import { GetDeviceBehaviorsByIdsParams } from '../../types/deviceBehaviors';
+import { Logger } from '../../types/logger';
+export declare const getDeviceBehaviorsByIds: (novaDataSource: NovaDataSource, params: GetDeviceBehaviorsByIdsParams, logger: Logger) => Promise<DeviceBehavior[]>;

package/dist/repositories/deviceBehaviors/getLatestDeviceBehaviorTasks.d.ts

@@ -0,0 +1,4 @@
+import { NovaDataSource } from '../../novaDataSource';
+import { GetLatestDeviceBehaviorTasksParams, GetLatestDeviceBehaviorTasksResult } from '../../types/deviceBehaviors';
+import { Logger } from '../../types/logger';
+export declare const getLatestDeviceBehaviorTasks: (novaDataSource: NovaDataSource, params: GetLatestDeviceBehaviorTasksParams, logger: Logger) => Promise<GetLatestDeviceBehaviorTasksResult[]>;

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

@@ -0,0 +1,72 @@
+import { DeviceBehavior, UserDeviceBehaviorTask } from '../../entities';
+import { CreateDeviceBehaviorTaskParams, GetDeviceBehaviorsByIdsParams, GetDeviceBehaviorsParams, GetDeviceBehaviorTasksParams, GetLatestDeviceBehaviorTasksParams, GetLatestDeviceBehaviorTasksResult, UpdateDeviceBehaviorTaskParams } from '../../types/deviceBehaviors';
+import { BaseRepository } from '../baseRepository';
+export declare class DeviceBehaviorsRepository extends BaseRepository {
+    /**
+     * Get user rating requests
+     * @param {GetDeviceBehaviorsParams} params containing information to get device behaviors
+     * - filters.status: The status
+     * - filters.imeiList: The imei list
+     * - filters.deviceTypeIdList: The device type id list
+     * - filters.stage: The stage
+     * - filters.clientId: The client id, optional
+     * - filters.type: The type, optional
+     * @returns The device behaviors list
+     */
+    getDeviceBehaviors(params: GetDeviceBehaviorsParams): Promise<DeviceBehavior[]>;
+    /**
+     * Get device behaviors by ids
+     * @params  {GetDeviceBehaviorsByIdsParams} params containing information to get device behaviors by ids
+     * - filters.deviceBehaviorIdList: The device behavior id list, required
+     * @returns The device behaviors list
+     */
+    getDeviceBehaviorsByIds(params: GetDeviceBehaviorsByIdsParams): Promise<DeviceBehavior[]>;
+    /**
+     * Get device behavior tasks
+     * @param {GetDeviceBehaviorTasksParams} params containing information to get device behavior tasks
+     * Filters (One of taskId or imeiList is required):
+     * - filters.taskId: The task id
+     * - filters.imeiList: The imei list
+     * - filters.status: The status, optional
+     * - filters.deviceBehaviorIdList: The device behavior id list, optional
+     * Paging options:
+     * - pagingOptions.offset: The offset, optional. Default is 0
+     * - pagingOptions.limit: The limit, optional. Default is 100
+     * @returns The device behavior tasks list
+     */
+    getDeviceBehaviorTasks(params: GetDeviceBehaviorTasksParams): Promise<UserDeviceBehaviorTask[]>;
+    /**
+     * Create device behavior task
+     * @param {CreateDeviceBehaviorTaskParams} params containing information to create a device behavior task
+     * - params.taskId: The task id
+     * - params.deviceBehaviorId: The device behavior id
+     * - params.clientId: The client id
+     * - params.userId: The user id
+     * - params.imei: The imei
+     * - params.behaviorName: The behavior name
+     * - params.behaviorParams: The behavior params, optional
+     * - params.status: The status
+     * - params.extraParams: The extra params, optional
+     * @returns The device behavior task
+     */
+    createDeviceBehaviorTask(params: CreateDeviceBehaviorTaskParams): Promise<UserDeviceBehaviorTask>;
+    /**
+     * Update device behavior task
+     * @param {UpdateDeviceBehaviorTaskParams} params containing information to update a device behavior task
+     * Filters:
+     * - params.filters.taskId: The task id
+     * Values:
+     * - params.values.status: The status
+     * @returns Whether the device behavior task was updated
+     */
+    updateDeviceBehaviorTask(params: UpdateDeviceBehaviorTaskParams): Promise<boolean>;
+    /**
+     * Get latest device behavior tasks
+     * @param {GetLatestDeviceBehaviorTasksParams} params containing information to get latest device behavior tasks
+     * - params.filters.clientId: The client id
+     * - params.filters.type: The device behavior type
+     * - params.filters.status: The task status
+     * @returns The latest device behavior tasks list
+     */
+    getLatestDeviceBehaviorTasks(params: GetLatestDeviceBehaviorTasksParams): Promise<GetLatestDeviceBehaviorTasksResult[]>;
+}

package/dist/repositories/deviceBehaviors/updateDeviceBehaviorTask.d.ts

@@ -0,0 +1,4 @@
+import { NovaDataSource } from '../../novaDataSource';
+import { UpdateDeviceBehaviorTaskParams } from '../../types/deviceBehaviors';
+import { Logger } from '../../types/logger';
+export declare const updateDeviceBehaviorTask: (novaDataSource: NovaDataSource, params: UpdateDeviceBehaviorTaskParams, logger: Logger) => Promise<boolean>;

package/dist/repositories/index.d.ts

@@ -2,12 +2,14 @@ import { AlertRepository } from './alerts';
 import { BoundariesRepository } from './boundaries';
 import { ClientsRepository } from './clients';
 import { CountriesRepository } from './countries';
+import { DeviceBehaviorsRepository } from './deviceBehaviors';
 import { DevicesRepository } from './devices';
 import { FirmwaresRepository } from './firmwares';
 import { PositionRepository } from './positions';
 import { SecurityRepository } from './security';
+import { UserConfigurationsRepository } from './userConfigurations';
 import { UserDataDeletionRequestsRepository } from './userDataDeletionRequests';
 import { UserInvitationsRepository } from './userInvitations';
 import { UserRatingRequestsRepository } from './userRatingRequests';
 import { UsersRepository } from './users';
-export { SecurityRepository, DevicesRepository, BoundariesRepository, ClientsRepository, FirmwaresRepository, PositionRepository, AlertRepository, UsersRepository, CountriesRepository, UserInvitationsRepository, UserDataDeletionRequestsRepository, UserRatingRequestsRepository, };
+export { AlertRepository, BoundariesRepository, ClientsRepository, CountriesRepository, DeviceBehaviorsRepository, DevicesRepository, FirmwaresRepository, PositionRepository, SecurityRepository, UserConfigurationsRepository, UserDataDeletionRequestsRepository, UserInvitationsRepository, UserRatingRequestsRepository, UsersRepository, };

package/dist/repositories/userConfigurations/bulkCreateUserAlertConfigurations.d.ts

@@ -0,0 +1,4 @@
+import { NovaDataSource } from '../../novaDataSource';
+import { Logger } from '../../types/logger';
+import { BulkCreateUserAlertConfigurationsParams } from '../../types/userConfigurations';
+export declare const bulkCreateUserAlertConfigurations: (novaDataSource: NovaDataSource, params: BulkCreateUserAlertConfigurationsParams, logger: Logger) => Promise<boolean>;

package/dist/repositories/userConfigurations/createUserConfiguration.d.ts

@@ -0,0 +1,5 @@
+import { UserConfiguration } from '../../entities/userConfiguration';
+import { NovaDataSource } from '../../novaDataSource';
+import { Logger } from '../../types/logger';
+import { CreateUserConfigurationParams } from '../../types/userConfigurations';
+export declare const createUserConfiguration: (novaDataSource: NovaDataSource, params: CreateUserConfigurationParams, logger: Logger) => Promise<UserConfiguration>;

package/dist/repositories/userConfigurations/deleteUserAlertConfigurations.d.ts

@@ -0,0 +1,4 @@
+import { NovaDataSource } from '../../novaDataSource';
+import { Logger } from '../../types/logger';
+import { DeleteUserAlertConfigurationsParams } from '../../types/userConfigurations';
+export declare const deleteUserAlertConfigurations: (novaDataSource: NovaDataSource, params: DeleteUserAlertConfigurationsParams, logger: Logger) => Promise<boolean>;

package/dist/repositories/userConfigurations/deleteUserConfiguration.d.ts

@@ -0,0 +1,4 @@
+import { NovaDataSource } from '../../novaDataSource';
+import { Logger } from '../../types/logger';
+import { DeleteUserConfigurationParams } from '../../types/userConfigurations';
+export declare const deleteUserConfiguration: (novaDataSource: NovaDataSource, params: DeleteUserConfigurationParams, logger: Logger) => Promise<boolean>;

package/dist/repositories/userConfigurations/getUserAlertConfigurations.d.ts

@@ -0,0 +1,5 @@
+import { UserAlertConfiguration } from '../../entities';
+import { NovaDataSource } from '../../novaDataSource';
+import { Logger } from '../../types/logger';
+import { GetUserAlertConfigurationsParams } from '../../types/userConfigurations';
+export declare const getUserAlertConfigurations: (novaDataSource: NovaDataSource, params: GetUserAlertConfigurationsParams, logger: Logger) => Promise<UserAlertConfiguration[]>;

package/dist/repositories/userConfigurations/getUserConfigurations.d.ts

@@ -0,0 +1,5 @@
+import { UserConfiguration } from '../../entities';
+import { NovaDataSource } from '../../novaDataSource';
+import { Logger } from '../../types/logger';
+import { GetUserConfigurationsParams } from '../../types/userConfigurations';
+export declare const getUserConfigurations: (novaDataSource: NovaDataSource, params: GetUserConfigurationsParams, logger: Logger) => Promise<UserConfiguration[]>;

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

@@ -0,0 +1,104 @@
+import { UserAlertConfiguration, UserConfiguration } from '../../entities';
+import { BulkCreateUserAlertConfigurationsParams, CreateUserConfigurationParams, DeleteUserAlertConfigurationsParams, DeleteUserConfigurationParams, GetUserAlertConfigurationsParams, GetUserConfigurationsParams, UpdateUserAlertConfigurationsParams, UpdateUserConfigurationParams } from '../../types/userConfigurations';
+import { BaseRepository } from '../baseRepository';
+export declare class UserConfigurationsRepository extends BaseRepository {
+    /**
+     * Get user configurations
+     * @param {GetUserConfigurationsParams} params containing information to get user configurations
+     * - filters.clientId: The client id to obtain all user configurations from that client
+     * - filters.userId: The user id to obtain all user configurations from that user
+     * @returns The user configurations
+     */
+    getUserConfigurations(params: GetUserConfigurationsParams): Promise<UserConfiguration[]>;
+    /**
+     * Create user configuration
+     * @param {CreateUserConfigurationParams} params containing information to create a user configuration
+     * - id: The user configuration id, optional. If not provided, it will be generated
+     * - userId: The user id, required
+     * - isMetric: Whether is metric, required
+     * - timezone: The user timezone, optional
+     * - defaultMapLayer: The user default map layer, optional
+     * - speedUnits: The user speed units, optional
+     * - distanceUnits: The user distance units, optional
+     * - alertsNotificationsOn: The user alerts notifications on, optional. If not provided, it will be true
+     * - dataSourceTypeId: The user data source type id, optional
+     * - homepage: The user homepage, optional
+     * - temperatureUnits: The user temperature units, optional
+     * @returns The created user configuration
+     */
+    createUserConfiguration(params: CreateUserConfigurationParams): Promise<UserConfiguration>;
+    /**
+     * Update user configuration
+     * @param {UpdateUserConfigurationParams} params containing information to update a user configuration
+     * Filters:
+     * - filters.userId: The user id to update the user configuration, required
+     * Values:
+     * One of the following values is required
+     * - values.timezone: The user timezone, optional
+     * - values.defaultMapLayer: The user default map layer, optional
+     * - values.speedUnits: The user speed units, optional
+     * - values.distanceUnits: The user distance units, optional
+     * - values.alertsNotificationsOn: The user alerts notifications on, optional
+     * - values.dataSourceTypeId: The user data source type id, optional
+     * - values.homepage: The user homepage, optional
+     * - values.temperatureUnits: The user temperature units, optional
+     * @returns Whether the user configuration was updated
+     */
+    updateUserConfiguration(params: UpdateUserConfigurationParams): Promise<boolean>;
+    /**
+     * Delete user configuration
+     * @param {DeleteUserConfigurationParams} params containing information to delete a user configuration
+     * - filters.userId: The user id to delete the user configuration, required
+     * @returns Whether the user configuration was deleted
+     */
+    deleteUserConfiguration(params: DeleteUserConfigurationParams): Promise<boolean>;
+    /**
+     * Get user alert configurations
+     * @param {GetUserAlertConfigurationsParams} params containing information to get user alert configurations
+     * - filters.userId: The user id to obtain all user alert configurations from that user, required
+     * - filters.includeBeta: Whether to include beta alert types, required
+     * @returns The user alert configurations
+     */
+    getUserAlertConfigurations(params: GetUserAlertConfigurationsParams): Promise<UserAlertConfiguration[]>;
+    /**
+     * Bulk create user alert configurations
+     * @param {BulkCreateUserAlertConfigurationsParams} params containing information to bulk create user alert configurations
+     * - alertConfigurations: The user alert configurations to create, required
+     * Each user alert configuration should contain:
+     * - id: The user alert configuration id, optional. If not provided, it will be generated
+     * - userId: The user id, required
+     * - alertTypeId: The alert type id, required
+     * - smsNotification: The user sms notification, optional
+     * - emailNotification: The user email notification, optional
+     * - appNotification: The user app notification, optional. If not provided, it will be true
+     * - pushNotification: The user push notification, optional. If not provided, it will be true
+     * - alertValue: The user alert value, optional
+     * - alertMetadata: The user alert metadata, optional
+     * @returns Whether the user alert configurations were created
+     */
+    bulkCreateUserAlertConfigurations(params: BulkCreateUserAlertConfigurationsParams): Promise<boolean>;
+    /**
+     * Update user alert configurations
+     * @param {UpdateUserAlertConfigurationsParams} params containing information to update user alert configurations
+     * Filters:
+     * - filters.userId: The user id to update the user alert configurations, required
+     * - filters.alertTypeId: The alert type id to update the user alert configurations, optional
+     * Values:
+     * One of the following values is required
+     * - values.smsNotification: The user sms notification, optional
+     * - values.emailNotification: The user email notification, optional
+     * - values.appNotification: The user app notification, optional
+     * - values.pushNotification: The user push notification, optional
+     * - values.alertValue: The user alert value, optional
+     * - values.alertMetadata: The user alert metadata, optional
+     * @returns Whether the user alert configurations were updated
+     */
+    updateUserAlertConfigurations(params: UpdateUserAlertConfigurationsParams): Promise<boolean>;
+    /**
+     * Delete user alert configurations
+     * @param {DeleteUserAlertConfigurationsParams} params containing information to delete user alert configurations
+     * - filters.userId: The user id to delete the user alert configurations, required
+     * @returns Whether the user alert configurations were deleted
+     */
+    deleteUserAlertConfigurations(params: DeleteUserAlertConfigurationsParams): Promise<boolean>;
+}

package/dist/repositories/userConfigurations/updateUserAlertConfigurations.d.ts

@@ -0,0 +1,4 @@
+import { NovaDataSource } from '../../novaDataSource';
+import { Logger } from '../../types/logger';
+import { UpdateUserAlertConfigurationsParams } from '../../types/userConfigurations';
+export declare const updateUserAlertConfigurations: (novaDataSource: NovaDataSource, params: UpdateUserAlertConfigurationsParams, logger: Logger) => Promise<boolean>;

package/dist/repositories/userConfigurations/updateUserConfiguration.d.ts

@@ -0,0 +1,4 @@
+import { NovaDataSource } from '../../novaDataSource';
+import { Logger } from '../../types/logger';
+import { UpdateUserConfigurationParams } from '../../types/userConfigurations';
+export declare const updateUserConfiguration: (novaDataSource: NovaDataSource, params: UpdateUserConfigurationParams, logger: Logger) => Promise<boolean>;

package/dist/types/deviceBehaviors.d.ts

@@ -0,0 +1,61 @@
+import { DeviceBehaviorStatus, DeviceBehaviorTaskStatus, DeviceBehaviorType } from './enums';
+export interface GetDeviceBehaviorsParams {
+    filters: {
+        status: DeviceBehaviorStatus;
+        imeiList: string[];
+        deviceTypeIdList: number[];
+        stage: string;
+        clientId?: number;
+        type?: DeviceBehaviorType;
+    };
+}
+export interface GetDeviceBehaviorsByIdsParams {
+    filters: {
+        deviceBehaviorIdList: number[];
+    };
+}
+export interface GetDeviceBehaviorTasksParams {
+    filters: {
+        taskId?: string;
+        imeiList?: string[];
+        status?: DeviceBehaviorTaskStatus;
+        deviceBehaviorIdList?: number[];
+    };
+    pagingOptions?: {
+        limit?: number;
+        offset?: number;
+    };
+}
+export interface CreateDeviceBehaviorTaskParams {
+    taskId: string;
+    deviceBehaviorId: number;
+    clientId: number;
+    userId: string;
+    imei: string;
+    behaviorName: string;
+    behaviorParams?: object;
+    status: DeviceBehaviorTaskStatus;
+    extraParams?: object;
+}
+export interface UpdateDeviceBehaviorTaskParams {
+    filters: {
+        taskId: string;
+    };
+    values: {
+        status: DeviceBehaviorTaskStatus;
+    };
+}
+export interface GetLatestDeviceBehaviorTasksParams {
+    filters: {
+        clientId: number;
+        type: DeviceBehaviorType;
+        status: DeviceBehaviorTaskStatus;
+    };
+}
+export interface GetLatestDeviceBehaviorTasksResult {
+    imei: string;
+    name: string;
+    description: string;
+    taskId: string;
+    modifiedAt: Date;
+}

package/dist/types/enums.d.ts

@@ -17,3 +17,19 @@ export declare enum HapnClientType {
     b2b = 2,
     test = 3
 }
+export declare enum DeviceBehaviorType {
+    ReportingFrequency = "ReportingFrequency",
+    Advanced = "Advanced",
+    Query = "Query",
+    General = "General"
+}
+export declare enum DeviceBehaviorStatus {
+    Active = "active",
+    Inactive = "inactive"
+}
+export declare enum DeviceBehaviorTaskStatus {
+    InProgress = "InProgress",
+    Completed = "Completed",
+    Canceled = "Canceled",
+    Failed = "Failed"
+}

package/dist/types/index.d.ts

@@ -1,11 +1,13 @@
 import * as Boundaries from './boundaries';
 import * as Clients from './clients';
+import * as DeviceBehaviors from './deviceBehaviors';
 import * as Devices from './devices';
 import * as Firmwares from './firmwares';
 import * as Logger from './logger';
 import * as Security from './security';
 import * as Users from './user';
+import * as UserConfigurations from './userConfigurations';
 import * as UserDataDeletionRequests from './userDataDeletionRequests';
 import * as UserInvitations from './userInvitations';
 import * as UserRatingRequests from './userRatingRequests';
-export { Logger, Devices, Firmwares, Security, Boundaries, Clients, Users, UserInvitations, UserDataDeletionRequests, UserRatingRequests, };
+export { Boundaries, Clients, DeviceBehaviors, Devices, Firmwares, Logger, Security, Users, UserConfigurations, UserDataDeletionRequests, UserInvitations, UserRatingRequests, };

package/dist/types/userConfigurations.d.ts

@@ -0,0 +1,78 @@
+export interface GetUserConfigurationsParams {
+    filters: {
+        clientId?: number;
+        userId?: string;
+    };
+}
+export interface CreateUserConfigurationParams {
+    id?: number;
+    userId: string;
+    isMetric: boolean;
+    timezone?: string;
+    defaultMapLayer?: string;
+    speedUnits?: string;
+    distanceUnits?: string;
+    alertsNotificationsOn?: boolean;
+    dataSourceTypeId?: number;
+    homepage?: string;
+    temperatureUnits?: string;
+}
+export interface UpdateUserConfigurationParams {
+    filters: {
+        userId: string;
+    };
+    values: {
+        timezone?: string;
+        defaultMapLayer?: string;
+        speedUnits?: string;
+        distanceUnits?: string;
+        alertsNotificationsOn?: boolean;
+        dataSourceTypeId?: number;
+        homepage?: string;
+        temperatureUnits?: string;
+    };
+}
+export interface DeleteUserConfigurationParams {
+    filters: {
+        userId: string;
+    };
+}
+export interface GetUserAlertConfigurationsParams {
+    filters: {
+        userId: string;
+        includeBeta: boolean;
+    };
+}
+export interface CreateUserAlertConfigurationParams {
+    id?: number;
+    userId: string;
+    alertTypeId: number;
+    smsNotification?: boolean;
+    emailNotification?: boolean;
+    appNotification?: boolean;
+    pushNotification?: boolean;
+    alertValue?: string;
+    alertMetadata?: string;
+}
+export interface BulkCreateUserAlertConfigurationsParams {
+    alertConfigurations: CreateUserAlertConfigurationParams[];
+}
+export interface UpdateUserAlertConfigurationsParams {
+    filters: {
+        userId: string;
+        alertTypeId?: number;
+    };
+    values: {
+        smsNotification?: boolean;
+        emailNotification?: boolean;
+        appNotification?: boolean;
+        pushNotification?: boolean;
+        alertValue?: string;
+        alertMetadata?: string;
+    };
+}
+export interface DeleteUserAlertConfigurationsParams {
+    filters: {
+        userId: string;
+    };
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@spytecgps/nova-orm",
-  "version": "0.0.58",
+  "version": "0.0.60",
   "description": "ORM with PlanetScale",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",