Skip to Content

createSandbox()

createSandbox(projectId, input?): Promise<{ appUserId?: string | null; billedRequests: object[]; billedUsages: object[]; conflicts: { clientData: unknown; conflictedAt: number; serverData: unknown; }; createdAt?: string; emailAddress?: string | null; id: string; isSuspended: boolean; metadata?: Record<string, unknown> | null; name?: string | null; project: { api?: { links?: Record<string, { href: string; }>; redactions?: object[]; }; authenticationProvider: | appleAppStore | clerk | customServer | firebase | none | oidc | { audiences: string[]; issuerURL: string; type: "oidc"; } | { type: "appleAppStore"; } | { type: "customServer"; } | { customerDeprovisioningPolicy: "completeProductGrants" | "retainProductGrants"; firebaseProjectId: string; type: "firebase"; } | { authorizedParties: string[]; customerDeprovisioningPolicy: "completeProductGrants" | "retainProductGrants"; hasSecretKey: boolean; instanceId: string; issuerURL: string; type: "clerk"; webhook: | { hasSigningSecret: boolean; status: "awaitingVerification" | "verified"; } | null; }; billingProviders: ( | { configuration: { appStoreConnect: { credentialSources?: { privateKey?: ... | ...; sharedSecret?: ... | ...; }; issuerId: string; privateKey: ""; privateKeyId: string; sharedSecret: ""; }; fragile_appStoreConnect: { bundleId: string; }; }; id: string; type: "appleAppStore"; updatedAt: string; } | { configuration: { connect: { accountId?: string | null; credentialSources?: { publishableKey?: ... | ...; secretKey?: ... | ...; }; publishableKey: string; redirectUrls: string[] | null; secretKey: ""; webhookApiVersion?: string | null; webhookId?: string | null; webhookSecret?: "" | null; }; }; id: string; type: "stripe"; updatedAt: string; })[]; conflicts: { clientData: unknown; conflictedAt: number; serverData: unknown; }; createdAt?: string; hidden: boolean; id: string; metadata: { customServerURL?: string | null; freeUsersAllowed: boolean | null; }; name: string; object: "project"; products?: string[]; sandboxMode: boolean; tombstoned?: boolean; tombstonedAt?: string | null; updatedAt?: string; user: string; }; sandboxMode: boolean; sandboxSecret?: string | null; tombstoned?: boolean; tombstonedAt?: string | null; updatedAt?: string; }>;

A customer for testing, whose requests run in sandbox mode, optionally named.

Parameters

projectId

string

input?

email?

string = ...

name?

string = ...

Last updated on