@spytecgps/nova-orm 0.0.68 → 0.0.69

package/dist/repositories/index.d.ts

@@ -7,6 +7,7 @@ import { CountriesRepository } from './countries';
 import { DeviceBehaviorsRepository } from './deviceBehaviors';
 import { DevicesRepository } from './devices';
 import { FirmwaresRepository } from './firmwares';
+import { NotificationRecipientsRepository } from './notificationRecipients';
 import { PositionRepository } from './positions';
 import { SecurityRepository } from './security';
 import { UserActivationsRepository } from './userActivations';
@@ -15,4 +16,4 @@ import { UserDataDeletionRequestsRepository } from './userDataDeletionRequests';
 import { UserInvitationsRepository } from './userInvitations';
 import { UserRatingRequestsRepository } from './userRatingRequests';
 import { UsersRepository } from './users';
-export { AlertRepository, AlertTypesRepository, AssetCategoriesRepository, BoundariesRepository, ClientsRepository, CountriesRepository, DeviceBehaviorsRepository, DevicesRepository, FirmwaresRepository, PositionRepository, SecurityRepository, UserActivationsRepository, UserConfigurationsRepository, UserDataDeletionRequestsRepository, UserInvitationsRepository, UserRatingRequestsRepository, UsersRepository, };
+export { AlertRepository, AlertTypesRepository, AssetCategoriesRepository, BoundariesRepository, ClientsRepository, CountriesRepository, DeviceBehaviorsRepository, DevicesRepository, FirmwaresRepository, NotificationRecipientsRepository, PositionRepository, SecurityRepository, UserActivationsRepository, UserConfigurationsRepository, UserDataDeletionRequestsRepository, UserInvitationsRepository, UserRatingRequestsRepository, UsersRepository, };

package/dist/repositories/notificationRecipients/createNotificationRecipient.d.ts

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

package/dist/repositories/notificationRecipients/deleteNotificationRecipients.d.ts

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

package/dist/repositories/notificationRecipients/deleteNotificationRecipientsByEmailOrPhone.d.ts

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

package/dist/repositories/notificationRecipients/getNotificationRecipients.d.ts

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

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

@@ -0,0 +1,70 @@
+import { NotificationRecipient } from '../../entities';
+import { CreateNotificationRecipientParams, DeleteNotificationRecipientsByEmailOrPhoneParams, DeleteNotificationRecipientsParams, GetNotificationRecipientsParams, UpdateNotificationRecipientParams, UpdateUsersNotificationsUnsuscribedStatusParams } from '../../types/notificationRecipients';
+import { BaseRepository } from '../baseRepository';
+export declare class NotificationRecipientsRepository extends BaseRepository {
+    /**
+     * Create notification recipient
+     * @param {CreateNotificationRecipientParams} params containing information to create a notification recipient
+     * - params.id: The notification recipient id, optional. If not provided, a new id will be generated
+     * - params.clientId: The client id
+     * - params.userId: The user id
+     * - params.notificationType: The notification type
+     * - params.recipient: The recipient
+     * - params.isEnabled: The is enabled flag
+     * - params.isUserProfile: The is user profile flag
+     * - params.unsubscribed: The unsubscribed flag
+     * - params.dataSourceTypeId: The data source type id, optional
+     * @returns The notification recipient information
+     */
+    createNotificationRecipient(params: CreateNotificationRecipientParams): Promise<NotificationRecipient>;
+    /**
+     * Get notification recipients with filters
+     * @param {GetNotificationRecipientsParams} params containing information to get notification recipients with filters
+     * - filters.clientId: The client id to obtain all notification recipients from that client
+     * @returns The notification recipients information
+     */
+    getNotificationRecipients(params: GetNotificationRecipientsParams): Promise<NotificationRecipient[]>;
+    /**
+     * Update notification recipient
+     * @param {UpdateNotificationRecipientParams} params containing information to update a notification recipient
+     * - params.filters.id: The notification recipient id
+     * At least one of the following fields is required:
+     * - params.values.notificationType: The notification type, optional
+     * - params.values.recipient: The recipient, optional
+     * - params.values.isEnabled: The is enabled flag, optional
+     * - params.values.isUserProfile: The is user profile flag, optional
+     * - params.values.unsubscribed: The unsubscribed flag, optional
+     * @returns Whether the notification recipient was updated or not
+     */
+    updateNotificationRecipient(params: UpdateNotificationRecipientParams): Promise<boolean>;
+    /**
+     * Update users notifications unsubscribed status
+     * @param {UpdateUsersNotificationsUnsuscribedStatusParams} params containing information to update users notifications unsubscribed status
+     * - params.filters: Using these filters, the query will update the users notifications unsubscribed
+     * status for all users with the corresponding phone number.
+     * The user country code will be used to remove the country code from the phone number before comparing it with the user phone number.
+     * - params.filters.userPhone: The user phone
+     * - params.filters.userCountryCode: The user country code
+     * - params.values.unsubscribed: The unsubscribed flag, optional
+     * @returns Whether the users notifications unsubscribed status was updated or not
+     */
+    updateUsersNotificationsUnsuscribedStatus(params: UpdateUsersNotificationsUnsuscribedStatusParams): Promise<boolean>;
+    /**
+     * Delete notification recipients
+     * @param {DeleteNotificationRecipientsParams} params containing information to delete notification recipients
+     * At least one of the following fields is required:
+     * - params.filters.id: The notification recipient id, optional
+     * - params.filters.userId: The user id, optional
+     * @returns Whether the notification recipients were deleted or not
+     */
+    deleteNotificationRecipients(params: DeleteNotificationRecipientsParams): Promise<boolean>;
+    /**
+     * Delete notification recipients by email or phone
+     * @param {DeleteNotificationRecipientsByEmailOrPhoneParams} params containing information to delete notification recipients by email or phone
+     * - params.filters.clientId: The client id
+     * - params.filters.notificationType: The notification type
+     * - params.filters.recipient: The recipient
+     * @returns Whether the notification recipients were deleted or not
+     */
+    deleteNotificationRecipientsByEmailOrPhone(params: DeleteNotificationRecipientsByEmailOrPhoneParams): Promise<boolean>;
+}

package/dist/repositories/notificationRecipients/updateNotificationRecipient.d.ts

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

package/dist/repositories/notificationRecipients/updateUsersNotificationsUnsuscribedStatus.d.ts

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

package/dist/types/enums.d.ts

@@ -33,3 +33,7 @@ export declare enum DeviceBehaviorTaskStatus {
     Canceled = "Canceled",
     Failed = "Failed"
 }
+export declare enum NotificationRecipientType {
+    Email = 1,
+    Phone = 2
+}

package/dist/types/index.d.ts

@@ -7,6 +7,7 @@ import * as DeviceBehaviors from './deviceBehaviors';
 import * as Devices from './devices';
 import * as Firmwares from './firmwares';
 import * as Logger from './logger';
+import * as NotificationRecipients from './notificationRecipients';
 import * as Positions from './position';
 import * as Security from './security';
 import * as Users from './user';
@@ -15,4 +16,4 @@ import * as UserConfigurations from './userConfigurations';
 import * as UserDataDeletionRequests from './userDataDeletionRequests';
 import * as UserInvitations from './userInvitations';
 import * as UserRatingRequests from './userRatingRequests';
-export { Alerts, AlertTypes, Boundaries, Clients, Countries, DeviceBehaviors, Devices, Firmwares, Logger, Positions, Security, Users, UserActivations, UserConfigurations, UserDataDeletionRequests, UserInvitations, UserRatingRequests, };
+export { Alerts, AlertTypes, Boundaries, Clients, Countries, DeviceBehaviors, Devices, Firmwares, Logger, NotificationRecipients, Positions, Security, Users, UserActivations, UserConfigurations, UserDataDeletionRequests, UserInvitations, UserRatingRequests, };

package/dist/types/notificationRecipients.d.ts

@@ -0,0 +1,51 @@
+import { NotificationRecipientType } from './enums';
+export interface GetNotificationRecipientsParams {
+    filters: {
+        clientId: number;
+    };
+}
+export interface CreateNotificationRecipientParams {
+    id?: number;
+    clientId: number;
+    notificationType: NotificationRecipientType;
+    recipient: string;
+    isEnabled: boolean;
+    isUserProfile: boolean;
+    unsubscribed: boolean;
+    userId: string;
+    dataSourceTypeId?: number;
+}
+export interface UpdateNotificationRecipientParams {
+    filters: {
+        id: number;
+    };
+    values: {
+        notificationType?: NotificationRecipientType;
+        recipient?: string;
+        isEnabled?: boolean;
+        isUserProfile?: boolean;
+        unsubscribed?: boolean;
+    };
+}
+export interface UpdateUsersNotificationsUnsuscribedStatusParams {
+    filters: {
+        userPhone: string;
+        userCountryCode: string;
+    };
+    values: {
+        unsubscribed?: boolean;
+    };
+}
+export interface DeleteNotificationRecipientsParams {
+    filters: {
+        id?: number;
+        userId?: string;
+    };
+}
+export interface DeleteNotificationRecipientsByEmailOrPhoneParams {
+    filters: {
+        clientId: number;
+        recipient: string;
+        notificationType: NotificationRecipientType;
+    };
+}

package/package.json

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