import type { NotePlanXSuccess } from './shared'; type RunPluginIdentifier = { /** * Plugin name. */ pluginName: string; pluginID?: never; } | { pluginName?: never; /** * Plugin ID. */ pluginID: string; }; /** * RunPlugin action payload definition. */ type RunPlugin = NotePlanXSuccess & RunPluginIdentifier & { /** * Plugin command name without a leading slash. */ command: string; /** * Optional plugin argument, where the number maps to NotePlan's arg0, arg1, arg2, ... parameters. */ [argument: `arg${number}`]: string | undefined; }; /** * Run a NotePlan plugin command. * * @param payload RunPlugin action payload. * @returns NotePlan runPlugin URL. * @example * runPlugin({ pluginName: ' Note Statistics', command: 'nc' }) * // => 'noteplan://x-callback-url/runPlugin?pluginName=%20Note%20Statistics&command=nc' * @link https://help.noteplan.co/article/49-x-callback-url-scheme#runPlugin */ export declare function runPlugin(payload: RunPlugin): string; export {};