UNPKG

1.09 kBTypeScriptView Raw
1import { ConfigFile } from './configFile';
2/**
3 * A config file that stores usernames for an org.
4 */
5export declare class SandboxOrgConfig extends ConfigFile<SandboxOrgConfig.Options> {
6 /**
7 * Constructor.
8 * **Do not directly construct instances of this class -- use {@link SandboxConfig.create} instead.**
9 *
10 * @param options The options for the class instance
11 * @ignore
12 */
13 constructor(options?: SandboxOrgConfig.Options);
14 /**
15 * Gets the config options for a given org ID.
16 *
17 * @param orgId The orgId. Generally this org would have multiple users configured.
18 */
19 static getOptions(orgId: string): SandboxOrgConfig.Options;
20}
21export declare namespace SandboxOrgConfig {
22 /**
23 * The config file options.
24 */
25 interface Options extends ConfigFile.Options {
26 /**
27 * The org id associated with this sandbox.
28 */
29 orgId: string;
30 }
31 enum Fields {
32 /**
33 * The username of the user who created the sandbox.
34 */
35 PROD_ORG_USERNAME = "prodOrgUsername"
36 }
37}