import { BaseClient, RequestOptions } from './base-client'; import { UserListResponse, UserResponse, UserPoliciesResponse, UserUpdateRequest, UserCreateResponse, UserCreateRequest, UserResetResponse, UserResetRequest, UserApiKeyCreateResponse, UserApiKeyCreateRequest, SuccessResponse } 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 UsersClient * @param {(string)} [url] - The URL of the API endpoint. */ export declare class UsersClient extends BaseClient { /** * Retrieve a list of users for a specified owner. * @method * @name UsersClient#listUsers * @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. */ listUsers(owner: string, offset?: number, limit?: number, sort?: string, filter?: string, $options?: RequestOptions): Promise; /** * Creates a new user * @method * @name UsersClient#createUser * @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) */ createUser(request: UserCreateRequest, $options?: RequestOptions): Promise; /** * Returns user details for the specified id * @method * @name UsersClient#getUser * @param {string} id - The UUID of the user */ getUser(id: string, $options?: RequestOptions): Promise; /** * Updates an existing user * @method * @name UsersClient#updateUser * @param {string} id - The UUID of the user * @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) */ updateUser(id: string, request: UserUpdateRequest, $options?: RequestOptions): Promise; /** * Returns active security policies for the current user * @method * @name UsersClient#getUserPolicies * @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) */ getUserPolicies(id: string, $options?: RequestOptions): Promise; /** * Optionally suspends the user and sends them a password reset email. * @method * @name UsersClient#resetUser * @param {string} id - The UUID of the user * @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) */ resetUser(id: string, request: UserResetRequest, $options?: RequestOptions): Promise; /** * Return the user avatar in binary format * @method * @name UsersClient#getUserAvatar * @param {string} id - The UUID of the user */ getUserAvatar(id: string, $options?: RequestOptions): Promise; /** * Updates the specified user's avatar. * @method * @name UsersClient#updateUserAvatar * @param {string} id - The user UUID you are requesting data for. */ updateUserAvatar(id: string, $options?: RequestOptions): Promise; /** * Permanently deletes a user avatar. * @method * @name UsersClient#deleteUserAvatar * @param {string} id - The user UUID. */ deleteUserAvatar(id: string, $options?: RequestOptions): Promise; /** * Creates a new API key * @method * @name UsersClient#createApiKey * @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 {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) */ createApiKey(id: string, request: UserApiKeyCreateRequest, $options?: RequestOptions): Promise; /** * Deletes an API key * @method * @name UsersClient#deleteApiKey * @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} keyid - 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) */ deleteApiKey(id: string, keyid: string, $options?: RequestOptions): Promise; /** * Deletes a previously configured OTP method for a user. * @method * @name UsersClient#deleteOTPMethod * @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} method - 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) */ deleteOTPMethod(id: string, method: string, $options?: RequestOptions): Promise; }