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 MailchimpPluginDefinition}. * * @category DataSource */ export declare type MailchimpEnv = { MAILCHIMP_KEY?: string; }; /** * A {@link MailchimpPluginDefinition} to configure the {@link MailchimpPlugin}. * * @category DataSource */ export declare type MailchimpPluginDefinition = { /** 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 MailchimpPlugin} */ env?: MailchimpEnv; }; /** * Create a streaming {@link DataSourceDefinition} for the Mailchimp Marketing API with supporting diagnostic pages: {@link https://mailchimp.com/developer/marketing/api/}. * * @param definition: the desired {@link MailchimpPluginDefinition}. * @return a {@link ELARASchema} containing a {@link MailchimpPluginDefinition} contents * * @category DataSource * * @example * ```typescript * // Create a `MailchimpPlugin` request the data from the API every `hour` with default environment names. * const mailchimp = MailchimpPlugin({ * poll: TimeSpan(1), * }) * ``` */ export declare function MailchimpPlugin(args?: MailchimpPluginDefinition): ELARASchema; //# sourceMappingURL=mailchimp.d.ts.map