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

IoTize Device client for Javascript

/**
 *   Generated file. Do not edit
 */
import { TapResponse } from '@iotize/tap';
import { ReadWriteRights } from './models';
import { AbstractService, ServiceCallType } from '@iotize/tap';
export declare class BundleService extends AbstractService {
    resources: {
        putAcl: ServiceCallType<ReadWriteRights, void>;
        getValues: ServiceCallType<void, Uint8Array>;
        getDataLogPeriod: ServiceCallType<void, number>;
        putDataLogPeriod: ServiceCallType<number, void>;
        getDataLogCryptoGroupId: ServiceCallType<void, number>;
        /**
         *
         *
         * LWM2M path: /1028/{bundleId}/1
         *
         * @tapVersion(">=1.0")
         * @param bundleId input
         * @return call options
         */
        putDataLogCryptoGroupId: ServiceCallType<number, void>;
        create: ServiceCallType<void, void>;
        getName: ServiceCallType<void, string>;
        putName: ServiceCallType<string, void>;
    };
    /**
     * Write acls
     *
     * LWM2M path: /1028/{bundleId}/0
     *
     * @tapVersion(">=1.0")
     * @param bundleId input
     * @param rights input
     * @return
     */
    putAcl(bundleId: number, rights: ReadWriteRights): Promise<TapResponse<void>>;
    /**
     *
     *
     * LWM2M path: /1028/{bundleId}/0
     *
     * @tapVersion(">=1.0")
     * @param bundleId input
     * @param rights input
     * @return call options
     */
    putAclCall(bundleId: number, rights: ReadWriteRights): ServiceCallType;
    /**
     * Get bundle values
     *
     * LWM2M path: /1028/{bundleId}/1
     *
     * @tapVersion(">=1.0")
     * @param bundleId input
     * @return
     */
    getValues(bundleId: number): Promise<TapResponse<Uint8Array>>;
    /**
     *
     *
     * LWM2M path: /1028/{bundleId}/1
     *
     * @tapVersion(">=1.0")
     * @param bundleId input
     * @return call options
     */
    getValuesCall(bundleId: number): ServiceCallType;
    /**
     * Get data log acquisition period
     *
     * LWM2M path: /1028/{bundleId}/2
     *
     * @tapVersion(">=1.0")
     * @param bundleId input
     * @return
     */
    getDataLogPeriod(bundleId: number): Promise<TapResponse<number>>;
    /**
     *
     *
     * LWM2M path: /1028/{bundleId}/2
     *
     * @tapVersion(">=1.0")
     * @param bundleId input
     * @return call options
     */
    getDataLogPeriodCall(bundleId: number): ServiceCallType;
    /**
     * Write data-log acquisition period in configuration
     *
     * LWM2M path: /1028/{bundleId}/2
     *
     * @tapVersion(">=1.0")
     * @param bundleId input
     * @param value input
     * @return
     */
    putDataLogPeriod(bundleId: number, value: number): Promise<TapResponse<void>>;
    /**
     *
     *
     * LWM2M path: /1028/{bundleId}/2
     *
     * @tapVersion(">=1.0")
     * @param bundleId input
     * @param value input
     * @return call options
     */
    putDataLogPeriodCall(bundleId: number, value: number): ServiceCallType;
    /**
     * Get data log encryption group id
     *
     * LWM2M path: /1028/{bundleId}/3
     *
     * @tapVersion(">=1.0")
     * @param bundleId input
     * @return
     */
    getDataLogCryptoGroupId(bundleId: number): Promise<TapResponse<number>>;
    /**
     *
     *
     * LWM2M path: /1028/{bundleId}/3
     *
     * @tapVersion(">=1.0")
     * @param bundleId input
     * @return call options
     */
    getDataLogCryptoGroupIdCall(bundleId: number): ServiceCallType;
    /**
     * Write data-log acquisition period in configuration
     *
     * LWM2M path: /1028/{bundleId}/3
     *
     * @tapVersion(">=1.0")
     * @param bundleId input
     * @param value input
     * @return
     */
    putDataLogCryptoGroupId(bundleId: number, value: number): Promise<TapResponse<void>>;
    /**
     *
     *
     * LWM2M path: /1028/{bundleId}/3
     *
     * @tapVersion(">=1.0")
     * @param bundleId input
     * @param value input
     * @return call options
     */
    putDataLogCryptoGroupIdCall(bundleId: number, value: number): ServiceCallType;
    /**
     * Create a new bundle
     *
     * LWM2M path: /1028/{bundleId}/65535
     *
     * @tapVersion(">=1.0")
     * @param bundleId input
     * @return
     */
    create(bundleId: number): Promise<TapResponse<void>>;
    /**
     *
     *
     * LWM2M path: /1028/{bundleId}/65535
     *
     * @tapVersion(">=1.0")
     * @param bundleId input
     * @return call options
     */
    createCall(bundleId: number): ServiceCallType;
    /**
     * Read bundle name
     *
     * LWM2M path: /1028/{bundleId}/4
     *
     * @tapVersion(">=1.0")
     * @param bundleId input
     * @return
     */
    getName(bundleId: number): Promise<TapResponse<string>>;
    /**
     *
     *
     * LWM2M path: /1028/{bundleId}/4
     *
     * @tapVersion(">=1.0")
     * @param bundleId input
     * @return call options
     */
    getNameCall(bundleId: number): ServiceCallType;
    /**
     * Write bundle name in configuration
     *
     * LWM2M path: /1028/{bundleId}/4
     *
     * @tapVersion(">=1.0")
     * @param bundleId input
     * @param name input
     * @return
     */
    putName(bundleId: number, name: string): Promise<TapResponse<void>>;
    /**
     *
     *
     * LWM2M path: /1028/{bundleId}/4
     *
     * @tapVersion(">=1.0")
     * @param bundleId input
     * @param name input
     * @return call options
     */
    putNameCall(bundleId: number, name: string): ServiceCallType;
}