@salesforce/packaging/lib/interfaces/packagingSObjects.d.ts

Packaging library for the Salesforce packaging platform

import { Nullable } from '@salesforce/ts-types';
import { CodeCoverage, CodeCoveragePercentages, PackageType } from './packagingInterfacesAndType';
export declare namespace PackagingSObjects {
    type Package2 = {
        Id: string;
        IsDeleted: boolean;
        CreatedDate: number;
        CreatedById: string;
        LastModifiedDate: number;
        LastModifiedById: string;
        SystemModstamp: number;
        SubscriberPackageId: string;
        Name: string;
        Description: string;
        NamespacePrefix: string;
        ContainerOptions: PackageType;
        IsDeprecated: boolean;
        IsOrgDependent: boolean;
        ConvertedFromPackageId: string;
        PackageErrorUsername: string;
        AppAnalyticsEnabled?: boolean;
        RecommendedVersionId?: string;
    };
    type Package2Version = {
        Id: string;
        IsDeleted: boolean;
        CreatedDate: number;
        CreatedById: string;
        LastModifiedDate: number;
        LastModifiedById: string;
        SystemModstamp: number;
        Package2Id: string;
        SubscriberPackageVersionId: string;
        Tag: string;
        Branch: string;
        AncestorId: string;
        ValidationSkipped: boolean;
        ValidatedAsync?: boolean;
        Name: string;
        Description: string;
        MajorVersion: number;
        MinorVersion: number;
        PatchVersion: number;
        BuildNumber: number;
        IsDeprecated: boolean;
        IsPasswordProtected: boolean;
        CodeCoverage: CodeCoverage;
        CodeCoveragePercentages: CodeCoveragePercentages;
        HasPassedCodeCoverageCheck: boolean;
        InstallKey: string;
        IsReleased: boolean;
        ConvertedFromVersionId: string;
        ReleaseVersion: number;
        BuildDurationInSeconds: number;
        HasMetadataRemoved: boolean;
        Language: string;
        EndToEndBuildDurationInSeconds?: number;
        TotalNumberOfMetadataFiles: number;
        TotalSizeOfMetadataFiles: number;
        DeveloperUsePkgZip?: string;
    };
    enum Package2VersionStatus {
        queued = "Queued",
        inProgress = "InProgress",
        success = "Success",
        error = "Error",
        initializing = "Initializing",
        verifyingFeaturesAndSettings = "VerifyingFeaturesAndSettings",
        verifyingDependencies = "VerifyingDependencies",
        verifyingMetadata = "VerifyingMetadata",
        finalizingPackageVersion = "FinalizingPackageVersion",
        performingValidations = "PerformingValidations"
    }
    type Package2VersionCreateRequest = {
        Id: string;
        IsDeleted: boolean;
        CreatedDate: number;
        CreatedById: string;
        LastModifiedDate: number;
        LastModifiedById: string;
        SystemModstamp: number;
        Package2Id: string;
        Package2VersionId: string;
        Tag: string;
        Branch: string;
        Status: Package2VersionStatus;
        Instance: string;
        IsPasswordProtected: boolean;
        InstallKey: string;
        CalculateCodeCoverage: boolean;
        SkipValidation: boolean;
        IsConversionRequest: boolean;
        VersionInfo: string;
        Language: string;
    };
    type Package2VersionCreateRequestError = {
        Id: string;
        IsDeleted: boolean;
        CreatedDate: number;
        CreatedById: string;
        LastModifiedDate: number;
        LastModifiedById: string;
        SystemModstamp: number;
        ParentRequestId: string;
        Message: string;
    };
    type SubscriberPackage = {
        Id: string;
        Name: string;
        NamespacePrefix: string;
        Description: string;
        IsPackageValid: boolean;
    };
    type SubscriberPackageDestinationProfile = {
        description: string;
        displayName: string;
        name: string;
        noAccess: boolean;
        profileId: string;
        type: string;
    };
    type SubscriberPackageSourceProfile = {
        label: string;
        value: string;
    };
    type SubscriberPackageProfiles = {
        destinationProfiles: SubscriberPackageDestinationProfile[];
        sourceProfiles: SubscriberPackageSourceProfile[];
    };
    type SubscriberPackageDependencies = {
        ids: Array<{
            subscriberPackageVersionId: string;
        }>;
    };
    type SubscriberPackageRemoteSiteSetting = {
        secure: boolean;
        url: string;
    };
    type SubscriberPackageRemoteSiteSettings = {
        settings: SubscriberPackageRemoteSiteSetting[];
    };
    type SubscriberPackageCspTrustedSite = {
        endpointUrl: string;
    };
    type SubscriberPackageCspTrustedSites = {
        settings: SubscriberPackageCspTrustedSite[];
    };
    type InstallValidationStatus = 'NO_ERRORS_DETECTED' | 'BETA_INSTALL_INTO_PRODUCTION_ORG' | 'CANNOT_INSTALL_EARLIER_VERSION' | 'CANNOT_UPGRADE_BETA' | 'CANNOT_UPGRADE_UNMANAGED' | 'DEPRECATED_INSTALL_PACKAGE' | 'EXTENSIONS_ON_LOCAL_PACKAGES' | 'PACKAGE_NOT_INSTALLED' | 'PACKAGE_HAS_IN_DEV_EXTENSIONS' | 'INSTALL_INTO_DEV_ORG' | 'NO_ACCESS' | 'PACKAGING_DISABLED' | 'PACKAGING_NO_ACCESS' | 'PACKAGE_UNAVAILABLE' | 'PACKAGE_UNAVAILABLE_CRC' | 'PACKAGE_UNAVAILABLE_ZIP' | 'UNINSTALL_IN_PROGRESS' | 'UNKNOWN_ERROR' | 'NAMESPACE_COLLISION';
    type SubscriberPackageVersion = {
        Id: string;
        SubscriberPackageId: string;
        Name: string;
        Description: string;
        PublisherName: string;
        MajorVersion: number;
        MinorVersion: number;
        PatchVersion: number;
        BuildNumber: number;
        ReleaseState: string;
        IsManaged: boolean;
        IsDeprecated: boolean;
        IsPasswordProtected: boolean;
        IsBeta: boolean;
        Package2ContainerOptions: PackageType;
        IsSecurityReviewed: boolean;
        IsOrgDependent: boolean;
        AppExchangePackageName: string;
        AppExchangeDescription: string;
        AppExchangePublisherName: string;
        AppExchangeLogoUrl: string;
        ReleaseNotesUrl: string;
        PostInstallUrl: string;
        RemoteSiteSettings: SubscriberPackageRemoteSiteSettings;
        CspTrustedSites: SubscriberPackageCspTrustedSites;
        Profiles: SubscriberPackageProfiles;
        Dependencies: SubscriberPackageDependencies;
        InstallValidationStatus: InstallValidationStatus;
    };
    type SubscriberPackageVersionUninstallRequest = {
        Id: string;
        IsDeleted: boolean;
        CreatedDate: number;
        CreatedById: string;
        LastModifiedDate: number;
        LastModifiedById: string;
        SystemModstamp: number;
        SubscriberPackageVersionId: string;
        Status: 'Error' | 'InProgress' | 'Queued' | 'Success';
    };
    type PackageVersionUninstallRequestError = {
        Id: string;
        IsDeleted: boolean;
        CreatedDate: number;
        CreatedById: string;
        LastModifiedDate: number;
        LastModifiedById: string;
        SystemModstamp: number;
        SubscriberPackageVersionId: string;
        Status: string;
    };
    type SubscriberPackageInstallError = {
        message: string;
    };
    type SubscriberPackageInstallErrors = {
        errors: SubscriberPackageInstallError[];
    };
    type SubscriberPackageProfileMapping = {
        source: string;
        target: string;
    };
    type SubscriberPackageProfileMappings = {
        profileMappings: SubscriberPackageProfileMapping[];
    };
    type Attributes = {
        type: string;
        url: string;
    };
    type PackageInstallRequest = {
        attributes: Attributes;
        Id: string;
        IsDeleted: boolean;
        CreatedDate: string;
        CreatedById: string;
        LastModifiedDate: string;
        LastModifiedById: string;
        SystemModstamp: string;
        SubscriberPackageVersionKey: string;
        NameConflictResolution: 'Block' | 'RenameMetadata';
        SecurityType: 'Custom' | 'Full' | 'None';
        PackageInstallSource: string;
        ProfileMappings: Nullable<SubscriberPackageProfileMappings>;
        Password: Nullable<string>;
        EnableRss: boolean;
        UpgradeType: Nullable<'delete-only' | 'deprecate-only' | 'mixed-mode'>;
        ApexCompileType: Nullable<'all' | 'package'>;
        SkipHandlers: Nullable<string>;
        Status: 'ERROR' | 'IN_PROGRESS' | 'SUCCESS' | 'UNKNOWN';
        Errors: Nullable<SubscriberPackageInstallErrors>;
    };
    type PackageUploadRequest = {
        Id: string;
        IsDeleted: boolean;
        CreatedDate: number;
        CreatedById: string;
        LastModifiedDate: number;
        LastModifiedById: string;
        SystemModstamp: number;
        MetadataPackageId: string;
        MetadataPackageVersionId: string;
        IsReleaseVersion: boolean;
        VersionName: string;
        Description: string;
        MajorVersion: number;
        MinorVersion: number;
        ReleaseNotesUrl: string;
        PostInstallUrl: string;
        Password: string;
        Status: string;
        Errors: any[];
    };
    type InstalledSubscriberPackageVersion = {
        Id: string;
        SubscriberPackageId: string;
        Name: string;
        Description: string;
        PublisherName: string;
        MajorVersion: number;
        MinorVersion: number;
        PatchVersion: number;
        BuildNumber: number;
        ReleaseState: string;
        IsManaged: boolean;
        IsDeprecated: boolean;
        IsPasswordProtected: boolean;
        IsBeta: boolean;
        Package2ContainerOptions: string;
        IsSecurityReviewed: boolean;
        IsOrgDependent: boolean;
        AppExchangePackageName: string;
        AppExchangeDescription: string;
        AppExchangePublisherName: string;
        AppExchangeLogoUrl: string;
        ReleaseNotesUrl: string;
        PostInstallUrl: string;
        RemoteSiteSettings: unknown;
        CspTrustedSites: unknown;
        Profiles: unknown;
        Dependencies: unknown;
        InstallValidationStatus: string;
    };
    type InstalledSubscriberPackage = {
        Id: string;
        SubscriberPackageId: string;
        SubscriberPackageVersionId: string;
        MinPackageVersionId: string;
    };
    type MetadataPackageVersion = {
        Id: string;
        MetadataPackageId: string;
        Name: string;
        ReleaseState: 'Beta' | 'Released';
        MajorVersion: number;
        MinorVersion: number;
        PatchVersion: number;
        BuildNumber: number;
        IsDeprecated: boolean;
    };
    type MetadataPackage = {
        Id: string;
        Name: string;
        NamespacePrefix: string;
        PackageCategory: 'Application' | 'Module' | 'Package' | 'Package2';
    };
}