@iotize/device-client.js
Version:
IoTize Device client for Javascript
1,648 lines (1,647 loc) • 47.5 kB
TypeScript
/**
* This file has been generated
* DO NOT EDIT, IT MAY BE OVERWRITTEN
*/
import { Client, Response, ApiConfig } from "../import-adapter";
import { AbstractService, ServiceCallType } from '../abstract-service';
import { AvailableFunction } from '../../all-models';
import { MultiRequest } from '../../all-models';
import { HostProtocol } from '../../all-models';
import { MultiResponse } from '../../all-models';
import { LowPowerOptimisationLevel } from '../../all-models';
import { NetworkMode } from '../../all-models';
import { TapVersion } from '../../all-models';
import { NfcPairingMode } from '../../all-models';
import { NfcConnectionPriority } from '../../all-models';
import { CloudConnectionMode } from '../../all-models';
import { InterfaceLock } from '../../all-models';
import { LoginCredentialHashed } from '../../all-models';
import { LoginCredential } from '../../all-models';
export declare class InterfaceService extends AbstractService {
constructor(client: Client, apiConfig: ApiConfig);
resources: {
[key: string]: ServiceCallType;
};
/**
* Get application name
*
* LWM2M path: /1024//9
* @tapVersion(">=1.0")
* @return string api call
*/
getAppName(): Promise<Response<string>>;
/**
* Get application name
*
* LWM2M path: /1024//9
* @tapVersion(">=1.0")
* @return call options
*/
getAppNameCall(): ServiceCallType;
/**
* Get app path
* Application Android à lancer ou page HTML à afficher quand l'IoTize est détecté par le téléphone
* LWM2M path: /1024//11
* @tapVersion(">=1.0")
* @return string api call
*/
getAppPath(): Promise<Response<string>>;
/**
* Get app path
* Application Android à lancer ou page HTML à afficher quand l'IoTize est détecté par le téléphone
* LWM2M path: /1024//11
* @tapVersion(">=1.0")
* @return call options
*/
getAppPathCall(): ServiceCallType;
/**
* Get application parameters
* Paramètres d'application : codes, URL secondaire, etc. le TAP les stocke et les restitue sans les interpréter.
* LWM2M path: /1024//36
* @tapVersion(">=1.0")
* @return Uint8Array api call
*/
getApplicationParameters(): Promise<Response<Uint8Array>>;
/**
* Get application parameters
* Paramètres d'application : codes, URL secondaire, etc. le TAP les stocke et les restitue sans les interpréter.
* LWM2M path: /1024//36
* @tapVersion(">=1.0")
* @return call options
*/
getApplicationParametersCall(): ServiceCallType;
/**
* Get authorized host protocols
*
* LWM2M path: /1024//17
* @tapVersion(">=1.0")
* @return Array<HostProtocol> api call
*/
getAuthorizedHostProtocol(): Promise<Response<Array<HostProtocol>>>;
/**
* Get authorized host protocols
*
* LWM2M path: /1024//17
* @tapVersion(">=1.0")
* @return call options
*/
getAuthorizedHostProtocolCall(): ServiceCallType;
/**
* Get available host protocols
*
* LWM2M path: /1024//21
* @tapVersion(">=1.0")
* @return Array<HostProtocol> api call
*/
getAvailableHostProtocols(): Promise<Response<Array<HostProtocol>>>;
/**
* Get available host protocols
*
* LWM2M path: /1024//21
* @tapVersion(">=1.0")
* @return call options
*/
getAvailableHostProtocolsCall(): ServiceCallType;
/**
* Get ble address
*
* LWM2M path: /1024//22
* @tapVersion(">=1.0")
* @return string api call
*/
getBleAddress(): Promise<Response<string>>;
/**
* Get ble address
*
* LWM2M path: /1024//22
* @tapVersion(">=1.0")
* @return call options
*/
getBleAddressCall(): ServiceCallType;
/**
* Get cloud client id
*
* LWM2M path: /1024//27
* @tapVersion(">=1.0")
* @return string api call
*/
getCloudClientId(): Promise<Response<string>>;
/**
* Get cloud client id
*
* LWM2M path: /1024//27
* @tapVersion(">=1.0")
* @return call options
*/
getCloudClientIdCall(): ServiceCallType;
/**
* Get cloud connection mode
*
* LWM2M path: /1024//26
* @tapVersion(">=1.0")
* @return CloudConnectionMode api call
*/
getCloudConnectionMode(): Promise<Response<CloudConnectionMode>>;
/**
* Get cloud connection mode
*
* LWM2M path: /1024//26
* @tapVersion(">=1.0")
* @return call options
*/
getCloudConnectionModeCall(): ServiceCallType;
/**
* Get cloud gateway url
* Adresse serveur Web du broker MQTT servant au Cloud. Pour envoyer le data-log par exemple. (Mais PAS pour le Relay MQTT)
* LWM2M path: /1024//12
* @tapVersion(">=1.0")
* @return string api call
*/
getCloudGatewayUrl(): Promise<Response<string>>;
/**
* Get cloud gateway url
* Adresse serveur Web du broker MQTT servant au Cloud. Pour envoyer le data-log par exemple. (Mais PAS pour le Relay MQTT)
* LWM2M path: /1024//12
* @tapVersion(">=1.0")
* @return call options
*/
getCloudGatewayUrlCall(): ServiceCallType;
/**
* Get cloud login id
*
* LWM2M path: /1024//28
* @tapVersion(">=1.0")
* @return string api call
*/
getCloudLogin(): Promise<Response<string>>;
/**
* Get cloud login id
*
* LWM2M path: /1024//28
* @tapVersion(">=1.0")
* @return call options
*/
getCloudLoginCall(): ServiceCallType;
/**
* Get cloud password
*
* LWM2M path: /1024//29
* @tapVersion(">=1.0")
* @return string api call
*/
getCloudPassword(): Promise<Response<string>>;
/**
* Get cloud password
*
* LWM2M path: /1024//29
* @tapVersion(">=1.0")
* @return call options
*/
getCloudPasswordCall(): ServiceCallType;
/**
* Get the cloud service name
*
* LWM2M path: /1024//61
* @tapVersion(">=1.0")
* @return string api call
*/
getCloudServiceName(): Promise<Response<string>>;
/**
* Get the cloud service name
*
* LWM2M path: /1024//61
* @tapVersion(">=1.0")
* @return call options
*/
getCloudServiceNameCall(): ServiceCallType;
/**
* Get config format firmware version
* Firmware version that wrote the current configuration
* LWM2M path: /1024//18
* @tapVersion(">=1.0")
* @return number api call
*/
getConfigFormatFirmwareVersion(): Promise<Response<number>>;
/**
* Get config format firmware version
* Firmware version that wrote the current configuration
* LWM2M path: /1024//18
* @tapVersion(">=1.0")
* @return call options
*/
getConfigFormatFirmwareVersionCall(): ServiceCallType;
/**
* Get config format version
*
* LWM2M path: /1024//8
* @tapVersion(">=1.0")
* @return number api call
*/
getConfigFormatVersion(): Promise<Response<number>>;
/**
* Get config format version
*
* LWM2M path: /1024//8
* @tapVersion(">=1.0")
* @return call options
*/
getConfigFormatVersionCall(): ServiceCallType;
/**
* Get config version
*
* LWM2M path: /1024//10
* @tapVersion(">=1.0")
* @return TapVersion api call
*/
getConfigVersion(): Promise<Response<TapVersion>>;
/**
* Get config version
*
* LWM2M path: /1024//10
* @tapVersion(">=1.0")
* @return call options
*/
getConfigVersionCall(): ServiceCallType;
/**
* Get current group id
*
* LWM2M path: /1024//7
* @tapVersion(">=1.0")
* @return number api call
*/
getCurrentGroupId(): Promise<Response<number>>;
/**
* Get current group id
*
* LWM2M path: /1024//7
* @tapVersion(">=1.0")
* @return call options
*/
getCurrentGroupIdCall(): ServiceCallType;
/**
* Get current host protocol
*
* LWM2M path: /1024//3
* @tapVersion(">=1.0")
* @return HostProtocol api call
*/
getCurrentHostProtocol(): Promise<Response<HostProtocol>>;
/**
* Get current host protocol
*
* LWM2M path: /1024//3
* @tapVersion(">=1.0")
* @return call options
*/
getCurrentHostProtocolCall(): ServiceCallType;
/**
* Get max frame sizes for current host protocol
*
* LWM2M path: /1024//88
* @tapVersion(">=1.86")
* @return number api call
*/
getCurrentHostProtocolMaxFrameSize(): Promise<Response<number>>;
/**
* Get max frame sizes for current host protocol
*
* LWM2M path: /1024//88
* @tapVersion(">=1.86")
* @return call options
*/
getCurrentHostProtocolMaxFrameSizeCall(): ServiceCallType;
/**
* Get current profile id
*
* LWM2M path: /1024//2
* @tapVersion(">=1.0")
* @return number api call
*/
getCurrentProfileId(): Promise<Response<number>>;
/**
* Get current profile id
*
* LWM2M path: /1024//2
* @tapVersion(">=1.0")
* @return call options
*/
getCurrentProfileIdCall(): ServiceCallType;
/**
* Get functions
* Get functions
* LWM2M path: /1024//20
* @tapVersion(">=1.0")
* @return AvailableFunction api call
*/
getFunctions(): Promise<Response<AvailableFunction>>;
/**
* Get functions
* Get functions
* LWM2M path: /1024//20
* @tapVersion(">=1.0")
* @return call options
*/
getFunctionsCall(): ServiceCallType;
/**
* Get host inactivity period
* Host inactivity period before switch to standby mode or shutdown depending on optimisation level (res /1024//14). Also tells to disconnect Client after timeout when not in Low-power mode
* LWM2M path: /1024//34
* @tapVersion(">=1.0")
* @return number api call
*/
getHostInactivityPeriod(): Promise<Response<number>>;
/**
* Get host inactivity period
* Host inactivity period before switch to standby mode or shutdown depending on optimisation level (res /1024//14). Also tells to disconnect Client after timeout when not in Low-power mode
* LWM2M path: /1024//34
* @tapVersion(">=1.0")
* @return call options
*/
getHostInactivityPeriodCall(): ServiceCallType;
/**
* Get lock infos
*
* LWM2M path: /1024//6
* @tapVersion(">=1.0")
* @return InterfaceLock api call
*/
getLock(): Promise<Response<InterfaceLock>>;
/**
* Get lock infos
*
* LWM2M path: /1024//6
* @tapVersion(">=1.0")
* @return call options
*/
getLockCall(): ServiceCallType;
/**
* Get mqtt relay client id.. For firmware version <= 1.86, use serial number (resource /3//2)
*
* LWM2M path: /1024//52
* @tapVersion(">=1.86")
* @return string api call
*/
getMqttRelayClientId(): Promise<Response<string>>;
/**
* Get mqtt relay client id.. For firmware version <= 1.86, use serial number (resource /3//2)
*
* LWM2M path: /1024//52
* @tapVersion(">=1.86")
* @return call options
*/
getMqttRelayClientIdCall(): ServiceCallType;
/**
* Get mqtt relay login. For firmware version <= 1.86, use serial number (resource /3//2)
*
* LWM2M path: /1024//53
* @deprecated
* @tapVersion(">=1.86")
* @return string api call
*/
getMqttRelayLogin(): Promise<Response<string>>;
/**
* Get mqtt relay login. For firmware version <= 1.86, use serial number (resource /3//2)
*
* LWM2M path: /1024//53
* @deprecated
* @tapVersion(">=1.86")
* @return call options
*/
getMqttRelayLoginCall(): ServiceCallType;
/**
* Get the mqtt net key for the server
*
* LWM2M path: /1024//55
* @tapVersion(">=1.0")
* @return string api call
*/
getMqttRelayNetKey(): Promise<Response<string>>;
/**
* Get the mqtt net key for the server
*
* LWM2M path: /1024//55
* @tapVersion(">=1.0")
* @return call options
*/
getMqttRelayNetKeyCall(): ServiceCallType;
/**
* Get the mqtt relay password
* Mot de passe connexion au broker
* LWM2M path: /1024//54
* @tapVersion(">=1.0")
* @return string api call
*/
getMqttRelayPassword(): Promise<Response<string>>;
/**
* Get the mqtt relay password
* Mot de passe connexion au broker
* LWM2M path: /1024//54
* @tapVersion(">=1.0")
* @return call options
*/
getMqttRelayPasswordCall(): ServiceCallType;
/**
* Get port of the mqtt broker
*
* LWM2M path: /1024//51
* @tapVersion(">=1.0")
* @return string api call
*/
getMqttRelayPort(): Promise<Response<string>>;
/**
* Get port of the mqtt broker
*
* LWM2M path: /1024//51
* @tapVersion(">=1.0")
* @return call options
*/
getMqttRelayPortCall(): ServiceCallType;
/**
* Get mqtt relay url
*
* LWM2M path: /1024//50
* @tapVersion(">=1.0")
* @return string api call
*/
getMqttRelayUrl(): Promise<Response<string>>;
/**
* Get mqtt relay url
*
* LWM2M path: /1024//50
* @tapVersion(">=1.0")
* @return call options
*/
getMqttRelayUrlCall(): ServiceCallType;
/**
* Get iotize gateway ip on the network
*
* LWM2M path: /1024//31
* @tapVersion(">=1.0")
* @return string api call
*/
getNetworkGatewayIp(): Promise<Response<string>>;
/**
* Get iotize gateway ip on the network
*
* LWM2M path: /1024//31
* @tapVersion(">=1.0")
* @return call options
*/
getNetworkGatewayIpCall(): ServiceCallType;
/**
* Get IoTize device ip on the network
* Adresse statique IP : ex 192.168.1.10. DHCP si adresse = 0.0.0.0. Seulement pour les IoTize Wifi.
* LWM2M path: /1024//30
* @tapVersion(">=1.0")
* @return string api call
*/
getNetworkInfraIp(): Promise<Response<string>>;
/**
* Get IoTize device ip on the network
* Adresse statique IP : ex 192.168.1.10. DHCP si adresse = 0.0.0.0. Seulement pour les IoTize Wifi.
* LWM2M path: /1024//30
* @tapVersion(">=1.0")
* @return call options
*/
getNetworkInfraIpCall(): ServiceCallType;
/**
* Get infrastructure ip mask
* For example: 255.255.255.0
* LWM2M path: /1024//32
* @tapVersion(">=1.0")
* @return string api call
*/
getNetworkInfraIpMask(): Promise<Response<string>>;
/**
* Get infrastructure ip mask
* For example: 255.255.255.0
* LWM2M path: /1024//32
* @tapVersion(">=1.0")
* @return call options
*/
getNetworkInfraIpMaskCall(): ServiceCallType;
/**
* Get network mode
*
* LWM2M path: /1024//15
* @tapVersion(">=1.0")
* @return NetworkMode api call
*/
getNetworkMode(): Promise<Response<NetworkMode>>;
/**
* Get network mode
*
* LWM2M path: /1024//15
* @tapVersion(">=1.0")
* @return call options
*/
getNetworkModeCall(): ServiceCallType;
/**
* Get profile id that will be logged in when starting an encrypted session with NFC
*
* LWM2M path: /1024//43
* @tapVersion(">=1.55")
* @return number api call
*/
getNfcAutologProfileId(): Promise<Response<number>>;
/**
* Get profile id that will be logged in when starting an encrypted session with NFC
*
* LWM2M path: /1024//43
* @tapVersion(">=1.55")
* @return call options
*/
getNfcAutologProfileIdCall(): ServiceCallType;
/**
* Get NFC connection priority over other protocols
*
* LWM2M path: /1024//24
* @tapVersion(">=1.85")
* @return NfcConnectionPriority api call
*/
getNfcConnectionPriority(): Promise<Response<NfcConnectionPriority>>;
/**
* Get NFC connection priority over other protocols
*
* LWM2M path: /1024//24
* @tapVersion(">=1.85")
* @return call options
*/
getNfcConnectionPriorityCall(): ServiceCallType;
/**
* Check if nfc paring is mandatory
*
* LWM2M path: /1024//13
* @tapVersion(">=1.0")
* @return NfcPairingMode api call
*/
getNfcPairingMode(): Promise<Response<NfcPairingMode>>;
/**
* Check if nfc paring is mandatory
*
* LWM2M path: /1024//13
* @tapVersion(">=1.0")
* @return call options
*/
getNfcPairingModeCall(): ServiceCallType;
/**
* Get power optimization level
*
* LWM2M path: /1024//14
* @tapVersion(">=1.0")
* @return LowPowerOptimisationLevel api call
*/
getPowerOptimisationLevel(): Promise<Response<LowPowerOptimisationLevel>>;
/**
* Get power optimization level
*
* LWM2M path: /1024//14
* @tapVersion(">=1.0")
* @return call options
*/
getPowerOptimisationLevelCall(): ServiceCallType;
/**
* Get the device open key
* Password utilisé pour l'enregistrement. Également défaut du MQTT Relay PWD
* LWM2M path: /1024//60
* @tapVersion(">=1.0")
* @return string api call
*/
getPublicPassword(): Promise<Response<string>>;
/**
* Get the device open key
* Password utilisé pour l'enregistrement. Également défaut du MQTT Relay PWD
* LWM2M path: /1024//60
* @tapVersion(">=1.0")
* @return call options
*/
getPublicPasswordCall(): ServiceCallType;
/**
* Generate a random number (only for firmware version <= 1.83)
*
* LWM2M path: /1024//49
* @deprecated
* @tapVersion(">=1.0")
* @return Uint8Array api call
*/
getRand(): Promise<Response<Uint8Array>>;
/**
* Generate a random number (only for firmware version <= 1.83)
*
* LWM2M path: /1024//49
* @deprecated
* @tapVersion(">=1.0")
* @return call options
*/
getRandCall(): ServiceCallType;
/**
* Get bundle id that have the special feature. Si non définit, retourne 0x0
*
* LWM2M path: /1024//{featureId}
* @tapVersion(">=1.23")
* @param featureId input
* @return number api call
*/
getSpecialFeatureProfile(featureId: number): Promise<Response<number>>;
/**
* Get bundle id that have the special feature. Si non définit, retourne 0x0
*
* LWM2M path: /1024//{featureId}
* @tapVersion(">=1.23")
* @param featureId input
* @return call options
*/
getSpecialFeatureProfileCall(featureId: number): ServiceCallType;
/**
* Get configured universal link value
* Universal link will be used by iOS system to find which iIS application is associated with this device. For example: http://www.iotize.com
* LWM2M path: /1024//19
* @tapVersion(">=1.0")
* @return string api call
*/
getUniversalLink(): Promise<Response<string>>;
/**
* Get configured universal link value
* Universal link will be used by iOS system to find which iIS application is associated with this device. For example: http://www.iotize.com
* LWM2M path: /1024//19
* @tapVersion(">=1.0")
* @return call options
*/
getUniversalLinkCall(): ServiceCallType;
/**
* Uploading period for the cloud
* Minimum period between 2 data log uploads in milliseconds. If set to 0, data log upload is disabled
* LWM2M path: /1024//33
* @tapVersion(">=1.0")
* @return number api call
*/
getUploadPeriod(): Promise<Response<number>>;
/**
* Uploading period for the cloud
* Minimum period between 2 data log uploads in milliseconds. If set to 0, data log upload is disabled
* LWM2M path: /1024//33
* @tapVersion(">=1.0")
* @return call options
*/
getUploadPeriodCall(): ServiceCallType;
/**
* Get network key
* Clé WAP / WEP pour connection réseau infrastructure & P2P
* LWM2M path: /1024//16
* @tapVersion(">=1.0")
* @return string api call
*/
getWepKey(): Promise<Response<string>>;
/**
* Get network key
* Clé WAP / WEP pour connection réseau infrastructure & P2P
* LWM2M path: /1024//16
* @tapVersion(">=1.0")
* @return call options
*/
getWepKeyCall(): ServiceCallType;
/**
* Get wifi hostname
*
* LWM2M path: /1024//35
* @tapVersion(">=1.0")
* @return string api call
*/
getWifiHostname(): Promise<Response<string>>;
/**
* Get wifi hostname
*
* LWM2M path: /1024//35
* @tapVersion(">=1.0")
* @return call options
*/
getWifiHostnameCall(): ServiceCallType;
/**
* Get wifi ssid
* May be null if not connected to any network
* LWM2M path: /1024//25
* @tapVersion(">=1.0")
* @return string api call
*/
getWifiSSID(): Promise<Response<string>>;
/**
* Get wifi ssid
* May be null if not connected to any network
* LWM2M path: /1024//25
* @tapVersion(">=1.0")
* @return call options
*/
getWifiSSIDCall(): ServiceCallType;
/**
* Keep alive.
* Call this method to ensure communication resources are maintain.
* LWM2M path: /1024//4
* @tapVersion(">=1.0")
* @return number api call
*/
keepAlive(): Promise<Response<number>>;
/**
* Keep alive.
* Call this method to ensure communication resources are maintain.
* LWM2M path: /1024//4
* @tapVersion(">=1.0")
* @return call options
*/
keepAliveCall(): ServiceCallType;
/**
* Login
* User login with username and password
* LWM2M path: /1024//0
* Body converter id: "LoginCredential"
* @tapVersion(">=1.0")
* @param credential input
* @return void api call
*/
login(credential: LoginCredential): Promise<Response<void>>;
/**
* Login
* User login with username and password
* LWM2M path: /1024//0
* Body converter id: "LoginCredential"
* @tapVersion(">=1.0")
* @param credential input
* @return call options
*/
loginCall(credential: LoginCredential): ServiceCallType;
/**
* Login
* User login with username and password hash
* LWM2M path: /1024//0
* Body converter id: "LoginCredentialHashed"
* @tapVersion(">=1.0")
* @param credential input
* @return void api call
*/
loginWithHash(credential: LoginCredentialHashed): Promise<Response<void>>;
/**
* Login
* User login with username and password hash
* LWM2M path: /1024//0
* Body converter id: "LoginCredentialHashed"
* @tapVersion(">=1.0")
* @param credential input
* @return call options
*/
loginWithHashCall(credential: LoginCredentialHashed): ServiceCallType;
/**
* Admnistration login
* Log in as an administrator thanks to the UID
* LWM2M path: /1024//5
* Body converter id: "Bytes"
* @tapVersion(">=1.0")
* @param uid input
* @return void api call
*/
loginWithUID(uid: Uint8Array): Promise<Response<void>>;
/**
* Admnistration login
* Log in as an administrator thanks to the UID
* LWM2M path: /1024//5
* Body converter id: "Bytes"
* @tapVersion(">=1.0")
* @param uid input
* @return call options
*/
loginWithUIDCall(uid: Uint8Array): ServiceCallType;
/**
* Logout
*
* LWM2M path: /1024//1
* @tapVersion(">=1.0")
* @return void api call
*/
logout(): Promise<Response<void>>;
/**
* Logout
*
* LWM2M path: /1024//1
* @tapVersion(">=1.0")
* @return call options
*/
logoutCall(): ServiceCallType;
/**
* Execute multiple commands sent in one frame, and return all answers in one
*
* LWM2M path: /1024//89
* Body converter id: "MultiRequest"
* @tapVersion(">=1.13")
* @param data input
* @return MultiResponse api call
*/
multiRequest(data: MultiRequest): Promise<Response<MultiResponse>>;
/**
* Execute multiple commands sent in one frame, and return all answers in one
*
* LWM2M path: /1024//89
* Body converter id: "MultiRequest"
* @tapVersion(">=1.13")
* @param data input
* @return call options
*/
multiRequestCall(data: MultiRequest): ServiceCallType;
/**
* Set NFC connection priority over other protocols
*
* LWM2M path: /1024//24
* Body converter id: "NfcConnectionPriority"
* @tapVersion(">=1.85")
* @param key input
* @return void api call
*/
postNfcConnectionPriority(key: NfcConnectionPriority): Promise<Response<void>>;
/**
* Set NFC connection priority over other protocols
*
* LWM2M path: /1024//24
* Body converter id: "NfcConnectionPriority"
* @tapVersion(">=1.85")
* @param key input
* @return call options
*/
postNfcConnectionPriorityCall(key: NfcConnectionPriority): ServiceCallType;
/**
* Set application name
*
* LWM2M path: /1024//9
* Body converter id: "string"
* @tapVersion(">=1.0")
* @param appName input
* @return void api call
*/
putAppName(appName: string): Promise<Response<void>>;
/**
* Set application name
*
* LWM2M path: /1024//9
* Body converter id: "string"
* @tapVersion(">=1.0")
* @param appName input
* @return call options
*/
putAppNameCall(appName: string): ServiceCallType;
/**
* Set app path
*
* LWM2M path: /1024//11
* Body converter id: "string"
* @tapVersion(">=1.0")
* @param value input
* @return void api call
*/
putAppPath(value: string): Promise<Response<void>>;
/**
* Set app path
*
* LWM2M path: /1024//11
* Body converter id: "string"
* @tapVersion(">=1.0")
* @param value input
* @return call options
*/
putAppPathCall(value: string): ServiceCallType;
/**
* Write application parameters
*
* LWM2M path: /1024//36
* Body converter id: "Bytes"
* @tapVersion(">=1.0")
* @param value input
* @return void api call
*/
putApplicationParameters(value: Uint8Array): Promise<Response<void>>;
/**
* Write application parameters
*
* LWM2M path: /1024//36
* Body converter id: "Bytes"
* @tapVersion(">=1.0")
* @param value input
* @return call options
*/
putApplicationParametersCall(value: Uint8Array): ServiceCallType;
/**
* Write authorized host protocols
*
* LWM2M path: /1024//17
* Body converter id: "Array<HostProtocol>"
* @tapVersion(">=1.0")
* @param mode input
* @return void api call
*/
putAuthorizedHostProtocol(mode: Array<HostProtocol>): Promise<Response<void>>;
/**
* Write authorized host protocols
*
* LWM2M path: /1024//17
* Body converter id: "Array<HostProtocol>"
* @tapVersion(">=1.0")
* @param mode input
* @return call options
*/
putAuthorizedHostProtocolCall(mode: Array<HostProtocol>): ServiceCallType;
/**
* Certificate data in PEM format for SSL mutual authentication, default is NULL
*
* LWM2M path: /1024//37
* Body converter id: "Bytes"
* @tapVersion(">=1.86")
* @param value input
* @return void api call
*/
putClientCertificate(value: Uint8Array): Promise<Response<void>>;
/**
* Certificate data in PEM format for SSL mutual authentication, default is NULL
*
* LWM2M path: /1024//37
* Body converter id: "Bytes"
* @tapVersion(">=1.86")
* @param value input
* @return call options
*/
putClientCertificateCall(value: Uint8Array): ServiceCallType;
/**
* private key data in PEM format for SSL mutual authentication, default is NULL
*
* LWM2M path: /1024//38
* Body converter id: "Bytes"
* @tapVersion(">=1.86")
* @param value input
* @return void api call
*/
putClientPrivateKey(value: Uint8Array): Promise<Response<void>>;
/**
* private key data in PEM format for SSL mutual authentication, default is NULL
*
* LWM2M path: /1024//38
* Body converter id: "Bytes"
* @tapVersion(">=1.86")
* @param value input
* @return call options
*/
putClientPrivateKeyCall(value: Uint8Array): ServiceCallType;
/**
* Write cloud client id
*
* LWM2M path: /1024//27
* Body converter id: "string"
* @tapVersion(">=1.0")
* @param value input
* @return void api call
*/
putCloudClientId(value: string): Promise<Response<void>>;
/**
* Write cloud client id
*
* LWM2M path: /1024//27
* Body converter id: "string"
* @tapVersion(">=1.0")
* @param value input
* @return call options
*/
putCloudClientIdCall(value: string): ServiceCallType;
/**
* Write cloud connection mode
*
* LWM2M path: /1024//26
* Body converter id: "CloudConnectionMode"
* @tapVersion(">=1.0")
* @param key input
* @return void api call
*/
putCloudConnectionMode(key: CloudConnectionMode): Promise<Response<void>>;
/**
* Write cloud connection mode
*
* LWM2M path: /1024//26
* Body converter id: "CloudConnectionMode"
* @tapVersion(">=1.0")
* @param key input
* @return call options
*/
putCloudConnectionModeCall(key: CloudConnectionMode): ServiceCallType;
/**
* Write cloud gateway url
*
* LWM2M path: /1024//12
* Body converter id: "string"
* @tapVersion(">=1.0")
* @param url input
* @return void api call
*/
putCloudGatewayUrl(url: string): Promise<Response<void>>;
/**
* Write cloud gateway url
*
* LWM2M path: /1024//12
* Body converter id: "string"
* @tapVersion(">=1.0")
* @param url input
* @return call options
*/
putCloudGatewayUrlCall(url: string): ServiceCallType;
/**
* Write cloud login id
*
* LWM2M path: /1024//28
* Body converter id: "string"
* @tapVersion(">=1.0")
* @param key input
* @return void api call
*/
putCloudLogin(key: string): Promise<Response<void>>;
/**
* Write cloud login id
*
* LWM2M path: /1024//28
* Body converter id: "string"
* @tapVersion(">=1.0")
* @param key input
* @return call options
*/
putCloudLoginCall(key: string): ServiceCallType;
/**
* Write cloud password
*
* LWM2M path: /1024//29
* Body converter id: "string"
* @tapVersion(">=1.0")
* @param key input
* @return void api call
*/
putCloudPassword(key: string): Promise<Response<void>>;
/**
* Write cloud password
*
* LWM2M path: /1024//29
* Body converter id: "string"
* @tapVersion(">=1.0")
* @param key input
* @return call options
*/
putCloudPasswordCall(key: string): ServiceCallType;
/**
* Write cloud service name
*
* LWM2M path: /1024//61
* Body converter id: "string"
* @tapVersion(">=1.0")
* @param name input
* @return void api call
*/
putCloudServiceName(name: string): Promise<Response<void>>;
/**
* Write cloud service name
*
* LWM2M path: /1024//61
* Body converter id: "string"
* @tapVersion(">=1.0")
* @param name input
* @return call options
*/
putCloudServiceNameCall(name: string): ServiceCallType;
/**
* Set config format version
*
* LWM2M path: /1024//8
* Body converter id: "integer_uint16"
* @tapVersion(">=1.0")
* @param configFormat input
* @return void api call
*/
putConfigFormatVersion(configFormat: number): Promise<Response<void>>;
/**
* Set config format version
*
* LWM2M path: /1024//8
* Body converter id: "integer_uint16"
* @tapVersion(">=1.0")
* @param configFormat input
* @return call options
*/
putConfigFormatVersionCall(configFormat: number): ServiceCallType;
/**
* Set config version
*
* LWM2M path: /1024//10
* Body converter id: "integer_uint32"
* @tapVersion(">=1.0")
* @param version input
* @return void api call
*/
putConfigVersion(version: number): Promise<Response<void>>;
/**
* Set config version
*
* LWM2M path: /1024//10
* Body converter id: "integer_uint32"
* @tapVersion(">=1.0")
* @param version input
* @return call options
*/
putConfigVersionCall(version: number): ServiceCallType;
/**
* Write current host protocol
*
* LWM2M path: /1024//3
* Body converter id: "HostProtocol"
* @tapVersion(">=1.0")
* @param hostProtocol input
* @return void api call
*/
putCurrentHostProtocol(hostProtocol: HostProtocol): Promise<Response<void>>;
/**
* Write current host protocol
*
* LWM2M path: /1024//3
* Body converter id: "HostProtocol"
* @tapVersion(">=1.0")
* @param hostProtocol input
* @return call options
*/
putCurrentHostProtocolCall(hostProtocol: HostProtocol): ServiceCallType;
/**
* Write host inactivity period
*
* LWM2M path: /1024//34
* Body converter id: "integer_uint16"
* @tapVersion(">=1.0")
* @param key input
* @return void api call
*/
putHostInactivityPeriod(key: number): Promise<Response<void>>;
/**
* Write host inactivity period
*
* LWM2M path: /1024//34
* Body converter id: "integer_uint16"
* @tapVersion(">=1.0")
* @param key input
* @return call options
*/
putHostInactivityPeriodCall(key: number): ServiceCallType;
/**
* Set lock infos
*
* LWM2M path: /1024//6
* Body converter id: "InterfaceLock"
* @tapVersion(">=1.0")
* @param infos input
* @return void api call
*/
putLock(infos: InterfaceLock): Promise<Response<void>>;
/**
* Set lock infos
*
* LWM2M path: /1024//6
* Body converter id: "InterfaceLock"
* @tapVersion(">=1.0")
* @param infos input
* @return call options
*/
putLockCall(infos: InterfaceLock): ServiceCallType;
/**
* Put MQTT relay topics prefix
*
* LWM2M path: /1024//58
* Body converter id: "string"
* @tapVersion(">=1.86")
* @param netkey input
* @return void api call
*/
putMqttRelayCertificate(netkey: string): Promise<Response<void>>;
/**
* Put MQTT relay topics prefix
*
* LWM2M path: /1024//58
* Body converter id: "string"
* @tapVersion(">=1.86")
* @param netkey input
* @return call options
*/
putMqttRelayCertificateCall(netkey: string): ServiceCallType;
/**
* Write mqtt relay client id. For firmware version <= 1.86, use serial number (resource /3//2)
*
* LWM2M path: /1024//52
* Body converter id: "string"
* @tapVersion(">=1.86")
* @param url input
* @return void api call
*/
putMqttRelayClientId(url: string): Promise<Response<void>>;
/**
* Write mqtt relay client id. For firmware version <= 1.86, use serial number (resource /3//2)
*
* LWM2M path: /1024//52
* Body converter id: "string"
* @tapVersion(">=1.86")
* @param url input
* @return call options
*/
putMqttRelayClientIdCall(url: string): ServiceCallType;
/**
* Write mqtt relay password id. For firmware version <= 1.86, use serial number (resource /3//2)
*
* LWM2M path: /1024//53
* Body converter id: "string"
* @tapVersion(">=1.86")
* @param url input
* @return void api call
*/
putMqttRelayLogin(url: string): Promise<Response<void>>;
/**
* Write mqtt relay password id. For firmware version <= 1.86, use serial number (resource /3//2)
*
* LWM2M path: /1024//53
* Body converter id: "string"
* @tapVersion(">=1.86")
* @param url input
* @return call options
*/
putMqttRelayLoginCall(url: string): ServiceCallType;
/**
* Write mqtt net key
*
* LWM2M path: /1024//55
* Body converter id: "string"
* @tapVersion(">=1.0")
* @param netkey input
* @return void api call
*/
putMqttRelayNetKey(netkey: string): Promise<Response<void>>;
/**
* Write mqtt net key
*
* LWM2M path: /1024//55
* Body converter id: "string"
* @tapVersion(">=1.0")
* @param netkey input
* @return call options
*/
putMqttRelayNetKeyCall(netkey: string): ServiceCallType;
/**
* Write mqtt relay password
*
* LWM2M path: /1024//54
* Body converter id: "string"
* @tapVersion(">=1.0")
* @param url input
* @return void api call
*/
putMqttRelayPassword(url: string): Promise<Response<void>>;
/**
* Write mqtt relay password
*
* LWM2M path: /1024//54
* Body converter id: "string"
* @tapVersion(">=1.0")
* @param url input
* @return call options
*/
putMqttRelayPasswordCall(url: string): ServiceCallType;
/**
* Write service name of the mqtt broker
*
* LWM2M path: /1024//51
* Body converter id: "string"
* @tapVersion(">=1.0")
* @param url input
* @return void api call
*/
putMqttRelayPort(url: string): Promise<Response<void>>;
/**
* Write service name of the mqtt broker
*
* LWM2M path: /1024//51
* Body converter id: "string"
* @tapVersion(">=1.0")
* @param url input
* @return call options
*/
putMqttRelayPortCall(url: string): ServiceCallType;
/**
* Write mqtt relay url
*
* LWM2M path: /1024//50
* Body converter id: "string"
* @tapVersion(">=1.0")
* @param url input
* @return void api call
*/
putMqttRelayUrl(url: string): Promise<Response<void>>;
/**
* Write mqtt relay url
*
* LWM2M path: /1024//50
* Body converter id: "string"
* @tapVersion(">=1.0")
* @param url input
* @return call options
*/
putMqttRelayUrlCall(url: string): ServiceCallType;
/**
* Write iotize gateway ip
*
* LWM2M path: /1024//31
* Body converter id: "string_ipv4"
* @tapVersion(">=1.0")
* @param key input
* @return void api call
*/
putNetworkGatewayIp(key: string): Promise<Response<void>>;
/**
* Write iotize gateway ip
*
* LWM2M path: /1024//31
* Body converter id: "string_ipv4"
* @tapVersion(">=1.0")
* @param key input
* @return call options
*/
putNetworkGatewayIpCall(key: string): ServiceCallType;
/**
* Write infrastructure ip
*
* LWM2M path: /1024//30
* Body converter id: "string_ipv4"
* @tapVersion(">=1.0")
* @param key input
* @return void api call
*/
putNetworkInfraIp(key: string): Promise<Response<void>>;
/**
* Write infrastructure ip
*
* LWM2M path: /1024//30
* Body converter id: "string_ipv4"
* @tapVersion(">=1.0")
* @param key input
* @return call options
*/
putNetworkInfraIpCall(key: string): ServiceCallType;
/**
* Write infrastructure ip mask
*
* LWM2M path: /1024//32
* Body converter id: "string_ipv4mask"
* @tapVersion(">=1.0")
* @param key input
* @return void api call
*/
putNetworkInfraIpMask(key: string): Promise<Response<void>>;
/**
* Write infrastructure ip mask
*
* LWM2M path: /1024//32
* Body converter id: "string_ipv4mask"
* @tapVersion(">=1.0")
* @param key input
* @return call options
*/
putNetworkInfraIpMaskCall(key: string): ServiceCallType;
/**
* Write network mode
*
* LWM2M path: /1024//15
* Body converter id: "NetworkMode"
* @tapVersion(">=1.0")
* @param mode input
* @return void api call
*/
putNetworkMode(mode: NetworkMode): Promise<Response<void>>;
/**
* Write network mode
*
* LWM2M path: /1024//15
* Body converter id: "NetworkMode"
* @tapVersion(">=1.0")
* @param mode input
* @return call options
*/
putNetworkModeCall(mode: NetworkMode): ServiceCallType;
/**
* Write profile id
*
* LWM2M path: /1024//43
* Body converter id: "integer_uint16"
* @tapVersion(">=1.55")
* @param value input
* @return void api call
*/
putNfcAutologProfileId(value: number): Promise<Response<void>>;
/**
* Write profile id
*
* LWM2M path: /1024//43
* Body converter id: "integer_uint16"
* @tapVersion(">=1.55")
* @param value input
* @return call options
*/
putNfcAutologProfileIdCall(value: number): ServiceCallType;
/**
* Write in configuration NFC connection priority over other protocols
*
* LWM2M path: /1024//24
* Body converter id: "NfcConnectionPriority"
* @tapVersion(">=1.85")
* @param key input
* @return void api call
*/
putNfcConnectionPriority(key: NfcConnectionPriority): Promise<Response<void>>;
/**
* Write in configuration NFC connection priority over other protocols
*
* LWM2M path: /1024//24
* Body converter id: "NfcConnectionPriority"
* @tapVersion(">=1.85")
* @param key input
* @return call options
*/
putNfcConnectionPriorityCall(key: NfcConnectionPriority): ServiceCallType;
/**
* Change wether if nfc pairing is mandatory
*
* LWM2M path: /1024//13
* Body converter id: "NfcPairingMode"
* @tapVersion(">=1.0")
* @param mode input
* @return void api call
*/
putNfcPairingMode(mode: NfcPairingMode): Promise<Response<void>>;
/**
* Change wether if nfc pairing is mandatory
*
* LWM2M path: /1024//13
* Body converter id: "NfcPairingMode"
* @tapVersion(">=1.0")
* @param mode input
* @return call options
*/
putNfcPairingModeCall(mode: NfcPairingMode): ServiceCallType;
/**
* Write power optimization level
*
* LWM2M path: /1024//14
* Body converter id: "LowPowerOptimisationLevel"
* @tapVersion(">=1.0")
* @param mode input
* @return void api call
*/
putPowerOptimisationLevel(mode: LowPowerOptimisationLevel): Promise<Response<void>>;
/**
* Write power optimization level
*
* LWM2M path: /1024//14
* Body converter id: "LowPowerOptimisationLevel"
* @tapVersion(">=1.0")
* @param mode input
* @return call options
*/
putPowerOptimisationLevelCall(mode: LowPowerOptimisationLevel): ServiceCallType;
/**
* Write bundle id that own the special feature
*
* LWM2M path: /1024//{featureId}
* Body converter id: "integer_uint16"
* @tapVersion(">=1.23")
* @param featureId input
* @param value input
* @return void api call
*/
putSpecialFeatureProfile(featureId: number, value: number): Promise<Response<void>>;
/**
* Write bundle id that own the special feature
*
* LWM2M path: /1024//{featureId}
* Body converter id: "integer_uint16"
* @tapVersion(">=1.23")
* @param featureId input
* @param value input
* @return call options
*/
putSpecialFeatureProfileCall(featureId: number, value: number): ServiceCallType;
/**
* Write universal link value
*
* LWM2M path: /1024//19
* Body converter id: "string"
* @tapVersion(">=1.0")
* @param url input
* @return void api call
*/
putUniversalLink(url: string): Promise<Response<void>>;
/**
* Write universal link value
*
* LWM2M path: /1024//19
* Body converter id: "string"
* @tapVersion(">=1.0")
* @param url input
* @return call options
*/
putUniversalLinkCall(url: string): ServiceCallType;
/**
* Write cloud mqtt period
*
* LWM2M path: /1024//33
* Body converter id: "integer_uint32"
* @tapVersion(">=1.0")
* @param key input
* @return void api call
*/
putUploadPeriod(key: number): Promise<Response<void>>;
/**
* Write cloud mqtt period
*
* LWM2M path: /1024//33
* Body converter id: "integer_uint32"
* @tapVersion(">=1.0")
* @param key input
* @return call options
*/
putUploadPeriodCall(key: number): ServiceCallType;
/**
* Write network key
*
* LWM2M path: /1024//16
* Body converter id: "string"
* @tapVersion(">=1.0")
* @param key input
* @return void api call
*/
putWepKey(key: string): Promise<Response<void>>;
/**
* Write network key
*
* LWM2M path: /1024//16
* Body converter id: "string"
* @tapVersion(">=1.0")
* @param key input
* @return call options
*/
putWepKeyCall(key: string): ServiceCallType;
/**
* Write wifi ssid
*
* LWM2M path: /1024//25
* Body converter id: "string"
* @tapVersion(">=1.0")
* @param key input
* @return void api call
*/
putWifiSSID(key: string): Promise<Response<void>>;
/**
* Write wifi ssid
*
* LWM2M path: /1024//25
* Body converter id: "string"
* @tapVersion(">=1.0")
* @param key input
* @return call options
*/
putWifiSSIDCall(key: string): ServiceCallType;
/**
* Apply the new configuration on the device
*
* LWM2M path: /1024//10
* @tapVersion(">=1.0")
* @return void api call
*/
reloadConfig(): Promise<Response<void>>;
/**
* Apply the new configuration on the device
*
* LWM2M path: /1024//10
* @tapVersion(">=1.0")
* @return call options
*/
reloadConfigCall(): ServiceCallType;
/**
* Set bundle id that own the special feature
*
* LWM2M path: /1024//{featureId}
* Body converter id: "integer_uint16"
* @tapVersion(">=1.23")
* @param featureId input
* @param value input
* @return void api call
*/
setSpecialFeatureProfile(featureId: number, value: number): Promise<Response<void>>;
/**
* Set bundle id that own the special feature
*
* LWM2M path: /1024//{featureId}
* Body converter id: "integer_uint16"
* @tapVersion(">=1.23")
* @param featureId input
* @param value input
* @return call options
*/
setSpecialFeatureProfileCall(featureId: number, value: number): ServiceCallType;
}