@salesforce/core/lib/schema/project-scratch-def/scratchOrgDef.d.ts

Core libraries to interact with SFDX projects, orgs, and APIs.

import { z } from 'zod';
/**
 * Scratch Org Definition Configuration
 * The scratch org definition file contains the configuration values that determine the shape of the scratch org.
 */
export declare const ScratchOrgDefSchema: z.ZodObject<{
    orgName: z.ZodOptional<z.ZodString>;
    edition: z.ZodEnum<{
        Group: "Group";
        Developer: "Developer";
        Enterprise: "Enterprise";
        "Partner Developer": "Partner Developer";
        "Partner Enterprise": "Partner Enterprise";
        "Partner Group": "Partner Group";
        "Partner Professional": "Partner Professional";
        Professional: "Professional";
    }>;
    country: z.ZodOptional<z.ZodString>;
    username: z.ZodOptional<z.ZodString>;
    adminEmail: z.ZodOptional<z.ZodString>;
    description: z.ZodOptional<z.ZodString>;
    hasSampleData: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
    language: z.ZodOptional<z.ZodString>;
    features: z.ZodOptional<z.ZodArray<z.ZodUnion<readonly [z.ZodUnion<z.ZodString[]>, z.ZodString]>>>;
    template: z.ZodOptional<z.ZodString>;
    settings: z.ZodOptional<z.ZodObject<{
        accountingSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        accountInsightsSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        accountIntelligenceSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        accountPlanSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        accountSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        actionsSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        activitiesSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        addressSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        agentforceForDevelopersSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        agentPlatformSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        aIReplyRecommendationsSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        analyticsSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        apexSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        appAnalyticsSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        appExperienceSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        associationEngineSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        automatedContactsSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        botSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        branchManagementSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        businessHoursSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        campaignSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        caseSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        chatterAnswersSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        chatterEmailsMDSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        chatterSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        codeBuilderSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        collectionsDashboardSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        communitiesSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        companySettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        connectedAppSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        contentSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        contractSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        conversationalIntelligenceSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        conversationChannelDefinition: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        currencySettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        customAddressFieldSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        dataDotComSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        dataImportManagementSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        deploymentSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        devHubSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        documentGenerationSetting: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        dynamicFormsSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        eACSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        einsteinAgentSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        einsteinAISettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        einsteinGptSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        emailAdministrationSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        emailIntegrationSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        emailTemplateSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        employeeUserSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        encryptionKeySettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        enhancedNotesSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        entitlementSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        eventSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        experienceBundleSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        externalClientAppSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        externalServicesSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        fieldServiceSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        filesConnectSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        fileUploadAndDownloadSecuritySettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        flowSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        forecastingObjectListSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        forecastingSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        highVelocitySalesSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        ideasSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        identityProviderSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        iframeWhiteListUrlSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        incidentMgmtSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        industriesEinsteinFeatureSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        industriesLoyaltySettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        industriesSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        interestTaggingSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        inventorySettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        invLatePymntRiskCalcSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        invocableActionSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        ioTSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        knowledgeSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        languageSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        leadConfigSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        leadConvertSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        lightningExperienceSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        liveAgentSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        liveMessageSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        macroSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        mailMergeSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        mapAndLocationSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        meetingsSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        mfgServiceConsoleSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        mobileSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        myDomainSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        nameSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        notificationsSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        oauthOidcSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        objectHierarchyRelationship: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        objectLinkingSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        omniChannelSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        opportunityInsightsSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        opportunityScoreSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        opportunitySettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        orderManagementSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        orderSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        orgPreferenceSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        orgSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        pardotEinsteinSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        pardotSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        partyDataModelSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        pathAssistantSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        paymentsSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        picklistSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        platformEncryptionSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        platformEventSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        predictionBuilderSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        privacySettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        processFlowMigration: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        productSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        quoteSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        realTimeEventSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        recordPageSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        retailExecutionSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        salesAgreementSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        sandboxSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        schemaSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        searchSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        securitySettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        serviceCloudVoiceSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        serviceSetupAssistantSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        sharingSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        siteSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        socialCustomerServiceSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        socialProfileSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        sourceTrackingSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        subscriptionManagementSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        surveySettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        territory2Settings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        trailheadSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        trialOrgSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        userEngagementSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        userInterfaceSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        userManagementSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        voiceSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        warrantyLifeCycleMgmtSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        workDotComSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        workforceEngagementSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
    }, z.core.$catchall<z.ZodUnknown>>>;
    release: z.ZodOptional<z.ZodEnum<{
        preview: "preview";
        previous: "previous";
    }>>;
}, z.core.$catchall<z.ZodUnknown>>;
export type ScratchOrgDef = z.infer<typeof ScratchOrgDefSchema>;