@iotize/device-client.js/device/service/gen/group-service.d.ts

IoTize Device client for Javascript

/**
 * 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';
export declare class GroupService extends AbstractService {
    constructor(client: Client, apiConfig: ApiConfig);
    resources: {
        [key: string]: ServiceCallType;
    };
    /**
    * Update password
    * Change groupId password using an ASCII string
    * LWM2M path: /1025/{groupId}/2
    * Body converter id: "string"
    * @tapVersion(">=1.0")
    * @param groupId input
    * @param password input
    * @return void api call
    */
    changePassword(groupId: number, password: string): Promise<Response<void>>;
    /**
    * Update password
    * Change groupId password using an ASCII string
    * LWM2M path: /1025/{groupId}/2
    * Body converter id: "string"
    * @tapVersion(">=1.0")
    * @param groupId input
    * @param password input
    * @return call options
    */
    changePasswordCall(groupId: number, password: string): ServiceCallType;
    /**
    * Change password using bytes data
    * Change groupId password using binary data. If SCRAM multi-hash mode: StoredKey+ServerKey+UserSalt+UserIt (40 uchar)
    * LWM2M path: /1025/{groupId}/2
    * Body converter id: "Bytes"
    * @tapVersion(">=1.0")
    * @param groupId input
    * @param password input
    * @return void api call
    */
    changePasswordKey(groupId: number, password: Uint8Array): Promise<Response<void>>;
    /**
    * Change password using bytes data
    * Change groupId password using binary data. If SCRAM multi-hash mode: StoredKey+ServerKey+UserSalt+UserIt (40 uchar)
    * LWM2M path: /1025/{groupId}/2
    * Body converter id: "Bytes"
    * @tapVersion(">=1.0")
    * @param groupId input
    * @param password input
    * @return call options
    */
    changePasswordKeyCall(groupId: number, password: Uint8Array): ServiceCallType;
    /**
    * Create group with id groupId
    *
    * LWM2M path: /1025/{groupId}/65535
    * @tapVersion(">=1.0")
    * @param groupId input
    * @return void api call
    */
    create(groupId: number): Promise<Response<void>>;
    /**
    * Create group with id groupId
    *
    * LWM2M path: /1025/{groupId}/65535
    * @tapVersion(">=1.0")
    * @param groupId input
    * @return call options
    */
    createCall(groupId: number): ServiceCallType;
    /**
    * Get group alias
    * ID du groupe dont ce groupe hérite les droits. Si l&#39;Alias correspond à l&#39;ID du groupe, alors c&#39;est un Profile, sinon c&#39;est un User.
    * LWM2M path: /1025/{groupId}/5
    * @tapVersion(">=1.0")
    * @param groupId input
    * @return number api call
    */
    getAlias(groupId: number): Promise<Response<number>>;
    /**
    * Get group alias
    * ID du groupe dont ce groupe hérite les droits. Si l&#39;Alias correspond à l&#39;ID du groupe, alors c&#39;est un Profile, sinon c&#39;est un User.
    * LWM2M path: /1025/{groupId}/5
    * @tapVersion(">=1.0")
    * @param groupId input
    * @return call options
    */
    getAliasCall(groupId: number): ServiceCallType;
    /**
    * Get the name of the group
    *
    * LWM2M path: /1025/{groupId}/0
    * @tapVersion(">=1.0")
    * @param groupId input
    * @return string api call
    */
    getName(groupId: number): Promise<Response<string>>;
    /**
    * Get the name of the group
    *
    * LWM2M path: /1025/{groupId}/0
    * @tapVersion(">=1.0")
    * @param groupId input
    * @return call options
    */
    getNameCall(groupId: number): ServiceCallType;
    /**
    * Get the maximum session lifetime
    *
    * LWM2M path: /1025/{groupId}/4
    * @tapVersion(">=1.0")
    * @param groupId input
    * @return number api call
    */
    getSessionLifetime(groupId: number): Promise<Response<number>>;
    /**
    * Get the maximum session lifetime
    *
    * LWM2M path: /1025/{groupId}/4
    * @tapVersion(">=1.0")
    * @param groupId input
    * @return call options
    */
    getSessionLifetimeCall(groupId: number): ServiceCallType;
    /**
    * Write group alias
    *
    * LWM2M path: /1025/{groupId}/5
    * Body converter id: "integer_uint16"
    * @tapVersion(">=1.0")
    * @param groupId input
    * @param value input
    * @return void api call
    */
    putAlias(groupId: number, value: number): Promise<Response<void>>;
    /**
    * Write group alias
    *
    * LWM2M path: /1025/{groupId}/5
    * Body converter id: "integer_uint16"
    * @tapVersion(">=1.0")
    * @param groupId input
    * @param value input
    * @return call options
    */
    putAliasCall(groupId: number, value: number): ServiceCallType;
    /**
    * Write group name
    *
    * LWM2M path: /1025/{groupId}/0
    * Body converter id: "string"
    * @tapVersion(">=1.0")
    * @param groupId input
    * @param name input
    * @return void api call
    */
    putName(groupId: number, name: string): Promise<Response<void>>;
    /**
    * Write group name
    *
    * LWM2M path: /1025/{groupId}/0
    * Body converter id: "string"
    * @tapVersion(">=1.0")
    * @param groupId input
    * @param name input
    * @return call options
    */
    putNameCall(groupId: number, name: string): ServiceCallType;
    /**
    * Write session lifetime
    *
    * LWM2M path: /1025/{groupId}/4
    * Body converter id: "integer_uint16"
    * @tapVersion(">=1.0")
    * @param groupId input
    * @param value input
    * @return void api call
    */
    putSessionLifetime(groupId: number, value: number): Promise<Response<void>>;
    /**
    * Write session lifetime
    *
    * LWM2M path: /1025/{groupId}/4
    * Body converter id: "integer_uint16"
    * @tapVersion(">=1.0")
    * @param groupId input
    * @param value input
    * @return call options
    */
    putSessionLifetimeCall(groupId: number, value: number): ServiceCallType;
}