import { BaseClient, RequestOptions } from './base-client'; import { DistributorListResponse, DistributorResponse, DistributorUpdateRequest, DistributorDetailsUpdateRequest, DistributorCreateRequest } 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 DistributorsClient * @param {(string)} [url] - The URL of the API endpoint. */ export declare class DistributorsClient extends BaseClient { /** * Retrieve a list of distributors for a specified owner. * @method * @name DistributorsClient#listDistributors * @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. * @param {string} counts - A list of entity types to return counts for that belong to this distributor, comma delimited, i.e. `counts=vendor,client,asset,device`. Each additional entity affects the performance of the query and should be used sparingly. */ listDistributors(owner: string, offset?: number, limit?: number, sort?: string, filter?: string, counts?: string, $options?: RequestOptions): Promise; /** * Creates a new distributor account * @method * @name DistributorsClient#createDistributor * @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) */ createDistributor(request: DistributorCreateRequest, $options?: RequestOptions): Promise; /** * Returns distributor details for the specified id * @method * @name DistributorsClient#getDistributor * @param {string} id - The UUID of the distributor */ getDistributor(id: string, $options?: RequestOptions): Promise; /** * Updates an existing distributor account * @method * @name DistributorsClient#updateDistributor * @param {string} id - The UUID of the distributor * @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) */ updateDistributor(id: string, request: DistributorUpdateRequest, $options?: RequestOptions): Promise; /** * Updates an existing distributor account details. Unlike `updateDistributor`, this route is available to distributor users. * @method * @name DistributorsClient#updateDistributorDetails * @param {string} id - The UUID of the distributor * @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) */ updateDistributorDetails(id: string, request: DistributorDetailsUpdateRequest, $options?: RequestOptions): Promise; /** * Return the specified distributors's logo in binary format. Should the distributor not have a custom logo, the default Key Telematics logo will be supplied. * @method * @name DistributorsClient#getDistributorLogo * @param {string} id - The distributor UUID you are requesting data for. * @param {string} size - The size of the returned image. Can be either "small" or "large". */ getDistributorLogo(id: string, size?: string, $options?: RequestOptions): Promise; /** * Updates the specified distributor's logo. * @method * @name DistributorsClient#updateDistributorLogo * @param {string} id - The distributor UUID you are requesting data for. * @param {string} size - The size of the image. Can be either "small" or "large". */ updateDistributorLogo(id: string, size: string, $options?: RequestOptions): Promise; /** * Permanently deletes a custom distributor logo. The logo will revert to the Key Telematics logo. * @method * @name DistributorsClient#deleteDistributorLogo * @param {string} id - The distributor UUID. * @param {string} size - The size of the image. Can be either "small" or "large". */ deleteDistributorLogo(id: string, size: string, $options?: RequestOptions): Promise; }