import { BaseClient, RequestOptions } from './base-client'; import { NotificationFeedResponse, TelemetryFeedResponse, TripFeedResponse, EventResponse, EventFeedResponse, AuditEventFeedResponse, EventCommentRequest } 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 FeedsClient * @param {(string)} [url] - The URL of the API endpoint. */ export declare class FeedsClient extends BaseClient { /** * Retrieve the notification feed for the current user. * @method * @name FeedsClient#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 FeedsClient#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 FeedsClient#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 FeedsClient#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 FeedsClient#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 FeedsClient#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 FeedsClient#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 FeedsClient#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; }