import { TimeSpan } from '@elaraai/core/east'; import { Cache } from '@elaraai/core/datasource'; import { ELARASchema } from '@elaraai/core/schema'; /** * The environment variables to define an {@link ProfitwellPlugin}. * * @category DataSource */ export declare type ProfitwellEnv = { PROFITWELL_KEY?: string; }; /** * A {@link ProfitwellPluginDefinition} to configure the {@link ProfitwellPlugin}. * * @category DataSource */ export declare type ProfitwellPluginDefinition = { /** the configuration of the DataSource {@link Poll} */ poll?: TimeSpan; /** the configuration of the {@link Cache} for the DataSource. */ cache?: Cache; /** the environment variables to apply to the {@link ProfitwellPlugin} */ env?: ProfitwellEnv; }; /** * Create a streaming {@link DataSourceDefinition} for the Profitwell API with supporting diagnostic pages: {@link https://profitwellapiv2.docs.apiary.io/#}. * * @param definition: the desired {@link ProfitwellPluginDefinition}. * @return a {@link ELARASchema} containing a {@link ProfitwellPluginDefinition} contents * * @category DataSource * * @example * ```typescript * //Create a ProfitwellPlugin polling data from the API every `hour` with default environment names. * const deputy = ProfitwellPlugin({ * poll: TimeSpan(1) * }) * ``` */ export declare function ProfitwellPlugin(args?: ProfitwellPluginDefinition): ELARASchema; //# sourceMappingURL=profitwell.d.ts.map