import { BaseClient, RequestOptions } from './base-client'; import { DashboardListResponse, DashboardResponse, DashboardUpdateRequest, DashboardCreateRequest, RebuildDashboardWidgetResponse } 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 DashboardsClient * @param {(string)} [url] - The URL of the API endpoint. */ export declare class DashboardsClient extends BaseClient { /** * Retrieve a list of Dashboards for a specified owner. * @method * @name DashboardsClient#listDashboards * @param {string} owner - The owner id you are requesting data for * @param {number} offset - An offset into the result set, useful for pagination * @param {number} limit - Limit the number of results to this value. * @param {string} sort - Sorting column or attribute name with an optional direction, e.g. `sort=name:desc` * @param {string} filter - A filter to apply to the data in RQL format. */ listDashboards(owner: string, offset?: number, limit?: number, sort?: string, filter?: string, $options?: RequestOptions): Promise; /** * Creates a new dashboard entity * @method * @name DashboardsClient#createDashboard * @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) */ createDashboard(request: DashboardCreateRequest, $options?: RequestOptions): Promise; /** * Returns dashboard entity details for the specified id * @method * @name DashboardsClient#getDashboard * @param {string} id - The UUID of the Dashboard */ getDashboard(id: string, $options?: RequestOptions): Promise; /** * Updates an existing dashboard entity * @method * @name DashboardsClient#updateDashboard * @param {string} id - The UUID of the Dashboard * @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) */ updateDashboard(id: string, request: DashboardUpdateRequest, $options?: RequestOptions): Promise; /** * Permanently deletes a dashboard * @method * @name DashboardsClient#deleteDashboard * @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) */ deleteDashboard(id: string, $options?: RequestOptions): Promise; /** * Rebuilds a widget * @method * @name DashboardsClient#rebuildDashboardWidget * @param {string} id - The UUID of the dashboard to which the widget belongs * @param {string} widgetId - The UUID of the widget to rebuild */ rebuildDashboardWidget(id: string, widgetId: string, $options?: RequestOptions): Promise; }