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

IoTize Device client for Javascript

/**
 *   Generated file. Do not edit
 */
import { TapResponse } from '@iotize/tap';
import { AbstractService, ServiceCallType } from '@iotize/tap';
export declare class GroupService extends AbstractService {
    resources: {
        getName: ServiceCallType<void, string>; /**
         *
         *
         * LWM2M path: /1025/{groupId}/0
         *
         * @tapVersion(">=1.0")
         * @param groupId input
         * @return call options
         */
        putName: ServiceCallType<string, void>;
        changePassword: ServiceCallType<string, void>;
        changePasswordKey: ServiceCallType<Uint8Array, void>;
        getSessionLifetime: ServiceCallType<void, number>;
        putSessionLifetime: ServiceCallType<number, void>;
        getAlias: ServiceCallType<void, number>;
        putAlias: ServiceCallType<number, void>;
        create: ServiceCallType<void, void>;
    };
    /**
     * Get the name of the group
     *
     * LWM2M path: /1025/{groupId}/0
     *
     * @tapVersion(">=1.0")
     * @param groupId input
     * @return
     */
    getName(groupId: number): Promise<TapResponse<string>>;
    /**
     *
     *
     * LWM2M path: /1025/{groupId}/0
     *
     * @tapVersion(">=1.0")
     * @param groupId input
     * @return call options
     */
    getNameCall(groupId: number): ServiceCallType;
    /**
     * Write group name
     *
     * LWM2M path: /1025/{groupId}/0
     *
     * @tapVersion(">=1.0")
     * @param groupId input
     * @param name input
     * @return
     */
    putName(groupId: number, name: string): Promise<TapResponse<void>>;
    /**
     *
     *
     * LWM2M path: /1025/{groupId}/0
     *
     * @tapVersion(">=1.0")
     * @param groupId input
     * @param name input
     * @return call options
     */
    putNameCall(groupId: number, name: string): ServiceCallType;
    /**
     * Update password
     *
     * LWM2M path: /1025/{groupId}/2
     *
     * @tapVersion(">=1.0")
     * @param groupId input
     * @param password input
     * @return
     */
    changePassword(groupId: number, password: string): Promise<TapResponse<void>>;
    /**
     *
     *
     * LWM2M path: /1025/{groupId}/2
     *
     * @tapVersion(">=1.0")
     * @param groupId input
     * @param password input
     * @return call options
     */
    changePasswordCall(groupId: number, password: string): ServiceCallType;
    /**
     * Change password using bytes data
     *
     * LWM2M path: /1025/{groupId}/2
     *
     * @tapVersion(">=1.0")
     * @param groupId input
     * @param password input
     * @return
     */
    changePasswordKey(groupId: number, password: Uint8Array): Promise<TapResponse<void>>;
    /**
     *
     *
     * LWM2M path: /1025/{groupId}/2
     *
     * @tapVersion(">=1.0")
     * @param groupId input
     * @param password input
     * @return call options
     */
    changePasswordKeyCall(groupId: number, password: Uint8Array): ServiceCallType;
    /**
     * Get the maximum session lifetime
     *
     * LWM2M path: /1025/{groupId}/4
     *
     * @tapVersion(">=1.0")
     * @param groupId input
     * @return
     */
    getSessionLifetime(groupId: number): Promise<TapResponse<number>>;
    /**
     *
     *
     * LWM2M path: /1025/{groupId}/4
     *
     * @tapVersion(">=1.0")
     * @param groupId input
     * @return call options
     */
    getSessionLifetimeCall(groupId: number): ServiceCallType;
    /**
     * Write session lifetime in configuration
     *
     * LWM2M path: /1025/{groupId}/4
     *
     * @tapVersion(">=1.0")
     * @param groupId input
     * @param value input
     * @return
     */
    putSessionLifetime(groupId: number, value: number): Promise<TapResponse<void>>;
    /**
     *
     *
     * LWM2M path: /1025/{groupId}/4
     *
     * @tapVersion(">=1.0")
     * @param groupId input
     * @param value input
     * @return call options
     */
    putSessionLifetimeCall(groupId: number, value: number): ServiceCallType;
    /**
     * Get group alias
     *
     * LWM2M path: /1025/{groupId}/5
     *
     * @tapVersion(">=1.0")
     * @param groupId input
     * @return
     */
    getAlias(groupId: number): Promise<TapResponse<number>>;
    /**
     *
     *
     * LWM2M path: /1025/{groupId}/5
     *
     * @tapVersion(">=1.0")
     * @param groupId input
     * @return call options
     */
    getAliasCall(groupId: number): ServiceCallType;
    /**
     * Write group alias in configuration
     *
     * LWM2M path: /1025/{groupId}/5
     *
     * @tapVersion(">=1.0")
     * @param groupId input
     * @param value input
     * @return
     */
    putAlias(groupId: number, value: number): Promise<TapResponse<void>>;
    /**
     *
     *
     * LWM2M path: /1025/{groupId}/5
     *
     * @tapVersion(">=1.0")
     * @param groupId input
     * @param value input
     * @return call options
     */
    putAliasCall(groupId: number, value: number): ServiceCallType;
    /**
     * Create group
     *
     * LWM2M path: /1025/{groupId}/65535
     *
     * @tapVersion(">=1.0")
     * @param groupId input
     * @return
     */
    create(groupId: number): Promise<TapResponse<void>>;
    /**
     *
     *
     * LWM2M path: /1025/{groupId}/65535
     *
     * @tapVersion(">=1.0")
     * @param groupId input
     * @return call options
     */
    createCall(groupId: number): ServiceCallType;
}