UNPKG

@c8y/client

Version:

Client application programming interface to access the Cumulocity IoT-Platform REST services.

35 lines 1.29 kB
import { Service, IResult } from '../core/index.js'; import { ITenantSecurityOption } from './ITenantSecurityOption.js'; /** * @description * This service allows to get tenant security option. */ export declare class TenantSecurityOptionsService extends Service<ITenantSecurityOption> { protected baseUrl: string; protected listUrl: string; protected category: string; protected propertyName: string; /** * Get a specific tenant's security option. * * @param {ITenantSecurityOption} Tenant's security option object with key value. * * @returns Returns promise object that is resolved with the ITenantSecurityOption wrapped by IResult. * * **Example** * ```typescript * * const option: ITenantSecurityOption = { * key: 'limit.validity' * }; * * (async () => { * const {data, res} = await tenantSecurityOptionsService.detail(option); * })(); * ``` */ detail(tenantSecurityOption: ITenantSecurityOption): Promise<IResult<ITenantSecurityOption>>; protected getDetailUrl(tenantSecurityOption: ITenantSecurityOption): string; protected onBeforeCreate(obj: ITenantSecurityOption): any; } //# sourceMappingURL=TenantSecurityOptionsService.d.ts.map