@iotize/tap
Version:
IoTize Device client for Javascript
1,826 lines (1,825 loc) • 46.6 kB
TypeScript
/**
* Generated file. Do not edit
*/
import { TapResponse } from '@iotize/tap';
import { LoginCredential } from './models';
import { LoginCredentialHashed } from './models';
import { HostProtocol } from '@iotize/tap';
import { SecurityOptions } from './models';
import { NfcPairingMode } from './models';
import { WirelessPairingOptions } from './models';
import { LowPowerOptimizationLevel } from './models';
import { CpuFrequencyOptions } from './models';
import { CpuFrequencySpeed } from './models';
import { PowerOptimizationOptions } from './models';
import { ServiceCode } from './models';
import { NetworkOptions } from './models';
import { NfcConnectionPriority } from './models';
import { ProtocolMaxFrameSize } from './models';
import { MultiRequestFrame } from './models';
import { MultiResponseFrame } from './models';
import { AbstractService, ServiceCallType } from '@iotize/tap';
export declare class InterfaceService extends AbstractService {
resources: {
login: ServiceCallType<LoginCredential, void>;
loginWithHash: ServiceCallType<LoginCredentialHashed, void>;
logout: ServiceCallType<void, void>;
getCurrentProfileId: ServiceCallType<void, number>;
getCurrentHostProtocol: ServiceCallType<void, HostProtocol>;
putCurrentHostProtocol: ServiceCallType<HostProtocol, void>;
getUID: ServiceCallType<void, Uint8Array>;
loginWithUID: ServiceCallType<Uint8Array, void>;
keepAlive: ServiceCallType<void, number>;
postKeepAlive: ServiceCallType<void, void>;
getSecurityOptions: ServiceCallType<void, SecurityOptions>;
putSecurityOptions: ServiceCallType<SecurityOptions, void>;
getCurrentGroupId: ServiceCallType<void, number>;
getBundleIdSwdDirectAccess: ServiceCallType<void, number>;
putBundleIdSwdDirectAccess: ServiceCallType<number, void>;
getBundleIdSerialAccess: ServiceCallType<void, number>;
putBundleIdSerialAccess: ServiceCallType<number, void>;
getBundleIdModbusDirectAccess: ServiceCallType<void, number>;
putBundleIdModbusDirectAccess: ServiceCallType<number, void>;
getBundleIdTapnpassControlAccess: ServiceCallType<void, number>;
putBundleIdTapnpassControlAccess: ServiceCallType<number, void>;
getBundleIdFirmwareUpdateAccess: ServiceCallType<void, number>;
putBundleIdFirmwareUpdateAccess: ServiceCallType<number, void>;
getBundleIdMqttIdsAccess: ServiceCallType<void, number>;
putBundleIdMqttIdsAccess: ServiceCallType<number, void>;
getBundleIdVariableConfigAccess: ServiceCallType<void, number>;
putBundleIdVariableConfigAccess: ServiceCallType<number, void>;
getBundleIdFileSystemAccess: ServiceCallType<void, number>; /**
*
*
* LWM2M path: /1024//6
*
* @tapVersion(">=1.0")
* @param infos input
* @return call options
*/
putBundleIdFileSystemAccess: ServiceCallType<number, void>;
getConfigFormatVersion: ServiceCallType<void, number>;
putConfigFormatVersion: ServiceCallType<number, void>;
getAppName: ServiceCallType<void, string>;
putAppName: ServiceCallType<string, void>;
getConfigVersion: ServiceCallType<void, string>;
putConfigVersion: ServiceCallType<string, void>;
reloadConfig: ServiceCallType<void, void>;
getAppPath: ServiceCallType<void, string>;
putAppPath: ServiceCallType<string, void>;
postAppPath: ServiceCallType<string, void>;
getNfcPairingMode: ServiceCallType<void, NfcPairingMode>;
putNfcPairingMode: ServiceCallType<NfcPairingMode, void>;
getPairingOptions: ServiceCallType<void, WirelessPairingOptions>;
postPairingOptions: ServiceCallType<WirelessPairingOptions, void>;
putPairingOptions: ServiceCallType<WirelessPairingOptions, void>;
getPowerOptimisationLevel: ServiceCallType<void, LowPowerOptimizationLevel>;
putPowerOptimisationLevel: ServiceCallType<LowPowerOptimizationLevel, void>;
getCpuFrequencyOptions: ServiceCallType<void, CpuFrequencyOptions>;
putCpuFrequencyOptions: ServiceCallType<CpuFrequencySpeed, void>;
getPowerOptimisationOptions: ServiceCallType<void, PowerOptimizationOptions>;
putPowerOptimisationOptions: ServiceCallType<PowerOptimizationOptions, void>;
getMaxLowPowerTime: ServiceCallType<void, number>;
putMaxLowPowerTime: ServiceCallType<number, void>;
getAutoRebootTimeout: ServiceCallType<void, number>;
putAutoRebootTimeout: ServiceCallType<number, void>;
getAuthorizedHostProtocol: ServiceCallType<void, HostProtocol[]>;
putAuthorizedHostProtocol: ServiceCallType<HostProtocol[], void>;
getConfigFormatFirmwareVersion: ServiceCallType<void, number>;
getUniversalLink: ServiceCallType<void, string>;
putUniversalLink: ServiceCallType<string, void>;
postUniversalLink: ServiceCallType<string, void>;
listObjectInstances: ServiceCallType<number, Uint8Array>;
getAvailableHostProtocols: ServiceCallType<void, HostProtocol[]>;
getDisabledServices: ServiceCallType<void, ServiceCode[]>;
postDisabledServices: ServiceCallType<ServiceCode[], void>;
getNetworkOptions: ServiceCallType<void, NetworkOptions>;
putNetworkOptions: ServiceCallType<NetworkOptions, void>;
getRadioMixEnabled: ServiceCallType<void, number>;
putRadioMixEnabled: ServiceCallType<number, void>;
getNfcConnectionPriority: ServiceCallType<void, NfcConnectionPriority>;
postNfcConnectionPriority: ServiceCallType<NfcConnectionPriority, void>;
putNfcConnectionPriority: ServiceCallType<NfcConnectionPriority, void>;
getNfcAutologProfileId: ServiceCallType<void, number>;
putNfcAutologProfileId: ServiceCallType<number, void>;
getHostInactivityPeriod: ServiceCallType<void, number>;
putHostInactivityPeriod: ServiceCallType<number, void>;
getApplicationData: ServiceCallType<void, Uint8Array>;
putApplicationData: ServiceCallType<Uint8Array, void>;
postApplicationData: ServiceCallType<Uint8Array, void>;
getProductKey: ServiceCallType<void, string>;
getCurrentHostProtocolMaxFrameSize: ServiceCallType<void, ProtocolMaxFrameSize>;
executeMultiRequestFrame: ServiceCallType<MultiRequestFrame, MultiResponseFrame>;
putCertificatePublicKey: ServiceCallType<Uint8Array, void>;
putCertificatePrivateKey: ServiceCallType<Uint8Array, void>;
putCertificateRootKey: ServiceCallType<Uint8Array, void>;
getProductCode: ServiceCallType<void, string>;
putProductCode: ServiceCallType<string, void>;
getSpecialFeatureProfile: ServiceCallType<void, number>;
setSpecialFeatureProfile: ServiceCallType<number, void>;
putSpecialFeatureProfile: ServiceCallType<number, void>;
};
/**
* Login
*
* LWM2M path: /1024//0
*
* @tapVersion(">=1.0")
* @param credential input
* @return
*/
login(credential: LoginCredential): Promise<TapResponse<void>>;
/**
*
*
* LWM2M path: /1024//0
*
* @tapVersion(">=1.0")
* @param credential input
* @return call options
*/
loginCall(credential: LoginCredential): ServiceCallType;
/**
* Login
*
* LWM2M path: /1024//0
*
* @tapVersion(">=1.0")
* @param credential input
* @return
*/
loginWithHash(credential: LoginCredentialHashed): Promise<TapResponse<void>>;
/**
*
*
* LWM2M path: /1024//0
*
* @tapVersion(">=1.0")
* @param credential input
* @return call options
*/
loginWithHashCall(credential: LoginCredentialHashed): ServiceCallType;
/**
* Logout
*
* LWM2M path: /1024//1
*
* @tapVersion(">=1.0")
* @return
*/
logout(): Promise<TapResponse<void>>;
/**
*
*
* LWM2M path: /1024//1
*
* @tapVersion(">=1.0")
* @return call options
*/
logoutCall(): ServiceCallType;
/**
* Get current profile id
*
* LWM2M path: /1024//2
*
* @tapVersion(">=1.0")
* @return
*/
getCurrentProfileId(): Promise<TapResponse<number>>;
/**
*
*
* LWM2M path: /1024//2
*
* @tapVersion(">=1.0")
* @return call options
*/
getCurrentProfileIdCall(): ServiceCallType;
/**
* Get current host protocol
*
* LWM2M path: /1024//3
*
* @tapVersion(">=1.0")
* @return
*/
getCurrentHostProtocol(): Promise<TapResponse<HostProtocol>>;
/**
*
*
* LWM2M path: /1024//3
*
* @tapVersion(">=1.0")
* @return call options
*/
getCurrentHostProtocolCall(): ServiceCallType;
/**
* Write current host protocol
*
* LWM2M path: /1024//3
*
* @tapVersion(">=1.0")
* @param hostProtocol input
* @return
*/
putCurrentHostProtocol(hostProtocol: HostProtocol): Promise<TapResponse<void>>;
/**
*
*
* LWM2M path: /1024//3
*
* @tapVersion(">=1.0")
* @param hostProtocol input
* @return call options
*/
putCurrentHostProtocolCall(hostProtocol: HostProtocol): ServiceCallType;
/**
* Get UID value
*
* LWM2M path: /1024//5
*
* @tapVersion(">=1.0")
* @return
*/
getUID(): Promise<TapResponse<Uint8Array>>;
/**
*
*
* LWM2M path: /1024//5
*
* @tapVersion(">=1.0")
* @return call options
*/
getUIDCall(): ServiceCallType;
/**
* Administrator login with UID.
*
* LWM2M path: /1024//5
*
* @tapVersion(">=1.0")
* @param uid input
* @return
*/
loginWithUID(uid: Uint8Array): Promise<TapResponse<void>>;
/**
*
*
* LWM2M path: /1024//5
*
* @tapVersion(">=1.0")
* @param uid input
* @return call options
*/
loginWithUIDCall(uid: Uint8Array): ServiceCallType;
/**
* Keep alive.
*
* LWM2M path: /1024//4
*
* @tapVersion(">=1.0")
* @return
*/
keepAlive(): Promise<TapResponse<number>>;
/**
*
*
* LWM2M path: /1024//4
*
* @tapVersion(">=1.0")
* @return call options
*/
keepAliveCall(): ServiceCallType;
/**
* Keep alive.
*
* LWM2M path: /1024//4
*
* @tapVersion(">=1.0")
* @return
*/
postKeepAlive(): Promise<TapResponse<void>>;
/**
*
*
* LWM2M path: /1024//4
*
* @tapVersion(">=1.0")
* @return call options
*/
postKeepAliveCall(): ServiceCallType;
/**
* Get lock infos
*
* LWM2M path: /1024//6
*
* @tapVersion(">=1.0")
* @return
*/
getSecurityOptions(): Promise<TapResponse<SecurityOptions>>;
/**
*
*
* LWM2M path: /1024//6
*
* @tapVersion(">=1.0")
* @return call options
*/
getSecurityOptionsCall(): ServiceCallType;
/**
* Put lock infos
*
* LWM2M path: /1024//6
*
* @tapVersion(">=1.0")
* @param infos input
* @return
*/
putSecurityOptions(infos: SecurityOptions): Promise<TapResponse<void>>;
/**
*
*
* LWM2M path: /1024//6
*
* @tapVersion(">=1.0")
* @param infos input
* @return call options
*/
putSecurityOptionsCall(infos: SecurityOptions): ServiceCallType;
/**
* Get current group id
*
* LWM2M path: /1024//7
*
* @tapVersion(">=1.0")
* @return
*/
getCurrentGroupId(): Promise<TapResponse<number>>;
/**
*
*
* LWM2M path: /1024//7
*
* @tapVersion(">=1.0")
* @return call options
*/
getCurrentGroupIdCall(): ServiceCallType;
/**
* Get bundle Id for SWD Direct
*
* LWM2M path: /1024//100
*
* @tapVersion(">=1.23")
* @return
*/
getBundleIdSwdDirectAccess(): Promise<TapResponse<number>>;
/**
*
*
* LWM2M path: /1024//100
*
* @tapVersion(">=1.23")
* @return call options
*/
getBundleIdSwdDirectAccessCall(): ServiceCallType;
/**
* Set bundle Id for SWD Direct
*
* LWM2M path: /1024//100
*
* @tapVersion(">=1.23")
* @param bundleId input
* @return
*/
putBundleIdSwdDirectAccess(bundleId: number): Promise<TapResponse<void>>;
/**
*
*
* LWM2M path: /1024//100
*
* @tapVersion(">=1.23")
* @param bundleId input
* @return call options
*/
putBundleIdSwdDirectAccessCall(bundleId: number): ServiceCallType;
/**
* Get bundle Id for Serial Direct
*
* LWM2M path: /1024//101
*
* @tapVersion(">=1.23")
* @return
*/
getBundleIdSerialAccess(): Promise<TapResponse<number>>;
/**
*
*
* LWM2M path: /1024//101
*
* @tapVersion(">=1.23")
* @return call options
*/
getBundleIdSerialAccessCall(): ServiceCallType;
/**
* Set bundle Id for Serial Direct
*
* LWM2M path: /1024//101
*
* @tapVersion(">=1.23")
* @param bundleId input
* @return
*/
putBundleIdSerialAccess(bundleId: number): Promise<TapResponse<void>>;
/**
*
*
* LWM2M path: /1024//101
*
* @tapVersion(">=1.23")
* @param bundleId input
* @return call options
*/
putBundleIdSerialAccessCall(bundleId: number): ServiceCallType;
/**
* Get bundle Id for Modbus Direct
*
* LWM2M path: /1024//102
*
* @tapVersion(">=1.23")
* @return
*/
getBundleIdModbusDirectAccess(): Promise<TapResponse<number>>;
/**
*
*
* LWM2M path: /1024//102
*
* @tapVersion(">=1.23")
* @return call options
*/
getBundleIdModbusDirectAccessCall(): ServiceCallType;
/**
* Set bundle Id for Modbus Direct
*
* LWM2M path: /1024//102
*
* @tapVersion(">=1.23")
* @param bundleId input
* @return
*/
putBundleIdModbusDirectAccess(bundleId: number): Promise<TapResponse<void>>;
/**
*
*
* LWM2M path: /1024//102
*
* @tapVersion(">=1.23")
* @param bundleId input
* @return call options
*/
putBundleIdModbusDirectAccessCall(bundleId: number): ServiceCallType;
/**
* Get bundle Id for TapNPass Control
*
* LWM2M path: /1024//103
*
* @tapVersion(">=1.23")
* @return
*/
getBundleIdTapnpassControlAccess(): Promise<TapResponse<number>>;
/**
*
*
* LWM2M path: /1024//103
*
* @tapVersion(">=1.23")
* @return call options
*/
getBundleIdTapnpassControlAccessCall(): ServiceCallType;
/**
* Set bundle Id for TapNPass Control
*
* LWM2M path: /1024//103
*
* @tapVersion(">=1.23")
* @param bundleId input
* @return
*/
putBundleIdTapnpassControlAccess(bundleId: number): Promise<TapResponse<void>>;
/**
*
*
* LWM2M path: /1024//103
*
* @tapVersion(">=1.23")
* @param bundleId input
* @return call options
*/
putBundleIdTapnpassControlAccessCall(bundleId: number): ServiceCallType;
/**
* Get bundle Id for Firmware Update
*
* LWM2M path: /1024//104
*
* @tapVersion(">=1.35")
* @return
*/
getBundleIdFirmwareUpdateAccess(): Promise<TapResponse<number>>;
/**
*
*
* LWM2M path: /1024//104
*
* @tapVersion(">=1.35")
* @return call options
*/
getBundleIdFirmwareUpdateAccessCall(): ServiceCallType;
/**
* Set bundle Id for Firmware Update
*
* LWM2M path: /1024//104
*
* @tapVersion(">=1.35")
* @param bundleId input
* @return
*/
putBundleIdFirmwareUpdateAccess(bundleId: number): Promise<TapResponse<void>>;
/**
*
*
* LWM2M path: /1024//104
*
* @tapVersion(">=1.35")
* @param bundleId input
* @return call options
*/
putBundleIdFirmwareUpdateAccessCall(bundleId: number): ServiceCallType;
/**
* Get bundle Id for MQTT IDs
*
* LWM2M path: /1024//105
*
* @tapVersion(">=1.35")
* @return
*/
getBundleIdMqttIdsAccess(): Promise<TapResponse<number>>;
/**
*
*
* LWM2M path: /1024//105
*
* @tapVersion(">=1.35")
* @return call options
*/
getBundleIdMqttIdsAccessCall(): ServiceCallType;
/**
* Set bundle Id for MQTT IDs
*
* LWM2M path: /1024//105
*
* @tapVersion(">=1.35")
* @param bundleId input
* @return
*/
putBundleIdMqttIdsAccess(bundleId: number): Promise<TapResponse<void>>;
/**
*
*
* LWM2M path: /1024//105
*
* @tapVersion(">=1.35")
* @param bundleId input
* @return call options
*/
putBundleIdMqttIdsAccessCall(bundleId: number): ServiceCallType;
/**
* Get bundle Id for Variable Config
*
* LWM2M path: /1024//106
*
* @tapVersion(">=2.11")
* @return
*/
getBundleIdVariableConfigAccess(): Promise<TapResponse<number>>;
/**
*
*
* LWM2M path: /1024//106
*
* @tapVersion(">=2.11")
* @return call options
*/
getBundleIdVariableConfigAccessCall(): ServiceCallType;
/**
* Set bundle Id for Variable Config
*
* LWM2M path: /1024//106
*
* @tapVersion(">=2.11")
* @param bundleId input
* @return
*/
putBundleIdVariableConfigAccess(bundleId: number): Promise<TapResponse<void>>;
/**
*
*
* LWM2M path: /1024//106
*
* @tapVersion(">=2.11")
* @param bundleId input
* @return call options
*/
putBundleIdVariableConfigAccessCall(bundleId: number): ServiceCallType;
/**
* Get bundle Id for File System
*
* LWM2M path: /1024//107
*
* @tapVersion(">=2.13")
* @return
*/
getBundleIdFileSystemAccess(): Promise<TapResponse<number>>;
/**
*
*
* LWM2M path: /1024//107
*
* @tapVersion(">=2.13")
* @return call options
*/
getBundleIdFileSystemAccessCall(): ServiceCallType;
/**
* Set bundle Id for File System
*
* LWM2M path: /1024//107
*
* @tapVersion(">=2.13")
* @param bundleId input
* @return
*/
putBundleIdFileSystemAccess(bundleId: number): Promise<TapResponse<void>>;
/**
*
*
* LWM2M path: /1024//107
*
* @tapVersion(">=2.13")
* @param bundleId input
* @return call options
*/
putBundleIdFileSystemAccessCall(bundleId: number): ServiceCallType;
/**
* Get config format version
*
* LWM2M path: /1024//8
*
* @tapVersion(">=1.0")
* @return
*/
getConfigFormatVersion(): Promise<TapResponse<number>>;
/**
*
*
* LWM2M path: /1024//8
*
* @tapVersion(">=1.0")
* @return call options
*/
getConfigFormatVersionCall(): ServiceCallType;
/**
* Set config format version
*
* LWM2M path: /1024//8
*
* @tapVersion(">=1.0")
* @param configFormat input
* @return
*/
putConfigFormatVersion(configFormat: number): Promise<TapResponse<void>>;
/**
*
*
* LWM2M path: /1024//8
*
* @tapVersion(">=1.0")
* @param configFormat input
* @return call options
*/
putConfigFormatVersionCall(configFormat: number): ServiceCallType;
/**
* Get application name
*
* LWM2M path: /1024//9
*
* @tapVersion(">=1.0")
* @return
*/
getAppName(): Promise<TapResponse<string>>;
/**
*
*
* LWM2M path: /1024//9
*
* @tapVersion(">=1.0")
* @return call options
*/
getAppNameCall(): ServiceCallType;
/**
* Set application name
*
* LWM2M path: /1024//9
*
* @tapVersion(">=1.0")
* @param appName input
* @return
*/
putAppName(appName: string): Promise<TapResponse<void>>;
/**
*
*
* LWM2M path: /1024//9
*
* @tapVersion(">=1.0")
* @param appName input
* @return call options
*/
putAppNameCall(appName: string): ServiceCallType;
/**
* Get config version
*
* LWM2M path: /1024//10
*
* @tapVersion(">=1.0")
* @return
*/
getConfigVersion(): Promise<TapResponse<string>>;
/**
*
*
* LWM2M path: /1024//10
*
* @tapVersion(">=1.0")
* @return call options
*/
getConfigVersionCall(): ServiceCallType;
/**
* Set config version
*
* LWM2M path: /1024//10
*
* @tapVersion(">=1.0")
* @param version input
* @return
*/
putConfigVersion(version: string): Promise<TapResponse<void>>;
/**
*
*
* LWM2M path: /1024//10
*
* @tapVersion(">=1.0")
* @param version input
* @return call options
*/
putConfigVersionCall(version: string): ServiceCallType;
/**
* Apply the new configuration on the Tap
*
* LWM2M path: /1024//10
*
* @tapVersion(">=1.0")
* @return
*/
reloadConfig(): Promise<TapResponse<void>>;
/**
*
*
* LWM2M path: /1024//10
*
* @tapVersion(">=1.0")
* @return call options
*/
reloadConfigCall(): ServiceCallType;
/**
* Get app path
*
* LWM2M path: /1024//11
*
* @tapVersion(">=1.0")
* @return
*/
getAppPath(): Promise<TapResponse<string>>;
/**
*
*
* LWM2M path: /1024//11
*
* @tapVersion(">=1.0")
* @return call options
*/
getAppPathCall(): ServiceCallType;
/**
* Set app path
*
* LWM2M path: /1024//11
*
* @tapVersion(">=1.0")
* @param value input
* @return
*/
putAppPath(value: string): Promise<TapResponse<void>>;
/**
*
*
* LWM2M path: /1024//11
*
* @tapVersion(">=1.0")
* @param value input
* @return call options
*/
putAppPathCall(value: string): ServiceCallType;
/**
* Set app path
*
* LWM2M path: /1024//11
*
* @tapVersion(">=1.0")
* @param value input
* @return
*/
postAppPath(value: string): Promise<TapResponse<void>>;
/**
*
*
* LWM2M path: /1024//11
*
* @tapVersion(">=1.0")
* @param value input
* @return call options
*/
postAppPathCall(value: string): ServiceCallType;
/**
* Check if nfc paring is mandatory
*
* LWM2M path: /1024//13
*
* @tapVersion(">=1.0")
* @return
*/
getNfcPairingMode(): Promise<TapResponse<NfcPairingMode>>;
/**
*
*
* LWM2M path: /1024//13
*
* @tapVersion(">=1.0")
* @return call options
*/
getNfcPairingModeCall(): ServiceCallType;
/**
* Change wether nfc pairing is mandatory.
*
* LWM2M path: /1024//13
*
* @tapVersion(">=1.0")
* @param mode input
* @return
*/
putNfcPairingMode(mode: NfcPairingMode): Promise<TapResponse<void>>;
/**
*
*
* LWM2M path: /1024//13
*
* @tapVersion(">=1.0")
* @param mode input
* @return call options
*/
putNfcPairingModeCall(mode: NfcPairingMode): ServiceCallType;
/**
* Get pairing options
*
* LWM2M path: /1024//13
*
* @tapVersion(">=1.0")
* @return
*/
getPairingOptions(): Promise<TapResponse<WirelessPairingOptions>>;
/**
*
*
* LWM2M path: /1024//13
*
* @tapVersion(">=1.0")
* @return call options
*/
getPairingOptionsCall(): ServiceCallType;
/**
* Set pairing options (temporary)
*
* LWM2M path: /1024//13
*
* @tapVersion(">=1.0")
* @param options input
* @return
*/
postPairingOptions(options: WirelessPairingOptions): Promise<TapResponse<void>>;
/**
*
*
* LWM2M path: /1024//13
*
* @tapVersion(">=1.0")
* @param options input
* @return call options
*/
postPairingOptionsCall(options: WirelessPairingOptions): ServiceCallType;
/**
* Write pairing options
*
* LWM2M path: /1024//13
*
* @tapVersion(">=1.0")
* @param options input
* @return
*/
putPairingOptions(options: WirelessPairingOptions): Promise<TapResponse<void>>;
/**
*
*
* LWM2M path: /1024//13
*
* @tapVersion(">=1.0")
* @param options input
* @return call options
*/
putPairingOptionsCall(options: WirelessPairingOptions): ServiceCallType;
/**
* Get power optimization level
*
* LWM2M path: /1024//14
*
* @tapVersion(">=1.0")
* @return
*/
getPowerOptimisationLevel(): Promise<TapResponse<LowPowerOptimizationLevel>>;
/**
*
*
* LWM2M path: /1024//14
*
* @tapVersion(">=1.0")
* @return call options
*/
getPowerOptimisationLevelCall(): ServiceCallType;
/**
* Write power optimization level
*
* LWM2M path: /1024//14
*
* @tapVersion(">=1.0")
* @param mode input
* @return
*/
putPowerOptimisationLevel(mode: LowPowerOptimizationLevel): Promise<TapResponse<void>>;
/**
*
*
* LWM2M path: /1024//14
*
* @tapVersion(">=1.0")
* @param mode input
* @return call options
*/
putPowerOptimisationLevelCall(mode: LowPowerOptimizationLevel): ServiceCallType;
/**
* Get Tap CPU frequency options
*
* LWM2M path: /1024//141
*
* @tapVersion(">=2.15")
* @return
*/
getCpuFrequencyOptions(): Promise<TapResponse<CpuFrequencyOptions>>;
/**
*
*
* LWM2M path: /1024//141
*
* @tapVersion(">=2.15")
* @return call options
*/
getCpuFrequencyOptionsCall(): ServiceCallType;
/**
* Write Tap CPU frequency setting
*
* LWM2M path: /1024//141
*
* @tapVersion(">=2.15")
* @param mode input
* @return
*/
putCpuFrequencyOptions(mode: CpuFrequencySpeed): Promise<TapResponse<void>>;
/**
*
*
* LWM2M path: /1024//141
*
* @tapVersion(">=2.15")
* @param mode input
* @return call options
*/
putCpuFrequencyOptionsCall(mode: CpuFrequencySpeed): ServiceCallType;
/**
* Get power optimization options
*
* LWM2M path: /1024//142
*
* @tapVersion(">=2.15")
* @return
*/
getPowerOptimisationOptions(): Promise<TapResponse<PowerOptimizationOptions>>;
/**
*
*
* LWM2M path: /1024//142
*
* @tapVersion(">=2.15")
* @return call options
*/
getPowerOptimisationOptionsCall(): ServiceCallType;
/**
* Write power optimization options
*
* LWM2M path: /1024//142
*
* @tapVersion(">=2.15")
* @param mode input
* @return
*/
putPowerOptimisationOptions(mode: PowerOptimizationOptions): Promise<TapResponse<void>>;
/**
*
*
* LWM2M path: /1024//142
*
* @tapVersion(">=2.15")
* @param mode input
* @return call options
*/
putPowerOptimisationOptionsCall(mode: PowerOptimizationOptions): ServiceCallType;
/**
* Get Maximum duration of the low power state
*
* LWM2M path: /1024//33
*
* @tapVersion(">=1.0")
* @return
*/
getMaxLowPowerTime(): Promise<TapResponse<number>>;
/**
*
*
* LWM2M path: /1024//33
*
* @tapVersion(">=1.0")
* @return call options
*/
getMaxLowPowerTimeCall(): ServiceCallType;
/**
* Set Maximum duration of the low power state
*
* LWM2M path: /1024//33
*
* @tapVersion(">=1.0")
* @param key input
* @return
*/
putMaxLowPowerTime(key: number): Promise<TapResponse<void>>;
/**
*
*
* LWM2M path: /1024//33
*
* @tapVersion(">=1.0")
* @param key input
* @return call options
*/
putMaxLowPowerTimeCall(key: number): ServiceCallType;
/**
* Read auto reboot timeout value
*
* LWM2M path: /1024//123
*
* @tapVersion(">=2.11")
* @return
*/
getAutoRebootTimeout(): Promise<TapResponse<number>>;
/**
*
*
* LWM2M path: /1024//123
*
* @tapVersion(">=2.11")
* @return call options
*/
getAutoRebootTimeoutCall(): ServiceCallType;
/**
* Write auto reboot timeout value
*
* LWM2M path: /1024//123
*
* @tapVersion(">=2.11")
* @param bundleId input
* @return
*/
putAutoRebootTimeout(bundleId: number): Promise<TapResponse<void>>;
/**
*
*
* LWM2M path: /1024//123
*
* @tapVersion(">=2.11")
* @param bundleId input
* @return call options
*/
putAutoRebootTimeoutCall(bundleId: number): ServiceCallType;
/**
* Get authorized host protocols
*
* LWM2M path: /1024//17
*
* @tapVersion(">=1.0")
* @return
*/
getAuthorizedHostProtocol(): Promise<TapResponse<HostProtocol[]>>;
/**
*
*
* LWM2M path: /1024//17
*
* @tapVersion(">=1.0")
* @return call options
*/
getAuthorizedHostProtocolCall(): ServiceCallType;
/**
* Write authorized host protocols
*
* LWM2M path: /1024//17
*
* @tapVersion(">=1.0")
* @param mode input
* @return
*/
putAuthorizedHostProtocol(mode: HostProtocol[]): Promise<TapResponse<void>>;
/**
*
*
* LWM2M path: /1024//17
*
* @tapVersion(">=1.0")
* @param mode input
* @return call options
*/
putAuthorizedHostProtocolCall(mode: HostProtocol[]): ServiceCallType;
/**
* Get config format firmware version
*
* LWM2M path: /1024//18
*
* @tapVersion(">=1.0")
* @return
*/
getConfigFormatFirmwareVersion(): Promise<TapResponse<number>>;
/**
*
*
* LWM2M path: /1024//18
*
* @tapVersion(">=1.0")
* @return call options
*/
getConfigFormatFirmwareVersionCall(): ServiceCallType;
/**
* Get configured universal link value
*
* LWM2M path: /1024//19
*
* @tapVersion(">=1.0")
* @return
*/
getUniversalLink(): Promise<TapResponse<string>>;
/**
*
*
* LWM2M path: /1024//19
*
* @tapVersion(">=1.0")
* @return call options
*/
getUniversalLinkCall(): ServiceCallType;
/**
* Write universal link value
*
* LWM2M path: /1024//19
*
* @tapVersion(">=1.0")
* @param url input
* @return
*/
putUniversalLink(url: string): Promise<TapResponse<void>>;
/**
*
*
* LWM2M path: /1024//19
*
* @tapVersion(">=1.0")
* @param url input
* @return call options
*/
putUniversalLinkCall(url: string): ServiceCallType;
/**
* Set universal link value
*
* LWM2M path: /1024//19
*
* @tapVersion(">=1.0")
* @param value input
* @return
*/
postUniversalLink(value: string): Promise<TapResponse<void>>;
/**
*
*
* LWM2M path: /1024//19
*
* @tapVersion(">=1.0")
* @param value input
* @return call options
*/
postUniversalLinkCall(value: string): ServiceCallType;
/**
* List instances of another object
*
* LWM2M path: /1024//140
*
* @tapVersion(">=2.13")
* @param objectId input
* @return
*/
listObjectInstances(objectId: number): Promise<TapResponse<Uint8Array>>;
/**
*
*
* LWM2M path: /1024//140
*
* @tapVersion(">=2.13")
* @param objectId input
* @return call options
*/
listObjectInstancesCall(objectId: number): ServiceCallType;
/**
* Get available host protocols
*
* LWM2M path: /1024//21
*
* @tapVersion(">=1.0")
* @return
*/
getAvailableHostProtocols(): Promise<TapResponse<HostProtocol[]>>;
/**
*
*
* LWM2M path: /1024//21
*
* @tapVersion(">=1.0")
* @return call options
*/
getAvailableHostProtocolsCall(): ServiceCallType;
/**
* Get currently disabled service list
*
* LWM2M path: /1024//75
*
* @tapVersion(">=1.107")
* @return
*/
getDisabledServices(): Promise<TapResponse<ServiceCode[]>>;
/**
*
*
* LWM2M path: /1024//75
*
* @tapVersion(">=1.107")
* @return call options
*/
getDisabledServicesCall(): ServiceCallType;
/**
* Enable/disable execution of services
*
* LWM2M path: /1024//75
*
* @tapVersion(">=1.107")
* @param serviceCodes input
* @return
*/
postDisabledServices(serviceCodes: ServiceCode[]): Promise<TapResponse<void>>;
/**
*
*
* LWM2M path: /1024//75
*
* @tapVersion(">=1.107")
* @param serviceCodes input
* @return call options
*/
postDisabledServicesCall(serviceCodes: ServiceCode[]): ServiceCallType;
/**
* Get network options
*
* LWM2M path: /1024//127
*
* @tapVersion(">=2.13")
* @return
*/
getNetworkOptions(): Promise<TapResponse<NetworkOptions>>;
/**
*
*
* LWM2M path: /1024//127
*
* @tapVersion(">=2.13")
* @return call options
*/
getNetworkOptionsCall(): ServiceCallType;
/**
* Write network options
*
* LWM2M path: /1024//127
*
* @tapVersion(">=2.13")
* @param mode input
* @return
*/
putNetworkOptions(mode: NetworkOptions): Promise<TapResponse<void>>;
/**
*
*
* LWM2M path: /1024//127
*
* @tapVersion(">=2.13")
* @param mode input
* @return call options
*/
putNetworkOptionsCall(mode: NetworkOptions): ServiceCallType;
/**
* Get Radio Mix enable status
*
* LWM2M path: /1024//132
*
* @tapVersion(">=2.13")
* @return
*/
getRadioMixEnabled(): Promise<TapResponse<number>>;
/**
*
*
* LWM2M path: /1024//132
*
* @tapVersion(">=2.13")
* @return call options
*/
getRadioMixEnabledCall(): ServiceCallType;
/**
* Write LTE enable status
*
* LWM2M path: /1024//132
*
* @tapVersion(">=2.13")
* @param mode input
* @return
*/
putRadioMixEnabled(mode: number): Promise<TapResponse<void>>;
/**
*
*
* LWM2M path: /1024//132
*
* @tapVersion(">=2.13")
* @param mode input
* @return call options
*/
putRadioMixEnabledCall(mode: number): ServiceCallType;
/**
* Get NFC connection priority over other protocols
*
* LWM2M path: /1024//24
*
* @tapVersion(">=1.85")
* @return
*/
getNfcConnectionPriority(): Promise<TapResponse<NfcConnectionPriority>>;
/**
*
*
* LWM2M path: /1024//24
*
* @tapVersion(">=1.85")
* @return call options
*/
getNfcConnectionPriorityCall(): ServiceCallType;
/**
* Set NFC connection priority over other protocols (until reboot)
*
* LWM2M path: /1024//24
*
* @tapVersion(">=1.85")
* @param key input
* @return
*/
postNfcConnectionPriority(key: NfcConnectionPriority): Promise<TapResponse<void>>;
/**
*
*
* LWM2M path: /1024//24
*
* @tapVersion(">=1.85")
* @param key input
* @return call options
*/
postNfcConnectionPriorityCall(key: NfcConnectionPriority): ServiceCallType;
/**
* Write in configuration NFC connection priority over other protocols
*
* LWM2M path: /1024//24
*
* @tapVersion(">=1.85")
* @param key input
* @return
*/
putNfcConnectionPriority(key: NfcConnectionPriority): Promise<TapResponse<void>>;
/**
*
*
* LWM2M path: /1024//24
*
* @tapVersion(">=1.85")
* @param key input
* @return call options
*/
putNfcConnectionPriorityCall(key: NfcConnectionPriority): ServiceCallType;
/**
* Get NFC autolog profile id
*
* LWM2M path: /1024//43
*
* @tapVersion(">=1.55")
* @return
*/
getNfcAutologProfileId(): Promise<TapResponse<number>>;
/**
*
*
* LWM2M path: /1024//43
*
* @tapVersion(">=1.55")
* @return call options
*/
getNfcAutologProfileIdCall(): ServiceCallType;
/**
* Write NFC autolog profile id
*
* LWM2M path: /1024//43
*
* @tapVersion(">=1.55")
* @param value input
* @return
*/
putNfcAutologProfileId(value: number): Promise<TapResponse<void>>;
/**
*
*
* LWM2M path: /1024//43
*
* @tapVersion(">=1.55")
* @param value input
* @return call options
*/
putNfcAutologProfileIdCall(value: number): ServiceCallType;
/**
* Get host inactivity period
*
* LWM2M path: /1024//34
*
* @tapVersion(">=1.0")
* @return
*/
getHostInactivityPeriod(): Promise<TapResponse<number>>;
/**
*
*
* LWM2M path: /1024//34
*
* @tapVersion(">=1.0")
* @return call options
*/
getHostInactivityPeriodCall(): ServiceCallType;
/**
* Write host inactivity timeout
*
* LWM2M path: /1024//34
*
* @tapVersion(">=1.0")
* @param key input
* @return
*/
putHostInactivityPeriod(key: number): Promise<TapResponse<void>>;
/**
*
*
* LWM2M path: /1024//34
*
* @tapVersion(">=1.0")
* @param key input
* @return call options
*/
putHostInactivityPeriodCall(key: number): ServiceCallType;
/**
* Get application data
*
* LWM2M path: /1024//36
*
* @tapVersion(">=1.0")
* @return
*/
getApplicationData(): Promise<TapResponse<Uint8Array>>;
/**
*
*
* LWM2M path: /1024//36
*
* @tapVersion(">=1.0")
* @return call options
*/
getApplicationDataCall(): ServiceCallType;
/**
* Set application data
*
* LWM2M path: /1024//36
*
* @tapVersion(">=1.0")
* @param value input
* @return
*/
putApplicationData(value: Uint8Array): Promise<TapResponse<void>>;
/**
*
*
* LWM2M path: /1024//36
*
* @tapVersion(">=1.0")
* @param value input
* @return call options
*/
putApplicationDataCall(value: Uint8Array): ServiceCallType;
/**
* Change application data
*
* LWM2M path: /1024//36
*
* @tapVersion(">=1.0")
* @param value input
* @return
*/
postApplicationData(value: Uint8Array): Promise<TapResponse<void>>;
/**
*
*
* LWM2M path: /1024//36
*
* @tapVersion(">=1.0")
* @param value input
* @return call options
*/
postApplicationDataCall(value: Uint8Array): ServiceCallType;
/**
* Get the Tap product key
*
* LWM2M path: /1024//60
*
* @tapVersion(">=1.0")
* @return
*/
getProductKey(): Promise<TapResponse<string>>;
/**
*
*
* LWM2M path: /1024//60
*
* @tapVersion(">=1.0")
* @return call options
*/
getProductKeyCall(): ServiceCallType;
/**
* Get max frame size for current host protocol.
*
* LWM2M path: /1024//88
*
* @tapVersion(">=1.88")
* @return
*/
getCurrentHostProtocolMaxFrameSize(): Promise<TapResponse<ProtocolMaxFrameSize>>;
/**
*
*
* LWM2M path: /1024//88
*
* @tapVersion(">=1.88")
* @return call options
*/
getCurrentHostProtocolMaxFrameSizeCall(): ServiceCallType;
/**
* Execute multiple commands
*
* LWM2M path: /1024//89
*
* @tapVersion(">=1.13")
* @param data input
* @return
*/
executeMultiRequestFrame(data: MultiRequestFrame): Promise<TapResponse<MultiResponseFrame>>;
/**
*
*
* LWM2M path: /1024//89
*
* @tapVersion(">=1.13")
* @param data input
* @return call options
*/
executeMultiRequestFrameCall(data: MultiRequestFrame): ServiceCallType;
/**
* Set SSL Certificate
*
* LWM2M path: /1024//37
*
* @tapVersion(">=1.86")
* @param value input
* @return
*/
putCertificatePublicKey(value: Uint8Array): Promise<TapResponse<void>>;
putCertificatePublicKeyAppendCalls(value: Uint8Array, chunkSize?: number): ServiceCallType<Uint8Array, void>[];
/**
*
*
* LWM2M path: /1024//37
*
* @tapVersion(">=1.86")
* @param value input
* @return call options
*/
putCertificatePublicKeyCall(value: Uint8Array): ServiceCallType;
/**
* Set SSL private key data
*
* LWM2M path: /1024//38
*
* @tapVersion(">=1.86")
* @param value input
* @return
*/
putCertificatePrivateKey(value: Uint8Array): Promise<TapResponse<void>>;
putCertificatePrivateKeyAppendCalls(value: Uint8Array, chunkSize?: number): ServiceCallType<Uint8Array, void>[];
/**
*
*
* LWM2M path: /1024//38
*
* @tapVersion(">=1.86")
* @param value input
* @return call options
*/
putCertificatePrivateKeyCall(value: Uint8Array): ServiceCallType;
/**
* Set Public key certificate
*
* LWM2M path: /1024//39
*
* @tapVersion(">=1.86")
* @param value input
* @return
*/
putCertificateRootKey(value: Uint8Array): Promise<TapResponse<void>>;
putCertificateRootKeyAppendCalls(value: Uint8Array, chunkSize?: number): ServiceCallType<Uint8Array, void>[];
/**
*
*
* LWM2M path: /1024//39
*
* @tapVersion(">=1.86")
* @param value input
* @return call options
*/
putCertificateRootKeyCall(value: Uint8Array): ServiceCallType;
/**
* Get product code
*
* LWM2M path: /1024//84
*
* @tapVersion(">=1.113")
* @return
*/
getProductCode(): Promise<TapResponse<string>>;
/**
*
*
* LWM2M path: /1024//84
*
* @tapVersion(">=1.113")
* @return call options
*/
getProductCodeCall(): ServiceCallType;
/**
* Put product code
*
* LWM2M path: /1024//84
*
* @tapVersion(">=1.113")
* @param topic input
* @return
*/
putProductCode(topic: string): Promise<TapResponse<void>>;
/**
*
*
* LWM2M path: /1024//84
*
* @tapVersion(">=1.113")
* @param topic input
* @return call options
*/
putProductCodeCall(topic: string): ServiceCallType;
/**
* Get bundle id for the special feature
*
* LWM2M path: /1024//{featureId}
*
* @tapVersion(">=1.23")
* @param featureId input
* @return
*/
getSpecialFeatureProfile(featureId: number): Promise<TapResponse<number>>;
/**
*
*
* LWM2M path: /1024//{featureId}
*
* @tapVersion(">=1.23")
* @param featureId input
* @return call options
*/
getSpecialFeatureProfileCall(featureId: number): ServiceCallType;
/**
* Set bundle id that own the special feature (not available anymore)
*
* LWM2M path: /1024//{featureId}
*
* @tapVersion(">=1.23")
* @param featureId input
* @param value input
* @return
*/
setSpecialFeatureProfile(featureId: number, value: number): Promise<TapResponse<void>>;
/**
*
*
* LWM2M path: /1024//{featureId}
*
* @tapVersion(">=1.23")
* @param featureId input
* @param value input
* @return call options
*/
setSpecialFeatureProfileCall(featureId: number, value: number): ServiceCallType;
/**
* Write bundle id for the special feature
*
* LWM2M path: /1024//{featureId}
*
* @tapVersion(">=1.23")
* @param featureId input
* @param value input
* @return
*/
putSpecialFeatureProfile(featureId: number, value: number): Promise<TapResponse<void>>;
/**
*
*
* LWM2M path: /1024//{featureId}
*
* @tapVersion(">=1.23")
* @param featureId input
* @param value input
* @return call options
*/
putSpecialFeatureProfileCall(featureId: number, value: number): ServiceCallType;
}