@spytecgps/nova-orm 1.2.28 → 1.2.29-rc2

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

@@ -1,170 +1,170 @@
-import { UserAlertConfiguration, UserAlertNotificationsConfig, UserConfiguration } from '../../entities';
-import { BulkCreateUserAlertConfigurationsParams, CreateUserAlertConfigurationParams, CreateUserConfigurationParams, DeleteUserAlertConfigurationsParams, DeleteUserAlertNotificationsConfigParams, DeleteUserConfigurationParams, GetUserAlertConfigurationsParams, GetUserAlertNotificationsConfigParams, GetUserConfigurationsParams, UpdateUserAlertConfigurationByIdParams, UpdateUserAlertConfigurationsParams, UpdateUserConfigurationParams, UpsertUserAlertNotificationsConfigParams } 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
-     * - addressFormat: The user address format, 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
-     * - values.addressFormat: The user address format, 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<UserAlertConfiguration[]>;
-    /**
-     * Create user alert configuration
-     * @param {CreateUserAlertConfigurationParams} 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
-     * - createdBy: The user created by, optional
-     * - filter: The user filter, optional
-     * - name: The user name, optional
-     * - enabled: The user enabled, optional
-     * @returns Whether the user alert configurations were created
-     */
-    createUserAlertConfiguration(params: CreateUserAlertConfigurationParams): Promise<UserAlertConfiguration>;
-    /**
-     * @deprecated Use updateUserAlertConfigurationById instead
-     * 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>;
-    /**
-     * 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.userAlertConfigurationId: The user alert configuration id to update the user alert configurations, required
-     * 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
-     * - values.createdBy: The user created by, optional
-     * - values.filter: The user filter, optional
-     * - values.name: The user name, optional
-     * - values.enabled: The user enabled, optional
-     * @returns Whether the user alert configurations were updated
-     */
-    updateUserAlertConfigurationById(params: UpdateUserAlertConfigurationByIdParams): 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>;
-    /**
-     * Get user alert notifications config
-     * @param {GetUserAlertNotificationsConfigParams} params containing information to get user alert notifications config
-     * - filters.userId: The user id to obtain all user alert notifications config from that user, required
-     * @returns The user alert notifications config
-     */
-    getUserAlertNotificationsConfig(params: GetUserAlertNotificationsConfigParams): Promise<UserAlertNotificationsConfig[]>;
-    /**
-     * Upsert user alert notifications config
-     * @param {UpsertUserAlertNotificationsConfigParams} params containing information to upsert user alert notifications config
-     * - id: The user alert notifications config id, optional. If not provided, it will be generated
-     * - clientAlertConfigurationId: The client alert configuration id, required
-     * - userId: The user 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
-     * @returns Whether the user alert notifications config was upserted
-     */
-    upsertUserAlertNotificationsConfig(params: UpsertUserAlertNotificationsConfigParams): Promise<boolean>;
-    deleteUserAlertNotificationsConfig: (params: DeleteUserAlertNotificationsConfigParams) => Promise<boolean>;
-}
+import { UserAlertConfiguration, UserAlertNotificationsConfig, UserConfiguration } from '../../entities';
+import { BulkCreateUserAlertConfigurationsParams, CreateUserAlertConfigurationParams, CreateUserConfigurationParams, DeleteUserAlertConfigurationsParams, DeleteUserAlertNotificationsConfigParams, DeleteUserConfigurationParams, GetUserAlertConfigurationsParams, GetUserAlertNotificationsConfigParams, GetUserConfigurationsParams, UpdateUserAlertConfigurationByIdParams, UpdateUserAlertConfigurationsParams, UpdateUserConfigurationParams, UpsertUserAlertNotificationsConfigParams } 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
+     * - addressFormat: The user address format, 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
+     * - values.addressFormat: The user address format, 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<UserAlertConfiguration[]>;
+    /**
+     * Create user alert configuration
+     * @param {CreateUserAlertConfigurationParams} 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
+     * - createdBy: The user created by, optional
+     * - filter: The user filter, optional
+     * - name: The user name, optional
+     * - enabled: The user enabled, optional
+     * @returns Whether the user alert configurations were created
+     */
+    createUserAlertConfiguration(params: CreateUserAlertConfigurationParams): Promise<UserAlertConfiguration>;
+    /**
+     * @deprecated Use updateUserAlertConfigurationById instead
+     * 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>;
+    /**
+     * 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.userAlertConfigurationId: The user alert configuration id to update the user alert configurations, required
+     * 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
+     * - values.createdBy: The user created by, optional
+     * - values.filter: The user filter, optional
+     * - values.name: The user name, optional
+     * - values.enabled: The user enabled, optional
+     * @returns Whether the user alert configurations were updated
+     */
+    updateUserAlertConfigurationById(params: UpdateUserAlertConfigurationByIdParams): 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>;
+    /**
+     * Get user alert notifications config
+     * @param {GetUserAlertNotificationsConfigParams} params containing information to get user alert notifications config
+     * - filters.userId: The user id to obtain all user alert notifications config from that user, required
+     * @returns The user alert notifications config
+     */
+    getUserAlertNotificationsConfig(params: GetUserAlertNotificationsConfigParams): Promise<UserAlertNotificationsConfig[]>;
+    /**
+     * Upsert user alert notifications config
+     * @param {UpsertUserAlertNotificationsConfigParams} params containing information to upsert user alert notifications config
+     * - id: The user alert notifications config id, optional. If not provided, it will be generated
+     * - clientAlertConfigurationId: The client alert configuration id, required
+     * - userId: The user 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
+     * @returns Whether the user alert notifications config was upserted
+     */
+    upsertUserAlertNotificationsConfig(params: UpsertUserAlertNotificationsConfigParams): Promise<boolean>;
+    deleteUserAlertNotificationsConfig: (params: DeleteUserAlertNotificationsConfigParams) => Promise<boolean>;
+}