@citrineos/base/dist/interfaces/api/AsDataEndpoint.d.ts

The base module for OCPP v2.0.1 including all interfaces. This module is not intended to be used directly, but rather as a dependency for other modules.

import { HttpMethod } from '.';
import { Namespace, OCPP1_6_Namespace, OCPP2_0_1_Namespace } from '../../ocpp/persistence';
/**
 * Decorator for use in module API class to expose methods as REST data endpoints.
 *
 * @param {OCPP2_0_1_Namespace} namespace - The namespace value.
 * @param {HttpMethod} method - The HTTP method value.
 * @param {object} querySchema - The query schema value (optional).
 * @param {object} bodySchema - The body schema value (optional).
 * @param {object} paramSchema - The param schema value (optional).
 * @param {object} headerSchema - The header schema value (optional).
 * @param {object} responseSchema - The response schema value (optional).
 * @param {object} tags - The tags value (optional).
 * @param {object} security - The security value (optional).
 * @param {string} description - The description (optional).
 * @return {void} - No return value.
 */
export declare const AsDataEndpoint: (namespace: OCPP2_0_1_Namespace | OCPP1_6_Namespace | Namespace, method: HttpMethod, querySchema?: object, bodySchema?: object, paramSchema?: object, headerSchema?: object, responseSchema?: object, tags?: string | string[], security?: object[], description?: string) => (target: any, propertyKey: string, descriptor: PropertyDescriptor) => void;