import { BaseClient, RequestOptions } from './base-client'; import { Dictionary, TelemetryStateResponse, AlertListResponse, AlertResponse, AlertUpdateRequest, AlertCreateRequest, AssetCategoryResponse, AssetCategoryListResponse, AssetCategoryUpdateRequest, AssetCategoryCreateRequest, AssetGroupResponse, AssetGroupListResponse, AssetGroupUpdateRequest, AssetGroupCreateRequest, AssetRatingProfileListResponse, AssetRatingProfileResponse, AssetRatingProfileUpdateRequest, AssetRatingProfileCreateRequest, AssetListResponse, AssetResponse, AssetUpdateRequest, AssetCreateRequest, AssetSharedLocationResponse, AssetSharedLocationTokenResponse, AssetSharedLocationTokenListResponse, AssetSharedLocationTokenRequest, DeviceConfigurationResponse, AssetPrivacyRequest, AssetLinkResponse, AssetLinkRequest, AssetMoveRequest, AssetStateProfileListResponse, AssetStateProfileResponse, AssetStateProfileUpdateRequest, AssetStateProfileCreateRequest, AssetTagListResponse, AssetTagResponse, AssetTagUpdateRequest, AssetTagCreateRequest, AssetTagTypeResponse, AssetTagTypeListResponse, AssetTypeResponse, AssetTypeListResponse, CostCentreResponse, CostCentreListResponse, CostCentreUpdateRequest, CostCentreCreateRequest, DashboardListResponse, DashboardResponse, DashboardUpdateRequest, DashboardCreateRequest, RebuildDashboardWidgetResponse, DashboardTemplateListResponse, DashboardTemplateResponse, DashboardTemplateUpdateRequest, DashboardTemplateCreateRequest, DeviceListResponse, DeviceResponse, DeviceUpdateRequest, DeviceCreateRequest, DeviceConfigProfileListResponse, DeviceConfigProfileResponse, DeviceConfigProfileUpdateRequest, DeviceConfigProfileCreateRequest, DeviceTypeListResponse, DeviceTypeResponse, DeviceTypeUpdateRequest, DeviceTypeCreateRequest, DeviceProviderListResponse, DeviceProviderResponse, DeviceProviderUpdateRequest, DeviceProviderCreateRequest, DeviceProviderTypeListResponse, DeviceProviderTypeResponse, EmailProviderListResponse, EmailProviderResponse, EmailProviderUpdateRequest, EmailProviderCreateRequest, ExportTaskListResponse, ExportTaskResponse, ExportTaskUpdateRequest, ExportTaskCreateRequest, FuelCardListResponse, FuelCardResponse, FuelCardUpdateRequest, FuelCardCreateRequest, GeoLockProfileListResponse, GeoLockProfileResponse, GeoLockProfileUpdateRequest, GeoLockProfileCreateRequest, IoTypeListResponse, IoTypeResponse, IoTypeUpdateRequest, IoTypeCreateRequest, LabelListResponse, LabelResponse, LabelUpdateRequest, LabelCreateRequest, MapSetListResponse, MapSetResponse, MapsetUpdateRequest, MapsetCreateRequest, OverspeedProfileListResponse, OverspeedProfileResponse, OverspeedProfileUpdateRequest, OverspeedProfileCreateRequest, PrivacyProfileListResponse, PrivacyProfileResponse, PrivacyProfileUpdateRequest, PrivacyProfileCreateRequest, ReportDefinitionResponse, ReportDefinitionListResponse, ReportTemplateResponse, ReportTemplateListResponse, ReportTemplateCreateRequest, ReportTemplateUpdateRequest, ReminderListResponse, ReminderResponse, ReminderUpdateRequest, ReminderCreateRequest, RoadProfileListResponse, RoadProfileResponse, RoadProfileUpdateRequest, RoadProfileCreateRequest, ScheduledReportListResponse, ScheduledReportResponse, ScheduledReportUpdateRequest, ScheduledReportCreateRequest, SimCardListResponse, SimCardResponse, SimCardUpdateRequest, SimCardCreateRequest, SmsGatewayProviderListResponse, SmsGatewayProviderResponse, SmsGatewayProviderUpdateRequest, SmsGatewayProviderCreateRequest, SmsGatewayProviderTypeListResponse, SmsGatewayProviderTypeResponse, EmailProviderTypeListResponse, EmailProviderTypeResponse, ThemeListResponse, ThemeResponse, ThemeUpdateRequest, ThemeCreateRequest, DomainThemeResponse, ZoneGroupListResponse, ZoneGroupResponse, ZoneGroupUpdateRequest, ZoneGroupCreateRequest, ZoneListResponse, ZoneResponse, ZoneUpdateRequest, ZoneCreateRequest, SslCertificateListResponse, SslCertificateResponse, SslCertificateCreateRequest, SslCertificateUpdateRequest, SslCertificateValidationResponse, SslCertificateProvisionResponse } 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 EntitiesClient * @param {(string)} [url] - The URL of the API endpoint. */ export declare class EntitiesClient extends BaseClient { /** * Retrieve a list of alerts for a specified owner. * @method * @name EntitiesClient#listAlerts * @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. */ listAlerts(owner: string, offset?: number, limit?: number, sort?: string, filter?: string, $options?: RequestOptions): Promise; /** * Creates a new Alert * @method * @name EntitiesClient#createAlert * @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) */ createAlert(request: AlertCreateRequest, $options?: RequestOptions): Promise; /** * Returns alert details for the specified id * @method * @name EntitiesClient#getAlert * @param {string} id - The UUID of the alert */ getAlert(id: string, $options?: RequestOptions): Promise; /** * Updates an existing Alert * @method * @name EntitiesClient#updateAlert * @param {string} id - The UUID of the Alert * @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) */ updateAlert(id: string, request: AlertUpdateRequest, $options?: RequestOptions): Promise; /** * Retrieve a list of asset categories for a specified owner. * @method * @name EntitiesClient#listAssetCategories * @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. */ listAssetCategories(owner: string, offset?: number, limit?: number, sort?: string, filter?: string, $options?: RequestOptions): Promise; /** * Creates a new asset category * @method * @name EntitiesClient#createAssetCategory * @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) */ createAssetCategory(request: AssetCategoryCreateRequest, $options?: RequestOptions): Promise; /** * Returns asset category details for the specified id * @method * @name EntitiesClient#getAssetCategory * @param {string} id - The UUID of the asset category */ getAssetCategory(id: string, $options?: RequestOptions): Promise; /** * Updates an existing asset category * @method * @name EntitiesClient#updateAssetCategory * @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) */ updateAssetCategory(id: string, request: AssetCategoryUpdateRequest, $options?: RequestOptions): Promise; /** * Delete an asset category * @method * @name EntitiesClient#deleteAssetCategory * @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) */ deleteAssetCategory(id: string, $options?: RequestOptions): Promise; /** * Retrieve a list of asset groups for a specified owner. * @method * @name EntitiesClient#listAssetGroups * @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. */ listAssetGroups(owner: string, offset?: number, limit?: number, sort?: string, filter?: string, $options?: RequestOptions): Promise; /** * Creates a new Asset Group * @method * @name EntitiesClient#createAssetGroup * @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) */ createAssetGroup(request: AssetGroupCreateRequest, $options?: RequestOptions): Promise; /** * Returns asset group details for the specified id * @method * @name EntitiesClient#getAssetGroup * @param {string} id - The UUID of the asset group */ getAssetGroup(id: string, $options?: RequestOptions): Promise; /** * Updates an existing Asset Group * @method * @name EntitiesClient#updateAssetGroup * @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) */ updateAssetGroup(id: string, request: AssetGroupUpdateRequest, $options?: RequestOptions): Promise; /** * Delete an asset group * @method * @name EntitiesClient#deleteAssetGroup * @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) */ deleteAssetGroup(id: string, $options?: RequestOptions): Promise; /** * Retrieve a list of asset rating profiles for a specified owner. * @method * @name EntitiesClient#listAssetRatingProfiles * @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. */ listAssetRatingProfiles(owner: string, offset?: number, limit?: number, sort?: string, filter?: string, $options?: RequestOptions): Promise; /** * Creates a new Asset Rating Profile entity * @method * @name EntitiesClient#createAssetRatingProfile * @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) */ createAssetRatingProfile(request: AssetRatingProfileCreateRequest, $options?: RequestOptions): Promise; /** * Returns asset rating profile details for the specified id * @method * @name EntitiesClient#getAssetRatingProfile * @param {string} id - The UUID of the asset rating profile */ getAssetRatingProfile(id: string, $options?: RequestOptions): Promise; /** * Updates an existing Asset Rating Profile entity * @method * @name EntitiesClient#updateAssetRatingProfile * @param {string} id - The UUID of the Asset State Profile * @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) */ updateAssetRatingProfile(id: string, request: AssetRatingProfileUpdateRequest, $options?: RequestOptions): Promise; /** * Retrieve a list of assets for a specified owner. * @method * @name EntitiesClient#listAssets * @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. */ listAssets(owner: string, offset?: number, limit?: number, sort?: string, filter?: string, $options?: RequestOptions): Promise; /** * Creates a new asset entity * @method * @name EntitiesClient#createAsset * @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) */ createAsset(request: AssetCreateRequest, $options?: RequestOptions): Promise; /** * Returns asset details for the specified id * @method * @name EntitiesClient#getAsset * @param {string} id - The UUID of the asset */ getAsset(id: string, $options?: RequestOptions): Promise; /** * Updates an existing asset * @method * @name EntitiesClient#updateAsset * @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) */ updateAsset(id: string, request: AssetUpdateRequest, $options?: RequestOptions): Promise; /** * Returns the latest known telemetry record for an asset using a shared token * @method * @name EntitiesClient#getSharedAssetLocation * @param {string} token - The shared token */ getSharedAssetLocation(token: string, $options?: RequestOptions): Promise; /** * Update a shared asset location token * @method * @name EntitiesClient#updateSharedAssetLocationToken * @param {string} token - The shared asset token to update * @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) */ updateSharedAssetLocationToken(token: string, request: AssetSharedLocationTokenRequest, $options?: RequestOptions): Promise; /** * Deletes a shared asset location token * @method * @name EntitiesClient#deleteSharedAssetLocationToken * @param {string} token - The shared asset token to delete */ deleteSharedAssetLocationToken(token: string, $options?: RequestOptions): Promise; /** * Retrieve a list of shared asset tokens for an asset or client. * @method * @name EntitiesClient#listSharedAssetLocationTokens * @param {string} owner - The owner id you are requesting data for * @param {string} asset - The asset 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. */ listSharedAssetLocationTokens(owner?: string, asset?: string, offset?: number, limit?: number, sort?: string, filter?: string, $options?: RequestOptions): Promise; /** * Creates a new shared asset location token * @method * @name EntitiesClient#createSharedAssetLocationToken * @param {string} id - The UUID of the asset * @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) */ createSharedAssetLocationToken(id: string, request: AssetSharedLocationTokenRequest, $options?: RequestOptions): Promise; /** * Returns the device configuration of the device attached to this asset (also works for cloned assets) * @method * @name EntitiesClient#getAssetDeviceConfiguration * @param {string} id - The UUID of the asset */ getAssetDeviceConfiguration(id: string, $options?: RequestOptions): Promise; /** * Update asset privacy mode * @method * @name EntitiesClient#setAssetPrivacy * @param {string} id - The UUID of the asset * @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) */ setAssetPrivacy(id: string, request: AssetPrivacyRequest, $options?: RequestOptions): Promise; /** * Return the asset avatar in binary format * @method * @name EntitiesClient#getAssetAvatar * @param {string} id - The UUID of the asset */ getAssetAvatar(id: string, $options?: RequestOptions): Promise; /** * Updates the specified asset's avatar. * @method * @name EntitiesClient#updateAssetAvatar * @param {string} id - The asset UUID you are requesting data for. */ updateAssetAvatar(id: string, $options?: RequestOptions): Promise; /** * Permanently deletes a asset avatar. * @method * @name EntitiesClient#deleteAssetAvatar * @param {string} id - The asset UUID. */ deleteAssetAvatar(id: string, $options?: RequestOptions): Promise; /** * Returns the latest known telemetry record for an asset * @method * @name EntitiesClient#getAssetLocation * @param {string} id - The UUID of the asset */ getAssetLocation(id: string, $options?: RequestOptions): Promise; /** * Links an asset from one account to one in another account. All data from the source asset will be duplicated for the destination asset. Returns both the source and destination asset if successful. * @method * @name EntitiesClient#linkAssets * @param {string} id - The source asset UUID you would like to link. * @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) */ linkAssets(id: string, request: AssetLinkRequest, $options?: RequestOptions): Promise; /** * Unlinks an asset linked to another. Returns both the source and destination asset if successful. * @method * @name EntitiesClient#unlinkAssets * @param {string} id - The source asset UUID you would like to unlink from. * @param {string} asset - The destination asset UUID you would like to unlink from. */ unlinkAssets(id: string, asset: string, $options?: RequestOptions): Promise; /** * Moves an asset from one client to another by deleting the asset in the source client and recreating it in the destination client. Also moves any associated device and simcard if assigned. * @method * @name EntitiesClient#moveAsset * @param {string} id - The asset UUID you would like to move. * @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) */ moveAsset(id: string, request: AssetMoveRequest, $options?: RequestOptions): Promise; /** * Retrieve a list of asset state profiles for a specified owner. * @method * @name EntitiesClient#listAssetStateProfiles * @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. */ listAssetStateProfiles(owner: string, offset?: number, limit?: number, sort?: string, filter?: string, $options?: RequestOptions): Promise; /** * Creates a new Asset State Profile entity * @method * @name EntitiesClient#createAssetStateProfile * @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) */ createAssetStateProfile(request: AssetStateProfileCreateRequest, $options?: RequestOptions): Promise; /** * Returns asset state profile details for the specified id * @method * @name EntitiesClient#getAssetStateProfile * @param {string} id - The UUID of the asset state profile */ getAssetStateProfile(id: string, $options?: RequestOptions): Promise; /** * Updates an existing Asset State Profile entity * @method * @name EntitiesClient#updateAssetStateProfile * @param {string} id - The UUID of the Asset State Profile * @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) */ updateAssetStateProfile(id: string, request: AssetStateProfileUpdateRequest, $options?: RequestOptions): Promise; /** * Retrieve a list of Asset Tags for a specified owner. * @method * @name EntitiesClient#listAssetTags * @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. */ listAssetTags(owner: string, offset?: number, limit?: number, sort?: string, filter?: string, $options?: RequestOptions): Promise; /** * Creates a new Asset Tag * @method * @name EntitiesClient#createAssetTag * @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) */ createAssetTag(request: AssetTagCreateRequest, $options?: RequestOptions): Promise; /** * Returns Asset Tag details for the specified id * @method * @name EntitiesClient#getAssetTag * @param {string} id - The UUID of the Asset Tag */ getAssetTag(id: string, $options?: RequestOptions): Promise; /** * Updates an existing Asset Tag * @method * @name EntitiesClient#updateAssetTag * @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) */ updateAssetTag(id: string, request: AssetTagUpdateRequest, $options?: RequestOptions): Promise; /** * Retrieve a list of asset tag types for a specified owner. * @method * @name EntitiesClient#listAssetTagTypes * @param {string} owner - The owner id you are requesting data for */ listAssetTagTypes(owner: string, $options?: RequestOptions): Promise; /** * Returns asset tag type details for the specified id * @method * @name EntitiesClient#getAssetTagType * @param {string} id - The UUID of the entity */ getAssetTagType(id: string, $options?: RequestOptions): Promise; /** * Retrieve a list of asset types for a specified owner. * @method * @name EntitiesClient#listAssetTypes * @param {string} owner - The owner id you are requesting data for */ listAssetTypes(owner: string, $options?: RequestOptions): Promise; /** * Returns asset type details for the specified id * @method * @name EntitiesClient#getAssetType * @param {string} id - The UUID of the entity */ getAssetType(id: string, $options?: RequestOptions): Promise; /** * Retrieve a list of cost centres for a specified owner. * @method * @name EntitiesClient#listCostCentres * @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. */ listCostCentres(owner: string, offset?: number, limit?: number, sort?: string, filter?: string, $options?: RequestOptions): Promise; /** * Creates a new cost centre * @method * @name EntitiesClient#createCostCentre * @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) */ createCostCentre(request: CostCentreCreateRequest, $options?: RequestOptions): Promise; /** * Returns cost centre details for the specified id * @method * @name EntitiesClient#getCostCentre * @param {string} id - The UUID of the cost centre */ getCostCentre(id: string, $options?: RequestOptions): Promise; /** * Updates an existing cost centre * @method * @name EntitiesClient#updateCostCentre * @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) */ updateCostCentre(id: string, request: CostCentreUpdateRequest, $options?: RequestOptions): Promise; /** * Delete a cost centre * @method * @name EntitiesClient#deleteCostCentre * @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) */ deleteCostCentre(id: string, $options?: RequestOptions): Promise; /** * Retrieve a list of Dashboards for a specified owner. * @method * @name EntitiesClient#listDashboards * @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. */ listDashboards(owner: string, offset?: number, limit?: number, sort?: string, filter?: string, $options?: RequestOptions): Promise; /** * Creates a new dashboard entity * @method * @name EntitiesClient#createDashboard * @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) */ createDashboard(request: DashboardCreateRequest, $options?: RequestOptions): Promise; /** * Returns dashboard entity details for the specified id * @method * @name EntitiesClient#getDashboard * @param {string} id - The UUID of the Dashboard */ getDashboard(id: string, $options?: RequestOptions): Promise; /** * Updates an existing dashboard entity * @method * @name EntitiesClient#updateDashboard * @param {string} id - The UUID of the Dashboard * @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) */ updateDashboard(id: string, request: DashboardUpdateRequest, $options?: RequestOptions): Promise; /** * Permanently deletes a dashboard * @method * @name EntitiesClient#deleteDashboard * @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) */ deleteDashboard(id: string, $options?: RequestOptions): Promise; /** * Rebuilds a widget * @method * @name EntitiesClient#rebuildDashboardWidget * @param {string} id - The UUID of the dashboard to which the widget belongs * @param {string} widgetId - The UUID of the widget to rebuild */ rebuildDashboardWidget(id: string, widgetId: string, $options?: RequestOptions): Promise; /** * Retrieve a list of Dashboard templates for a specified owner. * @method * @name EntitiesClient#listDashboardTemplates * @param {string} owner - The owner id you are requesting data for * @param {boolean} recurse - Load items from the parent as well * @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. */ listDashboardTemplates(owner: string, recurse?: boolean, offset?: number, limit?: number, sort?: string, filter?: string, $options?: RequestOptions): Promise; /** * Creates a new dashboard template * @method * @name EntitiesClient#createDashboardTemplate * @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) */ createDashboardTemplate(request: DashboardTemplateCreateRequest, $options?: RequestOptions): Promise; /** * Returns dashboard template entity details for the specified id * @method * @name EntitiesClient#getDashboardTemplate * @param {string} id - The UUID of the Dashboard */ getDashboardTemplate(id: string, $options?: RequestOptions): Promise; /** * Updates an existing dashboard template entity * @method * @name EntitiesClient#updateDashboardTemplate * @param {string} id - The UUID of the Dashboard * @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) */ updateDashboardTemplate(id: string, request: DashboardTemplateUpdateRequest, $options?: RequestOptions): Promise; /** * Retrieve a list of devices for a specified owner. * @method * @name EntitiesClient#listDevices * @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. */ listDevices(owner: string, offset?: number, limit?: number, sort?: string, filter?: string, $options?: RequestOptions): Promise; /** * Creates a new device entity * @method * @name EntitiesClient#createDevice * @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) */ createDevice(request: DeviceCreateRequest, $options?: RequestOptions): Promise; /** * Returns device details for the specified id * @method * @name EntitiesClient#getDevice * @param {string} id - The UUID of the device */ getDevice(id: string, $options?: RequestOptions): Promise; /** * Updates an existing device * @method * @name EntitiesClient#updateDevice * @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) */ updateDevice(id: string, request: DeviceUpdateRequest, $options?: RequestOptions): Promise; /** * Returns device details for the specified device type and device IMEI or serial number * @method * @name EntitiesClient#getDeviceByName * @param {string} deviceType - The UUID of the device type * @param {string} deviceName - The name of the device (usually an IMEI or serial number) */ getDeviceByName(deviceType: string, deviceName: string, $options?: RequestOptions): Promise; /** * Retrieve a list of device config profiles for a specified owner. * @method * @name EntitiesClient#listDeviceConfigProfiles * @param {string} owner - The owner id you are requesting data for * @param {boolean} recurse - Load items from the parent as well * @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. */ listDeviceConfigProfiles(owner: string, recurse?: boolean, offset?: number, limit?: number, sort?: string, filter?: string, $options?: RequestOptions): Promise; /** * Creates a new DeviceConfig Profile entity * @method * @name EntitiesClient#createDeviceConfigProfile * @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) */ createDeviceConfigProfile(request: DeviceConfigProfileCreateRequest, $options?: RequestOptions): Promise; /** * Returns device config profile details for the specified id * @method * @name EntitiesClient#getDeviceConfigProfile * @param {string} id - The UUID of the device config profile */ getDeviceConfigProfile(id: string, $options?: RequestOptions): Promise; /** * Updates an existing DeviceConfig Profile entity * @method * @name EntitiesClient#updateDeviceConfigProfile * @param {string} id - The UUID of the DeviceConfig Profile * @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) */ updateDeviceConfigProfile(id: string, request: DeviceConfigProfileUpdateRequest, $options?: RequestOptions): Promise; /** * Retrieve a list of device types for a specified owner. * @method * @name EntitiesClient#listDeviceTypes * @param {string} owner - The owner id you are requesting data for * @param {boolean} recurse - Load items from the parent company tree as well (defaults to "true") * @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. */ listDeviceTypes(owner: string, recurse?: boolean, offset?: number, limit?: number, sort?: string, filter?: string, $options?: RequestOptions): Promise; /** * Creates a new device type entity * @method * @name EntitiesClient#createDeviceType * @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) */ createDeviceType(request: DeviceTypeCreateRequest, $options?: RequestOptions): Promise; /** * Returns device type details for the specified id * @method * @name EntitiesClient#getDeviceType * @param {string} id - The UUID of the device * @param {string} owner - The optional UUID of a Client. The device type may be customized based on settings and features in the client. */ getDeviceType(id: string, owner?: string, $options?: RequestOptions): Promise; /** * Updates an existing device type * @method * @name EntitiesClient#updateDeviceType * @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) */ updateDeviceType(id: string, request: DeviceTypeUpdateRequest, $options?: RequestOptions): Promise; /** * Retrieve a list of device providers for a specified owner. * @method * @name EntitiesClient#listDeviceProviders * @param {string} owner - The owner id you are requesting data for * @param {boolean} recurse - Load items from the parent as well * @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. */ listDeviceProviders(owner: string, recurse?: boolean, offset?: number, limit?: number, sort?: string, filter?: string, $options?: RequestOptions): Promise; /** * Creates a new device provider entity * @method * @name EntitiesClient#createDeviceProvider * @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) */ createDeviceProvider(request: DeviceProviderCreateRequest, $options?: RequestOptions): Promise; /** * Returns device provider details for the specified id * @method * @name EntitiesClient#getDeviceProvider * @param {string} id - The UUID of the device */ getDeviceProvider(id: string, $options?: RequestOptions): Promise; /** * Updates an existing device provider * @method * @name EntitiesClient#updateDeviceProvider * @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) */ updateDeviceProvider(id: string, request: DeviceProviderUpdateRequest, $options?: RequestOptions): Promise; /** * Retrieve a list of device provider types for a specified owner. * @method * @name EntitiesClient#listDeviceProviderTypes * @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. */ listDeviceProviderTypes(owner: string, offset?: number, limit?: number, sort?: string, filter?: string, $options?: RequestOptions): Promise; /** * Returns device provider type details for the specified id * @method * @name EntitiesClient#getDeviceProviderType * @param {string} id - The UUID of the device */ getDeviceProviderType(id: string, $options?: RequestOptions): Promise; /** * Retrieve a list of email providers. * @method * @name EntitiesClient#listEmailProviders * @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. */ listEmailProviders(owner: string, offset?: number, limit?: number, sort?: string, filter?: string, $options?: RequestOptions): Promise; /** * Creates a new email provider entity * @method * @name EntitiesClient#createEmailProvider * @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) */ createEmailProvider(request: EmailProviderCreateRequest, $options?: RequestOptions): Promise; /** * Returns email provider details for the specified id * @method * @name EntitiesClient#getEmailProvider * @param {string} id - The UUID of the email provider */ getEmailProvider(id: string, $options?: RequestOptions): Promise; /** * Updates an existing email provider entity * @method * @name EntitiesClient#updateEmailProvider * @param {string} id - The UUID of the email provider * @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) */ updateEmailProvider(id: string, request: EmailProviderUpdateRequest, $options?: RequestOptions): Promise; /** * Retrieve a list of export tasks for a specified owner. * @method * @name EntitiesClient#listExportTasks * @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. */ listExportTasks(owner: string, offset?: number, limit?: number, sort?: string, filter?: string, $options?: RequestOptions): Promise; /** * Creates a new export task entity * @method * @name EntitiesClient#createExportTask * @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) */ createExportTask(request: ExportTaskCreateRequest, $options?: RequestOptions): Promise; /** * Returns export task details for the specified id * @method * @name EntitiesClient#getExportTask * @param {string} id - The UUID of the export task */ getExportTask(id: string, $options?: RequestOptions): Promise; /** * Updates an existing export task entity * @method * @name EntitiesClient#updateExportTask * @param {string} id - The UUID of the export task * @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) */ updateExportTask(id: string, request: ExportTaskUpdateRequest, $options?: RequestOptions): Promise; /** * Retrieve a list of fuel cards for a specified owner. * @method * @name EntitiesClient#listFuelCards * @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. */ listFuelCards(owner: string, offset?: number, limit?: number, sort?: string, filter?: string, $options?: RequestOptions): Promise; /** * Creates a new fuel card * @method * @name EntitiesClient#createFuelCard * @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) */ createFuelCard(request: FuelCardCreateRequest, $options?: RequestOptions): Promise; /** * Returns fuel card details for the specified id * @method * @name EntitiesClient#getFuelCard * @param {string} id - The UUID of the fuel card */ getFuelCard(id: string, $options?: RequestOptions): Promise; /** * Updates an existing fuel card * @method * @name EntitiesClient#updateFuelCard * @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) */ updateFuelCard(id: string, request: FuelCardUpdateRequest, $options?: RequestOptions): Promise; /** * Retrieve a list of GeoLock profiles for a specified owner. * @method * @name EntitiesClient#listGeoLockProfiles * @param {string} owner - The owner id you are requesting data for * @param {boolean} recurse - Load items from the parent as well * @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. */ listGeoLockProfiles(owner: string, recurse?: boolean, offset?: number, limit?: number, sort?: string, filter?: string, $options?: RequestOptions): Promise; /** * Creates a new GeoLock Profile entity * @method * @name EntitiesClient#createGeoLockProfile * @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) */ createGeoLockProfile(request: GeoLockProfileCreateRequest, $options?: RequestOptions): Promise; /** * Returns GeoLock profile details for the specified id * @method * @name EntitiesClient#getGeoLockProfile * @param {string} id - The UUID of the GeoLock profile */ getGeoLockProfile(id: string, $options?: RequestOptions): Promise; /** * Updates an existing GeoLock Profile entity * @method * @name EntitiesClient#updateGeoLockProfile * @param {string} id - The UUID of the GeoLock Profile * @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) */ updateGeoLockProfile(id: string, request: GeoLockProfileUpdateRequest, $options?: RequestOptions): Promise; /** * Retrieve a list of I/O types for a specified owner. * @method * @name EntitiesClient#listIoTypes * @param {string} owner - The owner id you are requesting data for * @param {boolean} recurse - Load items from the parent as well * @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. */ listIoTypes(owner: string, recurse?: boolean, offset?: number, limit?: number, sort?: string, filter?: string, $options?: RequestOptions): Promise; /** * Creates a new I/O type entity * @method * @name EntitiesClient#createIoType * @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) */ createIoType(request: IoTypeCreateRequest, $options?: RequestOptions): Promise; /** * Returns I/O type details for the specified id * @method * @name EntitiesClient#getIoType * @param {string} id - The UUID of the I/O type */ getIoType(id: string, $options?: RequestOptions): Promise; /** * Updates an existing I/O type entity * @method * @name EntitiesClient#updateIoType * @param {string} id - The UUID of the I/O type * @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) */ updateIoType(id: string, request: IoTypeUpdateRequest, $options?: RequestOptions): Promise; /** * Retrieve a list of I/O types for a specified owner. * @method * @name EntitiesClient#listLabels * @param {string} owner - The owner id you are requesting data for * @param {boolean} recurse - Load items from the parent as well * @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. */ listLabels(owner: string, recurse?: boolean, offset?: number, limit?: number, sort?: string, filter?: string, $options?: RequestOptions): Promise; /** * Creates a new I/O type entity * @method * @name EntitiesClient#createLabel * @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) */ createLabel(request: LabelCreateRequest, $options?: RequestOptions): Promise; /** * Returns I/O type details for the specified id * @method * @name EntitiesClient#getLabel * @param {string} id - The UUID of the I/O type */ getLabel(id: string, $options?: RequestOptions): Promise; /** * Updates an existing I/O type entity * @method * @name EntitiesClient#updateLabel * @param {string} id - The UUID of the I/O type * @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) */ updateLabel(id: string, request: LabelUpdateRequest, $options?: RequestOptions): Promise; /** * Retrieve a list of lookups for a specified entity. * @method * @name EntitiesClient#getLookups * @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) */ getLookups(entity: string, $options?: RequestOptions): Promise; /** * Retrieve a list of map sets for a specified owner. * @method * @name EntitiesClient#listMapSets * @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. */ listMapSets(owner: string, offset?: number, limit?: number, sort?: string, filter?: string, $options?: RequestOptions): Promise; /** * Creates a new map set entity * @method * @name EntitiesClient#createMapSet * @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) */ createMapSet(request: MapsetCreateRequest, $options?: RequestOptions): Promise; /** * Retrieve a map set by it's ID. * @method * @name EntitiesClient#getMapSet * @param {string} id - The Map Set UUID to retrieve. */ getMapSet(id: string, $options?: RequestOptions): Promise; /** * Updates an existing map set entity * @method * @name EntitiesClient#updateMapSet * @param {string} id - The UUID of the mapset * @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) */ updateMapSet(id: string, request: MapsetUpdateRequest, $options?: RequestOptions): Promise; /** * Retrieve a list of overspeed profiles for a specified owner. * @method * @name EntitiesClient#listOverspeedProfiles * @param {string} owner - The owner id you are requesting data for * @param {boolean} recurse - Load items from the parent as well * @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. */ listOverspeedProfiles(owner: string, recurse?: boolean, offset?: number, limit?: number, sort?: string, filter?: string, $options?: RequestOptions): Promise; /** * Creates a new Overspeed Profile entity * @method * @name EntitiesClient#createOverspeedProfile * @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) */ createOverspeedProfile(request: OverspeedProfileCreateRequest, $options?: RequestOptions): Promise; /** * Returns overspeed profile details for the specified id * @method * @name EntitiesClient#getOverspeedProfile * @param {string} id - The UUID of the overspeed profile */ getOverspeedProfile(id: string, $options?: RequestOptions): Promise; /** * Updates an existing Overspeed Profile entity * @method * @name EntitiesClient#updateOverspeedProfile * @param {string} id - The UUID of the Overspeed Profile * @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) */ updateOverspeedProfile(id: string, request: OverspeedProfileUpdateRequest, $options?: RequestOptions): Promise; /** * Retrieve a list of Privacy profiles for a specified owner. * @method * @name EntitiesClient#listPrivacyProfiles * @param {string} owner - The owner id you are requesting data for * @param {boolean} recurse - Load items from the parent as well * @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. */ listPrivacyProfiles(owner: string, recurse?: boolean, offset?: number, limit?: number, sort?: string, filter?: string, $options?: RequestOptions): Promise; /** * Creates a new Privacy Profile entity * @method * @name EntitiesClient#createPrivacyProfile * @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) */ createPrivacyProfile(request: PrivacyProfileCreateRequest, $options?: RequestOptions): Promise; /** * Returns Privacy profile details for the specified id * @method * @name EntitiesClient#getPrivacyProfile * @param {string} id - The UUID of the Privacy profile */ getPrivacyProfile(id: string, $options?: RequestOptions): Promise; /** * Updates an existing Privacy Profile entity * @method * @name EntitiesClient#updatePrivacyProfile * @param {string} id - The UUID of the Privacy Profile * @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) */ updatePrivacyProfile(id: string, request: PrivacyProfileUpdateRequest, $options?: RequestOptions): Promise; /** * Retrieve a list of report definitions for a specified owner. * @method * @name EntitiesClient#listReportDefinitions * @param {string} owner - The owner id you are requesting data for */ listReportDefinitions(owner: string, $options?: RequestOptions): Promise; /** * Retrieve a report definition by it's ID. * @method * @name EntitiesClient#getReportDefinition * @param {string} id - The UUID to retrieve. */ getReportDefinition(id: string, $options?: RequestOptions): Promise; /** * Retrieve a list of report templates for a specified owner. * @method * @name EntitiesClient#listReportTemplates * @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. */ listReportTemplates(owner: string, offset?: number, limit?: number, sort?: string, filter?: string, $options?: RequestOptions): Promise; /** * Creates a new report template * @method * @name EntitiesClient#createReportTemplate * @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) */ createReportTemplate(request: ReportTemplateCreateRequest, $options?: RequestOptions): Promise; /** * Retrieve a report template by it's ID. * @method * @name EntitiesClient#getReportTemplate * @param {string} id - The UUID to retrieve. */ getReportTemplate(id: string, $options?: RequestOptions): Promise; /** * Updates an existing report template * @method * @name EntitiesClient#updateReportTemplate * @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) */ updateReportTemplate(id: string, request: ReportTemplateUpdateRequest, $options?: RequestOptions): Promise; /** * Deletes a report template * @method * @name EntitiesClient#deleteReportTemplate * @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) */ deleteReportTemplate(id: string, $options?: RequestOptions): Promise; /** * Retrieve a list of reminders for a specified owner. * @method * @name EntitiesClient#listReminders * @param {string} owner - The owner id you are requesting data for * @param {string} target - The target entity 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. */ listReminders(owner: string, target?: string, offset?: number, limit?: number, sort?: string, filter?: string, $options?: RequestOptions): Promise; /** * Creates a new reminder entity * @method * @name EntitiesClient#createReminder * @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) */ createReminder(request: ReminderCreateRequest, $options?: RequestOptions): Promise; /** * Retrieve a reminder by it's ID. * @method * @name EntitiesClient#getReminder * @param {string} id - The reminder UUID. */ getReminder(id: string, $options?: RequestOptions): Promise; /** * Updates an existing reminder entity * @method * @name EntitiesClient#updateReminder * @param {string} id - The reminder UUID. * @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) */ updateReminder(id: string, request: ReminderUpdateRequest, $options?: RequestOptions): Promise; /** * Deletes an existing reminder entity * @method * @name EntitiesClient#deleteReminder * @param {string} id - The reminder UUID. */ deleteReminder(id: string, $options?: RequestOptions): Promise; /** * Retrieve a list of road profiles for a specified owner. * @method * @name EntitiesClient#listRoadProfiles * @param {string} owner - The owner id you are requesting data for * @param {boolean} recurse - Load items from the parent as well * @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. */ listRoadProfiles(owner: string, recurse?: boolean, offset?: number, limit?: number, sort?: string, filter?: string, $options?: RequestOptions): Promise; /** * Creates a new Road Profile entity * @method * @name EntitiesClient#createRoadProfile * @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) */ createRoadProfile(request: RoadProfileCreateRequest, $options?: RequestOptions): Promise; /** * Returns road profile details for the specified id * @method * @name EntitiesClient#getRoadProfile * @param {string} id - The UUID of the road profile */ getRoadProfile(id: string, $options?: RequestOptions): Promise; /** * Updates an existing Road Profile entity * @method * @name EntitiesClient#updateRoadProfile * @param {string} id - The UUID of the Road Profile * @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) */ updateRoadProfile(id: string, request: RoadProfileUpdateRequest, $options?: RequestOptions): Promise; /** * Retrieve a list of scheduled reports for a specified owner. * @method * @name EntitiesClient#listScheduledReports * @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. */ listScheduledReports(owner: string, offset?: number, limit?: number, sort?: string, filter?: string, $options?: RequestOptions): Promise; /** * Creates a new scheduled report entity * @method * @name EntitiesClient#createScheduledReport * @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) */ createScheduledReport(request: ScheduledReportCreateRequest, $options?: RequestOptions): Promise; /** * Returns scheduled report details for the specified id * @method * @name EntitiesClient#getScheduledReport * @param {string} id - The UUID of the scheduled report */ getScheduledReport(id: string, $options?: RequestOptions): Promise; /** * Updates an existing scheduled report entity * @method * @name EntitiesClient#updateScheduledReport * @param {string} id - The UUID of the scheduled report * @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) */ updateScheduledReport(id: string, request: ScheduledReportUpdateRequest, $options?: RequestOptions): Promise; /** * Retrieve a list of SIM cards for a specified owner. * @method * @name EntitiesClient#listSimCards * @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. */ listSimCards(owner: string, offset?: number, limit?: number, sort?: string, filter?: string, $options?: RequestOptions): Promise; /** * Creates a new SIM card * @method * @name EntitiesClient#createSimCard * @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) */ createSimCard(request: SimCardCreateRequest, $options?: RequestOptions): Promise; /** * Returns SIM card details for the specified id * @method * @name EntitiesClient#getSimCard * @param {string} id - The UUID of the SIM card */ getSimCard(id: string, $options?: RequestOptions): Promise; /** * Updates an existing SIM card * @method * @name EntitiesClient#updateSimCard * @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) */ updateSimCard(id: string, request: SimCardUpdateRequest, $options?: RequestOptions): Promise; /** * Retrieve a list of sms gateway providers. * @method * @name EntitiesClient#listSmsGatewayProviders * @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. */ listSmsGatewayProviders(owner: string, offset?: number, limit?: number, sort?: string, filter?: string, $options?: RequestOptions): Promise; /** * Creates a new sms gateway provider entity * @method * @name EntitiesClient#createSmsGatewayProvider * @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) */ createSmsGatewayProvider(request: SmsGatewayProviderCreateRequest, $options?: RequestOptions): Promise; /** * Returns sms gateway provider details for the specified id * @method * @name EntitiesClient#getSmsGatewayProvider * @param {string} id - The UUID of the entity */ getSmsGatewayProvider(id: string, $options?: RequestOptions): Promise; /** * Updates an existing sms gateway provider entity * @method * @name EntitiesClient#updateSmsGatewayProvider * @param {string} id - The UUID of the sms gateway provider * @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) */ updateSmsGatewayProvider(id: string, request: SmsGatewayProviderUpdateRequest, $options?: RequestOptions): Promise; /** * Retrieve a list of sms gateway provider types. * @method * @name EntitiesClient#listSmsGatewayProviderTypes * @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. */ listSmsGatewayProviderTypes(owner: string, offset?: number, limit?: number, sort?: string, filter?: string, $options?: RequestOptions): Promise; /** * Returns sms gateway provider type details for the specified id * @method * @name EntitiesClient#getSmsGatewayProviderType * @param {string} id - The UUID of the entity */ getSmsGatewayProviderType(id: string, $options?: RequestOptions): Promise; /** * Retrieve a list of email provider types. * @method * @name EntitiesClient#listEmailProviderTypes * @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. */ listEmailProviderTypes(owner: string, offset?: number, limit?: number, sort?: string, filter?: string, $options?: RequestOptions): Promise; /** * Returns email provider type details for the specified id * @method * @name EntitiesClient#getEmailProviderType * @param {string} id - The UUID of the entity */ getEmailProviderType(id: string, $options?: RequestOptions): Promise; /** * Retrieve a list of themes for a specified owner. * @method * @name EntitiesClient#listThemes * @param {string} owner - The owner id you are requesting data for * @param {boolean} recurse - 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} 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 - 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} 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) */ listThemes(owner: string, recurse?: boolean, offset?: number, limit?: number, sort?: string, filter?: string, $options?: RequestOptions): Promise; /** * Creates a new Theme entity * @method * @name EntitiesClient#createTheme * @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) */ createTheme(request: ThemeCreateRequest, $options?: RequestOptions): Promise; /** * Returns Theme details for the specified id * @method * @name EntitiesClient#getTheme * @param {string} id - The UUID of the Theme */ getTheme(id: string, $options?: RequestOptions): Promise; /** * Updates an existing Theme entity * @method * @name EntitiesClient#updateTheme * @param {string} id - The UUID of the Theme * @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) */ updateTheme(id: string, request: ThemeUpdateRequest, $options?: RequestOptions): Promise; /** * Returns client details for the specified id * @method * @name EntitiesClient#getThemeForDomain * @param {string} domain - The domain name to look up */ getThemeForDomain(domain: string, $options?: RequestOptions): Promise; /** * Return the specified vendor's logo in binary format. Should the vendor not have a custom logo, the logo of the distributor will be supplied. * @method * @name EntitiesClient#getThemeLogo * @param {string} id - The vendor UUID you are requesting data for. * @param {string} size - The size of the returned image. Can be either "small" or "large". * @param {boolean} recurse - If the theme doesn't have a logo, should we go up the client tree and try find one? */ getThemeLogo(id: string, size?: string, recurse?: boolean, $options?: RequestOptions): Promise; /** * Updates the theme logo. * @method * @name EntitiesClient#updateThemeLogo * @param {string} id - The theme UUID you are requesting data for. * @param {string} size - The size of the image. Can be either "small" or "large". */ updateThemeLogo(id: string, size: string, $options?: RequestOptions): Promise; /** * Permanently deletes a theme logo. * @method * @name EntitiesClient#deleteThemeLogo * @param {string} id - The theme UUID. * @param {string} size - The size of the image. Can be either "small" or "large". */ deleteThemeLogo(id: string, size: string, $options?: RequestOptions): Promise; /** * Retrieve a list of zone groups for a specified owner. * @method * @name EntitiesClient#listZoneGroups * @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. */ listZoneGroups(owner: string, offset?: number, limit?: number, sort?: string, filter?: string, $options?: RequestOptions): Promise; /** * Creates a new Zone Group * @method * @name EntitiesClient#createZoneGroup * @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) */ createZoneGroup(request: ZoneGroupCreateRequest, $options?: RequestOptions): Promise; /** * Returns zone group details for the specified id * @method * @name EntitiesClient#getZoneGroup * @param {string} id - The UUID of the zone group */ getZoneGroup(id: string, $options?: RequestOptions): Promise; /** * Updates an existing Zone Group * @method * @name EntitiesClient#updateZoneGroup * @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) */ updateZoneGroup(id: string, request: ZoneGroupUpdateRequest, $options?: RequestOptions): Promise; /** * Delete a Zone Group * @method * @name EntitiesClient#deleteZoneGroup * @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) */ deleteZoneGroup(id: string, $options?: RequestOptions): Promise; /** * Retrieve a list of zones for a specified owner. * @method * @name EntitiesClient#listZones * @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} bounds - A bounding rectangle to restrict the result set to in string format as `left,top,right,bottom` */ listZones(owner: string, offset?: number, limit?: number, sort?: string, filter?: string, bounds?: string, $options?: RequestOptions): Promise; /** * Creates a new zone * @method * @name EntitiesClient#createZone * @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) */ createZone(request: ZoneCreateRequest, $options?: RequestOptions): Promise; /** * Retrieve a Map Set by it's ID. * @method * @name EntitiesClient#getZone * @param {string} id - The Map Set UUID to retrieve. */ getZone(id: string, $options?: RequestOptions): Promise; /** * Updates an existing zone * @method * @name EntitiesClient#updateZone * @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) */ updateZone(id: string, request: ZoneUpdateRequest, $options?: RequestOptions): Promise; /** * Retrieve a list of ssl certificates. * @method * @name EntitiesClient#listSslCertificates * @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. */ listSslCertificates(owner: string, offset?: number, limit?: number, sort?: string, filter?: string, $options?: RequestOptions): Promise; /** * Creates a new ssl certificate entity * @method * @name EntitiesClient#createSslCertificate * @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) */ createSslCertificate(request: SslCertificateCreateRequest, $options?: RequestOptions): Promise; /** * Returns ssl certificate details for the specified id * @method * @name EntitiesClient#getSslCertificate * @param {string} id - The UUID of the ssl certificate */ getSslCertificate(id: string, $options?: RequestOptions): Promise; /** * Updates an existing ssl certificate entity * @method * @name EntitiesClient#updateSslCertificate * @param {string} id - The UUID of the ssl certificate * @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) */ updateSslCertificate(id: string, request: SslCertificateUpdateRequest, $options?: RequestOptions): Promise; /** * Validates the ssl certificate and all prerequisites * @method * @name EntitiesClient#validateSslCertificate * @param {string} id - The UUID of the ssl certificate */ validateSslCertificate(id: string, $options?: RequestOptions): Promise; /** * Attempts to provision the ssl certificate * @method * @name EntitiesClient#provisionSslCertificate * @param {string} id - The UUID of the ssl certificate */ provisionSslCertificate(id: string, $options?: RequestOptions): Promise; }