import { BaseClient, RequestOptions } from './base-client'; import { EventResponse, MediaInfoResponse, MediaInfoListResponse, VideoLiveStreamResponse, VideoLiveStreamRequest, MediaVideoEventCreateRequest, MediaVideoEventUpdateRequest } 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 MediaClient * @param {(string)} [url] - The URL of the API endpoint. */ export declare class MediaClient extends BaseClient { /** * [DEPRECATED] Legacy route that proxies to the media server. * @method * @name MediaClient#getLegacyImage */ getLegacyImage($options?: RequestOptions): Promise; /** * [DEPRECATED] Legacy route that retrieves a video based on it's filename. * @method * @name MediaClient#getLegacyVideo * @param {string} filename - The filename you're requesting data for. Make sure to escape any forward slashes in the filename. */ getLegacyVideo(filename: string, $options?: RequestOptions): Promise; /** * Retrieve a list of media information items for the specified owner. * @method * @name MediaClient#listMedia * @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} filter - A filter to apply to the data in RQL format. */ listMedia(owner: string, offset?: number, limit?: number, filter?: string, $options?: RequestOptions): Promise; /** * Retrieve a media information item. * @method * @name MediaClient#getMedia * @param {string} id - The media ID you are requesting data for */ getMedia(id: string, $options?: RequestOptions): Promise; /** * Cancel a pending or queued media item. * @method * @name MediaClient#cancelMedia * @param {string} id - The media ID you are canceling */ cancelMedia(id: string, $options?: RequestOptions): Promise; /** * Delete a media item media file * @method * @name MediaClient#deleteMediaFile * @param {string} id - The media ID you are deleting */ deleteMediaFile(id: string, $options?: RequestOptions): Promise; /** * Save a video in the user's saved list. * @method * @name MediaClient#saveMedia * @param {string} id - The media ID you are saving */ saveMedia(id: string, $options?: RequestOptions): Promise; /** * Retrieve a media item. * @method * @name MediaClient#getMediaFile * @param {string} asset - The UUID of the asset you are requesting media for. * @param {string} filename - The filename of the media item. */ getMediaFile(asset: string, filename: string, $options?: RequestOptions): Promise; /** * Returns information for a media item. * @method * @name MediaClient#getMediaInfo * @param {string} asset - The UUID of the asset you are requesting media for. * @param {string} filename - The filename of the media item. */ getMediaInfo(asset: string, filename: string, $options?: RequestOptions): Promise; /** * [DEPRECATED] Use getMediaInfo instead * @method * @name MediaClient#getMediaInfoDeprecated * @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} 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) * @param {string} filename - 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) */ getMediaInfoDeprecated(owner: string, asset: string, filename: string, $options?: RequestOptions): Promise; /** * Requests a live stream endpoint for a video. * @method * @name MediaClient#startVideoLiveStream * @param {string} asset - The UUID of the asset you are requesting media for. * @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) */ startVideoLiveStream(asset: string, request: VideoLiveStreamRequest, $options?: RequestOptions): Promise; /** * Creates a new video event for a specified date time. * @method * @name MediaClient#createVideoEvent * @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) */ createVideoEvent(request: MediaVideoEventCreateRequest, $options?: RequestOptions): Promise; /** * Request a video from a camera enabled device for a particular event. * @method * @name MediaClient#updateVideoEvent * @param {string} owner - The owner id of the company that owns the event * @param {string} event - The GUID of the event for which you wish to retrieve the video * @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) */ updateVideoEvent(owner: string, event: string, request: MediaVideoEventUpdateRequest, $options?: RequestOptions): Promise; }