@iotize/tap/service/impl/cloud/lib/generated/service.d.ts

IoTize Device client for Javascript

/**
 *   Generated file. Do not edit
 */
import { TapResponse } from '@iotize/tap';
import { CloudPlatform } from './models';
import { AbstractService, ServiceCallType } from '@iotize/tap';
export declare class CloudService extends AbstractService {
    resources: {
        getPlatform: ServiceCallType<void, CloudPlatform>;
        putPlatform: ServiceCallType<CloudPlatform, void>;
        getDataLogUploadPeriod: ServiceCallType<void, number>;
        putDataLogUploadPeriod: ServiceCallType<number, void>;
        getMqttBrokerPort: ServiceCallType<void, string>;
        putMqttBrokerPort: ServiceCallType<string, void>;
        getMqttClientId: ServiceCallType<void, string>;
        putMqttClientId: ServiceCallType<string, void>;
        getMqttUsername: ServiceCallType<void, string>;
        putMqttUsername: ServiceCallType<string, void>;
        getMqttPassword: ServiceCallType<void, string>;
        putMqttPassword: ServiceCallType<string, void>;
        getDataLogPublishTopic: ServiceCallType<void, string>;
        putDataLogPublishTopic: ServiceCallType<string, void>;
        getDataLogSubscribeTopic: ServiceCallType<void, string>;
        putDataLogSubscribeTopic: ServiceCallType<string, void>;
    };
    /**
     * Get cloud connection mode
     *
     * LWM2M path: /1024//26
     *
     * @tapVersion(">=1.0")
     * @return
     */
    getPlatform(): Promise<TapResponse<CloudPlatform>>;
    /**
     *
     *
     * LWM2M path: /1024//26
     *
     * @tapVersion(">=1.0")
     * @return call options
     */
    getPlatformCall(): ServiceCallType;
    /**
     * Write cloud connection mode
     *
     * LWM2M path: /1024//26
     *
     * @tapVersion(">=1.0")
     * @param key input
     * @return
     */
    putPlatform(key: CloudPlatform): Promise<TapResponse<void>>;
    /**
     *
     *
     * LWM2M path: /1024//26
     *
     * @tapVersion(">=1.0")
     * @param key input
     * @return call options
     */
    putPlatformCall(key: CloudPlatform): ServiceCallType;
    /**
     * Uploading period for the cloud
     *
     * LWM2M path: /1024//33
     *
     * @tapVersion(">=1.0")
     * @return
     */
    getDataLogUploadPeriod(): Promise<TapResponse<number>>;
    /**
     *
     *
     * LWM2M path: /1024//33
     *
     * @tapVersion(">=1.0")
     * @return call options
     */
    getDataLogUploadPeriodCall(): ServiceCallType;
    /**
     * Write cloud mqtt period
     *
     * LWM2M path: /1024//33
     *
     * @tapVersion(">=1.0")
     * @param key input
     * @return
     */
    putDataLogUploadPeriod(key: number): Promise<TapResponse<void>>;
    /**
     *
     *
     * LWM2M path: /1024//33
     *
     * @tapVersion(">=1.0")
     * @param key input
     * @return call options
     */
    putDataLogUploadPeriodCall(key: number): ServiceCallType;
    /**
     * Get the cloud MQTT broker port
     *
     * LWM2M path: /1024//61
     *
     * @tapVersion(">=1.0")
     * @return
     */
    getMqttBrokerPort(): Promise<TapResponse<string>>;
    /**
     *
     *
     * LWM2M path: /1024//61
     *
     * @tapVersion(">=1.0")
     * @return call options
     */
    getMqttBrokerPortCall(): ServiceCallType;
    /**
     * Write cloud MQTT broker port
     *
     * LWM2M path: /1024//61
     *
     * @tapVersion(">=1.0")
     * @param name input
     * @return
     */
    putMqttBrokerPort(name: string): Promise<TapResponse<void>>;
    /**
     *
     *
     * LWM2M path: /1024//61
     *
     * @tapVersion(">=1.0")
     * @param name input
     * @return call options
     */
    putMqttBrokerPortCall(name: string): ServiceCallType;
    /**
     * Get cloud MQTT client id
     *
     * LWM2M path: /1024//27
     *
     * @tapVersion(">=1.0")
     * @return
     */
    getMqttClientId(): Promise<TapResponse<string>>;
    /**
     *
     *
     * LWM2M path: /1024//27
     *
     * @tapVersion(">=1.0")
     * @return call options
     */
    getMqttClientIdCall(): ServiceCallType;
    /**
     * Write cloud MQTT client id
     *
     * LWM2M path: /1024//27
     *
     * @tapVersion(">=1.0")
     * @param value input
     * @return
     */
    putMqttClientId(value: string): Promise<TapResponse<void>>;
    /**
     *
     *
     * LWM2M path: /1024//27
     *
     * @tapVersion(">=1.0")
     * @param value input
     * @return call options
     */
    putMqttClientIdCall(value: string): ServiceCallType;
    /**
     * Get cloud MQTT login id
     *
     * LWM2M path: /1024//28
     *
     * @tapVersion(">=1.0")
     * @return
     */
    getMqttUsername(): Promise<TapResponse<string>>;
    /**
     *
     *
     * LWM2M path: /1024//28
     *
     * @tapVersion(">=1.0")
     * @return call options
     */
    getMqttUsernameCall(): ServiceCallType;
    /**
     * Write cloud MQTT login id
     *
     * LWM2M path: /1024//28
     *
     * @tapVersion(">=1.0")
     * @param key input
     * @return
     */
    putMqttUsername(key: string): Promise<TapResponse<void>>;
    /**
     *
     *
     * LWM2M path: /1024//28
     *
     * @tapVersion(">=1.0")
     * @param key input
     * @return call options
     */
    putMqttUsernameCall(key: string): ServiceCallType;
    /**
     * Get cloud MQTT user password
     *
     * LWM2M path: /1024//29
     *
     * @tapVersion(">=1.0")
     * @return
     */
    getMqttPassword(): Promise<TapResponse<string>>;
    /**
     *
     *
     * LWM2M path: /1024//29
     *
     * @tapVersion(">=1.0")
     * @return call options
     */
    getMqttPasswordCall(): ServiceCallType;
    /**
     * Write cloud MQTT user password
     *
     * LWM2M path: /1024//29
     *
     * @tapVersion(">=1.0")
     * @param key input
     * @return
     */
    putMqttPassword(key: string): Promise<TapResponse<void>>;
    /**
     *
     *
     * LWM2M path: /1024//29
     *
     * @tapVersion(">=1.0")
     * @param key input
     * @return call options
     */
    putMqttPasswordCall(key: string): ServiceCallType;
    /**
     * Get cloud data log public topic
     *
     * LWM2M path: /1024//68
     *
     * @tapVersion(">=1.0")
     * @return
     */
    getDataLogPublishTopic(): Promise<TapResponse<string>>;
    /**
     *
     *
     * LWM2M path: /1024//68
     *
     * @tapVersion(">=1.0")
     * @return call options
     */
    getDataLogPublishTopicCall(): ServiceCallType;
    /**
     * Write cloud data log publish topic
     *
     * LWM2M path: /1024//68
     *
     * @tapVersion(">=1.0")
     * @param key input
     * @return
     */
    putDataLogPublishTopic(key: string): Promise<TapResponse<void>>;
    /**
     *
     *
     * LWM2M path: /1024//68
     *
     * @tapVersion(">=1.0")
     * @param key input
     * @return call options
     */
    putDataLogPublishTopicCall(key: string): ServiceCallType;
    /**
     * Get cloud data log subscribe topic
     *
     * LWM2M path: /1024//69
     *
     * @tapVersion(">=1.0")
     * @return
     */
    getDataLogSubscribeTopic(): Promise<TapResponse<string>>;
    /**
     *
     *
     * LWM2M path: /1024//69
     *
     * @tapVersion(">=1.0")
     * @return call options
     */
    getDataLogSubscribeTopicCall(): ServiceCallType;
    /**
     * Write cloud data log subscribe topic
     *
     * LWM2M path: /1024//69
     *
     * @tapVersion(">=1.0")
     * @param key input
     * @return
     */
    putDataLogSubscribeTopic(key: string): Promise<TapResponse<void>>;
    /**
     *
     *
     * LWM2M path: /1024//69
     *
     * @tapVersion(">=1.0")
     * @param key input
     * @return call options
     */
    putDataLogSubscribeTopicCall(key: string): ServiceCallType;
}