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

IoTize Device client for Javascript

/**
 *   Generated file. Do not edit
 */
import { TapResponse } from '@iotize/tap';
import { WifiMode } from './models';
import { WifiProtocol } from './models';
import { WifiSSIDVisibility } from './models';
import { WifiKeyVisibility } from './models';
import { AbstractService, ServiceCallType } from '@iotize/tap';
export declare class WifiService extends AbstractService {
    resources: {
        getMode: ServiceCallType<void, WifiMode>;
        putMode: ServiceCallType<WifiMode, void>;
        getKey: ServiceCallType<void, string>;
        putKey: ServiceCallType<string, void>;
        getHostname: ServiceCallType<void, string>;
        getIp: ServiceCallType<void, string>;
        /**
         *
         *
         * LWM2M path: /1024//16
         *
         * @tapVersion(">=1.0")
         * @return call options
         */
        putIp: ServiceCallType<string, void>;
        getGatewayIp: ServiceCallType<void, string>;
        putGatewayIp: ServiceCallType<string, void>;
        getIpMask: ServiceCallType<void, string>;
        putIpMask: ServiceCallType<string, void>;
        getDnsIp: ServiceCallType<void, string>;
        putDnsIp: ServiceCallType<string, void>;
        getSSID: ServiceCallType<void, string>;
        putSSID: ServiceCallType<string, void>;
        getCountryCode: ServiceCallType<void, number>;
        putCountryCode: ServiceCallType<number, void>;
        getProtocol: ServiceCallType<void, WifiProtocol>;
        putProtocol: ServiceCallType<WifiProtocol[], void>;
        getTxPower: ServiceCallType<void, number>;
        putTxPower: ServiceCallType<number, void>;
        getSSIDVisibility: ServiceCallType<void, WifiSSIDVisibility>;
        putSSIDVisibility: ServiceCallType<WifiSSIDVisibility, void>;
        getKeyVisibility: ServiceCallType<void, WifiKeyVisibility>;
        putKeyVisibility: ServiceCallType<WifiKeyVisibility, void>;
        getNetworkMode: ServiceCallType<void, WifiMode>;
        putNetworkMode: ServiceCallType<WifiMode, void>;
        getDisabled: ServiceCallType<void, boolean>;
        putDisabled: ServiceCallType<boolean, void>;
    };
    /**
     * Get Wi-Fi mode
     *
     * LWM2M path: /1024//15
     *
     * @tapVersion(">=1.0")
     * @return
     */
    getMode(): Promise<TapResponse<WifiMode>>;
    /**
     *
     *
     * LWM2M path: /1024//15
     *
     * @tapVersion(">=1.0")
     * @return call options
     */
    getModeCall(): ServiceCallType;
    /**
     * Write Wi-Fi mode
     *
     * LWM2M path: /1024//15
     *
     * @tapVersion(">=1.0")
     * @param mode input
     * @return
     */
    putMode(mode: WifiMode): Promise<TapResponse<void>>;
    /**
     *
     *
     * LWM2M path: /1024//15
     *
     * @tapVersion(">=1.0")
     * @param mode input
     * @return call options
     */
    putModeCall(mode: WifiMode): ServiceCallType;
    /**
     * Get Wi-Fi key
     *
     * LWM2M path: /1024//16
     *
     * @tapVersion(">=1.0")
     * @return
     */
    getKey(): Promise<TapResponse<string>>;
    /**
     *
     *
     * LWM2M path: /1024//16
     *
     * @tapVersion(">=1.0")
     * @return call options
     */
    getKeyCall(): ServiceCallType;
    /**
     * Write network key
     *
     * LWM2M path: /1024//16
     *
     * @tapVersion(">=1.0")
     * @param key input
     * @return
     */
    putKey(key: string): Promise<TapResponse<void>>;
    /**
     *
     *
     * LWM2M path: /1024//16
     *
     * @tapVersion(">=1.0")
     * @param key input
     * @return call options
     */
    putKeyCall(key: string): ServiceCallType;
    /**
     * Get Wi-Fi hostname
     *
     * LWM2M path: /1024//35
     *
     * @tapVersion(">=1.0")
     * @return
     */
    getHostname(): Promise<TapResponse<string>>;
    /**
     *
     *
     * LWM2M path: /1024//35
     *
     * @tapVersion(">=1.0")
     * @return call options
     */
    getHostnameCall(): ServiceCallType;
    /**
     * Get IoTize device ip on the network
     *
     * LWM2M path: /1024//30
     *
     * @tapVersion(">=1.0")
     * @return
     */
    getIp(): Promise<TapResponse<string>>;
    /**
     *
     *
     * LWM2M path: /1024//30
     *
     * @tapVersion(">=1.0")
     * @return call options
     */
    getIpCall(): ServiceCallType;
    /**
     * Write Tap IP
     *
     * LWM2M path: /1024//30
     *
     * @tapVersion(">=1.0")
     * @param key input
     * @return
     */
    putIp(key: string): Promise<TapResponse<void>>;
    /**
     *
     *
     * LWM2M path: /1024//30
     *
     * @tapVersion(">=1.0")
     * @param key input
     * @return call options
     */
    putIpCall(key: string): ServiceCallType;
    /**
     * Get gateway ip on the network
     *
     * LWM2M path: /1024//31
     *
     * @tapVersion(">=1.0")
     * @return
     */
    getGatewayIp(): Promise<TapResponse<string>>;
    /**
     *
     *
     * LWM2M path: /1024//31
     *
     * @tapVersion(">=1.0")
     * @return call options
     */
    getGatewayIpCall(): ServiceCallType;
    /**
     * Write gateway ip
     *
     * LWM2M path: /1024//31
     *
     * @tapVersion(">=1.0")
     * @param key input
     * @return
     */
    putGatewayIp(key: string): Promise<TapResponse<void>>;
    /**
     *
     *
     * LWM2M path: /1024//31
     *
     * @tapVersion(">=1.0")
     * @param key input
     * @return call options
     */
    putGatewayIpCall(key: string): ServiceCallType;
    /**
     * Get network ip mask
     *
     * LWM2M path: /1024//32
     *
     * @tapVersion(">=1.0")
     * @return
     */
    getIpMask(): Promise<TapResponse<string>>;
    /**
     *
     *
     * LWM2M path: /1024//32
     *
     * @tapVersion(">=1.0")
     * @return call options
     */
    getIpMaskCall(): ServiceCallType;
    /**
     * Write network ip mask
     *
     * LWM2M path: /1024//32
     *
     * @tapVersion(">=1.0")
     * @param key input
     * @return
     */
    putIpMask(key: string): Promise<TapResponse<void>>;
    /**
     *
     *
     * LWM2M path: /1024//32
     *
     * @tapVersion(">=1.0")
     * @param key input
     * @return call options
     */
    putIpMaskCall(key: string): ServiceCallType;
    /**
     * Get network dns ip
     *
     * LWM2M path: /1024//124
     *
     * @tapVersion(">=1.0")
     * @return
     */
    getDnsIp(): Promise<TapResponse<string>>;
    /**
     *
     *
     * LWM2M path: /1024//124
     *
     * @tapVersion(">=1.0")
     * @return call options
     */
    getDnsIpCall(): ServiceCallType;
    /**
     * Write network dns ip
     *
     * LWM2M path: /1024//124
     *
     * @tapVersion(">=1.0")
     * @param key input
     * @return
     */
    putDnsIp(key: string): Promise<TapResponse<void>>;
    /**
     *
     *
     * LWM2M path: /1024//124
     *
     * @tapVersion(">=1.0")
     * @param key input
     * @return call options
     */
    putDnsIpCall(key: string): ServiceCallType;
    /**
     * Get Wi-Fi ssid
     *
     * LWM2M path: /1024//25
     *
     * @tapVersion(">=1.0")
     * @return
     */
    getSSID(): Promise<TapResponse<string>>;
    /**
     *
     *
     * LWM2M path: /1024//25
     *
     * @tapVersion(">=1.0")
     * @return call options
     */
    getSSIDCall(): ServiceCallType;
    /**
     * Write Wi-Fi ssid
     *
     * LWM2M path: /1024//25
     *
     * @tapVersion(">=1.0")
     * @param key input
     * @return
     */
    putSSID(key: string): Promise<TapResponse<void>>;
    /**
     *
     *
     * LWM2M path: /1024//25
     *
     * @tapVersion(">=1.0")
     * @param key input
     * @return call options
     */
    putSSIDCall(key: string): ServiceCallType;
    /**
     * Get Wi-Fi country code
     *
     * LWM2M path: /1024//95
     *
     * @tapVersion(">=1.88")
     * @return
     */
    getCountryCode(): Promise<TapResponse<number>>;
    /**
     *
     *
     * LWM2M path: /1024//95
     *
     * @tapVersion(">=1.88")
     * @return call options
     */
    getCountryCodeCall(): ServiceCallType;
    /**
     * Write Wi-Fi country code
     *
     * LWM2M path: /1024//95
     *
     * @tapVersion(">=1.88")
     * @param countryCode input
     * @return
     */
    putCountryCode(countryCode: number): Promise<TapResponse<void>>;
    /**
     *
     *
     * LWM2M path: /1024//95
     *
     * @tapVersion(">=1.88")
     * @param countryCode input
     * @return call options
     */
    putCountryCodeCall(countryCode: number): ServiceCallType;
    /**
     * Get Wi-Fi protocol
     *
     * LWM2M path: /1024//96
     *
     * @tapVersion(">=1.88")
     * @return
     */
    getProtocol(): Promise<TapResponse<WifiProtocol>>;
    /**
     *
     *
     * LWM2M path: /1024//96
     *
     * @tapVersion(">=1.88")
     * @return call options
     */
    getProtocolCall(): ServiceCallType;
    /**
     * Write Wi-Fi protocol
     *
     * LWM2M path: /1024//96
     *
     * @tapVersion(">=1.88")
     * @param protocol input
     * @return
     */
    putProtocol(protocol: WifiProtocol[]): Promise<TapResponse<void>>;
    /**
     *
     *
     * LWM2M path: /1024//96
     *
     * @tapVersion(">=1.88")
     * @param protocol input
     * @return call options
     */
    putProtocolCall(protocol: WifiProtocol[]): ServiceCallType;
    /**
     * Get Wi-Fi TX max power
     *
     * LWM2M path: /1024//97
     *
     * @tapVersion(">=1.88")
     * @return
     */
    getTxPower(): Promise<TapResponse<number>>;
    /**
     *
     *
     * LWM2M path: /1024//97
     *
     * @tapVersion(">=1.88")
     * @return call options
     */
    getTxPowerCall(): ServiceCallType;
    /**
     * Write Wi-Fi TX max power
     *
     * LWM2M path: /1024//97
     *
     * @tapVersion(">=1.88")
     * @param maxPower input
     * @return
     */
    putTxPower(maxPower: number): Promise<TapResponse<void>>;
    /**
     *
     *
     * LWM2M path: /1024//97
     *
     * @tapVersion(">=1.88")
     * @param maxPower input
     * @return call options
     */
    putTxPowerCall(maxPower: number): ServiceCallType;
    /**
     * Get Wi-Fi SSID visibility
     *
     * LWM2M path: /1024//98
     *
     * @tapVersion(">=1.88")
     * @return
     */
    getSSIDVisibility(): Promise<TapResponse<WifiSSIDVisibility>>;
    /**
     *
     *
     * LWM2M path: /1024//98
     *
     * @tapVersion(">=1.88")
     * @return call options
     */
    getSSIDVisibilityCall(): ServiceCallType;
    /**
     * Write Wi-Fi SSID visibility
     *
     * LWM2M path: /1024//98
     *
     * @tapVersion(">=1.88")
     * @param visibility input
     * @return
     */
    putSSIDVisibility(visibility: WifiSSIDVisibility): Promise<TapResponse<void>>;
    /**
     *
     *
     * LWM2M path: /1024//98
     *
     * @tapVersion(">=1.88")
     * @param visibility input
     * @return call options
     */
    putSSIDVisibilityCall(visibility: WifiSSIDVisibility): ServiceCallType;
    /**
     * Get Wi-Fi key visibility
     *
     * LWM2M path: /1024//99
     *
     * @tapVersion(">=1.88")
     * @return
     */
    getKeyVisibility(): Promise<TapResponse<WifiKeyVisibility>>;
    /**
     *
     *
     * LWM2M path: /1024//99
     *
     * @tapVersion(">=1.88")
     * @return call options
     */
    getKeyVisibilityCall(): ServiceCallType;
    /**
     * Write Wi-Fi key visibility
     *
     * LWM2M path: /1024//99
     *
     * @tapVersion(">=1.88")
     * @param visibility input
     * @return
     */
    putKeyVisibility(visibility: WifiKeyVisibility): Promise<TapResponse<void>>;
    /**
     *
     *
     * LWM2M path: /1024//99
     *
     * @tapVersion(">=1.88")
     * @param visibility input
     * @return call options
     */
    putKeyVisibilityCall(visibility: WifiKeyVisibility): ServiceCallType;
    /**
     * Get Wi-Fi network mode
     *
     * LWM2M path: /1024//128
     *
     * @tapVersion(">=2.13")
     * @return
     */
    getNetworkMode(): Promise<TapResponse<WifiMode>>;
    /**
     *
     *
     * LWM2M path: /1024//128
     *
     * @tapVersion(">=2.13")
     * @return call options
     */
    getNetworkModeCall(): ServiceCallType;
    /**
     * Write Wi-Fi network mode
     *
     * LWM2M path: /1024//128
     *
     * @tapVersion(">=2.13")
     * @param mode input
     * @return
     */
    putNetworkMode(mode: WifiMode): Promise<TapResponse<void>>;
    /**
     *
     *
     * LWM2M path: /1024//128
     *
     * @tapVersion(">=2.13")
     * @param mode input
     * @return call options
     */
    putNetworkModeCall(mode: WifiMode): ServiceCallType;
    /**
     * Get Wi-Fi disable status
     *
     * LWM2M path: /1024//129
     *
     * @tapVersion(">=2.13")
     * @return
     */
    getDisabled(): Promise<TapResponse<boolean>>;
    /**
     *
     *
     * LWM2M path: /1024//129
     *
     * @tapVersion(">=2.13")
     * @return call options
     */
    getDisabledCall(): ServiceCallType;
    /**
     * Write Wi-Fi disable status
     *
     * LWM2M path: /1024//129
     *
     * @tapVersion(">=2.13")
     * @param isDisabled input
     * @return
     */
    putDisabled(isDisabled: boolean): Promise<TapResponse<void>>;
    /**
     *
     *
     * LWM2M path: /1024//129
     *
     * @tapVersion(">=2.13")
     * @param isDisabled input
     * @return call options
     */
    putDisabledCall(isDisabled: boolean): ServiceCallType;
}