import { BaseClient, RequestOptions } from './base-client'; import { AnalyticsBaseReportResponse, AnalyticsBaseReportsListResponse, CompletedReportResponse, CompletedReportListResponse, CompletedReportUpdateRequest, CompletedReportDataRequest, CompletedReportRequest, QueuedReportResponse, QueuedReportListResponse, QueueReportRequest } 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 ReportsClient * @param {(string)} [url] - The URL of the API endpoint. */ export declare class ReportsClient extends BaseClient { /** * Retrieve a list of base reports for a specified owner, client or user. * @method * @name ReportsClient#listAnalyticsBaseReports * @param {string} owner - 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 - 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} 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) * @param {number} offset - 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) */ listAnalyticsBaseReports(owner?: string, client?: string, user?: string, offset?: number, limit?: number, $options?: RequestOptions): Promise; /** * Retrieve an analytics base report by its ID. * @method * @name ReportsClient#getAnalyticsBaseReport * @param {string} id - The UUID to retrieve. */ getAnalyticsBaseReport(id: string, $options?: RequestOptions): Promise; /** * Rebuilds a base report * @method * @name ReportsClient#rebuildAnalyticsBaseReport * @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) */ rebuildAnalyticsBaseReport(id: string, $options?: RequestOptions): Promise; /** * Retrieve a list of queued reports for a specified owner. * @method * @name ReportsClient#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 ReportsClient#getCompletedReport * @param {string} id - The UUID to retrieve. */ getCompletedReport(id: string, $options?: RequestOptions): Promise; /** * Update a report by it's ID. * @method * @name ReportsClient#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 ReportsClient#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 ReportsClient#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 ReportsClient#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 ReportsClient#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; /** * Retrieve a list of queued reports for a specified owner. * @method * @name ReportsClient#listQueuedReports * @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) * @param {string} server - An optional server identifier (will be inferred from client settings if possible) */ listQueuedReports(client?: string, user?: string, server?: string, $options?: RequestOptions): Promise; /** * Queue a new report * @method * @name ReportsClient#queueReport * @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) */ queueReport(request: QueueReportRequest, $options?: RequestOptions): Promise; /** * Retrieve a queued report by it's ID. * @method * @name ReportsClient#getQueuedReport * @param {string} id - The UUID to retrieve. */ getQueuedReport(id: string, $options?: RequestOptions): Promise; /** * Cancel a queued or running report * @method * @name ReportsClient#cancelReport * @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) */ cancelReport(id: string, $options?: RequestOptions): Promise; /** * Subscribe to a Server-Sent Events stream for real-time report progress and output. * @method * @name ReportsClient#subscribeToReport * @param {string} id - The UUID of the report to subscribe to. */ subscribeToReport(id: string, $options?: RequestOptions): Promise; }