@spytecgps/nova-orm 1.2.26 → 1.2.27

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

@@ -1,138 +1,138 @@
-import { Client, ClientConfiguration, ClientIngestorConfiguration } from '../../entities';
-import { CustomerAttribute } from '../../entities/customerAttribute';
-import { CreateClientConfigurationParams, CreateClientIngestorConfigurationParams, CreateClientParams, CreateCustomerAttributeParams, DeleteClientParams, GetClientConfigurationParams, GetClientIngestorConfigurationsParams, GetClientParams, GetClientsParams, GetCustomerAttributeParams, UpdateClientConfigurationParams, UpdateClientParams, UpdateCustomerAttributeParams } from '../../types/clients';
-import { BaseRepository } from '../baseRepository';
-export declare class ClientsRepository extends BaseRepository {
-    /**
-     * Get a client with filters. If multiple clients are found, the first one is returned.
-     * @param  {GetClientParams} params containing information to get a client
-     * - filters.clientId: The client id, optional
-     * - filters.email: The email, optional
-     */
-    getClient(params: GetClientParams): Promise<Client>;
-    /**
-     * Get clients with filters. If multiple clients are found, all are returned.
-     * @param  {GetClientsParams} params containing information to get clients
-     * - filters.email: The email filter
-     */
-    getClients(params: GetClientsParams): Promise<Client[]>;
-    /**
-     * Create client
-     * @param  {CreateClientParams} params containing information to create a client
-     * - name: client name
-     * - email: client email
-     * - uuid: client uuid
-     * - clientTypeId: client type id, optional
-     * - dataSourceTypeId: data source type id, optional
-     * - sievaUserName: sieva user name, optional
-     * - sievaBatchId: sieva batch id, optional
-     * - salesforceId: salesforce id, optional
-     * - accumaticaId: accumatica id, optional
-     * - expirationDate: expiration date, optional
-     * - useType: use type, optional
-     * - btCustomerId: bt customer id, optional
-     * - activationCampaign: activation campaign, optional
-     * - organizationId: organization id, optional
-     *  @returns {Promise<Client>} The created client
-     */
-    createClient(params: CreateClientParams): Promise<Client>;
-    /**
-     * Create client
-     * @param  {UpdateClientParams} params containing information to update a client
-     * - filters.clientId: The id of the client to update
-     * - values.name: client name, optional
-     * - values.email: client email, optional
-     * - values.uuid: client uuid, optional
-     * - values.clientTypeId: client type id, optional
-     * - values.dataSourceTypeId: data source type id, optional
-     * - values.sievaUserName: sieva user name, optional
-     * - values.sievaBatchId: sieva batch id, optional
-     * - values.salesforceId: salesforce id, optional
-     * - values.accumaticaId: accumatica id, optional
-     * - values.expirationDate: expiration date, optional
-     * - values.useType: use type, optional
-     * - values.btCustomerId: bt customer id, optional
-     * - values.activationCampaign: activation campaign, optional
-     * - values.organizationId: organization id, optional
-     *  @returns {Promise<boolean>} True if the client was updated, false otherwise
-     */
-    updateClient(params: UpdateClientParams): Promise<boolean>;
-    /**
-     * Delete a client and its configurations
-     * @param  {DeleteClientParams} params containing information to delete a client
-     * - filters.clientId: The id of the client to delete
-     * @returns {Promise<boolean>} True if the client was deleted, false otherwise
-     */
-    deleteClientAndConfigurations(params: DeleteClientParams): Promise<boolean>;
-    /**
-     * Get a client configuration
-     * @param  {GetClientConfigurationParams} params containing information to get a client configuration
-     * - filters.clientId: The client id
-     */
-    getClientConfiguration(params: GetClientConfigurationParams): Promise<ClientConfiguration>;
-    /**
-     * Create a client configuration
-     * @param  {CreateClientConfigurationParams} params containing information to create a client configuration
-     * - clientId: The client id
-     * - movementTripThreshold: The movement trip threshold
-     * - stopTripThreshold: The stop trip threshold
-     * - mapUpdateMode: The map update mode
-     * - maxUsersAllowed: The max users allowed
-     * - ssoDomain: The sso domain, optional
-     * - ssoMetadata: The sso metadata, optional
-     */
-    createClientConfiguration(params: CreateClientConfigurationParams): Promise<ClientConfiguration>;
-    /**
-     * Update a client configuration
-     * @param  {UpdateClientConfigurationParams} params containing information to update a client configuration
-     * - filters.clientId: The client id
-     * - values.movementTripThreshold: The movement trip threshold, optional
-     * - values.stopTripThreshold: The stop trip threshold, optional
-     * - values.mapUpdateMode: The map update mode, optional
-     * - values.maxUsersAllowed: The max users allowed, optional
-     * - values.ssoDomain: The sso domain, optional
-     * - values.ssoMetadata: The sso metadata, optional
-     * @returns {Promise<boolean>} True if the client configuration was updated, false otherwise
-     */
-    updateClientConfiguration(params: UpdateClientConfigurationParams): Promise<boolean>;
-    /**
-     * Create a customer attribute for a client
-     * @param  {CreateCustomerAttributeParams} params containing information to create a customer attribute
-     * - clientId: The client id
-     * - enterprise: The enterprise, optional
-     * - maintenanceModule: The maintenance module, optional
-     */
-    createCustomerAttribute(params: CreateCustomerAttributeParams): Promise<CustomerAttribute>;
-    /**
-     * Update a customer attribute for a client
-     * @param  {UpdateCustomerAttributeParams} params containing information to update a customer attribute
-     * - filters.clientId: The client id
-     * - enterprise: The enterprise, optional
-     * - maintenanceModule: The maintenance module, optional
-     * @returns {Promise<boolean>} True if the customer attribute was updated, false otherwise
-     */
-    updateCustomerAttribute(params: UpdateCustomerAttributeParams): Promise<boolean>;
-    /**
-     * Get a costumer attribute for a client
-     * @param  {GetCustomerAttributeParams} params containing information to get a customer attribute
-     * - filters.clientId: The client id
-     */
-    getCustomerAttribute(params: GetCustomerAttributeParams): Promise<CustomerAttribute>;
-    /**
-     * Get client ingestor configurations
-     * @param params containing information to get client ingestor configurations
-     * @returns  {Promise<ClientIngestorConfiguration[]>} The client ingestor configurations
-     */
-    getClientIngestorConfigurations(params: GetClientIngestorConfigurationsParams): Promise<ClientIngestorConfiguration[]>;
-    /**
-     * Create a client ingestor configuration
-     * @param  {CreateClientIngestorConfigurationParams} params containing information to create a client ingestor configuration
-     * - clientId: The client id
-     * - userActivationId: The user activation id
-     * - tokenUrl: The token url
-     * - fleetUrl: The fleet url
-     * - requestBody: The request body
-     * @returns {Promise<ClientIngestorConfiguration>} The created client ingestor configuration
-     */
-    createClientIngestorConfiguration(params: CreateClientIngestorConfigurationParams): Promise<ClientIngestorConfiguration>;
-}
+import { Client, ClientConfiguration, ClientIngestorConfiguration } from '../../entities';
+import { CustomerAttribute } from '../../entities/customerAttribute';
+import { CreateClientConfigurationParams, CreateClientIngestorConfigurationParams, CreateClientParams, CreateCustomerAttributeParams, DeleteClientParams, GetClientConfigurationParams, GetClientIngestorConfigurationsParams, GetClientParams, GetClientsParams, GetCustomerAttributeParams, UpdateClientConfigurationParams, UpdateClientParams, UpdateCustomerAttributeParams } from '../../types/clients';
+import { BaseRepository } from '../baseRepository';
+export declare class ClientsRepository extends BaseRepository {
+    /**
+     * Get a client with filters. If multiple clients are found, the first one is returned.
+     * @param  {GetClientParams} params containing information to get a client
+     * - filters.clientId: The client id, optional
+     * - filters.email: The email, optional
+     */
+    getClient(params: GetClientParams): Promise<Client>;
+    /**
+     * Get clients with filters. If multiple clients are found, all are returned.
+     * @param  {GetClientsParams} params containing information to get clients
+     * - filters.email: The email filter
+     */
+    getClients(params: GetClientsParams): Promise<Client[]>;
+    /**
+     * Create client
+     * @param  {CreateClientParams} params containing information to create a client
+     * - name: client name
+     * - email: client email
+     * - uuid: client uuid
+     * - clientTypeId: client type id, optional
+     * - dataSourceTypeId: data source type id, optional
+     * - sievaUserName: sieva user name, optional
+     * - sievaBatchId: sieva batch id, optional
+     * - salesforceId: salesforce id, optional
+     * - accumaticaId: accumatica id, optional
+     * - expirationDate: expiration date, optional
+     * - useType: use type, optional
+     * - btCustomerId: bt customer id, optional
+     * - activationCampaign: activation campaign, optional
+     * - organizationId: organization id, optional
+     *  @returns {Promise<Client>} The created client
+     */
+    createClient(params: CreateClientParams): Promise<Client>;
+    /**
+     * Create client
+     * @param  {UpdateClientParams} params containing information to update a client
+     * - filters.clientId: The id of the client to update
+     * - values.name: client name, optional
+     * - values.email: client email, optional
+     * - values.uuid: client uuid, optional
+     * - values.clientTypeId: client type id, optional
+     * - values.dataSourceTypeId: data source type id, optional
+     * - values.sievaUserName: sieva user name, optional
+     * - values.sievaBatchId: sieva batch id, optional
+     * - values.salesforceId: salesforce id, optional
+     * - values.accumaticaId: accumatica id, optional
+     * - values.expirationDate: expiration date, optional
+     * - values.useType: use type, optional
+     * - values.btCustomerId: bt customer id, optional
+     * - values.activationCampaign: activation campaign, optional
+     * - values.organizationId: organization id, optional
+     *  @returns {Promise<boolean>} True if the client was updated, false otherwise
+     */
+    updateClient(params: UpdateClientParams): Promise<boolean>;
+    /**
+     * Delete a client and its configurations
+     * @param  {DeleteClientParams} params containing information to delete a client
+     * - filters.clientId: The id of the client to delete
+     * @returns {Promise<boolean>} True if the client was deleted, false otherwise
+     */
+    deleteClientAndConfigurations(params: DeleteClientParams): Promise<boolean>;
+    /**
+     * Get a client configuration
+     * @param  {GetClientConfigurationParams} params containing information to get a client configuration
+     * - filters.clientId: The client id
+     */
+    getClientConfiguration(params: GetClientConfigurationParams): Promise<ClientConfiguration>;
+    /**
+     * Create a client configuration
+     * @param  {CreateClientConfigurationParams} params containing information to create a client configuration
+     * - clientId: The client id
+     * - movementTripThreshold: The movement trip threshold
+     * - stopTripThreshold: The stop trip threshold
+     * - mapUpdateMode: The map update mode
+     * - maxUsersAllowed: The max users allowed
+     * - ssoDomain: The sso domain, optional
+     * - ssoMetadata: The sso metadata, optional
+     */
+    createClientConfiguration(params: CreateClientConfigurationParams): Promise<ClientConfiguration>;
+    /**
+     * Update a client configuration
+     * @param  {UpdateClientConfigurationParams} params containing information to update a client configuration
+     * - filters.clientId: The client id
+     * - values.movementTripThreshold: The movement trip threshold, optional
+     * - values.stopTripThreshold: The stop trip threshold, optional
+     * - values.mapUpdateMode: The map update mode, optional
+     * - values.maxUsersAllowed: The max users allowed, optional
+     * - values.ssoDomain: The sso domain, optional
+     * - values.ssoMetadata: The sso metadata, optional
+     * @returns {Promise<boolean>} True if the client configuration was updated, false otherwise
+     */
+    updateClientConfiguration(params: UpdateClientConfigurationParams): Promise<boolean>;
+    /**
+     * Create a customer attribute for a client
+     * @param  {CreateCustomerAttributeParams} params containing information to create a customer attribute
+     * - clientId: The client id
+     * - enterprise: The enterprise, optional
+     * - maintenanceModule: The maintenance module, optional
+     */
+    createCustomerAttribute(params: CreateCustomerAttributeParams): Promise<CustomerAttribute>;
+    /**
+     * Update a customer attribute for a client
+     * @param  {UpdateCustomerAttributeParams} params containing information to update a customer attribute
+     * - filters.clientId: The client id
+     * - enterprise: The enterprise, optional
+     * - maintenanceModule: The maintenance module, optional
+     * @returns {Promise<boolean>} True if the customer attribute was updated, false otherwise
+     */
+    updateCustomerAttribute(params: UpdateCustomerAttributeParams): Promise<boolean>;
+    /**
+     * Get a costumer attribute for a client
+     * @param  {GetCustomerAttributeParams} params containing information to get a customer attribute
+     * - filters.clientId: The client id
+     */
+    getCustomerAttribute(params: GetCustomerAttributeParams): Promise<CustomerAttribute>;
+    /**
+     * Get client ingestor configurations
+     * @param params containing information to get client ingestor configurations
+     * @returns  {Promise<ClientIngestorConfiguration[]>} The client ingestor configurations
+     */
+    getClientIngestorConfigurations(params: GetClientIngestorConfigurationsParams): Promise<ClientIngestorConfiguration[]>;
+    /**
+     * Create a client ingestor configuration
+     * @param  {CreateClientIngestorConfigurationParams} params containing information to create a client ingestor configuration
+     * - clientId: The client id
+     * - userActivationId: The user activation id
+     * - tokenUrl: The token url
+     * - fleetUrl: The fleet url
+     * - requestBody: The request body
+     * @returns {Promise<ClientIngestorConfiguration>} The created client ingestor configuration
+     */
+    createClientIngestorConfiguration(params: CreateClientIngestorConfigurationParams): Promise<ClientIngestorConfiguration>;
+}