import { BaseClient, RequestOptions } from './base-client'; import { NotificationFeedResponse, TelemetryFeedResponse, TripResponse, TripFeedResponse, EventResponse, EventFeedResponse, AuditEventFeedResponse, EventCommentRequest, TelemetryListResponse, EventListResponse, TripListResponse, TripLabelRequest, LogResponse } 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 DataClient * @param {(string)} [url] - The URL of the API endpoint. */ export declare class DataClient extends BaseClient { /** * Retrieve the notification feed for the current user. * @method * @name DataClient#getNotificationFeed * @param {number} sequence - The sequence to continue from. * @param {string} direction - The direction to run the feed in. * @param {number} limit - Limit the number of results to this value. */ getNotificationFeed(sequence: number, direction: 'forward' | 'backward', limit?: number, $options?: RequestOptions): Promise; /** * Retrieve the current state for all assets for the specified client. * @method * @name DataClient#getLocationFeed * @param {string} client - The client id you're requesting data for. * @param {number} sequence - The sequence to continue from. * @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 - Limit the number of results to this value. * @param {string} sort - 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} filter - 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) */ getLocationFeed(client: string, sequence: number, offset?: number, limit?: number, sort?: string, filter?: string, $options?: RequestOptions): Promise; /** * Retrieve a trip feed for the specified asset. * @method * @name DataClient#getTripFeed * @param {string} client - The client id you are requesting data for * @param {number} sequence - The sequence to continue from. * @param {string} direction - The direction to run the feed in. * @param {number} limit - Limit the number of results to this value. * @param {string} asset - 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) */ getTripFeed(client: string, sequence: number, direction: 'forward' | 'backward', limit?: number, asset?: string, $options?: RequestOptions): Promise; /** * Retrieve an event feed for the specified asset. * @method * @name DataClient#getEventFeed * @param {string} client - The client id you are requesting data for * @param {number} sequence - The sequence to continue from. * @param {string} direction - The direction to run the feed in. * @param {number} limit - Limit the number of results to this value. * @param {string} asset - Filter events for this asset only. */ getEventFeed(client: string, sequence: number, direction: 'forward' | 'backward', limit?: number, asset?: string, $options?: RequestOptions): Promise; /** * Retrieve an audit log feed for the specified client and entity. * @method * @name DataClient#getAuditFeedForEntity * @param {string} company - The client, vendor or distributor id you are requesting data for * @param {string} entity - 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} sequence - The sequence to continue from. * @param {string} direction - The direction to run the feed in. * @param {number} limit - Limit the number of results to this value. */ getAuditFeedForEntity(company: string, entity: string, sequence: number, direction: 'forward' | 'backward', limit: number, $options?: RequestOptions): Promise; /** * Retrieve an alert feed for the specified asset. * @method * @name DataClient#getAlertFeed * @param {string} client - The client id you are requesting data for * @param {number} sequence - The sequence to continue from. * @param {string} direction - The direction to run the feed in. * @param {number} limit - Limit the number of results to this value. This function may return slightly more results than requested. * @param {string} asset - Filter alerts for this asset only. * @param {string} alert - Filter alerts for this alert only. */ getAlertFeed(client: string, sequence: number, direction: 'forward' | 'backward', limit?: number, asset?: string, alert?: string, $options?: RequestOptions): Promise; /** * Add a comment to an alert. * @method * @name DataClient#commentAlert * @param {string} client - The client id you are requesting data for * @param {string} alert - The alert id you wish to comment on. * @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) */ commentAlert(client: string, alert: string, request: EventCommentRequest, $options?: RequestOptions): Promise; /** * Acknowlege an alert. * @method * @name DataClient#acknowledgeAlert * @param {string} client - The client id you are requesting data for * @param {string} alert - The alert id you wish to acknowledge. * @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) */ acknowledgeAlert(client: string, alert: string, request: EventCommentRequest, $options?: RequestOptions): Promise; /** * Retrieve telemetry records between two dates. * @method * @name DataClient#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 DataClient#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 DataClient#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 DataClient#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 DataClient#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 DataClient#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 DataClient#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 DataClient#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 DataClient#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; }