@spytecgps/nova-orm 0.0.175 → 0.0.177

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,5 @@
1
+ import { DevicePairing } from '../../entities';
2
+ import { NovaDataSource } from '../../novaDataSource';
3
+ import { CreateDevicePairingParams } from '../../types/devicePairings';
4
+ import { Logger } from '../../types/logger';
5
+ export declare const createDevicePairing: (novaDataSource: NovaDataSource, params: CreateDevicePairingParams, logger: Logger) => Promise<DevicePairing>;
@@ -0,0 +1,4 @@
1
+ import { NovaDataSource } from '../../novaDataSource';
2
+ import { DeleteDevicePairingParams } from '../../types/devicePairings';
3
+ import { Logger } from '../../types/logger';
4
+ export declare const deleteDevicePairing: (novaDataSource: NovaDataSource, params: DeleteDevicePairingParams, logger: Logger) => Promise<boolean>;
@@ -0,0 +1,5 @@
1
+ import { DevicePairing } from '../../entities';
2
+ import { NovaDataSource } from '../../novaDataSource';
3
+ import { GetDevicePairingsParams } from '../../types/devicePairings';
4
+ import { Logger } from '../../types/logger';
5
+ export declare const getDevicePairings: (novaDataSource: NovaDataSource, params: GetDevicePairingsParams, logger: Logger) => Promise<DevicePairing[]>;
@@ -0,0 +1,49 @@
1
+ import { DevicePairing } from '../../entities';
2
+ import { CreateDevicePairingParams, DeleteDevicePairingParams, GetDevicePairingsParams, UpdateDevicePairingParams } from '../../types/devicePairings';
3
+ import { BaseRepository } from '../baseRepository';
4
+ export declare class DevicePairingsRepository extends BaseRepository {
5
+ /**
6
+ * Get device pairings
7
+ * @param params params containing information to get device pairings with filters
8
+ * At least one of the following filters is required:
9
+ * filters.imeiMain: the main device IMEI
10
+ * filters.imeiSecondary: the secondary device IMEI
11
+ * filters.btmacMain: the main device bluetooth MAC
12
+ * filters.btmacSecondary: the secondary device bluetooth MAC
13
+ * @returns Promise<DevicePairing[]> the device pairings
14
+ */
15
+ getDevicePairings(params: GetDevicePairingsParams): Promise<DevicePairing[]>;
16
+ /**
17
+ * Create device pairing
18
+ * @param params params containing information to create device pairing
19
+ * params.imeiMain: the main device IMEI, required
20
+ * params.btmacMain: the main device bluetooth MAC, required
21
+ * params.imeiSecondary: the secondary device IMEI, required
22
+ * params.btmacSecondary: the secondary device bluetooth MAC, required
23
+ * params.pairingMode: the pairing mode, optional
24
+ * params.connectionType: the connection type, optional
25
+ * @returns Promise<DevicePairing> the created device pairing
26
+ */
27
+ createDevicePairing(params: CreateDevicePairingParams): Promise<DevicePairing>;
28
+ /**
29
+ * Update device pairing
30
+ * @param params params containing information to update device pairing
31
+ * filters.id: the device pairing id
32
+ * At least one of the following values is required:
33
+ * values.imeiMain: the main device IMEI
34
+ * values.imeiSecondary: the secondary device IMEI
35
+ * values.btmacMain: the main device bluetooth MAC
36
+ * values.btmacSecondary: the secondary device bluetooth MAC
37
+ * values.pairingMode: the pairing mode
38
+ * values.connectionType: the connection type
39
+ * @returns Promise<boolean> true if the device pairing was updated, false otherwise
40
+ */
41
+ updateDevicePairing(params: UpdateDevicePairingParams): Promise<boolean>;
42
+ /**
43
+ * Delete device pairing
44
+ * @param params params containing information to delete device pairing
45
+ * filters.id: the device pairing id
46
+ * @returns Promise<boolean> true if the device pairing was deleted, false otherwise
47
+ */
48
+ deleteDevicePairing(params: DeleteDevicePairingParams): Promise<boolean>;
49
+ }
@@ -0,0 +1,4 @@
1
+ import { NovaDataSource } from '../../novaDataSource';
2
+ import { UpdateDevicePairingParams } from '../../types/devicePairings';
3
+ import { Logger } from '../../types/logger';
4
+ export declare const updateDevicePairing: (novaDataSource: NovaDataSource, params: UpdateDevicePairingParams, logger: Logger) => Promise<boolean>;
@@ -0,0 +1,5 @@
1
+ import { DeviceType } from '../../entities';
2
+ import { NovaDataSource } from '../../novaDataSource';
3
+ import { GetDeviceTypeByImeiParams } from '../../types/devices';
4
+ import { Logger } from '../../types/logger';
5
+ export declare const getDeviceTypeByImei: (novaDataSource: NovaDataSource, params: GetDeviceTypeByImeiParams, logger: Logger) => Promise<DeviceType>;
@@ -1,5 +1,5 @@
1
1
  import { ClientDeviceSetting, Device, DeviceCustomConfiguration, DeviceReplacement, DeviceType, IccidStatus, ImeiIccidCarrier } from '../../entities';
2
- import { CanceledDeviceWithActiveSimCard, CarrierStatus, CreateClientDeviceSettingParams, CreateDeviceParams, CreateDeviceReplacementParams, CreateDeviceTypeParams, DeleteDeviceParams, DeviceTypeModelWithDeviceCount, DeviceWithUsersInfo, GenerateIdentifierKeyParams, GetCanceledDevicesWithActiveSimCardsParams, GetCarrierStatusUpdatedBeforeParams, GetClientDeviceSettingParams, GetClientDeviceSettingsParams, GetDeviceCustomConfigParams, GetDeviceModelByIccidParams, GetDeviceParams, GetDevicesParams, GetDeviceTypesModelsOrderedByDeviceCountParams, GetDeviceTypesParams, GetDeviceWithUsersInfoParams, GetFilteredImeisWithStatusParams, GetIccidStatusParams, GetImeiIccidCarrierParams, GetImeiIccidCarriersParams, UpdateClientDeviceSettingParams, UpdateDeviceParams, UpdateDeviceTypeParams, UpdateIccidStatusParams, UpdateImeiIccidCarrierParams, UpsertIccidStatusParams } from '../../types/devices';
2
+ import { CanceledDeviceWithActiveSimCard, CarrierStatus, CreateClientDeviceSettingParams, CreateDeviceParams, CreateDeviceReplacementParams, CreateDeviceTypeParams, DeleteDeviceParams, DeviceTypeModelWithDeviceCount, DeviceWithUsersInfo, GenerateIdentifierKeyParams, GetCanceledDevicesWithActiveSimCardsParams, GetCarrierStatusUpdatedBeforeParams, GetClientDeviceSettingParams, GetClientDeviceSettingsParams, GetDeviceCustomConfigParams, GetDeviceParams, GetDevicesParams, GetDeviceTypeByImeiParams, GetDeviceTypesModelsOrderedByDeviceCountParams, GetDeviceTypesParams, GetDeviceWithUsersInfoParams, GetFilteredImeisWithStatusParams, GetIccidStatusParams, GetImeiIccidCarrierParams, GetImeiIccidCarriersParams, UpdateClientDeviceSettingParams, UpdateDeviceParams, UpdateDeviceTypeParams, UpdateIccidStatusParams, UpdateImeiIccidCarrierParams, UpsertIccidStatusParams } from '../../types/devices';
3
3
  import { BaseRepository } from './../baseRepository';
4
4
  export declare class DevicesRepository extends BaseRepository {
5
5
  /**
@@ -104,14 +104,12 @@ export declare class DevicesRepository extends BaseRepository {
104
104
  */
105
105
  getImeiIccidCarrier(params: GetImeiIccidCarrierParams): Promise<ImeiIccidCarrier>;
106
106
  /**
107
- * Get ImeiIccidCarrier
108
- * @param {GetDeviceModelByIccidParams} params containing information to get the device model by iccid
107
+ * Get DeviceTypeByImei
108
+ * @param {GetDeviceTypeByImeiParams} params containing information to get the device type by imei
109
109
  * - filters.imei: The imei of the device
110
- * @returns {Promise<{ modelFamily: string }>} The device model family
110
+ * @returns {Promise<DeviceType>} The device type record of an imei
111
111
  */
112
- getDeviceModelByIccid(params: GetDeviceModelByIccidParams): Promise<{
113
- modelFamily: string;
114
- }>;
112
+ getDeviceTypeByImei(params: GetDeviceTypeByImeiParams): Promise<DeviceType>;
115
113
  /**
116
114
  * Get ImeiIccidCarriers from a list of imeis
117
115
  * @param {GetImeiIccidCarriersParams} params containing information to get the ImeiIccidCarriers
@@ -10,6 +10,7 @@ import { ClientsRepository } from './clients';
10
10
  import { CountriesRepository } from './countries';
11
11
  import { DeactivationsRepository } from './deactivations';
12
12
  import { DeviceBehaviorsRepository } from './deviceBehaviors';
13
+ import { DevicePairingsRepository } from './devicePairings';
13
14
  import { DevicesRepository } from './devices';
14
15
  import { FirmwaresRepository } from './firmwares';
15
16
  import { NotificationRecipientsRepository } from './notificationRecipients';
@@ -25,4 +26,4 @@ import { UserInvitationsRepository } from './userInvitations';
25
26
  import { UserRatingRequestsRepository } from './userRatingRequests';
26
27
  import { UserRegistrationAttemptsRepository } from './userRegistrationAttempts';
27
28
  import { UsersRepository } from './users';
28
- export { AcumaticaRepository, AempTokenRepository, 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, };
29
+ export { AcumaticaRepository, AempTokenRepository, AlertRepository, AlertTypesRepository, AssetCategoriesRepository, BillingRepository, BlacklistRepository, BoundariesRepository, ClientsRepository, CountriesRepository, DeactivationsRepository, DeviceBehaviorsRepository, DevicePairingsRepository, DevicesRepository, FirmwaresRepository, NotificationRecipientsRepository, PositionRepository, SecurityRepository, TripRepository, UserActivationsRepository, UserAppFeedbackRepository, UserAppIncidentsRepository, UserConfigurationsRepository, UserDataDeletionRequestsRepository, UserInvitationsRepository, UserRatingRequestsRepository, UserRegistrationAttemptsRepository, UsersRepository, };
@@ -0,0 +1,35 @@
1
+ export interface CreateDevicePairingParams {
2
+ id?: number;
3
+ imeiMain: string;
4
+ btmacMain: string;
5
+ imeiSecondary: string;
6
+ btmacSecondary: string;
7
+ pairingMode?: string | null;
8
+ connectionType?: string | null;
9
+ }
10
+ export interface GetDevicePairingsParams {
11
+ filters: {
12
+ imeiMain?: string;
13
+ btmacMain?: string;
14
+ imeiSecondary?: string;
15
+ btmacSecondary?: string;
16
+ };
17
+ }
18
+ export interface UpdateDevicePairingParams {
19
+ filters: {
20
+ id: number;
21
+ };
22
+ values: {
23
+ imeiMain?: string;
24
+ imeiSecondary?: string;
25
+ btmacMain?: string;
26
+ btmacSecondary?: string;
27
+ pairingMode?: string;
28
+ connectionType?: string;
29
+ };
30
+ }
31
+ export interface DeleteDevicePairingParams {
32
+ filters: {
33
+ id: number;
34
+ };
35
+ }
@@ -29,7 +29,7 @@ export interface GetFilteredImeisWithStatusParams {
29
29
  status: DeviceStatus;
30
30
  };
31
31
  }
32
- export interface GetDeviceModelByIccidParams {
32
+ export interface GetDeviceTypeByImeiParams {
33
33
  filters: {
34
34
  imei: string;
35
35
  };
@@ -8,6 +8,7 @@ import * as Clients from './clients';
8
8
  import * as Countries from './countries';
9
9
  import * as Deactivations from './deactivations';
10
10
  import * as DeviceBehaviors from './deviceBehaviors';
11
+ import * as DevicePairings from './devicePairings';
11
12
  import * as Devices from './devices';
12
13
  import * as Enums from './enums';
13
14
  import * as Firmwares from './firmwares';
@@ -25,4 +26,4 @@ import * as UserDataDeletionRequests from './userDataDeletionRequests';
25
26
  import * as UserInvitations from './userInvitations';
26
27
  import * as UserRatingRequests from './userRatingRequests';
27
28
  import * as UserRegistrationAttempts from './userRegistrationAttempts';
28
- 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, Enums, };
29
+ export { Acumatica, Alerts, AlertTypes, Billing, Blacklist, Boundaries, Clients, Countries, Deactivations, DeviceBehaviors, DevicePairings, Devices, Firmwares, Logger, NotificationRecipients, Positions, Security, Trips, Users, UserActivations, UserAppFeedback, UserAppIncidents, UserConfigurations, UserDataDeletionRequests, UserInvitations, UserRatingRequests, UserRegistrationAttempts, Enums, };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@spytecgps/nova-orm",
3
- "version": "0.0.175",
3
+ "version": "0.0.177",
4
4
  "description": "ORM with PlanetScale",
5
5
  "main": "./dist/index.js",
6
6
  "types": "./dist/index.d.ts",
@@ -1,6 +0,0 @@
1
- import { NovaDataSource } from '../../novaDataSource';
2
- import { GetDeviceModelByIccidParams } from '../../types/devices';
3
- import { Logger } from '../../types/logger';
4
- export declare const getDeviceModelByIccid: (novaDataSource: NovaDataSource, params: GetDeviceModelByIccidParams, logger: Logger) => Promise<{
5
- modelFamily: string;
6
- }>;