UNPKG

1.22 kBTypeScriptView Raw
1import { ISiteDesignRun, ISiteDesignTask, ISiteScriptActionStatus } from "./types.js";
2declare module "../webs/types" {
3 interface _Web {
4 getSiteDesignRuns(siteDesignId?: string): Promise<ISiteDesignRun[]>;
5 addSiteDesignTask(siteDesignId: string): Promise<ISiteDesignTask>;
6 getSiteDesignRunStatus(runId: string): Promise<ISiteScriptActionStatus[]>;
7 }
8 interface IWeb {
9 /**
10 * Retrieves a list of site design that have run on the current web
11 * @param siteDesignId (Optional) the site design ID, if not provided will return all site design runs
12 */
13 getSiteDesignRuns(siteDesignId?: string): Promise<ISiteDesignRun[]>;
14 /**
15 * Adds a site design task on the current web to be invoked asynchronously.
16 * @param siteDesignId The ID of the site design to create a task for
17 */
18 addSiteDesignTask(siteDesignId: string): Promise<ISiteDesignTask>;
19 /**
20 * Retrieves the status of a site design that has been run or is still running
21 * @param runId the run ID
22 */
23 getSiteDesignRunStatus(runId: string): Promise<ISiteScriptActionStatus[]>;
24 }
25}
26//# sourceMappingURL=web.d.ts.map
\No newline at end of file