import { BaseClient, RequestOptions } from './base-client'; import { TripResponse, TelemetryListResponse, EventListResponse, TripListResponse, TripLabelRequest, LogResponse, CompletedReportResponse, CompletedReportListResponse, CompletedReportUpdateRequest, CompletedReportDataRequest, CompletedReportRequest } from './model'; /** * Welcome to the Key Telematics Fleet API specification. This document outlines the REST routes and data structures returned by the API and offers examples of usage. The API publishes a [swagger](https://swagger.io/) specification that can be used to [generate a client library](https://github.com/swagger-api/swagger-codegen) for your language of choice. The latest swagger file is available for download from the following link: [https://api.eu1.kt1.io/fleet/v2/swagger.json](https://api.eu1.kt1.io/fleet/v2/swagger.json) * @class HistoryClient * @param {(string)} [url] - The URL of the API endpoint. */ export declare class HistoryClient extends BaseClient { /** * Retrieve telemetry records between two dates. * @method * @name HistoryClient#getTelemetryHistory * @param {string} id - The asset id you are requesting data for * @param {string} start - The start date (in ISO format) * @param {string} end - The end date (in ISO format) * @param {number} limit - Limit the number of results to this value. */ getTelemetryHistory(id: string, start: string, end: string, limit?: number, $options?: RequestOptions): Promise; /** * Retrieve event records between two dates. * @method * @name HistoryClient#getEventHistory * @param {string} id - The asset id you are requesting data for * @param {string} start - The start date (in ISO format) * @param {string} end - The end date (in ISO format) * @param {number} limit - Limit the number of results to this value. */ getEventHistory(id: string, start: string, end: string, limit?: number, $options?: RequestOptions): Promise; /** * Retrieve alert records between two dates. * @method * @name HistoryClient#getAlertHistory * @param {string} id - The client, alert or asset id you are requesting data for * @param {string} start - The start date (in ISO format) * @param {string} end - The end date (in ISO format) * @param {number} limit - Limit the number of results to this value. */ getAlertHistory(id: string, start: string, end: string, limit?: number, $options?: RequestOptions): Promise; /** * Retrieve trip records between two dates. * @method * @name HistoryClient#getTripHistory * @param {string} id - The asset id you are requesting data for * @param {string} start - The start date (in ISO format) * @param {string} end - The end date (in ISO format) * @param {string} date - Use the date parameter to find the specific trip that contains this date (start and end are ignored) * @param {number} limit - Limit the number of results to this value. */ getTripHistory(id: string, start?: string, end?: string, date?: string, limit?: number, $options?: RequestOptions): Promise; /** * Adds one or more labels to a trip. * @method * @name HistoryClient#addTripLabels * @param {string} asset - The asset id for the trip * @param {string} date - The trip start date (in ISO format) * @param {object} request - Welcome to the Key Telematics Fleet API specification. This document outlines the REST routes and data structures returned by the API and offers examples of usage. The API publishes a [swagger](https://swagger.io/) specification that can be used to [generate a client library](https://github.com/swagger-api/swagger-codegen) for your language of choice. The latest swagger file is available for download from the following link: [https://api.eu1.kt1.io/fleet/v2/swagger.json](https://api.eu1.kt1.io/fleet/v2/swagger.json) */ addTripLabels(asset: string, date: string, request: TripLabelRequest, $options?: RequestOptions): Promise; /** * Adds one or more labels to a trip. * @method * @name HistoryClient#removeTripLabels * @param {string} asset - The asset id for the trip * @param {string} date - The trip start date (in ISO format) * @param {object} request - Welcome to the Key Telematics Fleet API specification. This document outlines the REST routes and data structures returned by the API and offers examples of usage. The API publishes a [swagger](https://swagger.io/) specification that can be used to [generate a client library](https://github.com/swagger-api/swagger-codegen) for your language of choice. The latest swagger file is available for download from the following link: [https://api.eu1.kt1.io/fleet/v2/swagger.json](https://api.eu1.kt1.io/fleet/v2/swagger.json) */ removeTripLabels(asset: string, date: string, request: TripLabelRequest, $options?: RequestOptions): Promise; /** * Sets a trip to private. * @method * @name HistoryClient#setTripPrivate * @param {string} asset - The asset id for the trip * @param {string} date - The trip start date (in ISO format) */ setTripPrivate(asset: string, date: string, $options?: RequestOptions): Promise; /** * Clears the private flag on a trip. * @method * @name HistoryClient#clearTripPrivate * @param {string} asset - The asset id for the trip * @param {string} date - The trip start date (in ISO format) */ clearTripPrivate(asset: string, date: string, $options?: RequestOptions): Promise; /** * Restricted route, not available for general usage. * @method * @name HistoryClient#getLogHistoryForEntity * @param {string} entityType - Welcome to the Key Telematics Fleet API specification. This document outlines the REST routes and data structures returned by the API and offers examples of usage. The API publishes a [swagger](https://swagger.io/) specification that can be used to [generate a client library](https://github.com/swagger-api/swagger-codegen) for your language of choice. The latest swagger file is available for download from the following link: [https://api.eu1.kt1.io/fleet/v2/swagger.json](https://api.eu1.kt1.io/fleet/v2/swagger.json) * @param {string} id - Welcome to the Key Telematics Fleet API specification. This document outlines the REST routes and data structures returned by the API and offers examples of usage. The API publishes a [swagger](https://swagger.io/) specification that can be used to [generate a client library](https://github.com/swagger-api/swagger-codegen) for your language of choice. The latest swagger file is available for download from the following link: [https://api.eu1.kt1.io/fleet/v2/swagger.json](https://api.eu1.kt1.io/fleet/v2/swagger.json) * @param {string} start - Welcome to the Key Telematics Fleet API specification. This document outlines the REST routes and data structures returned by the API and offers examples of usage. The API publishes a [swagger](https://swagger.io/) specification that can be used to [generate a client library](https://github.com/swagger-api/swagger-codegen) for your language of choice. The latest swagger file is available for download from the following link: [https://api.eu1.kt1.io/fleet/v2/swagger.json](https://api.eu1.kt1.io/fleet/v2/swagger.json) * @param {string} end - Welcome to the Key Telematics Fleet API specification. This document outlines the REST routes and data structures returned by the API and offers examples of usage. The API publishes a [swagger](https://swagger.io/) specification that can be used to [generate a client library](https://github.com/swagger-api/swagger-codegen) for your language of choice. The latest swagger file is available for download from the following link: [https://api.eu1.kt1.io/fleet/v2/swagger.json](https://api.eu1.kt1.io/fleet/v2/swagger.json) * @param {number} limit - Welcome to the Key Telematics Fleet API specification. This document outlines the REST routes and data structures returned by the API and offers examples of usage. The API publishes a [swagger](https://swagger.io/) specification that can be used to [generate a client library](https://github.com/swagger-api/swagger-codegen) for your language of choice. The latest swagger file is available for download from the following link: [https://api.eu1.kt1.io/fleet/v2/swagger.json](https://api.eu1.kt1.io/fleet/v2/swagger.json) * @param {string} levels - Welcome to the Key Telematics Fleet API specification. This document outlines the REST routes and data structures returned by the API and offers examples of usage. The API publishes a [swagger](https://swagger.io/) specification that can be used to [generate a client library](https://github.com/swagger-api/swagger-codegen) for your language of choice. The latest swagger file is available for download from the following link: [https://api.eu1.kt1.io/fleet/v2/swagger.json](https://api.eu1.kt1.io/fleet/v2/swagger.json) */ getLogHistoryForEntity(entityType: string, id: string, start?: string, end?: string, limit?: number, levels?: string, $options?: RequestOptions): Promise; /** * Retrieve a list of queued reports for a specified owner. * @method * @name HistoryClient#listCompletedReports * @param {string} start - Welcome to the Key Telematics Fleet API specification. This document outlines the REST routes and data structures returned by the API and offers examples of usage. The API publishes a [swagger](https://swagger.io/) specification that can be used to [generate a client library](https://github.com/swagger-api/swagger-codegen) for your language of choice. The latest swagger file is available for download from the following link: [https://api.eu1.kt1.io/fleet/v2/swagger.json](https://api.eu1.kt1.io/fleet/v2/swagger.json) * @param {string} end - Welcome to the Key Telematics Fleet API specification. This document outlines the REST routes and data structures returned by the API and offers examples of usage. The API publishes a [swagger](https://swagger.io/) specification that can be used to [generate a client library](https://github.com/swagger-api/swagger-codegen) for your language of choice. The latest swagger file is available for download from the following link: [https://api.eu1.kt1.io/fleet/v2/swagger.json](https://api.eu1.kt1.io/fleet/v2/swagger.json) * @param {string} client - The client id you are requesting reports for * @param {string} user - Welcome to the Key Telematics Fleet API specification. This document outlines the REST routes and data structures returned by the API and offers examples of usage. The API publishes a [swagger](https://swagger.io/) specification that can be used to [generate a client library](https://github.com/swagger-api/swagger-codegen) for your language of choice. The latest swagger file is available for download from the following link: [https://api.eu1.kt1.io/fleet/v2/swagger.json](https://api.eu1.kt1.io/fleet/v2/swagger.json) */ listCompletedReports(start: string, end: string, client?: string, user?: string, $options?: RequestOptions): Promise; /** * Retrieve a queued report by it's ID. * @method * @name HistoryClient#getCompletedReport * @param {string} id - The UUID to retrieve. */ getCompletedReport(id: string, $options?: RequestOptions): Promise; /** * Update a report by it's ID. * @method * @name HistoryClient#updateCompletedReport * @param {string} id - The UUID of the report to update * @param {object} report - The data with which to update an existing report. */ updateCompletedReport(id: string, report: CompletedReportUpdateRequest, $options?: RequestOptions): Promise; /** * Retrieve a queued report by it's ID. * @method * @name HistoryClient#getCompletedReportWithOptions * @param {string} id - The UUID to retrieve. * @param {object} options - Welcome to the Key Telematics Fleet API specification. This document outlines the REST routes and data structures returned by the API and offers examples of usage. The API publishes a [swagger](https://swagger.io/) specification that can be used to [generate a client library](https://github.com/swagger-api/swagger-codegen) for your language of choice. The latest swagger file is available for download from the following link: [https://api.eu1.kt1.io/fleet/v2/swagger.json](https://api.eu1.kt1.io/fleet/v2/swagger.json) */ getCompletedReportWithOptions(id: string, options: CompletedReportRequest, $options?: RequestOptions): Promise; /** * Retrieve the binary data for a queued report by it's ID. * @method * @name HistoryClient#getCompletedReportData * @param {string} id - The UUID to retrieve. * @param {string} filename - The filename and type your want the to be returned as, can be '.pdf', '.csv' or '.json' */ getCompletedReportData(id: string, filename: string, $options?: RequestOptions): Promise; /** * Retrieve the binary data for a queued report by it's ID. * @method * @name HistoryClient#getCompletedReportDataWithOptions * @param {string} id - The UUID to retrieve. * @param {string} filename - The filename and type your want the data to be returned as, can be '.pdf', '.csv' or '.json' * @param {object} options - Welcome to the Key Telematics Fleet API specification. This document outlines the REST routes and data structures returned by the API and offers examples of usage. The API publishes a [swagger](https://swagger.io/) specification that can be used to [generate a client library](https://github.com/swagger-api/swagger-codegen) for your language of choice. The latest swagger file is available for download from the following link: [https://api.eu1.kt1.io/fleet/v2/swagger.json](https://api.eu1.kt1.io/fleet/v2/swagger.json) */ getCompletedReportDataWithOptions(id: string, filename: string, options: CompletedReportDataRequest, $options?: RequestOptions): Promise; /** * Retrieve the binary data for a queued report by it's ID. * @method * @name HistoryClient#getCompletedReportDataStream * @param {string} id - The UUID to retrieve. * @param {string} filename - The filename and type your want the to be returned as, can be '.pdf', '.csv' or '.json' * @param {string} outputFormat - Welcome to the Key Telematics Fleet API specification. This document outlines the REST routes and data structures returned by the API and offers examples of usage. The API publishes a [swagger](https://swagger.io/) specification that can be used to [generate a client library](https://github.com/swagger-api/swagger-codegen) for your language of choice. The latest swagger file is available for download from the following link: [https://api.eu1.kt1.io/fleet/v2/swagger.json](https://api.eu1.kt1.io/fleet/v2/swagger.json) */ getCompletedReportDataStream(id: string, filename: string, outputFormat?: string, $options?: RequestOptions): Promise; }