import { BaseClient, RequestOptions } from './base-client'; import { IdName, ClientListResponse, ClientResponse, ClientUpdateRequest, ClientDetailsUpdateRequest, ClientCreateRequest } 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 ClientsClient * @param {(string)} [url] - The URL of the API endpoint. */ export declare class ClientsClient extends BaseClient { /** * Retrieve a list of clients for a specified vendor. * @method * @name ClientsClient#listClients * @param {string} owner - The UUID of the vendor 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. * @param {string} counts - A list of entity types to return counts for that belong to this client, comma delimited, i.e. `counts=asset,device,simcard`. Each additional entity affects the performance of the query and should be used sparingly. */ listClients(owner: string, offset?: number, limit?: number, sort?: string, filter?: string, counts?: string, $options?: RequestOptions): Promise; /** * Creates a new client entity. * @method * @name ClientsClient#createClient * @param {object} request - The `ClientCreateRequest` that contains the required properties for the new entity. */ createClient(request: ClientCreateRequest, $options?: RequestOptions): Promise; /** * Returns client details for the specified UUID. * @method * @name ClientsClient#getClient * @param {string} id - The UUID of the client. */ getClient(id: string, $options?: RequestOptions): Promise; /** * Updates an existing client entity by patching the existing object with the properties supplied in the `ClientUpdateRequest`. * @method * @name ClientsClient#updateClient * @param {string} id - The UUID of the client * @param {object} request - The `ClientUpdateRequest` that contains only the properites that are to be changed on the entity. */ updateClient(id: string, request: ClientUpdateRequest, $options?: RequestOptions): Promise; /** * Returns the client ID and name for the specified PIN. PINs are generated by the system and can be retrieved via the `pin` property on the `ClientResponse` object retrieved with `getClient`. * @method * @name ClientsClient#getClientByPin * @param {string} pin - The PIN code of the client. */ getClientByPin(pin: string, $options?: RequestOptions): Promise; /** * Updates an existing client account details. Unlike updateClient, this route is available to client users. * @method * @name ClientsClient#updateClientDetails * @param {string} id - The UUID of the client * @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) */ updateClientDetails(id: string, request: ClientDetailsUpdateRequest, $options?: RequestOptions): Promise; /** * Return the specified client's logo in binary format. Should the client not have a custom logo, the logo of the vendor will be supplied. * @method * @name ClientsClient#getClientLogo * @param {string} id - The client UUID you are requesting data for. * @param {string} size - The size of the returned image. Can be either "small" or "large". */ getClientLogo(id: string, size?: string, $options?: RequestOptions): Promise; /** * Updates the specified client's logo. * @method * @name ClientsClient#updateClientLogo * @param {string} id - The client UUID you are requesting data for. * @param {string} size - The size of the image. Can be either "small" or "large". */ updateClientLogo(id: string, size: string, $options?: RequestOptions): Promise; /** * Permanently deletes a custom client logo. The logo will revert to the client's parent logo. * @method * @name ClientsClient#deleteClientLogo * @param {string} id - The client UUID. * @param {string} size - The size of the image. Can be either "small" or "large". */ deleteClientLogo(id: string, size: string, $options?: RequestOptions): Promise; }