import { TimeSpan } from '@elaraai/core/east'; import { Cache } from '@elaraai/core/datasource'; import { ELARASchema } from '@elaraai/core/schema'; /** * The environment variables to define an `ShopifyPlugin`. * * @category DataSource */ export declare type ShopifyEnv = { SHOPIFY_API_KEY?: string; SHOPIFY_PASSWORD?: string; SHOPIFY_URL?: string; }; /** * A {@link ShopifyPluginDefinition} to configure the {@link ShopifyPlugin}. * * @category DataSource */ export declare type ShopifyPluginDefinition = { /** 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 ShopifyPlugin} */ env?: ShopifyEnv; }; /** * Create a streaming {@link DataSourceDefinition} for the Shopify REST Admin API with supporting diagnostic pages: {@link https://shopify.dev/api/admin/rest/reference}. * * @param definition: the desired {@link MyobPluginDefinition}. * @return a {@link ELARASchema} containing a {@link MyobPluginDefinition} contents * * @category DataSource * * @example * ```typescript * //Create a ShopifyPlugin and poll data from the API every `hour` with default environment names. * const deputy = ShopifyPlugin({ * poll: TimeSpan(1), * }) * ``` */ export declare function ShopifyPlugin(args?: ShopifyPluginDefinition): ELARASchema; //# sourceMappingURL=shopify.d.ts.map