@spytecgps/nova-orm 0.0.122 → 0.0.124

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

@@ -1,5 +1,5 @@
 import { Boundary } from '../../entities';
-import { BoundariesReportEntity, CreateBoundaryParams, DeleteBoundaryParams, GetBoundariesByClientIdParams, GetBoundariesReportParams, GetBoundaryByIdParams, UpdateBoundaryParams, UpsertBoundaryEventParams } from '../../types/boundaries';
+import { BoundariesReportEntity, CreateBoundaryParams, DeleteBoundaryParams, GetBoundariesByClientIdParams, GetBoundariesReportParams, GetBoundaryByIdParams, ProcessBoundaryEventParams, UpdateBoundaryParams, UpsertBoundaryEventParams } from '../../types/boundaries';
 import { BaseRepository } from '../baseRepository';
 export declare class BoundariesRepository extends BaseRepository {
     /**
@@ -82,6 +82,20 @@ export declare class BoundariesRepository extends BaseRepository {
      * @returns The boundaries report
      */
     getBoundariesReport(params: GetBoundariesReportParams): Promise<BoundariesReportEntity[]>;
+    /**
+     * Process boundary event
+     * @param  {ProcessBoundaryEventParams} params containing information to process boundary event
+     * - boundaryId: The boundary id
+     * - imei: The imei of the device
+     * - userId: The user id
+     * - sendTime: The event date
+     * - eventType: The event type (enter or exit)
+     * - lat: The latitude of the event
+     * - lon: The longitude of the event
+     * - address: The address of the event
+     * @returns true if the event was processed, false otherwise
+     */
+    processBoundaryEvent(params: ProcessBoundaryEventParams): Promise<boolean>;
     /**
      * Upsert boundary event
      * @param  {UpsertBoundaryEventParams} params containing information to upsert boundary event

package/dist/repositories/boundaries/processBoundaryEvent.d.ts

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

package/dist/repositories/deactivations/createDeactivation.d.ts

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

package/dist/repositories/deactivations/getDeactivationReasons.d.ts

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

package/dist/repositories/deactivations/getLatestDeactivationByImei.d.ts

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

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

@@ -0,0 +1,38 @@
+import { Deactivation, DeactivationReason } from '../../entities';
+import { CreateDeactivationParams, GetDeactivationReasonsParams, GetLatestDeactivationByImeiParams } from '../../types/deactivations';
+import { BaseRepository } from '../baseRepository';
+export declare class DeactivationsRepository extends BaseRepository {
+    /**
+     * Get deactivation reasons
+     * @param {GetDeactivationReasonsParams} params containing information to get deactivation reasons
+     * One of the following filters is required:
+     * - filters.code: The code
+     * - filters.customerVisible: The customer visible
+     * @returns The deactivation reasons list
+     */
+    getDeactivationReasons(params: GetDeactivationReasonsParams): Promise<DeactivationReason[]>;
+    /**
+     * Get latest deactivation by imei
+     * @param {GetLatestDeactivationByImeiParams} params containing information to get latest deactivation by imei
+     * - filters.imei: The imei
+     * @returns The deactivation
+     */
+    getLatestDeactivationByImei(params: GetLatestDeactivationByImeiParams): Promise<Deactivation>;
+    /**
+     * Create deactivation
+     * @param {CreateDeactivationParams} params containing information to create deactivation
+     * - params.id: The id, optional
+     * - params.imei: The imei, required
+     * - params.clientId: The client id, required
+     * - params.createdBy: The created by, required
+     * - params.billingSubscriptionId: The billing subscription id, optional
+     * - params.planId: The plan id, optional
+     * - params.billingPlatform: The billing platform, optional
+     * - params.deactivationReason: The deactivation reason, optional
+     * - params.deactivationReasonId: The deactivation reason id, optional
+     * - params.scheduledDate: The scheduled date, optional
+     * - params.displayOrder: The display order, optional
+     * @returns The deactivation
+     */
+    createDeactivation(params: CreateDeactivationParams): Promise<Deactivation>;
+}

package/dist/repositories/index.d.ts

@@ -7,6 +7,7 @@ import { BlacklistRepository } from './blacklist';
 import { BoundariesRepository } from './boundaries';
 import { ClientsRepository } from './clients';
 import { CountriesRepository } from './countries';
+import { DeactivationsRepository } from './deactivations';
 import { DeviceBehaviorsRepository } from './deviceBehaviors';
 import { DevicesRepository } from './devices';
 import { FirmwaresRepository } from './firmwares';
@@ -23,4 +24,4 @@ import { UserInvitationsRepository } from './userInvitations';
 import { UserRatingRequestsRepository } from './userRatingRequests';
 import { UserRegistrationAttemptsRepository } from './userRegistrationAttempts';
 import { UsersRepository } from './users';
-export { AcumaticaRepository, AlertRepository, AlertTypesRepository, AssetCategoriesRepository, BillingRepository, BlacklistRepository, BoundariesRepository, ClientsRepository, CountriesRepository, DeviceBehaviorsRepository, DevicesRepository, FirmwaresRepository, NotificationRecipientsRepository, PositionRepository, SecurityRepository, TripRepository, UserActivationsRepository, UserAppFeedbackRepository, UserAppIncidentsRepository, UserConfigurationsRepository, UserDataDeletionRequestsRepository, UserInvitationsRepository, UserRatingRequestsRepository, UserRegistrationAttemptsRepository, UsersRepository, };
+export { AcumaticaRepository, AlertRepository, AlertTypesRepository, AssetCategoriesRepository, BillingRepository, BlacklistRepository, BoundariesRepository, ClientsRepository, CountriesRepository, DeactivationsRepository, DeviceBehaviorsRepository, DevicesRepository, FirmwaresRepository, NotificationRecipientsRepository, PositionRepository, SecurityRepository, TripRepository, UserActivationsRepository, UserAppFeedbackRepository, UserAppIncidentsRepository, UserConfigurationsRepository, UserDataDeletionRequestsRepository, UserInvitationsRepository, UserRatingRequestsRepository, UserRegistrationAttemptsRepository, UsersRepository, };

package/dist/types/boundaries.d.ts

@@ -1,5 +1,5 @@
 import { ReportPagination } from './common';
-import { BoundaryStatus } from './enums';
+import { BoundaryEventType, BoundaryStatus } from './enums';
 export interface GetBoundariesByClientIdParams {
     filters: {
         clientId: number;
@@ -91,6 +91,16 @@ export interface BoundariesReportEntity {
     inOutDuration?: number | null;
     totalCount: number;
 }
+export interface ProcessBoundaryEventParams {
+    imei: string;
+    boundaryId: number;
+    userId: string;
+    sendTime: Date;
+    eventType: BoundaryEventType;
+    lat: number;
+    lon: number;
+    address: string;
+}
 export interface UpsertBoundaryEventParams {
     id: number;
     deviceId: number;

package/dist/types/deactivations.d.ts

@@ -0,0 +1,24 @@
+export interface GetDeactivationReasonsParams {
+    filters: {
+        code?: string;
+        customerVisible?: boolean;
+    };
+}
+export interface GetLatestDeactivationByImeiParams {
+    filters: {
+        imei: string;
+    };
+}
+export interface CreateDeactivationParams {
+    id?: number;
+    imei: string;
+    clientId: number;
+    createdBy: string;
+    billingSubscriptionId?: string | null;
+    planId?: string | null;
+    billingPlatform?: string | null;
+    deactivationReason?: string | null;
+    deactivationReasonId?: number | null;
+    scheduledDate?: Date | null;
+    displayOrder?: number | null;
+}

package/dist/types/enums.d.ts

@@ -56,3 +56,7 @@ export declare enum TripCompletionStatus {
     TempCurrent = 10,
     TempCompleted = 20
 }
+export declare enum BoundaryEventType {
+    Enter = "boundaryEnter",
+    Exit = "boundaryExit"
+}

package/dist/types/index.d.ts

@@ -6,6 +6,7 @@ import * as Blacklist from './blacklist';
 import * as Boundaries from './boundaries';
 import * as Clients from './clients';
 import * as Countries from './countries';
+import * as Deactivations from './deactivations';
 import * as DeviceBehaviors from './deviceBehaviors';
 import * as Devices from './devices';
 import * as Firmwares from './firmwares';
@@ -23,4 +24,4 @@ import * as UserDataDeletionRequests from './userDataDeletionRequests';
 import * as UserInvitations from './userInvitations';
 import * as UserRatingRequests from './userRatingRequests';
 import * as UserRegistrationAttempts from './userRegistrationAttempts';
-export { Acumatica, Alerts, AlertTypes, Billing, Blacklist, Boundaries, Clients, Countries, DeviceBehaviors, Devices, Firmwares, Logger, NotificationRecipients, Positions, Security, Trips, Users, UserActivations, UserAppFeedback, UserAppIncidents, UserConfigurations, UserDataDeletionRequests, UserInvitations, UserRatingRequests, UserRegistrationAttempts, };
+export { Acumatica, Alerts, AlertTypes, Billing, Blacklist, Boundaries, Clients, Countries, Deactivations, DeviceBehaviors, Devices, Firmwares, Logger, NotificationRecipients, Positions, Security, Trips, Users, UserActivations, UserAppFeedback, UserAppIncidents, UserConfigurations, UserDataDeletionRequests, UserInvitations, UserRatingRequests, UserRegistrationAttempts, };

package/package.json

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