@spytecgps/nova-orm 1.2.13 → 1.2.15-rc1

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

@@ -1,325 +1,325 @@
-import { DeviceTask, Task, TaskSchedule } from '../../entities';
-import { AddTaskScheduleDevicesParams, CompleteTaskParams, CreateTaskParams, CreateTaskScheduleParams, DeleteTaskParams, DeleteTaskScheduleDevicesParams, DeleteTaskScheduleParams, GetDeviceTasksParams, GetTaskScheduleParams, GetTaskSchedulesCountParams, GetTaskSchedulesParams, GetTasksCountParams, GetTasksParams, SetTaskAsPastDueParams, SetTaskScheduleDevicesParams, UpdateTaskParams, UpdateTaskScheduleParams } from '../../types/tasks';
-import { BaseRepository } from '../baseRepository';
-export declare class TasksRepository extends BaseRepository {
-    /**
-     * Create a new task schedule
-     * @param params params containing information to create task schedule
-     * params.id: the ID, optional. If not provided, a new ID will be generated
-     * params.clientId: the client ID, required
-     * params.title: the title, required
-     * params.description: the description, required
-     * params.repeats: whether the task repeats, required
-     * params.dueDate: the due date, optional
-     * params.dueOdometer: the due odometer, optional
-     * params.dueActiveHours: the due active hours, optional
-     * params.intervalDays: the interval days, optional
-     * params.intervalOdometer: the interval odometer, optional
-     * params.intervalActiveHours: the interval active hours, optional
-     * params.intervalStartDate: the interval start date, optional
-     * params.intervalStartingOdometer: the interval starting odometer, optional
-     * params.intervalStartingActiveHours: the interval starting active hours, optional
-     * params.notes: the notes, optional
-     * params.createdBy: the created by, required
-     * @returns Promise<TaskSchedule> the created task schedule
-     */
-    createTaskSchedule(params: CreateTaskScheduleParams): Promise<TaskSchedule>;
-    /**
-     * Get a task schedule
-     * @param params params containing information to get task schedule
-     * params.filters.id: the ID, required
-     * @returns Promise<TaskSchedule> the task schedule
-     */
-    getTaskSchedule(params: GetTaskScheduleParams): Promise<TaskSchedule>;
-    /**
-     * Update an existing task schedule
-     * @param params params containing information to update task schedule
-     * params.filters.id: the ID, required
-     * params.values.clientId: the client ID, optional
-     * params.values.title: the title, optional
-     * params.values.description: the description, optional
-     * params.values.repeats: whether the task repeats, optional
-     * params.values.dueDate: the due date, optional
-     * params.values.dueOdometer: the due odometer, optional
-     * params.values.dueActiveHours: the due active hours, optional
-     * params.values.intervalDays: the interval days, optional
-     * params.values.intervalOdometer: the interval odometer, optional
-     * params.values.intervalActiveHours: the interval active hours, optional
-     * params.values.intervalStartDate: the interval start date, optional
-     * params.values.intervalStartingOdometer: the interval starting odometer, optional
-     * params.values.intervalStartingActiveHours: the interval starting active hours, optional
-     * params.values.notes: the notes, optional
-     * params.values.modifiedBy: the modified by, required
-     * @returns Promise<boolean> whether the task schedule was updated
-     */
-    updateTaskSchedule(params: UpdateTaskScheduleParams): Promise<boolean>;
-    /**
-     * Delete an existing task schedule
-     * @param params params containing information to delete task schedule
-     * params.id: the ID, required
-     * params.deletedBy: the user performing the delete action, required
-     * @returns Promise<boolean> whether the task schedule was deleted
-     */
-    deleteTaskSchedule(params: DeleteTaskScheduleParams): Promise<boolean>;
-    /**
-     * Get task schedules with filters
-     * @param params params containing information to get task schedules
-     * At least one of the following filters is required:
-     * params.filters.imei: the IMEI, if provided, will return task schedules associated to the device
-     * params.filters.clientId: the client ID
-     * params.filters.title: the title for partial match search
-     * params.filters.description: the description for partial match search
-     * params.filters.repeats: filter for tasks that repeat or not
-     * params.filters.minDueDate: the minimum due date
-     * params.filters.maxDueDate: the maximum due date
-     * params.filters.minDueOdometer: the minimum due odometer
-     * params.filters.maxDueOdometer: the maximum due odometer
-     * params.filters.minDueActiveHours: the minimum due active hours
-     * params.filters.maxDueActiveHours: the maximum due active hours
-     * params.filters.minIntervalDays: the minimum interval days
-     * params.filters.maxIntervalDays: the maximum interval days
-     * params.filters.minIntervalStartDate: the minimum interval start date
-     * params.filters.maxIntervalStartDate: the maximum interval start date
-     * params.filters.minIntervalOdometer: the minimum interval odometer
-     * params.filters.maxIntervalOdometer: the maximum interval odometer
-     * params.filters.minIntervalActiveHours: the minimum interval active hours
-     * params.filters.maxIntervalActiveHours: the maximum interval active hours
-     * params.filters.minIntervalStartingOdometer: the minimum interval starting odometer
-     * params.filters.maxIntervalStartingOdometer: the maximum interval starting odometer
-     * params.filters.minIntervalStartingActiveHours: the minimum interval starting active hours
-     * params.filters.maxIntervalStartingActiveHours: the maximum interval starting active hours
-     * params.filters.notes: the notes for partial match search
-     * params.filters.createdBy: the created by, exact match search
-     * params.filters.minCreatedAt: the minimum created at
-     * params.filters.maxCreatedAt: the maximum created at
-     * params.filters.modifiedBy: the modified by, exact match search
-     * params.filters.minModifiedAt: the minimum modified at
-     * params.filters.maxModifiedAt: the maximum modified at
-     * params.filters.deletedBy: the deleted by, exact match search
-     * params.filters.minDeletedAt: the minimum deleted at
-     * params.filters.maxDeletedAt: the maximum deleted at
-     * params.filters.status: the status (active or deleted)
-     * params.projectionOptions:
-     * - numberOfDevicesToGet: the number of devices to get for each task schedule. By default, no device is returned.
-     * params.sortOptions:
-     * - sortField: field to order by
-     * - sortDirection: order direction (asc or desc)
-     * params.pagingOptions:
-     * - pageSize: the page size
-     * - pageIndex: the page index
-     * @returns Promise<TaskSchedule[]> the task schedules corresponding to the filters
-     */
-    getTaskSchedules(params: GetTaskSchedulesParams): Promise<TaskSchedule[]>;
-    /**
-     * Get the count of task schedules with filters
-     * @param params params containing information to get task schedules count
-     * At least one of the following filters is required:
-     * params.filters.imei: the IMEI, if provided, will return task schedules associated to the device
-     * params.filters.clientId: the client ID
-     * params.filters.title: the title for partial match search
-     * params.filters.description: the description for partial match search
-     * params.filters.repeats: filter for tasks that repeat or not
-     * params.filters.minDueDate: the minimum due date
-     * params.filters.maxDueDate: the maximum due date
-     * params.filters.minDueOdometer: the minimum due odometer
-     * params.filters.maxDueOdometer: the maximum due odometer
-     * params.filters.minDueActiveHours: the minimum due active hours
-     * params.filters.maxDueActiveHours: the maximum due active hours
-     * params.filters.minIntervalDays: the minimum interval days
-     * params.filters.maxIntervalDays: the maximum interval days
-     * params.filters.minIntervalStartDate: the minimum interval start date
-     * params.filters.maxIntervalStartDate: the maximum interval start date
-     * params.filters.minIntervalOdometer: the minimum interval odometer
-     * params.filters.maxIntervalOdometer: the maximum interval odometer
-     * params.filters.minIntervalActiveHours: the minimum interval active hours
-     * params.filters.maxIntervalActiveHours: the maximum interval active hours
-     * params.filters.minIntervalStartingOdometer: the minimum interval starting odometer
-     * params.filters.maxIntervalStartingOdometer: the maximum interval starting odometer
-     * params.filters.minIntervalStartingActiveHours: the minimum interval starting active hours
-     * params.filters.maxIntervalStartingActiveHours: the maximum interval starting active hours
-     * params.filters.notes: the notes for partial match search
-     * params.filters.createdBy: the created by, exact match search
-     * params.filters.minCreatedAt: the minimum created at
-     * params.filters.maxCreatedAt: the maximum created at
-     * params.filters.modifiedBy: the modified by, exact match search
-     * params.filters.minModifiedAt: the minimum modified at
-     * params.filters.maxModifiedAt: the maximum modified at
-     * params.filters.deletedBy: the deleted by, exact match search
-     * params.filters.minDeletedAt: the minimum deleted at
-     * params.filters.maxDeletedAt: the maximum deleted at
-     * params.filters.status: the status (active or deleted)
-     * @returns Promise<number> the count of task schedules corresponding to the filters
-     */
-    getTaskSchedulesCount(params: GetTaskSchedulesCountParams): Promise<number>;
-    /**
-     * Get device tasks
-     * @param params params containing information to get device tasks
-     * At least one of the following filters is required:
-     * params.filters.taskScheduleId: the task schedule ID
-     * params.filters.imei: the IMEI
-     * params.filters.clientId: the client ID
-     * @returns Promise<DeviceTask[]> the device tasks corresponding to the filters
-     */
-    getDeviceTasks(params: GetDeviceTasksParams): Promise<DeviceTask[]>;
-    /**
-     * Sets the imeis associated with a task schedule.
-     * This operation replaces all the existing records associated with the taskScheduleId, with the supplied imeis.
-     * @param params params containing information to set task schedule devices
-     * params.taskScheduleId: the task schedule ID, required.
-     * params.imeis: the IMEIs, optional. If not provided, all the existing records associated with the taskScheduleId will be deleted.
-     * @returns Promise<boolean> whether the task schedule devices were set
-     * If the task schedule does not exist, the function will return false
-     */
-    setTaskScheduleDevices(params: SetTaskScheduleDevicesParams): Promise<boolean>;
-    /**
-     * Adds the supplied imeis to the DeviceTask table, associated with a task schedule id.
-     * This operation adds the imeis if they do not exist and does not remove or modifies other records.
-     * @param params params containing information to add task schedule devices
-     * params.taskScheduleId: the task schedule ID, required.
-     * params.imeis: the IMEIs, required.
-     * @returns Promise<boolean> whether the task schedule devices were added
-     * If the task schedule does not exist, the function will return false
-     */
-    addTaskScheduleDevices(params: AddTaskScheduleDevicesParams): Promise<boolean>;
-    /**
-     * Deletes the supplied imeis from the DeviceTask table, associated with a task schedule id.
-     * This operation deletes the imeis if they exist and does not remove or modifies other records.
-     * @param params params containing information to delete task schedule devices
-     * params.taskScheduleId: the task schedule ID, required.
-     * params.imeis: the IMEIs, required.
-     * @returns Promise<boolean> whether the task schedule devices were deleted
-     */
-    deleteTaskScheduleDevices(params: DeleteTaskScheduleDevicesParams): Promise<boolean>;
-    /**
-     * Create a new task
-     * @param params params containing information to create task
-     * params.id: the ID, optional. If not provided, a new ID will be generated
-     * params.taskScheduleId: the task schedule ID, required
-     * params.imei: the IMEI, required
-     * params.clientId: the client ID, required
-     * params.startDate: the starting date, optional
-     * params.startingOdometer: the starting odometer, optional
-     * params.startingActiveHours: the starting active hours, optional
-     * One of the following is required:
-     * params.dueDate: the due date, required
-     * params.dueOdometer: the due odometer, required
-     * params.dueActiveHours: the due active hours, required
-     * @returns Promise<Task> the created task
-     */
-    createTask(params: CreateTaskParams): Promise<Task>;
-    /**
-     * Get tasks with filters
-     * @param params params containing information to get tasks
-     * At least one of the following filters is required:
-     * params.filters.taskId: the task ID
-     * params.filters.taskScheduleId: the task schedule ID
-     * params.filters.imei: the IMEI
-     * params.filters.clientId: the client ID
-     * params.filters.dueDateFilter: the due date range filter
-     * params.filters.dueOdometerFilter: the due odometer range filter
-     * params.filters.dueActiveHoursFilter: the due active hours range filter
-     * params.filters.startDateFilter: the start date range filter
-     * params.filters.startingOdometerFilter: the starting odometer range filter
-     * params.filters.startingActiveHoursFilter: the starting active hours range filter
-     * params.filters.status: the status (pending, past_due, completed, deleted)
-     * params.filters.pastDueAtFilter: the past due at range filter
-     * params.filters.createdAtFilter: the created at range filter
-     * params.filters.completedAtFilter: the completed at range filter
-     * params.filters.completionNotes: the completion notes for partial match search
-     * params.filters.completionOdometerFilter: the completion odometer range filter
-     * params.filters.completionActiveHoursFilter: the completion active hours range filter
-     * params.filters.completedBy: the completed by, partial match search
-     * params.filters.modifiedBy: the modified by, partial match search
-     * params.filters.modifiedAtFilter: the modified at range filter
-     * params.filters.queuedAtFilter: the queued at range filter
-     * params.filters.predictedDueDateFilter: the predicted due date range filter
-     * params.filters.deletedAtFilter: the deleted at range filter
-     * params.filters.deletedBy: the deleted by, partial match search
-     * params.sortOptions:
-     * - sortField: field to order by
-     * - sortDirection: order direction (asc or desc)
-     * params.pagingOptions:
-     * - pageSize: the page size
-     * - pageIndex: the page index
-     * @returns Promise<Task[]> the tasks corresponding to the filters
-     */
-    getTasks(params: GetTasksParams): Promise<Task[]>;
-    /**
-     * Get the count of tasks with filters
-     * @param params params containing information to get tasks count
-     * At least one of the following filters is required:
-     * params.filters.taskId: the task ID
-     * params.filters.taskScheduleId: the task schedule ID
-     * params.filters.imei: the IMEI
-     * params.filters.clientId: the client ID
-     * params.filters.dueDateFilter: the due date range filter
-     * params.filters.dueOdometerFilter: the due odometer range filter
-     * params.filters.dueActiveHoursFilter: the due active hours range filter
-     * params.filters.startDateFilter: the start date range filter
-     * params.filters.startingOdometerFilter: the starting odometer range filter
-     * params.filters.startingActiveHoursFilter: the starting active hours range filter
-     * params.filters.status: the status (pending, past_due, completed, deleted)
-     * params.filters.pastDueAtFilter: the past due at range filter
-     * params.filters.createdAtFilter: the created at range filter
-     * params.filters.completedAtFilter: the completed at range filter
-     * params.filters.completionNotes: the completion notes for partial match search
-     * params.filters.completionOdometerFilter: the completion odometer range filter
-     * params.filters.completionActiveHoursFilter: the completion active hours range filter
-     * params.filters.completedBy: the completed by, partial match search
-     * params.filters.modifiedBy: the modified by, partial match search
-     * params.filters.modifiedAtFilter: the modified at range filter
-     * params.filters.queuedAtFilter: the queued at range filter
-     * params.filters.predictedDueDateFilter: the predicted due date range filter
-     * params.filters.deletedAtFilter: the deleted at range filter
-     * params.filters.deletedBy: the deleted by, partial match search
-     * @returns Promise<number> the count of tasks corresponding to the filters
-     */
-    getTasksCount(params: GetTasksCountParams): Promise<number>;
-    /**
-     * Update an existing task
-     * @param params params containing information to update task
-     * params.filters.id: the ID, required
-     * params.values.modifiedBy: the modified by, required
-     * One of dueDate, dueOdometer, or dueActiveHours is required:
-     * params.values.dueDate: the due date, optional
-     * params.values.dueOdometer: the due odometer, optional
-     * params.values.dueActiveHours: the due active hours, optional
-     * params.values.startDate: the starting date, optional
-     * params.values.startingOdometer: the starting odometer, optional
-     * params.values.startingActiveHours: the starting active hours, optional
-     * params.values.predictedDueDate: the predicted due date, optional
-     * params.values.queuedAt: the queued at, optional
-     * @returns Promise<boolean> whether the task was updated
-     */
-    updateTask(params: UpdateTaskParams): Promise<boolean>;
-    /**
-     * Set a task as past due
-     * @param params params containing information to set task as past due
-     * params.id: the task ID, required
-     * params.pastDueAt: the past due at, optional. If not provided, the current date will be used
-     * params.modifiedBy: the modified by, required
-     * @returns Promise<boolean> whether the task was set as past due
-     */
-    setTaskAsPastDue(params: SetTaskAsPastDueParams): Promise<boolean>;
-    /**
-     * Complete a task
-     * @param params params containing information to complete task
-     * params.id: the ID, required
-     * params.completedBy: the completed by, required
-     * params.completionNotes: the completion notes, optional
-     * params.completionOdometer: the completion odometer, optional
-     * params.completionActiveHours: the completion active hours, optional
-     * params.completionMetadata: the completion metadata, optional
-     * params.includeTimeInCompletedAt: whether to include time in completed at, optional. Default is false
-     * @returns Promise<boolean> whether the task was completed
-     */
-    completeTask(params: CompleteTaskParams): Promise<boolean>;
-    /**
-     * Delete an existing task
-     * @param params params containing information to delete task
-     * params.id: the ID, required
-     * params.deletedBy: the user performing the delete action, required
-     * @returns Promise<boolean> whether the task was deleted
-     */
-    deleteTask(params: DeleteTaskParams): Promise<boolean>;
-}
+import { DeviceTask, Task, TaskSchedule } from '../../entities';
+import { AddTaskScheduleDevicesParams, CompleteTaskParams, CreateTaskParams, CreateTaskScheduleParams, DeleteTaskParams, DeleteTaskScheduleDevicesParams, DeleteTaskScheduleParams, GetDeviceTasksParams, GetTaskScheduleParams, GetTaskSchedulesCountParams, GetTaskSchedulesParams, GetTasksCountParams, GetTasksParams, SetTaskAsPastDueParams, SetTaskScheduleDevicesParams, UpdateTaskParams, UpdateTaskScheduleParams } from '../../types/tasks';
+import { BaseRepository } from '../baseRepository';
+export declare class TasksRepository extends BaseRepository {
+    /**
+     * Create a new task schedule
+     * @param params params containing information to create task schedule
+     * params.id: the ID, optional. If not provided, a new ID will be generated
+     * params.clientId: the client ID, required
+     * params.title: the title, required
+     * params.description: the description, required
+     * params.repeats: whether the task repeats, required
+     * params.dueDate: the due date, optional
+     * params.dueOdometer: the due odometer, optional
+     * params.dueActiveHours: the due active hours, optional
+     * params.intervalDays: the interval days, optional
+     * params.intervalOdometer: the interval odometer, optional
+     * params.intervalActiveHours: the interval active hours, optional
+     * params.intervalStartDate: the interval start date, optional
+     * params.intervalStartingOdometer: the interval starting odometer, optional
+     * params.intervalStartingActiveHours: the interval starting active hours, optional
+     * params.notes: the notes, optional
+     * params.createdBy: the created by, required
+     * @returns Promise<TaskSchedule> the created task schedule
+     */
+    createTaskSchedule(params: CreateTaskScheduleParams): Promise<TaskSchedule>;
+    /**
+     * Get a task schedule
+     * @param params params containing information to get task schedule
+     * params.filters.id: the ID, required
+     * @returns Promise<TaskSchedule> the task schedule
+     */
+    getTaskSchedule(params: GetTaskScheduleParams): Promise<TaskSchedule>;
+    /**
+     * Update an existing task schedule
+     * @param params params containing information to update task schedule
+     * params.filters.id: the ID, required
+     * params.values.clientId: the client ID, optional
+     * params.values.title: the title, optional
+     * params.values.description: the description, optional
+     * params.values.repeats: whether the task repeats, optional
+     * params.values.dueDate: the due date, optional
+     * params.values.dueOdometer: the due odometer, optional
+     * params.values.dueActiveHours: the due active hours, optional
+     * params.values.intervalDays: the interval days, optional
+     * params.values.intervalOdometer: the interval odometer, optional
+     * params.values.intervalActiveHours: the interval active hours, optional
+     * params.values.intervalStartDate: the interval start date, optional
+     * params.values.intervalStartingOdometer: the interval starting odometer, optional
+     * params.values.intervalStartingActiveHours: the interval starting active hours, optional
+     * params.values.notes: the notes, optional
+     * params.values.modifiedBy: the modified by, required
+     * @returns Promise<boolean> whether the task schedule was updated
+     */
+    updateTaskSchedule(params: UpdateTaskScheduleParams): Promise<boolean>;
+    /**
+     * Delete an existing task schedule
+     * @param params params containing information to delete task schedule
+     * params.id: the ID, required
+     * params.deletedBy: the user performing the delete action, required
+     * @returns Promise<boolean> whether the task schedule was deleted
+     */
+    deleteTaskSchedule(params: DeleteTaskScheduleParams): Promise<boolean>;
+    /**
+     * Get task schedules with filters
+     * @param params params containing information to get task schedules
+     * At least one of the following filters is required:
+     * params.filters.imei: the IMEI, if provided, will return task schedules associated to the device
+     * params.filters.clientId: the client ID
+     * params.filters.title: the title for partial match search
+     * params.filters.description: the description for partial match search
+     * params.filters.repeats: filter for tasks that repeat or not
+     * params.filters.minDueDate: the minimum due date
+     * params.filters.maxDueDate: the maximum due date
+     * params.filters.minDueOdometer: the minimum due odometer
+     * params.filters.maxDueOdometer: the maximum due odometer
+     * params.filters.minDueActiveHours: the minimum due active hours
+     * params.filters.maxDueActiveHours: the maximum due active hours
+     * params.filters.minIntervalDays: the minimum interval days
+     * params.filters.maxIntervalDays: the maximum interval days
+     * params.filters.minIntervalStartDate: the minimum interval start date
+     * params.filters.maxIntervalStartDate: the maximum interval start date
+     * params.filters.minIntervalOdometer: the minimum interval odometer
+     * params.filters.maxIntervalOdometer: the maximum interval odometer
+     * params.filters.minIntervalActiveHours: the minimum interval active hours
+     * params.filters.maxIntervalActiveHours: the maximum interval active hours
+     * params.filters.minIntervalStartingOdometer: the minimum interval starting odometer
+     * params.filters.maxIntervalStartingOdometer: the maximum interval starting odometer
+     * params.filters.minIntervalStartingActiveHours: the minimum interval starting active hours
+     * params.filters.maxIntervalStartingActiveHours: the maximum interval starting active hours
+     * params.filters.notes: the notes for partial match search
+     * params.filters.createdBy: the created by, exact match search
+     * params.filters.minCreatedAt: the minimum created at
+     * params.filters.maxCreatedAt: the maximum created at
+     * params.filters.modifiedBy: the modified by, exact match search
+     * params.filters.minModifiedAt: the minimum modified at
+     * params.filters.maxModifiedAt: the maximum modified at
+     * params.filters.deletedBy: the deleted by, exact match search
+     * params.filters.minDeletedAt: the minimum deleted at
+     * params.filters.maxDeletedAt: the maximum deleted at
+     * params.filters.status: the status (active or deleted)
+     * params.projectionOptions:
+     * - numberOfDevicesToGet: the number of devices to get for each task schedule. By default, no device is returned.
+     * params.sortOptions:
+     * - sortField: field to order by
+     * - sortDirection: order direction (asc or desc)
+     * params.pagingOptions:
+     * - pageSize: the page size
+     * - pageIndex: the page index
+     * @returns Promise<TaskSchedule[]> the task schedules corresponding to the filters
+     */
+    getTaskSchedules(params: GetTaskSchedulesParams): Promise<TaskSchedule[]>;
+    /**
+     * Get the count of task schedules with filters
+     * @param params params containing information to get task schedules count
+     * At least one of the following filters is required:
+     * params.filters.imei: the IMEI, if provided, will return task schedules associated to the device
+     * params.filters.clientId: the client ID
+     * params.filters.title: the title for partial match search
+     * params.filters.description: the description for partial match search
+     * params.filters.repeats: filter for tasks that repeat or not
+     * params.filters.minDueDate: the minimum due date
+     * params.filters.maxDueDate: the maximum due date
+     * params.filters.minDueOdometer: the minimum due odometer
+     * params.filters.maxDueOdometer: the maximum due odometer
+     * params.filters.minDueActiveHours: the minimum due active hours
+     * params.filters.maxDueActiveHours: the maximum due active hours
+     * params.filters.minIntervalDays: the minimum interval days
+     * params.filters.maxIntervalDays: the maximum interval days
+     * params.filters.minIntervalStartDate: the minimum interval start date
+     * params.filters.maxIntervalStartDate: the maximum interval start date
+     * params.filters.minIntervalOdometer: the minimum interval odometer
+     * params.filters.maxIntervalOdometer: the maximum interval odometer
+     * params.filters.minIntervalActiveHours: the minimum interval active hours
+     * params.filters.maxIntervalActiveHours: the maximum interval active hours
+     * params.filters.minIntervalStartingOdometer: the minimum interval starting odometer
+     * params.filters.maxIntervalStartingOdometer: the maximum interval starting odometer
+     * params.filters.minIntervalStartingActiveHours: the minimum interval starting active hours
+     * params.filters.maxIntervalStartingActiveHours: the maximum interval starting active hours
+     * params.filters.notes: the notes for partial match search
+     * params.filters.createdBy: the created by, exact match search
+     * params.filters.minCreatedAt: the minimum created at
+     * params.filters.maxCreatedAt: the maximum created at
+     * params.filters.modifiedBy: the modified by, exact match search
+     * params.filters.minModifiedAt: the minimum modified at
+     * params.filters.maxModifiedAt: the maximum modified at
+     * params.filters.deletedBy: the deleted by, exact match search
+     * params.filters.minDeletedAt: the minimum deleted at
+     * params.filters.maxDeletedAt: the maximum deleted at
+     * params.filters.status: the status (active or deleted)
+     * @returns Promise<number> the count of task schedules corresponding to the filters
+     */
+    getTaskSchedulesCount(params: GetTaskSchedulesCountParams): Promise<number>;
+    /**
+     * Get device tasks
+     * @param params params containing information to get device tasks
+     * At least one of the following filters is required:
+     * params.filters.taskScheduleId: the task schedule ID
+     * params.filters.imei: the IMEI
+     * params.filters.clientId: the client ID
+     * @returns Promise<DeviceTask[]> the device tasks corresponding to the filters
+     */
+    getDeviceTasks(params: GetDeviceTasksParams): Promise<DeviceTask[]>;
+    /**
+     * Sets the imeis associated with a task schedule.
+     * This operation replaces all the existing records associated with the taskScheduleId, with the supplied imeis.
+     * @param params params containing information to set task schedule devices
+     * params.taskScheduleId: the task schedule ID, required.
+     * params.imeis: the IMEIs, optional. If not provided, all the existing records associated with the taskScheduleId will be deleted.
+     * @returns Promise<boolean> whether the task schedule devices were set
+     * If the task schedule does not exist, the function will return false
+     */
+    setTaskScheduleDevices(params: SetTaskScheduleDevicesParams): Promise<boolean>;
+    /**
+     * Adds the supplied imeis to the DeviceTask table, associated with a task schedule id.
+     * This operation adds the imeis if they do not exist and does not remove or modifies other records.
+     * @param params params containing information to add task schedule devices
+     * params.taskScheduleId: the task schedule ID, required.
+     * params.imeis: the IMEIs, required.
+     * @returns Promise<boolean> whether the task schedule devices were added
+     * If the task schedule does not exist, the function will return false
+     */
+    addTaskScheduleDevices(params: AddTaskScheduleDevicesParams): Promise<boolean>;
+    /**
+     * Deletes the supplied imeis from the DeviceTask table, associated with a task schedule id.
+     * This operation deletes the imeis if they exist and does not remove or modifies other records.
+     * @param params params containing information to delete task schedule devices
+     * params.taskScheduleId: the task schedule ID, required.
+     * params.imeis: the IMEIs, required.
+     * @returns Promise<boolean> whether the task schedule devices were deleted
+     */
+    deleteTaskScheduleDevices(params: DeleteTaskScheduleDevicesParams): Promise<boolean>;
+    /**
+     * Create a new task
+     * @param params params containing information to create task
+     * params.id: the ID, optional. If not provided, a new ID will be generated
+     * params.taskScheduleId: the task schedule ID, required
+     * params.imei: the IMEI, required
+     * params.clientId: the client ID, required
+     * params.startDate: the starting date, optional
+     * params.startingOdometer: the starting odometer, optional
+     * params.startingActiveHours: the starting active hours, optional
+     * One of the following is required:
+     * params.dueDate: the due date, required
+     * params.dueOdometer: the due odometer, required
+     * params.dueActiveHours: the due active hours, required
+     * @returns Promise<Task> the created task
+     */
+    createTask(params: CreateTaskParams): Promise<Task>;
+    /**
+     * Get tasks with filters
+     * @param params params containing information to get tasks
+     * At least one of the following filters is required:
+     * params.filters.taskId: the task ID
+     * params.filters.taskScheduleId: the task schedule ID
+     * params.filters.imei: the IMEI
+     * params.filters.clientId: the client ID
+     * params.filters.dueDateFilter: the due date range filter
+     * params.filters.dueOdometerFilter: the due odometer range filter
+     * params.filters.dueActiveHoursFilter: the due active hours range filter
+     * params.filters.startDateFilter: the start date range filter
+     * params.filters.startingOdometerFilter: the starting odometer range filter
+     * params.filters.startingActiveHoursFilter: the starting active hours range filter
+     * params.filters.status: the status (pending, past_due, completed, deleted)
+     * params.filters.pastDueAtFilter: the past due at range filter
+     * params.filters.createdAtFilter: the created at range filter
+     * params.filters.completedAtFilter: the completed at range filter
+     * params.filters.completionNotes: the completion notes for partial match search
+     * params.filters.completionOdometerFilter: the completion odometer range filter
+     * params.filters.completionActiveHoursFilter: the completion active hours range filter
+     * params.filters.completedBy: the completed by, partial match search
+     * params.filters.modifiedBy: the modified by, partial match search
+     * params.filters.modifiedAtFilter: the modified at range filter
+     * params.filters.queuedAtFilter: the queued at range filter
+     * params.filters.predictedDueDateFilter: the predicted due date range filter
+     * params.filters.deletedAtFilter: the deleted at range filter
+     * params.filters.deletedBy: the deleted by, partial match search
+     * params.sortOptions:
+     * - sortField: field to order by
+     * - sortDirection: order direction (asc or desc)
+     * params.pagingOptions:
+     * - pageSize: the page size
+     * - pageIndex: the page index
+     * @returns Promise<Task[]> the tasks corresponding to the filters
+     */
+    getTasks(params: GetTasksParams): Promise<Task[]>;
+    /**
+     * Get the count of tasks with filters
+     * @param params params containing information to get tasks count
+     * At least one of the following filters is required:
+     * params.filters.taskId: the task ID
+     * params.filters.taskScheduleId: the task schedule ID
+     * params.filters.imei: the IMEI
+     * params.filters.clientId: the client ID
+     * params.filters.dueDateFilter: the due date range filter
+     * params.filters.dueOdometerFilter: the due odometer range filter
+     * params.filters.dueActiveHoursFilter: the due active hours range filter
+     * params.filters.startDateFilter: the start date range filter
+     * params.filters.startingOdometerFilter: the starting odometer range filter
+     * params.filters.startingActiveHoursFilter: the starting active hours range filter
+     * params.filters.status: the status (pending, past_due, completed, deleted)
+     * params.filters.pastDueAtFilter: the past due at range filter
+     * params.filters.createdAtFilter: the created at range filter
+     * params.filters.completedAtFilter: the completed at range filter
+     * params.filters.completionNotes: the completion notes for partial match search
+     * params.filters.completionOdometerFilter: the completion odometer range filter
+     * params.filters.completionActiveHoursFilter: the completion active hours range filter
+     * params.filters.completedBy: the completed by, partial match search
+     * params.filters.modifiedBy: the modified by, partial match search
+     * params.filters.modifiedAtFilter: the modified at range filter
+     * params.filters.queuedAtFilter: the queued at range filter
+     * params.filters.predictedDueDateFilter: the predicted due date range filter
+     * params.filters.deletedAtFilter: the deleted at range filter
+     * params.filters.deletedBy: the deleted by, partial match search
+     * @returns Promise<number> the count of tasks corresponding to the filters
+     */
+    getTasksCount(params: GetTasksCountParams): Promise<number>;
+    /**
+     * Update an existing task
+     * @param params params containing information to update task
+     * params.filters.id: the ID, required
+     * params.values.modifiedBy: the modified by, required
+     * One of dueDate, dueOdometer, or dueActiveHours is required:
+     * params.values.dueDate: the due date, optional
+     * params.values.dueOdometer: the due odometer, optional
+     * params.values.dueActiveHours: the due active hours, optional
+     * params.values.startDate: the starting date, optional
+     * params.values.startingOdometer: the starting odometer, optional
+     * params.values.startingActiveHours: the starting active hours, optional
+     * params.values.predictedDueDate: the predicted due date, optional
+     * params.values.queuedAt: the queued at, optional
+     * @returns Promise<boolean> whether the task was updated
+     */
+    updateTask(params: UpdateTaskParams): Promise<boolean>;
+    /**
+     * Set a task as past due
+     * @param params params containing information to set task as past due
+     * params.id: the task ID, required
+     * params.pastDueAt: the past due at, optional. If not provided, the current date will be used
+     * params.modifiedBy: the modified by, required
+     * @returns Promise<boolean> whether the task was set as past due
+     */
+    setTaskAsPastDue(params: SetTaskAsPastDueParams): Promise<boolean>;
+    /**
+     * Complete a task
+     * @param params params containing information to complete task
+     * params.id: the ID, required
+     * params.completedBy: the completed by, required
+     * params.completionNotes: the completion notes, optional
+     * params.completionOdometer: the completion odometer, optional
+     * params.completionActiveHours: the completion active hours, optional
+     * params.completionMetadata: the completion metadata, optional
+     * params.includeTimeInCompletedAt: whether to include time in completed at, optional. Default is false
+     * @returns Promise<boolean> whether the task was completed
+     */
+    completeTask(params: CompleteTaskParams): Promise<boolean>;
+    /**
+     * Delete an existing task
+     * @param params params containing information to delete task
+     * params.id: the ID, required
+     * params.deletedBy: the user performing the delete action, required
+     * @returns Promise<boolean> whether the task was deleted
+     */
+    deleteTask(params: DeleteTaskParams): Promise<boolean>;
+}