diff --git a/classes/package1_package1Version.Package1Version.html b/classes/package1_package1Version.Package1Version.html index b60f9277f..ca8caa932 100644 --- a/classes/package1_package1Version.Package1Version.html +++ b/classes/package1_package1Version.Package1Version.html @@ -5,19 +5,19 @@

Create a new 1GP package version in the org:

const myPkg = await Package1Version.create(connection, options, pollingOptions);

More implementation examples are in the plugin here: https://github.com/salesforcecli/plugin-packaging/tree/main/src/commands/force/package1/

-

Implements

Constructors

constructor +

Implements

Constructors

constructor

Methods

getPackageVersion create getCreateStatus list

Constructors

constructor

Methods

getPackageVersion

Staticcreate

StaticgetCreateStatus

Methods

getPackageVersion

Staticcreate

StaticgetCreateStatus

Staticlist

  • list(connection, id?): Promise<MetadataPackageVersion[]>

  • Lists package versions available in the org. If package ID is supplied, only list versions of that package, +

Returns Promise<PackageUploadRequest>

Staticlist

Settings

Member Visibility

On This Page

Constructors
Methods
+

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/classes/package_package.Package.html b/classes/package_package.Package.html index 54ad7f1ba..f2a1a11bc 100644 --- a/classes/package_package.Package.html +++ b/classes/package_package.Package.html @@ -7,7 +7,7 @@

const myPkg = await Package.create(connection, project, options);

List all packages in the org:

const pkgList = await Package.list(connection);

-

Constructors

constructor +

Constructors

constructor

Methods

delete getId getPackageData @@ -21,37 +21,37 @@ getAncestry list listVersions -

Constructors

constructor

Methods

delete

  • delete(): Promise<SaveResult>

  • Deletes the package.

    -

    Returns Promise<SaveResult>

getId

  • getId(): string

  • Returns the package ID of the package.

    +

Constructors

constructor

Methods

delete

  • delete(): Promise<SaveResult>

  • Deletes the package.

    +

    Returns Promise<SaveResult>

getId

  • getId(): string

  • Returns the package ID of the package.

    Returns string

    package ID (0Ho)

    -

getPackageData

getPackageData

  • getPackageData(force?): Promise<undefined | Package2>

  • Returns the package data for the package.

    Parameters

    • force: boolean = false

      force a refresh of the package data

      -

    Returns Promise<undefined | Package2>

getPackageVersions

  • getPackageVersions(options?): Promise<PackageVersionListResult[]>

  • Returns the list of package versions for the package. +

Returns Promise<undefined | Package2>

getPackageVersions

getType

undelete

  • undelete(): Promise<SaveResult>

  • Un-Deletes the package.

    -

    Returns Promise<SaveResult>

update

getType

undelete

  • undelete(): Promise<SaveResult>

  • Un-Deletes the package.

    +

    Returns Promise<SaveResult>

update

Staticconvert

Staticconvert

Staticcreate

  • create(connection, project, options): Promise<{
        Id: string;
    }>

  • Create a new package.

    +
  • Optionalproject: SfProject

Returns Promise<PackageVersionCreateRequestResult>

Staticcreate

  • create(connection, project, options): Promise<{
        Id: string;
    }>

  • Create a new package.

    Parameters

    • connection: Connection<Schema>

      instance of Connection

    • project: SfProject

      instance of SfProject

    • options: PackageCreateOptions

      options for creating a package - see PackageCreateOptions

    Returns Promise<{
        Id: string;
    }>

    Package

    -

StaticdownloadPackageVersionMetadata

  • downloadPackageVersionMetadata(project, options, connection): Promise<ConvertResult>

  • Download the metadata files for a previously published package version, convert them to source format, and put them into a new project folder within the sfdx project.

    +

StaticdownloadPackageVersionMetadata

StaticgetAncestry

  • getAncestry(packageId, project, connection): Promise<PackageAncestry>

  • create a PackageAncestry instance

    +
  • connection: Connection<Schema>

Returns Promise<ConvertResult>

StaticgetAncestry

  • getAncestry(packageId, project, connection): Promise<PackageAncestry>

  • create a PackageAncestry instance

    Parameters

    • packageId: string

      to get version information for

    • project: undefined | SfProject

      SfProject instance

    • connection: Connection<Schema>

      Hub Org Connection

      -

    Returns Promise<PackageAncestry>

Staticlist

  • list(connection): Promise<Package2[]>

  • Returns all the packages that are available in the org, up to 10,000. If more records are +

Returns Promise<PackageAncestry>

Staticlist

  • list(connection): Promise<Package2[]>

  • Returns all the packages that are available in the org, up to 10,000. If more records are needed use the SF_ORG_MAX_QUERY_LIMIT env var.

    -

    Parameters

    • connection: Connection<Schema>

    Returns Promise<Package2[]>

StaticlistVersions

StaticlistVersions

Settings

Member Visibility

On This Page

Constructors
Methods
+

Returns Promise<PackageVersionListResult[]>

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/classes/package_packageAncestry.AncestryDotProducer.html b/classes/package_packageAncestry.AncestryDotProducer.html index 52259242e..0d21ca638 100644 --- a/classes/package_packageAncestry.AncestryDotProducer.html +++ b/classes/package_packageAncestry.AncestryDotProducer.html @@ -1,10 +1,10 @@ -AncestryDotProducer | @salesforce/packaging

Class AncestryDotProducer

Implements

Constructors

constructor +AncestryDotProducer | @salesforce/packaging

Class AncestryDotProducer

Implements

Constructors

constructor

Properties

label options?

Methods

addNode produce buildDotEdge buildDotNode -

Constructors

constructor

Properties

label

label: string

Optionaloptions

options?: AncestryRepresentationProducerOptions

Methods

addNode

produce

StaticbuildDotEdge

StaticbuildDotNode

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Constructors

constructor

Properties

label

label: string

Optionaloptions

options?: AncestryRepresentationProducerOptions

Methods

addNode

produce

StaticbuildDotEdge

StaticbuildDotNode

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/classes/package_packageAncestry.AncestryJsonProducer.html b/classes/package_packageAncestry.AncestryJsonProducer.html index 590f3918a..7be9fb830 100644 --- a/classes/package_packageAncestry.AncestryJsonProducer.html +++ b/classes/package_packageAncestry.AncestryJsonProducer.html @@ -1,6 +1,6 @@ -AncestryJsonProducer | @salesforce/packaging

Class AncestryJsonProducer

Implements

Constructors

constructor +AncestryJsonProducer | @salesforce/packaging

Class AncestryJsonProducer

Implements

Constructors

constructor

Properties

label options?

Methods

addNode produce -

Constructors

constructor

Properties

label

label: string

Optionaloptions

options?: AncestryRepresentationProducerOptions

Methods

addNode

produce

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Constructors

constructor

Properties

label

label: string

Optionaloptions

options?: AncestryRepresentationProducerOptions

Methods

addNode

produce

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/classes/package_packageAncestry.AncestryTreeProducer.html b/classes/package_packageAncestry.AncestryTreeProducer.html index 0a67acc11..b249df071 100644 --- a/classes/package_packageAncestry.AncestryTreeProducer.html +++ b/classes/package_packageAncestry.AncestryTreeProducer.html @@ -1,4 +1,4 @@ -AncestryTreeProducer | @salesforce/packaging

Class AncestryTreeProducer

Hierarchy

  • Tree
    • AncestryTreeProducer

Implements

Constructors

constructor +AncestryTreeProducer | @salesforce/packaging

Class AncestryTreeProducer

Hierarchy

  • Tree
    • AncestryTreeProducer

Implements

Constructors

constructor

Properties

label nodes options? @@ -7,4 +7,4 @@ insert produce search -

Constructors

constructor

Properties

label

label: string

nodes

nodes: {
    [key: string]: Tree;
} = {}

Optionaloptions

options?: AncestryRepresentationProducerOptions

Methods

addNode

display

  • display(logger?): void

  • Parameters

    • logger: ((text: string) => void) = console.log
        • (text): void

        • Parameters

          • text: string

          Returns void

    Returns void

insert

produce

search

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Constructors

constructor

Properties

label

label: string

nodes

nodes: {
    [key: string]: Tree;
} = {}

Optionaloptions

options?: AncestryRepresentationProducerOptions

Methods

addNode

display

  • display(logger?): void

  • Parameters

    • logger: ((text: string) => void) = console.log
        • (text): void

        • Parameters

          • text: string

          Returns void

    Returns void

insert

produce

search

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/classes/package_packageAncestry.PackageAncestry.html b/classes/package_packageAncestry.PackageAncestry.html index cba93673b..6fcd8f0ed 100644 --- a/classes/package_packageAncestry.PackageAncestry.html +++ b/classes/package_packageAncestry.PackageAncestry.html @@ -1,6 +1,6 @@ PackageAncestry | @salesforce/packaging

Class PackageAncestry

A class that represents the package ancestry graph. Given a package Id (0Ho) or a package version Id (04t), it will build a graph of the package's ancestors.

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Accessors

requestedPackageId

Methods

getAncestryGraph getDotProducer @@ -9,14 +9,14 @@ getRepresentationProducer getTreeProducer init -

Constructors

constructor

Accessors

requestedPackageId

Methods

getAncestryGraph

  • getAncestryGraph(): DirectedGraph<Attributes, Attributes, Attributes>

  • Returns the internal representation of the requested package ancestry graph.

    -

    Returns DirectedGraph<Attributes, Attributes, Attributes>

getDotProducer

getJsonProducer

getLeafPathToRoot

  • getLeafPathToRoot(subscriberPackageVersionId?): PackageAncestryNode[][]

  • Returns a list of ancestry nodes that represent the path from subscriber package version id to the root of the +

Constructors

constructor

Accessors

requestedPackageId

Methods

getAncestryGraph

  • getAncestryGraph(): DirectedGraph<Attributes, Attributes, Attributes>

  • Returns the internal representation of the requested package ancestry graph.

    +

    Returns DirectedGraph<Attributes, Attributes, Attributes>

getDotProducer

getJsonProducer

getLeafPathToRoot

getRepresentationProducer

getRepresentationProducer

getTreeProducer

init

  • init(): Promise<void>

  • Asynchronously initializes newly constructed instances of a concrete subclass.

    -

    Returns Promise<void>

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods
+

Returns AncestryRepresentationProducer

getTreeProducer

init

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods
diff --git a/classes/package_packageAncestry.PackageAncestryNode.html b/classes/package_packageAncestry.PackageAncestryNode.html index c040b5073..18116077a 100644 --- a/classes/package_packageAncestry.PackageAncestryNode.html +++ b/classes/package_packageAncestry.PackageAncestryNode.html @@ -1,4 +1,4 @@ -PackageAncestryNode | @salesforce/packaging

Class PackageAncestryNode

Hierarchy

Constructors

constructor +PackageAncestryNode | @salesforce/packaging

Class PackageAncestryNode

Hierarchy

Constructors

constructor

Properties

AncestorId BuildNumber MajorVersion @@ -9,4 +9,4 @@ options version

Methods

getVersion -

Constructors

constructor

Properties

ReadonlyAncestorId

AncestorId: undefined | string

ReadonlyBuildNumber

BuildNumber: string | number

ReadonlyMajorVersion

MajorVersion: number

ReadonlyMinorVersion

MinorVersion: number

ReadonlyPatchVersion

PatchVersion: number

ReadonlySubscriberPackageVersionId

SubscriberPackageVersionId: string

ReadonlydepthCounter

depthCounter: 0 = 0

options

options: PackageAncestryNodeOptions

Readonlyversion

version: VersionNumber

Methods

getVersion

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Constructors

constructor

Properties

ReadonlyAncestorId

AncestorId: undefined | string

ReadonlyBuildNumber

BuildNumber: string | number

ReadonlyMajorVersion

MajorVersion: number

ReadonlyMinorVersion

MinorVersion: number

ReadonlyPatchVersion

PatchVersion: number

ReadonlySubscriberPackageVersionId

SubscriberPackageVersionId: string

ReadonlydepthCounter

depthCounter: 0 = 0

options

options: PackageAncestryNodeOptions

Readonlyversion

version: VersionNumber

Methods

getVersion

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/classes/package_packageProfileApi.PackageProfileApi.html b/classes/package_packageProfileApi.PackageProfileApi.html index cccfc225c..2d2d3a1dc 100644 --- a/classes/package_packageProfileApi.PackageProfileApi.html +++ b/classes/package_packageProfileApi.PackageProfileApi.html @@ -1,16 +1,16 @@ -PackageProfileApi | @salesforce/packaging

Class PackageProfileApi

Hierarchy

Constructors

constructor +PackageProfileApi | @salesforce/packaging

Class PackageProfileApi

Hierarchy

Constructors

constructor

Properties

includeUserLicenses project

Methods

filterAndGenerateProfilesForManifest generateProfiles init -

Constructors

constructor

Properties

includeUserLicenses

includeUserLicenses: boolean = false

project

project: SfProject

Methods

filterAndGenerateProfilesForManifest

  • filterAndGenerateProfilesForManifest(typesArr, excludedDirectories?): PackageTypeMembers[]

  • Filter out all profiles in the manifest and if any profiles exist in the project package directories, add them to the manifest.

    +

Constructors

constructor

Properties

includeUserLicenses

includeUserLicenses: boolean = false

project

project: SfProject

Methods

filterAndGenerateProfilesForManifest

  • filterAndGenerateProfilesForManifest(typesArr, excludedDirectories?): PackageTypeMembers[]

  • Filter out all profiles in the manifest and if any profiles exist in the project package directories, add them to the manifest.

    Parameters

    • typesArr: PackageTypeMembers[]

      array of objects { name[], members[] } that represent package types JSON.

    • excludedDirectories: string[] = []

      Direcotires not to generate profiles for

      -

    Returns PackageTypeMembers[]

generateProfiles

  • generateProfiles(destPath, manifestTypes, excludedDirectories?): string[]

  • For any profile present in the project package directories, this function generates a subset of data that only +

Returns PackageTypeMembers[]

generateProfiles

init

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Returns string[]

init

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/classes/package_packageVersion.PackageVersion.html b/classes/package_packageVersion.PackageVersion.html index 047f67377..c3e9c20ec 100644 --- a/classes/package_packageVersion.PackageVersion.html +++ b/classes/package_packageVersion.PackageVersion.html @@ -7,7 +7,7 @@

const myPkgVersion = await PackageVersion.create(options, pollingOptions);

Promote a package version:

new PackageVersion({connection, project, idOrAlias}).promote();

-

Constructors

constructor +

Constructors

constructor

Methods

delete getData getId @@ -25,49 +25,49 @@ pollCreateStatus queryPackage2Version waitForCreateVersion -

Constructors

constructor

Methods

delete

getData

  • getData(force?): Promise<Package2Version>

  • Get the Package2Version SObject data for this PackageVersion.

    +

Constructors

constructor

Methods

delete

getData

getId

getId

  • getId(): Promise<undefined | string>

  • Get the package version ID for this PackageVersion.

    Returns Promise<undefined | string>

    The PackageVersionId (05i).

    -

getPackageId

getPackageId

  • getPackageId(): Promise<undefined | string>

  • Get the package Id for this PackageVersion.

    Returns Promise<undefined | string>

    The PackageId (0Ho).

    -

getPackageType

getPackageType

getSubscriberId

  • getSubscriberId(): Promise<undefined | string>

  • Get the subscriber package version ID for this PackageVersion.

    +

getSubscriberId

  • getSubscriberId(): Promise<undefined | string>

  • Get the subscriber package version ID for this PackageVersion.

    Returns Promise<undefined | string>

    The SubscriberPackageVersionId (04t).

    -

promote

  • promote(): Promise<SaveResult>

  • Promotes this PackageVersion to released state.

    -

    Returns Promise<SaveResult>

report

promote

  • promote(): Promise<SaveResult>

  • Promotes this PackageVersion to released state.

    +

    Returns Promise<SaveResult>

report

undelete

update

Staticcreate

Returns Promise<PackageVersionReportResult>

undelete

update

Staticcreate

StaticgetCreateStatus

StaticgetCreateVersionReport

StaticgetPackageVersionCreateRequests

StaticgetCreateStatus

StaticgetCreateVersionReport

StaticgetPackageVersionCreateRequests

StaticpollCreateStatus

StaticpollCreateStatus

  • pollCreateStatus(createPackageVersionRequestId, connection, project, polling): Promise<PackageVersionCreateRequestResult>

  • Convenience function that will wait for a package version to be created.

    This function emits LifeCycle events, "enqueued", "in-progress", "success", "error" and "timed-out" to progress and current status. Events also carry a payload of type PackageVersionCreateRequestResult.

    Parameters

    • createPackageVersionRequestId: string
    • connection: Connection<Schema>

      Connection to the org

    • project: SfProject

      SfProject to read/write aliases from

    • polling: {
          frequency: Duration;
          timeout: Duration;
      }

      frequency and timeout Durations to be used in polling

      -
      • frequency: Duration
      • timeout: Duration

    Returns Promise<PackageVersionCreateRequestResult>

StaticqueryPackage2Version

  • queryPackage2Version(connection, options?): Promise<(undefined | Package2Version)[]>

  • Query the Package2Version SObject and return data with the provided type.

    +
    • frequency: Duration
    • timeout: Duration

Returns Promise<PackageVersionCreateRequestResult>

StaticqueryPackage2Version

  • queryPackage2Version(connection, options?): Promise<(undefined | Package2Version)[]>

  • Query the Package2Version SObject and return data with the provided type.

    NOTE: There is a limit of 2000 records that can be returned, otherwise a GACK might be thrown. If more than 2000 records are desired you should filter the query by date and aggregate all results.

    Parameters

    Returns Promise<(undefined | Package2Version)[]>

    Results from querying the Package2Version SObject.

    -

StaticwaitForCreateVersion

StaticwaitForCreateVersion

  • waitForCreateVersion(createPackageVersionRequestId, project, connection, polling): Promise<PackageVersionCreateRequestResult>

  • Convenience function that will wait for a package version to be created.

    This function emits LifeCycle events, "enqueued", "in-progress", "success", "error" and "timed-out" to progress and current status. Events also carry a payload of type PackageVersionCreateRequestResult.

    Parameters

    • createPackageVersionRequestId: string
    • project: SfProject
    • connection: Connection<Schema>
    • polling: {
          frequency: Duration;
          timeout: Duration;
      }

      frequency and timeout Durations to be used in polling

      -
      • frequency: Duration
      • timeout: Duration

    Returns Promise<PackageVersionCreateRequestResult>

Settings

Member Visibility

On This Page

Constructors
Methods
+

Returns Promise<PackageVersionCreateRequestResult>

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/classes/package_packageVersionCreate.MetadataResolver.html b/classes/package_packageVersionCreate.MetadataResolver.html index 8dddf2bb5..2d7c7724b 100644 --- a/classes/package_packageVersionCreate.MetadataResolver.html +++ b/classes/package_packageVersionCreate.MetadataResolver.html @@ -1,4 +1,4 @@ -MetadataResolver | @salesforce/packaging

Class MetadataResolver

Constructors

constructor +MetadataResolver | @salesforce/packaging

Class MetadataResolver

Constructors

constructor

Methods

generateMDFolderForArtifact resolveMetadata -

Constructors

constructor

Methods

generateMDFolderForArtifact

resolveMetadata

  • resolveMetadata(metadataRelativePath, metadataOutputPath, errorMessageLabel, sourceApiVersion?): Promise<boolean>

  • Parameters

    • metadataRelativePath: undefined | string
    • metadataOutputPath: string
    • errorMessageLabel: string
    • OptionalsourceApiVersion: string

    Returns Promise<boolean>

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

generateMDFolderForArtifact

resolveMetadata

  • resolveMetadata(metadataRelativePath, metadataOutputPath, errorMessageLabel, sourceApiVersion?): Promise<boolean>

  • Parameters

    • metadataRelativePath: undefined | string
    • metadataOutputPath: string
    • errorMessageLabel: string
    • OptionalsourceApiVersion: string

    Returns Promise<boolean>

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/classes/package_packageVersionCreate.PackageVersionCreate.html b/classes/package_packageVersionCreate.PackageVersionCreate.html index 3d99245d7..1871b5062 100644 --- a/classes/package_packageVersionCreate.PackageVersionCreate.html +++ b/classes/package_packageVersionCreate.PackageVersionCreate.html @@ -1,9 +1,9 @@ -PackageVersionCreate | @salesforce/packaging

Class PackageVersionCreate

Constructors

constructor +PackageVersionCreate | @salesforce/packaging

Class PackageVersionCreate

Constructors

constructor

Methods

createPackageVersion retrieveSubscriberPackageVersionId -

Constructors

constructor

Methods

createPackageVersion

retrieveSubscriberPackageVersionId

  • retrieveSubscriberPackageVersionId(dependency): Promise<string>

  • A dependency in the project config file may be specified using either a subscriber package version id (04t) +

Constructors

constructor

Methods

createPackageVersion

retrieveSubscriberPackageVersionId

  • retrieveSubscriberPackageVersionId(dependency): Promise<string>

  • A dependency in the project config file may be specified using either a subscriber package version id (04t) or a package Id (0Ho) + a version number. Additionally, a build number may be the actual build number, or a keyword: LATEST or RELEASED (meaning the latest or released build number for a given major.minor.patch).

    This method resolves a package Id + version number to a subscriber package version id (04t) and adds it as a SubscriberPackageVersionId parameter in the dependency object.

    -

    Parameters

    Returns Promise<string>

Settings

Member Visibility

On This Page

Constructors
Methods
+

Parameters

Returns Promise<string>

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/classes/package_subscriberPackageVersion.SubscriberPackageVersion.html b/classes/package_subscriberPackageVersion.SubscriberPackageVersion.html index 2491fc2b4..2d0ffb9e5 100644 --- a/classes/package_subscriberPackageVersion.SubscriberPackageVersion.html +++ b/classes/package_subscriberPackageVersion.SubscriberPackageVersion.html @@ -5,7 +5,7 @@

const installedPkgs = await SubscriberPackageVersion.installedList(connection);

Install a 2GP subscriber package version:

const installStatus = await new SubscriberPackageVersion(options).install(request, options);

-

Constructors

constructor +

Constructors

constructor

Methods

getCspTrustedSites getData getDependencies @@ -30,30 +30,30 @@ installedList resolveId uninstallStatus -

Constructors

constructor

Methods

getCspTrustedSites

Constructors

constructor

Methods

getCspTrustedSites

getData

getData

getDependencies

getDependencies

getExternalSites

getExternalSites

  • getExternalSites(): Promise<Optional<string[]>>

  • Returns an array of RSS and CSP external sites for the package.

    Returns Promise<Optional<string[]>>

    an array of RSS and CSP site URLs, or undefined if the package doesn't have any.

    -

getField

  • getField<T>(field): Promise<T>

  • Return a field value from the SubscriberPackageVersion SObject using the field name.

    -

    Type Parameters

    • T

    Parameters

    • field: string

    Returns Promise<T>

getId

getField

  • getField<T>(field): Promise<T>

  • Return a field value from the SubscriberPackageVersion SObject using the field name.

    +

    Type Parameters

    • T

    Parameters

    • field: string

    Returns Promise<T>

getId

  • getId(): Promise<string>

  • Get the package version ID for this SubscriberPackageVersion.

    Returns Promise<string>

    The SubscriberPackageVersion Id (04t).

    -

getInstallValidationStatus

getInstallValidationStatus

getPackageType

getPackageType

getPassword

getPassword

getRemoteSiteSettings

getRemoteSiteSettings

getSubscriberPackageId

getSubscriberPackageId

  • getSubscriberPackageId(): Promise<string>

  • Get the subscriber package Id (033) for this SubscriberPackageVersion.

    Returns Promise<string>

    The subscriber package Id (033).

    -

getVersionNumber

getVersionNumber

install

install

isDeprecated

isDeprecated

  • isDeprecated(): Promise<boolean>

  • Is the SubscriberPackageVersion deprecated?

    Returns Promise<boolean>

    True if the SubscriberPackageVersion is deprecated.

    -

isManaged

isOrgDependent

isManaged

isOrgDependent

  • isOrgDependent(): Promise<boolean>

  • Is the SubscriberPackageVersion org dependent?

    Returns Promise<boolean>

    True if the SubscriberPackageVersion is org dependent.

    -

isPasswordProtected

isPasswordProtected

  • isPasswordProtected(): Promise<boolean>

  • Is the SubscriberPackageVersion password protected?

    Returns Promise<boolean>

    True if the SubscriberPackageVersion is password protected.

    -

uninstall

waitForPublish

  • waitForPublish(options?): Promise<void>

  • Wait for the subscriber package version to be replicated across instances and available to be queried against

    +

uninstall

waitForPublish

  • waitForPublish(options?): Promise<void>

  • Wait for the subscriber package version to be replicated across instances and available to be queried against

    Parameters

    • options: {
          installationKey?: string;
          publishFrequency: Duration;
          publishTimeout: Duration;
      } = ...
      • OptionalinstallationKey?: string

        the installation key for the package version

      • publishFrequency: Duration

        how often to check for the package version to be published

      • publishTimeout: Duration

        how long to wait for the package version to be published

        -

    Returns Promise<void>

StaticgetInstallRequest

StaticinstallStatus

  • installStatus(connection, packageInstallRequestOrId, installationKey?, options?): Promise<PackageInstallRequest>

  • Fetches the status of a package version install request and will wait for the install to complete, if requested +

Returns Promise<void>

StaticgetInstallRequest

StaticinstallStatus

StaticinstalledList

StaticresolveId

StaticinstalledList

StaticresolveId

  • resolveId(connection, pkgDescriptor): Promise<string>

  • Resolve fields from a packageDirectories entry to a SubscriberPackageVersionId (04t). Specifically uses the versionNumber and packageId fields, as well as an optional branch field.

    Parameters

    • connection: Connection<Schema>

      A connection object to the org

      @@ -88,6 +88,6 @@ The versionNumber and packageId fields are required. Optionally, the branch and package fields can be passed.

    Returns Promise<string>

    the SubscriberPackageVersionId (04t)

    -

StaticuninstallStatus

StaticuninstallStatus

Settings

Member Visibility

On This Page

Constructors
Methods
+
  • connection: Connection<Schema>

    • Returns Promise<SubscriberPackageVersionUninstallRequest>

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    diff --git a/classes/package_versionNumber.VersionNumber.html b/classes/package_versionNumber.VersionNumber.html index 325cb6200..27b6aac5e 100644 --- a/classes/package_versionNumber.VersionNumber.html +++ b/classes/package_versionNumber.VersionNumber.html @@ -1,4 +1,4 @@ -VersionNumber | @salesforce/packaging

    Class VersionNumber

    Constructors

    constructor +VersionNumber | @salesforce/packaging

    Class VersionNumber

    Constructors

    constructor

    Properties

    build major minor @@ -9,6 +9,6 @@ from isABuildKeyword parseMajorMinor -

    Constructors

    constructor

    Properties

    build

    build: string | number

    major

    major: string | number

    minor

    minor: string | number

    patch

    patch: string | number

    Methods

    compareTo

    isBuildKeyword

    toString

    Staticfrom

    StaticisABuildKeyword

    StaticparseMajorMinor

    • parseMajorMinor(versionString): {
          major: null | number;
          minor: null | number;
      }

    • Separates at major.minor string into {major: Number, minor: Number} object

      +

    Constructors

    constructor

    Properties

    build

    build: string | number

    major

    major: string | number

    minor

    minor: string | number

    patch

    patch: string | number

    Methods

    compareTo

    isBuildKeyword

    toString

    Staticfrom

    StaticisABuildKeyword

    StaticparseMajorMinor

    • parseMajorMinor(versionString): {
          major: null | number;
          minor: null | number;
      }

    • Separates at major.minor string into {major: Number, minor: Number} object

      Parameters

      • versionString: string

        a string in the format of major.minor like '3.2'

        -

      Returns {
          major: null | number;
          minor: null | number;
      }

      • major: null | number
      • minor: null | number

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Returns {
        major: null | number;
        minor: null | number;
    }

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/enums/interfaces_packagingSObjects.PackagingSObjects.Package2VersionStatus.html b/enums/interfaces_packagingSObjects.PackagingSObjects.Package2VersionStatus.html index 0e6f8594e..57c55b846 100644 --- a/enums/interfaces_packagingSObjects.PackagingSObjects.Package2VersionStatus.html +++ b/enums/interfaces_packagingSObjects.PackagingSObjects.Package2VersionStatus.html @@ -1,4 +1,4 @@ -Package2VersionStatus | @salesforce/packaging

    Enumeration Package2VersionStatus

    Enumeration Members

    error +Package2VersionStatus | @salesforce/packaging

    Enumeration Package2VersionStatus

    Enumeration Members

    error finalizingPackageVersion inProgress initializing @@ -8,4 +8,4 @@ verifyingDependencies verifyingFeaturesAndSettings verifyingMetadata -

    Enumeration Members

    error

    error: "Error"

    finalizingPackageVersion

    finalizingPackageVersion: "FinalizingPackageVersion"

    inProgress

    inProgress: "InProgress"

    initializing

    initializing: "Initializing"

    performingValidations

    performingValidations: "PerformingValidations"

    queued

    queued: "Queued"

    success

    success: "Success"

    verifyingDependencies

    verifyingDependencies: "VerifyingDependencies"

    verifyingFeaturesAndSettings

    verifyingFeaturesAndSettings: "VerifyingFeaturesAndSettings"

    verifyingMetadata

    verifyingMetadata: "VerifyingMetadata"

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    +

    Enumeration Members

    error

    error: "Error"

    finalizingPackageVersion

    finalizingPackageVersion: "FinalizingPackageVersion"

    inProgress

    inProgress: "InProgress"

    initializing

    initializing: "Initializing"

    performingValidations

    performingValidations: "PerformingValidations"

    queued

    queued: "Queued"

    success

    success: "Success"

    verifyingDependencies

    verifyingDependencies: "VerifyingDependencies"

    verifyingFeaturesAndSettings

    verifyingFeaturesAndSettings: "VerifyingFeaturesAndSettings"

    verifyingMetadata

    verifyingMetadata: "VerifyingMetadata"

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    diff --git a/enums/package_versionNumber.BuildNumberToken.html b/enums/package_versionNumber.BuildNumberToken.html index dfeb87a13..a1656b8ee 100644 --- a/enums/package_versionNumber.BuildNumberToken.html +++ b/enums/package_versionNumber.BuildNumberToken.html @@ -1,6 +1,6 @@ -BuildNumberToken | @salesforce/packaging

    Enumeration BuildNumberToken

    Enumeration Members

    HIGHEST_VERSION_NUMBER_TOKEN +BuildNumberToken | @salesforce/packaging

    Enumeration BuildNumberToken

    Enumeration Members

    HIGHEST_VERSION_NUMBER_TOKEN LATEST_BUILD_NUMBER_TOKEN NEXT_BUILD_NUMBER_TOKEN NONE_VERSION_NUMBER_TOKEN RELEASED_BUILD_NUMBER_TOKEN -

    Enumeration Members

    HIGHEST_VERSION_NUMBER_TOKEN

    HIGHEST_VERSION_NUMBER_TOKEN: "HIGHEST"

    LATEST_BUILD_NUMBER_TOKEN

    LATEST_BUILD_NUMBER_TOKEN: "LATEST"

    NEXT_BUILD_NUMBER_TOKEN

    NEXT_BUILD_NUMBER_TOKEN: "NEXT"

    NONE_VERSION_NUMBER_TOKEN

    NONE_VERSION_NUMBER_TOKEN: "NONE"

    RELEASED_BUILD_NUMBER_TOKEN

    RELEASED_BUILD_NUMBER_TOKEN: "RELEASED"

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    +

    Enumeration Members

    HIGHEST_VERSION_NUMBER_TOKEN

    HIGHEST_VERSION_NUMBER_TOKEN: "HIGHEST"

    LATEST_BUILD_NUMBER_TOKEN

    LATEST_BUILD_NUMBER_TOKEN: "LATEST"

    NEXT_BUILD_NUMBER_TOKEN

    NEXT_BUILD_NUMBER_TOKEN: "NEXT"

    NONE_VERSION_NUMBER_TOKEN

    NONE_VERSION_NUMBER_TOKEN: "NONE"

    RELEASED_BUILD_NUMBER_TOKEN

    RELEASED_BUILD_NUMBER_TOKEN: "RELEASED"

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    diff --git a/functions/package_packageConvert.convertPackage.html b/functions/package_packageConvert.convertPackage.html index ac13470e2..531f9c1e6 100644 --- a/functions/package_packageConvert.convertPackage.html +++ b/functions/package_packageConvert.convertPackage.html @@ -1 +1 @@ -convertPackage | @salesforce/packaging

    Function convertPackage

    Settings

    Member Visibility
    +convertPackage | @salesforce/packaging

    Function convertPackage

    Settings

    Member Visibility
    diff --git a/functions/package_packageConvert.findOrCreatePackage2.html b/functions/package_packageConvert.findOrCreatePackage2.html index 203f58910..7bf88514f 100644 --- a/functions/package_packageConvert.findOrCreatePackage2.html +++ b/functions/package_packageConvert.findOrCreatePackage2.html @@ -1 +1 @@ -findOrCreatePackage2 | @salesforce/packaging

    Function findOrCreatePackage2

    • findOrCreatePackage2(seedPackage, connection, project?): Promise<string>

    • Parameters

      • seedPackage: string
      • connection: Connection<Schema>
      • Optionalproject: SfProject

      Returns Promise<string>

    Settings

    Member Visibility
    +findOrCreatePackage2 | @salesforce/packaging

    Function findOrCreatePackage2

    • findOrCreatePackage2(seedPackage, connection, project?): Promise<string>

    • Parameters

      • seedPackage: string
      • connection: Connection<Schema>
      • Optionalproject: SfProject

      Returns Promise<string>

    Settings

    Member Visibility
    diff --git a/functions/package_packageCreate.createPackage.html b/functions/package_packageCreate.createPackage.html index 231785c8b..e8feb89a3 100644 --- a/functions/package_packageCreate.createPackage.html +++ b/functions/package_packageCreate.createPackage.html @@ -1 +1 @@ -createPackage | @salesforce/packaging

    Function createPackage

    • createPackage(connection, project, options): Promise<{
          Id: string;
      }>

    • Parameters

      Returns Promise<{
          Id: string;
      }>

    Settings

    Member Visibility
    +createPackage | @salesforce/packaging

    Function createPackage

    • createPackage(connection, project, options): Promise<{
          Id: string;
      }>

    • Parameters

      Returns Promise<{
          Id: string;
      }>

    Settings

    Member Visibility
    diff --git a/functions/package_packageCreate.createPackageRequestFromContext.html b/functions/package_packageCreate.createPackageRequestFromContext.html index e11ed7c4d..132e1a2f1 100644 --- a/functions/package_packageCreate.createPackageRequestFromContext.html +++ b/functions/package_packageCreate.createPackageRequestFromContext.html @@ -1 +1 @@ -createPackageRequestFromContext | @salesforce/packaging

    Function createPackageRequestFromContext

    Settings

    Member Visibility
    +createPackageRequestFromContext | @salesforce/packaging

    Function createPackageRequestFromContext

    Settings

    Member Visibility
    diff --git a/functions/package_packageDelete.deletePackage.html b/functions/package_packageDelete.deletePackage.html index 15431312b..af21d5a31 100644 --- a/functions/package_packageDelete.deletePackage.html +++ b/functions/package_packageDelete.deletePackage.html @@ -1 +1 @@ -deletePackage | @salesforce/packaging

    Function deletePackage

    Settings

    Member Visibility
    +deletePackage | @salesforce/packaging

    Function deletePackage

    Settings

    Member Visibility
    diff --git a/functions/package_packageInstall.createPackageInstallRequest.html b/functions/package_packageInstall.createPackageInstallRequest.html index ca31d5d2d..55e80ee2e 100644 --- a/functions/package_packageInstall.createPackageInstallRequest.html +++ b/functions/package_packageInstall.createPackageInstallRequest.html @@ -1 +1 @@ -createPackageInstallRequest | @salesforce/packaging

    Function createPackageInstallRequest

    Settings

    Member Visibility
    +createPackageInstallRequest | @salesforce/packaging

    Function createPackageInstallRequest

    Settings

    Member Visibility
    diff --git a/functions/package_packageInstall.getInstallationStatus.html b/functions/package_packageInstall.getInstallationStatus.html index 9bbccafae..40ca9e35e 100644 --- a/functions/package_packageInstall.getInstallationStatus.html +++ b/functions/package_packageInstall.getInstallationStatus.html @@ -1 +1 @@ -getInstallationStatus | @salesforce/packaging

    Function getInstallationStatus

    Settings

    Member Visibility
    +getInstallationStatus | @salesforce/packaging

    Function getInstallationStatus

    Settings

    Member Visibility
    diff --git a/functions/package_packageInstall.getStatus.html b/functions/package_packageInstall.getStatus.html index f718539a9..b652f6628 100644 --- a/functions/package_packageInstall.getStatus.html +++ b/functions/package_packageInstall.getStatus.html @@ -1 +1 @@ -getStatus | @salesforce/packaging

    Function getStatus

    Settings

    Member Visibility
    +getStatus | @salesforce/packaging

    Function getStatus

    Settings

    Member Visibility
    diff --git a/functions/package_packageInstall.isErrorFromSPVQueryRestriction.html b/functions/package_packageInstall.isErrorFromSPVQueryRestriction.html index d3ff2e846..dbf47fbbd 100644 --- a/functions/package_packageInstall.isErrorFromSPVQueryRestriction.html +++ b/functions/package_packageInstall.isErrorFromSPVQueryRestriction.html @@ -1 +1 @@ -isErrorFromSPVQueryRestriction | @salesforce/packaging

    Function isErrorFromSPVQueryRestriction

    Settings

    Member Visibility
    +isErrorFromSPVQueryRestriction | @salesforce/packaging

    Function isErrorFromSPVQueryRestriction

    Settings

    Member Visibility
    diff --git a/functions/package_packageInstall.isErrorPackageNotAvailable.html b/functions/package_packageInstall.isErrorPackageNotAvailable.html index ec95c58e0..a5d0906f7 100644 --- a/functions/package_packageInstall.isErrorPackageNotAvailable.html +++ b/functions/package_packageInstall.isErrorPackageNotAvailable.html @@ -1 +1 @@ -isErrorPackageNotAvailable | @salesforce/packaging

    Function isErrorPackageNotAvailable

    Settings

    Member Visibility
    +isErrorPackageNotAvailable | @salesforce/packaging

    Function isErrorPackageNotAvailable

    Settings

    Member Visibility
    diff --git a/functions/package_packageInstall.pollStatus.html b/functions/package_packageInstall.pollStatus.html index 0ed0ade52..a13800bbf 100644 --- a/functions/package_packageInstall.pollStatus.html +++ b/functions/package_packageInstall.pollStatus.html @@ -1 +1 @@ -pollStatus | @salesforce/packaging

    Function pollStatus

    Settings

    Member Visibility
    +pollStatus | @salesforce/packaging

    Function pollStatus

    Settings

    Member Visibility
    diff --git a/functions/package_packageInstall.waitForPublish.html b/functions/package_packageInstall.waitForPublish.html index d1e7d6125..5fd8caf7b 100644 --- a/functions/package_packageInstall.waitForPublish.html +++ b/functions/package_packageInstall.waitForPublish.html @@ -1 +1 @@ -waitForPublish | @salesforce/packaging

    Function waitForPublish

    • waitForPublish(connection, subscriberPackageVersionId, frequency?, timeout?, installationKey?): Promise<void>

    • Parameters

      • connection: Connection<Schema>
      • subscriberPackageVersionId: string
      • Optionalfrequency: number | Duration
      • Optionaltimeout: number | Duration
      • OptionalinstallationKey: Nullable<string>

      Returns Promise<void>

    Settings

    Member Visibility
    +waitForPublish | @salesforce/packaging

    Function waitForPublish

    • waitForPublish(connection, subscriberPackageVersionId, frequency?, timeout?, installationKey?): Promise<void>

    • Parameters

      • connection: Connection<Schema>
      • subscriberPackageVersionId: string
      • Optionalfrequency: number | Duration
      • Optionaltimeout: number | Duration
      • OptionalinstallationKey: Nullable<string>

      Returns Promise<void>

    Settings

    Member Visibility
    diff --git a/functions/package_packageUninstall.getUninstallErrors.html b/functions/package_packageUninstall.getUninstallErrors.html index 54dd1c454..2ef17d809 100644 --- a/functions/package_packageUninstall.getUninstallErrors.html +++ b/functions/package_packageUninstall.getUninstallErrors.html @@ -1 +1 @@ -getUninstallErrors | @salesforce/packaging

    Function getUninstallErrors

    • getUninstallErrors(conn, id): Promise<{
          Message: string;
      }[]>

    • Parameters

      • conn: Connection<Schema>
      • id: string

      Returns Promise<{
          Message: string;
      }[]>

    Settings

    Member Visibility
    +getUninstallErrors | @salesforce/packaging

    Function getUninstallErrors

    • getUninstallErrors(conn, id): Promise<{
          Message: string;
      }[]>

    • Parameters

      • conn: Connection<Schema>
      • id: string

      Returns Promise<{
          Message: string;
      }[]>

    Settings

    Member Visibility
    diff --git a/functions/package_packageUninstall.pollUninstall.html b/functions/package_packageUninstall.pollUninstall.html index e60f0a88b..e23e0f506 100644 --- a/functions/package_packageUninstall.pollUninstall.html +++ b/functions/package_packageUninstall.pollUninstall.html @@ -1 +1 @@ -pollUninstall | @salesforce/packaging

    Function pollUninstall

    • pollUninstall(uninstallRequestId, conn, frequency, wait): Promise<UninstallResult>

    • Parameters

      • uninstallRequestId: string
      • conn: Connection<Schema>
      • frequency: Duration
      • wait: Duration

      Returns Promise<UninstallResult>

    Settings

    Member Visibility
    +pollUninstall | @salesforce/packaging

    Function pollUninstall

    • pollUninstall(uninstallRequestId, conn, frequency, wait): Promise<UninstallResult>

    • Parameters

      • uninstallRequestId: string
      • conn: Connection<Schema>
      • frequency: Duration
      • wait: Duration

      Returns Promise<UninstallResult>

    Settings

    Member Visibility
    diff --git a/functions/package_packageUninstall.uninstallPackage.html b/functions/package_packageUninstall.uninstallPackage.html index 122a63d26..ab0f0e711 100644 --- a/functions/package_packageUninstall.uninstallPackage.html +++ b/functions/package_packageUninstall.uninstallPackage.html @@ -1 +1 @@ -uninstallPackage | @salesforce/packaging

    Function uninstallPackage

    • uninstallPackage(id, conn, frequency?, wait?): Promise<UninstallResult>

    • Parameters

      • id: string
      • conn: Connection<Schema>
      • frequency: Duration = ...
      • wait: Duration = ...

      Returns Promise<UninstallResult>

    Settings

    Member Visibility
    +uninstallPackage | @salesforce/packaging

    Function uninstallPackage

    • uninstallPackage(id, conn, frequency?, wait?): Promise<UninstallResult>

    • Parameters

      • id: string
      • conn: Connection<Schema>
      • frequency: Duration = ...
      • wait: Duration = ...

      Returns Promise<UninstallResult>

    Settings

    Member Visibility
    diff --git a/functions/package_packageVersionCreate.packageXmlJsonToXmlString.html b/functions/package_packageVersionCreate.packageXmlJsonToXmlString.html index f232387b4..c7d75a35b 100644 --- a/functions/package_packageVersionCreate.packageXmlJsonToXmlString.html +++ b/functions/package_packageVersionCreate.packageXmlJsonToXmlString.html @@ -1,2 +1,2 @@ packageXmlJsonToXmlString | @salesforce/packaging

    Function packageXmlJsonToXmlString

    Converts PackageXmlJson to a string representing the Xml

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/package_packageVersionCreate.packageXmlStringToPackageXmlJson.html b/functions/package_packageVersionCreate.packageXmlStringToPackageXmlJson.html index 1f5ab72ce..ac053b952 100644 --- a/functions/package_packageVersionCreate.packageXmlStringToPackageXmlJson.html +++ b/functions/package_packageVersionCreate.packageXmlStringToPackageXmlJson.html @@ -1 +1 @@ -packageXmlStringToPackageXmlJson | @salesforce/packaging

    Function packageXmlStringToPackageXmlJson

    Settings

    Member Visibility
    +packageXmlStringToPackageXmlJson | @salesforce/packaging

    Function packageXmlStringToPackageXmlJson

    Settings

    Member Visibility
    diff --git a/functions/package_packageVersionCreate.validateAncestorId.html b/functions/package_packageVersionCreate.validateAncestorId.html index 63aa9ab91..7d6b94a70 100644 --- a/functions/package_packageVersionCreate.validateAncestorId.html +++ b/functions/package_packageVersionCreate.validateAncestorId.html @@ -1 +1 @@ -validateAncestorId | @salesforce/packaging

    Function validateAncestorId

    • validateAncestorId(ancestorId, highestReleasedVersion, explicitUseNoAncestor, isPatch, skipAncestorCheck, origSpecifiedAncestor): string

    • Parameters

      • ancestorId: string
      • highestReleasedVersion: undefined | null | Package2Version
      • explicitUseNoAncestor: boolean
      • isPatch: boolean
      • skipAncestorCheck: boolean
      • origSpecifiedAncestor: string

      Returns string

    Settings

    Member Visibility
    +validateAncestorId | @salesforce/packaging

    Function validateAncestorId

    • validateAncestorId(ancestorId, highestReleasedVersion, explicitUseNoAncestor, isPatch, skipAncestorCheck, origSpecifiedAncestor): string

    • Parameters

      • ancestorId: string
      • highestReleasedVersion: undefined | null | Package2Version
      • explicitUseNoAncestor: boolean
      • isPatch: boolean
      • skipAncestorCheck: boolean
      • origSpecifiedAncestor: string

      Returns string

    Settings

    Member Visibility
    diff --git a/functions/package_packageVersionCreate.validateVersionNumber.html b/functions/package_packageVersionCreate.validateVersionNumber.html index 53edd49df..a5c68bb97 100644 --- a/functions/package_packageVersionCreate.validateVersionNumber.html +++ b/functions/package_packageVersionCreate.validateVersionNumber.html @@ -1 +1 @@ -validateVersionNumber | @salesforce/packaging

    Function validateVersionNumber

    • validateVersionNumber(versionNumberString, supportedBuildNumberToken, supportedBuildNumberToken2?): string

    • Parameters

      • versionNumberString: string
      • supportedBuildNumberToken: string
      • OptionalsupportedBuildNumberToken2: string

      Returns string

    Settings

    Member Visibility
    +validateVersionNumber | @salesforce/packaging

    Function validateVersionNumber

    • validateVersionNumber(versionNumberString, supportedBuildNumberToken, supportedBuildNumberToken2?): string

    • Parameters

      • versionNumberString: string
      • supportedBuildNumberToken: string
      • OptionalsupportedBuildNumberToken2: string

      Returns string

    Settings

    Member Visibility
    diff --git a/functions/package_packageVersionCreateRequest.byId.html b/functions/package_packageVersionCreateRequest.byId.html index 519eefe68..61a9bff78 100644 --- a/functions/package_packageVersionCreateRequest.byId.html +++ b/functions/package_packageVersionCreateRequest.byId.html @@ -1 +1 @@ -byId | @salesforce/packaging

    Function byId

    Settings

    Member Visibility
    +byId | @salesforce/packaging

    Function byId

    Settings

    Member Visibility
    diff --git a/functions/package_packageVersionCreateRequest.getQuery.html b/functions/package_packageVersionCreateRequest.getQuery.html index 3607b24d8..932f711c1 100644 --- a/functions/package_packageVersionCreateRequest.getQuery.html +++ b/functions/package_packageVersionCreateRequest.getQuery.html @@ -1 +1 @@ -getQuery | @salesforce/packaging

    Function getQuery

    Settings

    Member Visibility
    +getQuery | @salesforce/packaging

    Function getQuery

    Settings

    Member Visibility
    diff --git a/functions/package_packageVersionCreateRequest.list.html b/functions/package_packageVersionCreateRequest.list.html index 42b89a3ff..09e95be54 100644 --- a/functions/package_packageVersionCreateRequest.list.html +++ b/functions/package_packageVersionCreateRequest.list.html @@ -1 +1 @@ -list | @salesforce/packaging

    Function list

    Settings

    Member Visibility
    +list | @salesforce/packaging

    Function list

    Settings

    Member Visibility
    diff --git a/functions/package_packageVersionCreateRequestReport.getCreatePackageVersionCreateRequestReport.html b/functions/package_packageVersionCreateRequestReport.getCreatePackageVersionCreateRequestReport.html index 0dc9944cc..d893d4ff1 100644 --- a/functions/package_packageVersionCreateRequestReport.getCreatePackageVersionCreateRequestReport.html +++ b/functions/package_packageVersionCreateRequestReport.getCreatePackageVersionCreateRequestReport.html @@ -1 +1 @@ -getCreatePackageVersionCreateRequestReport | @salesforce/packaging

    Function getCreatePackageVersionCreateRequestReport

    Settings

    Member Visibility
    +getCreatePackageVersionCreateRequestReport | @salesforce/packaging

    Function getCreatePackageVersionCreateRequestReport

    Settings

    Member Visibility
    diff --git a/functions/package_packageVersionList.assembleQueryParts.html b/functions/package_packageVersionList.assembleQueryParts.html index 6904e9223..b9b426977 100644 --- a/functions/package_packageVersionList.assembleQueryParts.html +++ b/functions/package_packageVersionList.assembleQueryParts.html @@ -1 +1 @@ -assembleQueryParts | @salesforce/packaging

    Function assembleQueryParts

    • assembleQueryParts(select, where, orderBy?): string

    • Parameters

      • select: string
      • where: string[]
      • OptionalorderBy: string

      Returns string

    Settings

    Member Visibility
    +assembleQueryParts | @salesforce/packaging

    Function assembleQueryParts

    • assembleQueryParts(select, where, orderBy?): string

    • Parameters

      • select: string
      • where: string[]
      • OptionalorderBy: string

      Returns string

    Settings

    Member Visibility
    diff --git a/functions/package_packageVersionList.constructQuery.html b/functions/package_packageVersionList.constructQuery.html index 3a9c7d1ee..8fe3590f7 100644 --- a/functions/package_packageVersionList.constructQuery.html +++ b/functions/package_packageVersionList.constructQuery.html @@ -1 +1 @@ -constructQuery | @salesforce/packaging

    Function constructQuery

    Settings

    Member Visibility
    +constructQuery | @salesforce/packaging

    Function constructQuery

    Settings

    Member Visibility
    diff --git a/functions/package_packageVersionList.constructWhere.html b/functions/package_packageVersionList.constructWhere.html index 131a4d89a..8e7b0969b 100644 --- a/functions/package_packageVersionList.constructWhere.html +++ b/functions/package_packageVersionList.constructWhere.html @@ -1 +1 @@ -constructWhere | @salesforce/packaging

    Function constructWhere

    Settings

    Member Visibility
    +constructWhere | @salesforce/packaging

    Function constructWhere

    Settings

    Member Visibility
    diff --git a/functions/package_packageVersionList.listPackageVersions.html b/functions/package_packageVersionList.listPackageVersions.html index a56753131..0b9022ecc 100644 --- a/functions/package_packageVersionList.listPackageVersions.html +++ b/functions/package_packageVersionList.listPackageVersions.html @@ -1,4 +1,4 @@ listPackageVersions | @salesforce/packaging

    Function listPackageVersions

    Settings

    Member Visibility
    +

    Returns Promise<QueryResult<PackageVersionListResult>>

    Settings

    Member Visibility
    diff --git a/functions/package_packageVersionList.validateDays.html b/functions/package_packageVersionList.validateDays.html index fdfca878b..231573335 100644 --- a/functions/package_packageVersionList.validateDays.html +++ b/functions/package_packageVersionList.validateDays.html @@ -1 +1 @@ -validateDays | @salesforce/packaging

    Function validateDays

    Settings

    Member Visibility
    +validateDays | @salesforce/packaging

    Function validateDays

    Settings

    Member Visibility
    diff --git a/functions/package_packageVersionReport.getPackageVersionReport.html b/functions/package_packageVersionReport.getPackageVersionReport.html index 1b7bda425..a1744c645 100644 --- a/functions/package_packageVersionReport.getPackageVersionReport.html +++ b/functions/package_packageVersionReport.getPackageVersionReport.html @@ -1 +1 @@ -getPackageVersionReport | @salesforce/packaging

    Function getPackageVersionReport

    Settings

    Member Visibility
    +getPackageVersionReport | @salesforce/packaging

    Function getPackageVersionReport

    Settings

    Member Visibility
    diff --git a/functions/package_packageVersionRetrieve.retrievePackageVersionMetadata.html b/functions/package_packageVersionRetrieve.retrievePackageVersionMetadata.html index 9f599cd80..c133c8a55 100644 --- a/functions/package_packageVersionRetrieve.retrievePackageVersionMetadata.html +++ b/functions/package_packageVersionRetrieve.retrievePackageVersionMetadata.html @@ -1,3 +1,3 @@ retrievePackageVersionMetadata | @salesforce/packaging

    Function retrievePackageVersionMetadata

    Settings

    Member Visibility
    +
  • connection: Connection<Schema>

    • Returns Promise<PackageVersionMetadataDownloadResult>

    Settings

    Member Visibility
    diff --git a/functions/package_profileRewriter.fieldCorrections.html b/functions/package_profileRewriter.fieldCorrections.html index 8e7e81759..aef52a4a5 100644 --- a/functions/package_profileRewriter.fieldCorrections.html +++ b/functions/package_profileRewriter.fieldCorrections.html @@ -1 +1 @@ -fieldCorrections | @salesforce/packaging

    Function fieldCorrections

    Settings

    Member Visibility
    +fieldCorrections | @salesforce/packaging

    Function fieldCorrections

    Settings

    Member Visibility
    diff --git a/functions/package_profileRewriter.manifestTypesToMap.html b/functions/package_profileRewriter.manifestTypesToMap.html index 57e27e154..2ff0ff6d3 100644 --- a/functions/package_profileRewriter.manifestTypesToMap.html +++ b/functions/package_profileRewriter.manifestTypesToMap.html @@ -1,2 +1,2 @@ manifestTypesToMap | @salesforce/packaging

    Function manifestTypesToMap

    it's easier to do lookups by Metadata Type on a Map

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/package_profileRewriter.profileObjectToString.html b/functions/package_profileRewriter.profileObjectToString.html index a7c531ff4..dfc44d8ea 100644 --- a/functions/package_profileRewriter.profileObjectToString.html +++ b/functions/package_profileRewriter.profileObjectToString.html @@ -1,3 +1,3 @@ profileObjectToString | @salesforce/packaging

    Function profileObjectToString

    pass in an object that has the Profile props at the top level. This function will add the outer wrapper Profile and convert the result to xml

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/package_profileRewriter.profileRewriter.html b/functions/package_profileRewriter.profileRewriter.html index 8b8bdb37b..d884a4bef 100644 --- a/functions/package_profileRewriter.profileRewriter.html +++ b/functions/package_profileRewriter.profileRewriter.html @@ -9,4 +9,4 @@
  • packageXml: PackageMap

    package.xml as json

  • retainUserLicense: boolean = false

    boolean will preserve userLicense if true

    • Returns Profile

    Profile

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/package_profileRewriter.profileStringToProfile.html b/functions/package_profileRewriter.profileStringToProfile.html index 2eb3050cf..0fc4d7887 100644 --- a/functions/package_profileRewriter.profileStringToProfile.html +++ b/functions/package_profileRewriter.profileStringToProfile.html @@ -1,2 +1,2 @@ profileStringToProfile | @salesforce/packaging

    Function profileStringToProfile

    • profileStringToProfile(profileString): Profile

    • Parameters

      • profileString: string

      Returns Profile

      CorrectedProfile (json representation of the profile)

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/utils_packageUtils.applyErrorAction.html b/functions/utils_packageUtils.applyErrorAction.html index d24cdda85..a0d0fee5b 100644 --- a/functions/utils_packageUtils.applyErrorAction.html +++ b/functions/utils_packageUtils.applyErrorAction.html @@ -1 +1 @@ -applyErrorAction | @salesforce/packaging

    Function applyErrorAction

    • applyErrorAction(err): Error

    • Parameters

      • err: Error & {
            action?: string;
        }

      Returns Error

    Settings

    Member Visibility
    +applyErrorAction | @salesforce/packaging

    Function applyErrorAction

    • applyErrorAction(err): Error

    • Parameters

      • err: Error & {
            action?: string;
        }

      Returns Error

    Settings

    Member Visibility
    diff --git a/functions/utils_packageUtils.combineSaveErrors.html b/functions/utils_packageUtils.combineSaveErrors.html index 1fda65c62..225ed6508 100644 --- a/functions/utils_packageUtils.combineSaveErrors.html +++ b/functions/utils_packageUtils.combineSaveErrors.html @@ -1 +1 @@ -combineSaveErrors | @salesforce/packaging

    Function combineSaveErrors

    • combineSaveErrors(sObject, crudOperation, errors): SfError

    • Parameters

      • sObject: string
      • crudOperation: string
      • errors: SaveError[]

      Returns SfError

    Settings

    Member Visibility
    +combineSaveErrors | @salesforce/packaging

    Function combineSaveErrors

    • combineSaveErrors(sObject, crudOperation, errors): SfError

    • Parameters

      • sObject: string
      • crudOperation: string
      • errors: SaveError[]

      Returns SfError

    Settings

    Member Visibility
    diff --git a/functions/utils_packageUtils.copyDescriptorProperties.html b/functions/utils_packageUtils.copyDescriptorProperties.html index 34ce3e7b6..a3c6f4b6d 100644 --- a/functions/utils_packageUtils.copyDescriptorProperties.html +++ b/functions/utils_packageUtils.copyDescriptorProperties.html @@ -1,4 +1,4 @@ copyDescriptorProperties | @salesforce/packaging

    Function copyDescriptorProperties

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/utils_packageUtils.copyDir.html b/functions/utils_packageUtils.copyDir.html index 2276e6e03..b15a80ee4 100644 --- a/functions/utils_packageUtils.copyDir.html +++ b/functions/utils_packageUtils.copyDir.html @@ -1 +1 @@ -copyDir | @salesforce/packaging

    Function copyDir

    Settings

    Member Visibility
    +copyDir | @salesforce/packaging

    Function copyDir

    Settings

    Member Visibility
    diff --git a/functions/utils_packageUtils.escapeInstallationKey.html b/functions/utils_packageUtils.escapeInstallationKey.html index eb9bb561f..b32321762 100644 --- a/functions/utils_packageUtils.escapeInstallationKey.html +++ b/functions/utils_packageUtils.escapeInstallationKey.html @@ -1 +1 @@ -escapeInstallationKey | @salesforce/packaging

    Function escapeInstallationKey

    Settings

    Member Visibility
    +escapeInstallationKey | @salesforce/packaging

    Function escapeInstallationKey

    Settings

    Member Visibility
    diff --git a/functions/utils_packageUtils.getContainerOptions.html b/functions/utils_packageUtils.getContainerOptions.html index 444fa377c..5b9de1b2d 100644 --- a/functions/utils_packageUtils.getContainerOptions.html +++ b/functions/utils_packageUtils.getContainerOptions.html @@ -2,4 +2,4 @@

    Parameters

    Returns Promise<Map<string, PackageType>>

    Map of 0Ho id to container option api value

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/utils_packageUtils.getPackageVersionId.html b/functions/utils_packageUtils.getPackageVersionId.html index a67ee421f..c193fbe77 100644 --- a/functions/utils_packageUtils.getPackageVersionId.html +++ b/functions/utils_packageUtils.getPackageVersionId.html @@ -1,4 +1,4 @@ getPackageVersionId | @salesforce/packaging

    Function getPackageVersionId

    • getPackageVersionId(versionId, connection): Promise<string | undefined>

    • Given a subscriber package version ID (04t) or package version ID (05i), return the package version ID (05i)

      Parameters

      • versionId: string

        The subscriber package version ID

      • connection: Connection<Schema>

        For tooling query

        -

      Returns Promise<string | undefined>

    Settings

    Member Visibility
    +

    Returns Promise<string | undefined>

    Settings

    Member Visibility
    diff --git a/functions/utils_packageUtils.getPackageVersionNumber.html b/functions/utils_packageUtils.getPackageVersionNumber.html index f61667755..09d6c0bff 100644 --- a/functions/utils_packageUtils.getPackageVersionNumber.html +++ b/functions/utils_packageUtils.getPackageVersionNumber.html @@ -1 +1 @@ -getPackageVersionNumber | @salesforce/packaging

    Function getPackageVersionNumber

    Settings

    Member Visibility
    +getPackageVersionNumber | @salesforce/packaging

    Function getPackageVersionNumber

    Settings

    Member Visibility
    diff --git a/functions/utils_packageUtils.getPackageVersionStrings.html b/functions/utils_packageUtils.getPackageVersionStrings.html index 37ecb7bba..d8a4dadce 100644 --- a/functions/utils_packageUtils.getPackageVersionStrings.html +++ b/functions/utils_packageUtils.getPackageVersionStrings.html @@ -1,4 +1,4 @@ getPackageVersionStrings | @salesforce/packaging

    Function getPackageVersionStrings

    • getPackageVersionStrings(subscriberPackageVersionIds, connection): Promise<Map<string, string>>

    • Given a list of subscriber package version IDs (04t), return the associated version strings (e.g., Major.Minor.Patch.Build)

      Parameters

      • subscriberPackageVersionIds: string[]
      • connection: Connection<Schema>

        For tooling query

      Returns Promise<Map<string, string>>

      Map of subscriberPackageVersionId to versionString

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/utils_packageUtils.isPackageDirectoryEffectivelyEmpty.html b/functions/utils_packageUtils.isPackageDirectoryEffectivelyEmpty.html index f5f237956..c17be172d 100644 --- a/functions/utils_packageUtils.isPackageDirectoryEffectivelyEmpty.html +++ b/functions/utils_packageUtils.isPackageDirectoryEffectivelyEmpty.html @@ -4,4 +4,4 @@

    Parameters

    Returns boolean

    true if the directory contains nothing except empty directories or directories containing only an .eslintrc.json file.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/utils_packageUtils.massageErrorMessage.html b/functions/utils_packageUtils.massageErrorMessage.html index fbdda2b2c..99530cc82 100644 --- a/functions/utils_packageUtils.massageErrorMessage.html +++ b/functions/utils_packageUtils.massageErrorMessage.html @@ -1 +1 @@ -massageErrorMessage | @salesforce/packaging

    Function massageErrorMessage

    Settings

    Member Visibility
    +massageErrorMessage | @salesforce/packaging

    Function massageErrorMessage

    Settings

    Member Visibility
    diff --git a/functions/utils_packageUtils.numberToDuration.html b/functions/utils_packageUtils.numberToDuration.html index 45d7084eb..90e26e15c 100644 --- a/functions/utils_packageUtils.numberToDuration.html +++ b/functions/utils_packageUtils.numberToDuration.html @@ -2,4 +2,4 @@

    Parameters

    Returns Duration

    Link

    for valid values

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/utils_packageUtils.queryWithInConditionChunking.html b/functions/utils_packageUtils.queryWithInConditionChunking.html index bb83af780..727104a01 100644 --- a/functions/utils_packageUtils.queryWithInConditionChunking.html +++ b/functions/utils_packageUtils.queryWithInConditionChunking.html @@ -5,4 +5,4 @@
  • replaceToken: string

    A placeholder in the query's IN condition that will be replaced with the chunked items

  • connection: Connection<Schema>

    For tooling query

    • Returns Promise<T[]>

    concatenated array of records returned from the resulting query(ies)

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/utils_packageUtils.uniqid.html b/functions/utils_packageUtils.uniqid.html index 5eee8f221..a16316f6c 100644 --- a/functions/utils_packageUtils.uniqid.html +++ b/functions/utils_packageUtils.uniqid.html @@ -6,4 +6,4 @@
  • template: a template string.
  • length: the length of the unique id as presented in hexadecimal.
    • -

    Returns string

    Settings

    Member Visibility
    +

    Returns string

    Settings

    Member Visibility
    diff --git a/functions/utils_packageUtils.validateId.html b/functions/utils_packageUtils.validateId.html index bc6a7a5aa..e9d815274 100644 --- a/functions/utils_packageUtils.validateId.html +++ b/functions/utils_packageUtils.validateId.html @@ -1 +1 @@ -validateId | @salesforce/packaging

    Function validateId

    Settings

    Member Visibility
    +validateId | @salesforce/packaging

    Function validateId

    Settings

    Member Visibility
    diff --git a/functions/utils_packageUtils.validateIdNoThrow.html b/functions/utils_packageUtils.validateIdNoThrow.html index 451780c78..902e9d624 100644 --- a/functions/utils_packageUtils.validateIdNoThrow.html +++ b/functions/utils_packageUtils.validateIdNoThrow.html @@ -1 +1 @@ -validateIdNoThrow | @salesforce/packaging

    Function validateIdNoThrow

    Settings

    Member Visibility
    +validateIdNoThrow | @salesforce/packaging

    Function validateIdNoThrow

    Settings

    Member Visibility
    diff --git a/functions/utils_packageUtils.zipDir.html b/functions/utils_packageUtils.zipDir.html index 86795f22a..d415002f1 100644 --- a/functions/utils_packageUtils.zipDir.html +++ b/functions/utils_packageUtils.zipDir.html @@ -1,4 +1,4 @@ zipDir | @salesforce/packaging

    Function zipDir

    • zipDir(dir, zipfile): Promise<void>

    • Zips directory to given zipfile.

      Parameters

      • dir: string

        directory to zip

      • zipfile: string

        path to the zip file to create

        -

      Returns Promise<void>

    Settings

    Member Visibility
    +

    Returns Promise<void>

    Settings

    Member Visibility
    diff --git a/modules/exported.html b/modules/exported.html index 2a91ef6e2..2a048bbf0 100644 --- a/modules/exported.html +++ b/modules/exported.html @@ -1,4 +1,4 @@ -exported | @salesforce/packaging

    Module exported

    References

    AncestryRepresentationProducer +exported | @salesforce/packaging

    Module exported

    References

    AncestryRepresentationProducer AncestryRepresentationProducerOptions CodeCoverage CodeCoveragePercentages diff --git a/modules/interfaces.html b/modules/interfaces.html index dbdbc63f6..6b776c27b 100644 --- a/modules/interfaces.html +++ b/modules/interfaces.html @@ -1,4 +1,4 @@ -interfaces | @salesforce/packaging

    Module interfaces

    References

    AncestryRepresentationProducer +interfaces | @salesforce/packaging

    Module interfaces

    References

    AncestryRepresentationProducer AncestryRepresentationProducerOptions CodeCoverage CodeCoveragePercentages diff --git a/modules/interfaces_packagingInterfacesAndType.html b/modules/interfaces_packagingInterfacesAndType.html index aeb6078f8..3b224ed33 100644 --- a/modules/interfaces_packagingInterfacesAndType.html +++ b/modules/interfaces_packagingInterfacesAndType.html @@ -1,4 +1,4 @@ -interfaces/packagingInterfacesAndType | @salesforce/packaging

    Module interfaces/packagingInterfacesAndType

    Index

    Type Aliases

    AncestryRepresentationProducer +interfaces/packagingInterfacesAndType | @salesforce/packaging

    Module interfaces/packagingInterfacesAndType

    Index

    Type Aliases

    AncestryRepresentationProducer AncestryRepresentationProducerOptions CodeCoverage CodeCoveragePercentages diff --git a/modules/interfaces_packagingSObjects.PackagingSObjects.html b/modules/interfaces_packagingSObjects.PackagingSObjects.html index 832baa2f7..85e8763a3 100644 --- a/modules/interfaces_packagingSObjects.PackagingSObjects.html +++ b/modules/interfaces_packagingSObjects.PackagingSObjects.html @@ -1,4 +1,4 @@ -PackagingSObjects | @salesforce/packaging

    Namespace PackagingSObjects

    Index

    Enumerations

    Package2VersionStatus +PackagingSObjects | @salesforce/packaging

    Namespace PackagingSObjects

    Index

    Enumerations

    Package2VersionStatus

    Type Aliases

    Attributes InstallValidationStatus InstalledSubscriberPackage diff --git a/modules/interfaces_packagingSObjects.html b/modules/interfaces_packagingSObjects.html index 0befb7376..d14b53bfb 100644 --- a/modules/interfaces_packagingSObjects.html +++ b/modules/interfaces_packagingSObjects.html @@ -1,2 +1,2 @@ -interfaces/packagingSObjects | @salesforce/packaging

    Module interfaces/packagingSObjects

    Index

    Namespaces

    PackagingSObjects +interfaces/packagingSObjects | @salesforce/packaging

    Module interfaces/packagingSObjects

    Index

    Namespaces

    PackagingSObjects

    Settings

    Member Visibility
    diff --git a/modules/package.html b/modules/package.html index 905e2af08..5c9618e1c 100644 --- a/modules/package.html +++ b/modules/package.html @@ -1,4 +1,4 @@ -package | @salesforce/packaging

    Module package

    References

    Package +package | @salesforce/packaging

    Module package

    References

    Package Package2Fields Package2VersionFieldTypes Package2VersionFields diff --git a/modules/package1.html b/modules/package1.html index 398a60acf..494009783 100644 --- a/modules/package1.html +++ b/modules/package1.html @@ -1,2 +1,2 @@ -package1 | @salesforce/packaging

    Module package1

    References

    Package1Version +package1 | @salesforce/packaging

    Module package1

    References

    Package1Version

    References

    Package1Version

    Re-exports Package1Version

    Settings

    Member Visibility

    On This Page

    References
    diff --git a/modules/package1_package1Version.html b/modules/package1_package1Version.html index 81b313dc8..7dab926a6 100644 --- a/modules/package1_package1Version.html +++ b/modules/package1_package1Version.html @@ -1,2 +1,2 @@ -package1/package1Version | @salesforce/packaging

    Module package1/package1Version

    Index

    Classes

    Package1Version +package1/package1Version | @salesforce/packaging

    Module package1/package1Version

    Index

    Classes

    Package1Version

    Settings

    Member Visibility
    diff --git a/modules/package_package.html b/modules/package_package.html index d51cadef0..574f359da 100644 --- a/modules/package_package.html +++ b/modules/package_package.html @@ -1,3 +1,3 @@ -package/package | @salesforce/packaging

    Module package/package

    Index

    Classes

    Package +package/package | @salesforce/packaging

    Module package/package

    Index

    Classes

    Package

    Variables

    Package2Fields

    Settings

    Member Visibility
    diff --git a/modules/package_packageAncestry.html b/modules/package_packageAncestry.html index 58db15ca5..d5820ae6a 100644 --- a/modules/package_packageAncestry.html +++ b/modules/package_packageAncestry.html @@ -1,4 +1,4 @@ -package/packageAncestry | @salesforce/packaging

    Module package/packageAncestry

    Index

    Classes

    AncestryDotProducer +package/packageAncestry | @salesforce/packaging

    Module package/packageAncestry

    Index

    Classes

    AncestryDotProducer AncestryJsonProducer AncestryTreeProducer PackageAncestry diff --git a/modules/package_packageConvert.html b/modules/package_packageConvert.html index 27971ece3..31b6bf778 100644 --- a/modules/package_packageConvert.html +++ b/modules/package_packageConvert.html @@ -1,3 +1,3 @@ -package/packageConvert | @salesforce/packaging

    Module package/packageConvert

    Index

    Functions

    convertPackage +package/packageConvert | @salesforce/packaging

    Module package/packageConvert

    Index

    Functions

    convertPackage findOrCreatePackage2

    Settings

    Member Visibility
    diff --git a/modules/package_packageCreate.html b/modules/package_packageCreate.html index d530fdca6..d35578358 100644 --- a/modules/package_packageCreate.html +++ b/modules/package_packageCreate.html @@ -1,3 +1,3 @@ -package/packageCreate | @salesforce/packaging

    Module package/packageCreate

    Index

    Functions

    createPackage +package/packageCreate | @salesforce/packaging

    Module package/packageCreate

    Index

    Functions

    createPackage createPackageRequestFromContext

    Settings

    Member Visibility
    diff --git a/modules/package_packageDelete.html b/modules/package_packageDelete.html index 51f2a6c03..f59c5ab01 100644 --- a/modules/package_packageDelete.html +++ b/modules/package_packageDelete.html @@ -1,2 +1,2 @@ -package/packageDelete | @salesforce/packaging

    Module package/packageDelete

    Index

    Functions

    deletePackage +package/packageDelete | @salesforce/packaging

    Module package/packageDelete

    Index

    Functions

    deletePackage

    Settings

    Member Visibility
    diff --git a/modules/package_packageInstall.html b/modules/package_packageInstall.html index 867addfac..64facae98 100644 --- a/modules/package_packageInstall.html +++ b/modules/package_packageInstall.html @@ -1,4 +1,4 @@ -package/packageInstall | @salesforce/packaging

    Module package/packageInstall

    Index

    Functions

    createPackageInstallRequest +package/packageInstall | @salesforce/packaging

    Module package/packageInstall

    Index

    Functions

    createPackageInstallRequest getInstallationStatus getStatus isErrorFromSPVQueryRestriction diff --git a/modules/package_packageProfileApi.html b/modules/package_packageProfileApi.html index 378cf4418..7488cf9f7 100644 --- a/modules/package_packageProfileApi.html +++ b/modules/package_packageProfileApi.html @@ -1,2 +1,2 @@ -package/packageProfileApi | @salesforce/packaging

    Module package/packageProfileApi

    Index

    Classes

    PackageProfileApi +package/packageProfileApi | @salesforce/packaging

    Module package/packageProfileApi

    Index

    Classes

    PackageProfileApi

    Settings

    Member Visibility
    diff --git a/modules/package_packageUninstall.html b/modules/package_packageUninstall.html index 0e336d9b2..a87c9a100 100644 --- a/modules/package_packageUninstall.html +++ b/modules/package_packageUninstall.html @@ -1,4 +1,4 @@ -package/packageUninstall | @salesforce/packaging

    Module package/packageUninstall

    Index

    Functions

    getUninstallErrors +package/packageUninstall | @salesforce/packaging

    Module package/packageUninstall

    Index

    Functions

    getUninstallErrors pollUninstall uninstallPackage

    Settings

    Member Visibility
    diff --git a/modules/package_packageVersion.html b/modules/package_packageVersion.html index 774fe2693..45e24c905 100644 --- a/modules/package_packageVersion.html +++ b/modules/package_packageVersion.html @@ -1,4 +1,4 @@ -package/packageVersion | @salesforce/packaging

    Module package/packageVersion

    Index

    Classes

    PackageVersion +package/packageVersion | @salesforce/packaging

    Module package/packageVersion

    Index

    Classes

    PackageVersion

    Type Aliases

    Package2VersionFieldTypes Package2VersionQueryOptions

    Variables

    Package2VersionFields diff --git a/modules/package_packageVersionCreate.html b/modules/package_packageVersionCreate.html index e71b2b37e..34cc196ce 100644 --- a/modules/package_packageVersionCreate.html +++ b/modules/package_packageVersionCreate.html @@ -1,4 +1,4 @@ -package/packageVersionCreate | @salesforce/packaging

    Module package/packageVersionCreate

    Index

    Classes

    MetadataResolver +package/packageVersionCreate | @salesforce/packaging

    Module package/packageVersionCreate

    Index

    Classes

    MetadataResolver PackageVersionCreate

    Functions

    packageXmlJsonToXmlString packageXmlStringToPackageXmlJson diff --git a/modules/package_packageVersionCreateRequest.html b/modules/package_packageVersionCreateRequest.html index 125047257..926b8bfdb 100644 --- a/modules/package_packageVersionCreateRequest.html +++ b/modules/package_packageVersionCreateRequest.html @@ -1,4 +1,4 @@ -package/packageVersionCreateRequest | @salesforce/packaging

    Module package/packageVersionCreateRequest

    Index

    Functions

    byId +package/packageVersionCreateRequest | @salesforce/packaging

    Module package/packageVersionCreateRequest

    Index

    Functions

    byId getQuery list

    Settings

    Member Visibility
    diff --git a/modules/package_packageVersionCreateRequestReport.html b/modules/package_packageVersionCreateRequestReport.html index 39972c43b..9d806564c 100644 --- a/modules/package_packageVersionCreateRequestReport.html +++ b/modules/package_packageVersionCreateRequestReport.html @@ -1,2 +1,2 @@ -package/packageVersionCreateRequestReport | @salesforce/packaging

    Module package/packageVersionCreateRequestReport

    Index

    Functions

    getCreatePackageVersionCreateRequestReport +package/packageVersionCreateRequestReport | @salesforce/packaging

    Module package/packageVersionCreateRequestReport

    Index

    Functions

    getCreatePackageVersionCreateRequestReport

    Settings

    Member Visibility
    diff --git a/modules/package_packageVersionList.html b/modules/package_packageVersionList.html index 7da9e6721..e90536512 100644 --- a/modules/package_packageVersionList.html +++ b/modules/package_packageVersionList.html @@ -1,4 +1,4 @@ -package/packageVersionList | @salesforce/packaging

    Module package/packageVersionList

    Index

    Variables

    DEFAULT_ORDER_BY_FIELDS +package/packageVersionList | @salesforce/packaging

    Module package/packageVersionList

    Index

    Variables

    DEFAULT_ORDER_BY_FIELDS

    Functions

    assembleQueryParts constructQuery constructWhere diff --git a/modules/package_packageVersionReport.html b/modules/package_packageVersionReport.html index f3d1b10b0..84585898d 100644 --- a/modules/package_packageVersionReport.html +++ b/modules/package_packageVersionReport.html @@ -1,2 +1,2 @@ -package/packageVersionReport | @salesforce/packaging

    Module package/packageVersionReport

    Index

    Functions

    getPackageVersionReport +package/packageVersionReport | @salesforce/packaging

    Module package/packageVersionReport

    Index

    Functions

    getPackageVersionReport

    Settings

    Member Visibility
    diff --git a/modules/package_packageVersionRetrieve.html b/modules/package_packageVersionRetrieve.html index c4520dcd3..1731879fb 100644 --- a/modules/package_packageVersionRetrieve.html +++ b/modules/package_packageVersionRetrieve.html @@ -1,2 +1,2 @@ -package/packageVersionRetrieve | @salesforce/packaging

    Module package/packageVersionRetrieve

    Index

    Functions

    retrievePackageVersionMetadata +package/packageVersionRetrieve | @salesforce/packaging

    Module package/packageVersionRetrieve

    Index

    Functions

    retrievePackageVersionMetadata

    Settings

    Member Visibility
    diff --git a/modules/package_profileRewriter.html b/modules/package_profileRewriter.html index 1c9aa9aad..e3a264599 100644 --- a/modules/package_profileRewriter.html +++ b/modules/package_profileRewriter.html @@ -1,4 +1,4 @@ -package/profileRewriter | @salesforce/packaging

    Module package/profileRewriter

    Index

    Type Aliases

    CorrectedProfile +package/profileRewriter | @salesforce/packaging

    Module package/profileRewriter

    Index

    Type Aliases

    CorrectedProfile

    Functions

    fieldCorrections manifestTypesToMap profileObjectToString diff --git a/modules/package_subscriberPackageVersion.html b/modules/package_subscriberPackageVersion.html index 0a3fbe6e5..455c274df 100644 --- a/modules/package_subscriberPackageVersion.html +++ b/modules/package_subscriberPackageVersion.html @@ -1,3 +1,3 @@ -package/subscriberPackageVersion | @salesforce/packaging

    Module package/subscriberPackageVersion

    Index

    Classes

    SubscriberPackageVersion +package/subscriberPackageVersion | @salesforce/packaging

    Module package/subscriberPackageVersion

    Index

    Classes

    SubscriberPackageVersion

    Variables

    SubscriberPackageVersionFields

    Settings

    Member Visibility
    diff --git a/modules/package_versionNumber.html b/modules/package_versionNumber.html index f7f37e164..ca80357e9 100644 --- a/modules/package_versionNumber.html +++ b/modules/package_versionNumber.html @@ -1,3 +1,3 @@ -package/versionNumber | @salesforce/packaging

    Module package/versionNumber

    Index

    Enumerations

    BuildNumberToken +package/versionNumber | @salesforce/packaging

    Module package/versionNumber

    Index

    Enumerations

    BuildNumberToken

    Classes

    VersionNumber

    Settings

    Member Visibility
    diff --git a/modules/utils.html b/modules/utils.html index 6f23f1d3f..bc33804a3 100644 --- a/modules/utils.html +++ b/modules/utils.html @@ -1,4 +1,4 @@ -utils | @salesforce/packaging

    Module utils

    References

    INSTALL_URL_BASE +utils | @salesforce/packaging

    Module utils

    References

    INSTALL_URL_BASE getContainerOptions getPackageVersionNumber getPackageVersionStrings diff --git a/modules/utils_packageUtils.html b/modules/utils_packageUtils.html index 10ed9a9ef..e98f177d8 100644 --- a/modules/utils_packageUtils.html +++ b/modules/utils_packageUtils.html @@ -1,4 +1,4 @@ -utils/packageUtils | @salesforce/packaging

    Module utils/packageUtils

    Index

    Type Aliases

    IdRegistry +utils/packageUtils | @salesforce/packaging

    Module utils/packageUtils

    Index

    Type Aliases

    IdRegistry IdRegistryValue

    Variables

    BY_LABEL INSTALL_URL_BASE diff --git a/types/interfaces_packagingInterfacesAndType.AncestryRepresentationProducer.html b/types/interfaces_packagingInterfacesAndType.AncestryRepresentationProducer.html index fe51a76cb..761dd9c4b 100644 --- a/types/interfaces_packagingInterfacesAndType.AncestryRepresentationProducer.html +++ b/types/interfaces_packagingInterfacesAndType.AncestryRepresentationProducer.html @@ -1 +1 @@ -AncestryRepresentationProducer | @salesforce/packaging

    Type Alias AncestryRepresentationProducer

    AncestryRepresentationProducer: {
        label: string;
        options?: AncestryRepresentationProducerOptions;
        addNode(node: AncestryRepresentationProducer): void;
        produce(): string | void | PackageAncestryNodeData;
    }

    Settings

    Member Visibility
    +AncestryRepresentationProducer | @salesforce/packaging

    Type Alias AncestryRepresentationProducer

    AncestryRepresentationProducer: {
        label: string;
        options?: AncestryRepresentationProducerOptions;
        addNode(node: AncestryRepresentationProducer): void;
        produce(): string | void | PackageAncestryNodeData;
    }

    Settings

    Member Visibility
    diff --git a/types/interfaces_packagingInterfacesAndType.AncestryRepresentationProducerOptions.html b/types/interfaces_packagingInterfacesAndType.AncestryRepresentationProducerOptions.html index 14121f8c0..c41378eeb 100644 --- a/types/interfaces_packagingInterfacesAndType.AncestryRepresentationProducerOptions.html +++ b/types/interfaces_packagingInterfacesAndType.AncestryRepresentationProducerOptions.html @@ -1 +1 @@ -AncestryRepresentationProducerOptions | @salesforce/packaging

    Type Alias AncestryRepresentationProducerOptions

    AncestryRepresentationProducerOptions: {
        depth: number;
        logger?: ((text: string) => void);
        packageNode?: PackageAncestryNode;
        verbose?: boolean;
    }

    Settings

    Member Visibility
    +AncestryRepresentationProducerOptions | @salesforce/packaging

    Type Alias AncestryRepresentationProducerOptions

    AncestryRepresentationProducerOptions: {
        depth: number;
        logger?: ((text: string) => void);
        packageNode?: PackageAncestryNode;
        verbose?: boolean;
    }

    Settings

    Member Visibility
    diff --git a/types/interfaces_packagingInterfacesAndType.CodeCoverage.html b/types/interfaces_packagingInterfacesAndType.CodeCoverage.html index 485dd3e1c..ca40d19bb 100644 --- a/types/interfaces_packagingInterfacesAndType.CodeCoverage.html +++ b/types/interfaces_packagingInterfacesAndType.CodeCoverage.html @@ -1 +1 @@ -CodeCoverage | @salesforce/packaging

    Type Alias CodeCoverage

    CodeCoverage: null | {
        apexCodeCoveragePercentage: number;
    }

    Settings

    Member Visibility
    +CodeCoverage | @salesforce/packaging

    Type Alias CodeCoverage

    CodeCoverage: null | {
        apexCodeCoveragePercentage: number;
    }

    Settings

    Member Visibility
    diff --git a/types/interfaces_packagingInterfacesAndType.CodeCoveragePercentages.html b/types/interfaces_packagingInterfacesAndType.CodeCoveragePercentages.html index 72cb1a055..7537a7784 100644 --- a/types/interfaces_packagingInterfacesAndType.CodeCoveragePercentages.html +++ b/types/interfaces_packagingInterfacesAndType.CodeCoveragePercentages.html @@ -1 +1 @@ -CodeCoveragePercentages | @salesforce/packaging

    Type Alias CodeCoveragePercentages

    CodeCoveragePercentages: null | {
        codeCovPercentages: [{
            className: string;
            codeCoveragePercentage: number;
        }];
    }

    Settings

    Member Visibility
    +CodeCoveragePercentages | @salesforce/packaging

    Type Alias CodeCoveragePercentages

    CodeCoveragePercentages: null | {
        codeCovPercentages: [{
            className: string;
            codeCoveragePercentage: number;
        }];
    }

    Settings

    Member Visibility
    diff --git a/types/interfaces_packagingInterfacesAndType.ConvertPackageOptions.html b/types/interfaces_packagingInterfacesAndType.ConvertPackageOptions.html index 09a93843f..cf93f7a42 100644 --- a/types/interfaces_packagingInterfacesAndType.ConvertPackageOptions.html +++ b/types/interfaces_packagingInterfacesAndType.ConvertPackageOptions.html @@ -1,2 +1,2 @@ ConvertPackageOptions | @salesforce/packaging

    Type Alias ConvertPackageOptions

    ConvertPackageOptions: {
        buildInstance?: string;
        definitionfile?: string;
        frequency?: Duration;
        installationKey?: string;
        installationKeyBypass: boolean;
        seedMetadata?: string;
        wait: Duration;
    }

    Type declaration

    • OptionalbuildInstance?: string
    • Optionaldefinitionfile?: string
    • Optionalfrequency?: Duration
    • OptionalinstallationKey?: string
    • installationKeyBypass: boolean

      Deprecated

      stop using it

      -
    • OptionalseedMetadata?: string
    • wait: Duration

    Settings

    Member Visibility
    +
  • OptionalseedMetadata?: string
  • wait: Duration

    • Settings

    Member Visibility
    diff --git a/types/interfaces_packagingInterfacesAndType.IPackageVersion1GP.html b/types/interfaces_packagingInterfacesAndType.IPackageVersion1GP.html index 386c27943..da0d56535 100644 --- a/types/interfaces_packagingInterfacesAndType.IPackageVersion1GP.html +++ b/types/interfaces_packagingInterfacesAndType.IPackageVersion1GP.html @@ -1 +1 @@ -IPackageVersion1GP | @salesforce/packaging

    Type Alias IPackageVersion1GP

    IPackageVersion1GP: {
        getPackageVersion(id: string): Promise<MetadataPackageVersion[]>;
    }

    Settings

    Member Visibility
    +IPackageVersion1GP | @salesforce/packaging

    Type Alias IPackageVersion1GP

    IPackageVersion1GP: {
        getPackageVersion(id: string): Promise<MetadataPackageVersion[]>;
    }

    Settings

    Member Visibility
    diff --git a/types/interfaces_packagingInterfacesAndType.IPackageVersion2GP.html b/types/interfaces_packagingInterfacesAndType.IPackageVersion2GP.html index 7e7388893..0d0e9f8ce 100644 --- a/types/interfaces_packagingInterfacesAndType.IPackageVersion2GP.html +++ b/types/interfaces_packagingInterfacesAndType.IPackageVersion2GP.html @@ -1 +1 @@ -IPackageVersion2GP | @salesforce/packaging

    Type Alias IPackageVersion2GP

    IPackageVersion2GP: {
        convert(): Promise<void>;
        create(): Promise<void>;
        delete(): Promise<void>;
        install(): Promise<void>;
        list(): Promise<void>;
        uninstall(): Promise<void>;
        update(): Promise<void>;
    }

    Settings

    Member Visibility
    +IPackageVersion2GP | @salesforce/packaging

    Type Alias IPackageVersion2GP

    IPackageVersion2GP: {
        convert(): Promise<void>;
        create(): Promise<void>;
        delete(): Promise<void>;
        install(): Promise<void>;
        list(): Promise<void>;
        uninstall(): Promise<void>;
        update(): Promise<void>;
    }

    Settings

    Member Visibility
    diff --git a/types/interfaces_packagingInterfacesAndType.InstalledPackages.html b/types/interfaces_packagingInterfacesAndType.InstalledPackages.html index a87b6ab27..d97e0ce10 100644 --- a/types/interfaces_packagingInterfacesAndType.InstalledPackages.html +++ b/types/interfaces_packagingInterfacesAndType.InstalledPackages.html @@ -1 +1 @@ -InstalledPackages | @salesforce/packaging

    Type Alias InstalledPackages

    InstalledPackages: {
        Id: string;
        MinPackageVersionId: string;
        SubscriberPackage?: SubscriberPackage;
        SubscriberPackageId: string;
        SubscriberPackageVersion?: Omit<MetadataPackageVersion, "MetadataPackageId" | "ReleaseState" | "IsDeprecated">;
        SubscriberPackageVersionId: string;
    }

    Settings

    Member Visibility
    +InstalledPackages | @salesforce/packaging

    Type Alias InstalledPackages

    InstalledPackages: {
        Id: string;
        MinPackageVersionId: string;
        SubscriberPackage?: SubscriberPackage;
        SubscriberPackageId: string;
        SubscriberPackageVersion?: Omit<MetadataPackageVersion, "MetadataPackageId" | "ReleaseState" | "IsDeprecated">;
        SubscriberPackageVersionId: string;
    }

    Settings

    Member Visibility
    diff --git a/types/interfaces_packagingInterfacesAndType.MDFolderForArtifactOptions.html b/types/interfaces_packagingInterfacesAndType.MDFolderForArtifactOptions.html index d82edb61b..f596174a1 100644 --- a/types/interfaces_packagingInterfacesAndType.MDFolderForArtifactOptions.html +++ b/types/interfaces_packagingInterfacesAndType.MDFolderForArtifactOptions.html @@ -1 +1 @@ -MDFolderForArtifactOptions | @salesforce/packaging

    Type Alias MDFolderForArtifactOptions

    MDFolderForArtifactOptions: {
        deploydir?: string;
        manifest?: string;
        metadataPaths?: string[];
        outputDir?: string;
        packageName?: string;
        sourceApiVersion?: string;
        sourceDir?: string;
        sourcePaths?: string[];
    }

    Settings

    Member Visibility
    +MDFolderForArtifactOptions | @salesforce/packaging

    Type Alias MDFolderForArtifactOptions

    MDFolderForArtifactOptions: {
        deploydir?: string;
        manifest?: string;
        metadataPaths?: string[];
        outputDir?: string;
        packageName?: string;
        sourceApiVersion?: string;
        sourceDir?: string;
        sourcePaths?: string[];
    }

    Settings

    Member Visibility
    diff --git a/types/interfaces_packagingInterfacesAndType.Package1Display.html b/types/interfaces_packagingInterfacesAndType.Package1Display.html index 7d20d981b..278fa1647 100644 --- a/types/interfaces_packagingInterfacesAndType.Package1Display.html +++ b/types/interfaces_packagingInterfacesAndType.Package1Display.html @@ -1 +1 @@ -Package1Display | @salesforce/packaging

    Type Alias Package1Display

    Package1Display: {
        BuildNumber: number;
        MetadataPackageId: string;
        MetadataPackageVersionId: string;
        Name: string;
        ReleaseState: string;
        Version: string;
    }

    Settings

    Member Visibility
    +Package1Display | @salesforce/packaging

    Type Alias Package1Display

    Package1Display: {
        BuildNumber: number;
        MetadataPackageId: string;
        MetadataPackageVersionId: string;
        Name: string;
        ReleaseState: string;
        Version: string;
    }

    Settings

    Member Visibility
    diff --git a/types/interfaces_packagingInterfacesAndType.Package1VersionCreateRequest.html b/types/interfaces_packagingInterfacesAndType.Package1VersionCreateRequest.html index 27663b2dc..45358760f 100644 --- a/types/interfaces_packagingInterfacesAndType.Package1VersionCreateRequest.html +++ b/types/interfaces_packagingInterfacesAndType.Package1VersionCreateRequest.html @@ -1 +1 @@ -Package1VersionCreateRequest | @salesforce/packaging

    Type Alias Package1VersionCreateRequest

    Package1VersionCreateRequest: Pick<PackageUploadRequest, "VersionName" | "MetadataPackageId"> & Partial<Pick<PackageUploadRequest,
        | "Description"
        | "MajorVersion"
        | "MinorVersion"
        | "IsReleaseVersion"
        | "ReleaseNotesUrl"
        | "PostInstallUrl"
        | "Password">>

    Settings

    Member Visibility
    +Package1VersionCreateRequest | @salesforce/packaging

    Type Alias Package1VersionCreateRequest

    Package1VersionCreateRequest: Pick<PackageUploadRequest, "VersionName" | "MetadataPackageId"> & Partial<Pick<PackageUploadRequest,
        | "Description"
        | "MajorVersion"
        | "MinorVersion"
        | "IsReleaseVersion"
        | "ReleaseNotesUrl"
        | "PostInstallUrl"
        | "Password">>

    Settings

    Member Visibility
    diff --git a/types/interfaces_packagingInterfacesAndType.PackageAncestryData.html b/types/interfaces_packagingInterfacesAndType.PackageAncestryData.html index 977447637..ced3affa6 100644 --- a/types/interfaces_packagingInterfacesAndType.PackageAncestryData.html +++ b/types/interfaces_packagingInterfacesAndType.PackageAncestryData.html @@ -1 +1 @@ -PackageAncestryData | @salesforce/packaging

    Type Alias PackageAncestryData

    PackageAncestryData: Omit<PackageAncestryNodeAttributes, "AncestorId">

    Settings

    Member Visibility
    +PackageAncestryData | @salesforce/packaging

    Type Alias PackageAncestryData

    PackageAncestryData: Omit<PackageAncestryNodeAttributes, "AncestorId">

    Settings

    Member Visibility
    diff --git a/types/interfaces_packagingInterfacesAndType.PackageAncestryNodeAttributes.html b/types/interfaces_packagingInterfacesAndType.PackageAncestryNodeAttributes.html index 13bdae1ed..584d2af99 100644 --- a/types/interfaces_packagingInterfacesAndType.PackageAncestryNodeAttributes.html +++ b/types/interfaces_packagingInterfacesAndType.PackageAncestryNodeAttributes.html @@ -1 +1 @@ -PackageAncestryNodeAttributes | @salesforce/packaging

    Type Alias PackageAncestryNodeAttributes

    PackageAncestryNodeAttributes: PackageAncestryNodeOptions & {
        node: PackageAncestryNode;
    }

    Settings

    Member Visibility
    +PackageAncestryNodeAttributes | @salesforce/packaging

    Type Alias PackageAncestryNodeAttributes

    PackageAncestryNodeAttributes: PackageAncestryNodeOptions & {
        node: PackageAncestryNode;
    }

    Settings

    Member Visibility
    diff --git a/types/interfaces_packagingInterfacesAndType.PackageAncestryNodeData.html b/types/interfaces_packagingInterfacesAndType.PackageAncestryNodeData.html index 305c3460c..93d5f994c 100644 --- a/types/interfaces_packagingInterfacesAndType.PackageAncestryNodeData.html +++ b/types/interfaces_packagingInterfacesAndType.PackageAncestryNodeData.html @@ -1 +1 @@ -PackageAncestryNodeData | @salesforce/packaging

    Type Alias PackageAncestryNodeData

    PackageAncestryNodeData: {
        children: PackageAncestryNodeData[];
        data: PackageAncestryNodeOptions;
    }

    Settings

    Member Visibility
    +PackageAncestryNodeData | @salesforce/packaging

    Type Alias PackageAncestryNodeData

    PackageAncestryNodeData: {
        children: PackageAncestryNodeData[];
        data: PackageAncestryNodeOptions;
    }

    Settings

    Member Visibility
    diff --git a/types/interfaces_packagingInterfacesAndType.PackageAncestryNodeOptions.html b/types/interfaces_packagingInterfacesAndType.PackageAncestryNodeOptions.html index 148daea59..1ddc322f6 100644 --- a/types/interfaces_packagingInterfacesAndType.PackageAncestryNodeOptions.html +++ b/types/interfaces_packagingInterfacesAndType.PackageAncestryNodeOptions.html @@ -1 +1 @@ -PackageAncestryNodeOptions | @salesforce/packaging

    Type Alias PackageAncestryNodeOptions

    PackageAncestryNodeOptions: Attributes & {
        AncestorId?: string;
        BuildNumber: string | number;
        MajorVersion: string | number;
        MinorVersion: string | number;
        PatchVersion: string | number;
        SubscriberPackageVersionId: string;
        depthCounter: number;
    }

    Settings

    Member Visibility
    +PackageAncestryNodeOptions | @salesforce/packaging

    Type Alias PackageAncestryNodeOptions

    PackageAncestryNodeOptions: Attributes & {
        AncestorId?: string;
        BuildNumber: string | number;
        MajorVersion: string | number;
        MinorVersion: string | number;
        PatchVersion: string | number;
        SubscriberPackageVersionId: string;
        depthCounter: number;
    }

    Settings

    Member Visibility
    diff --git a/types/interfaces_packagingInterfacesAndType.PackageAncestryOptions.html b/types/interfaces_packagingInterfacesAndType.PackageAncestryOptions.html index 13ee33a9e..da1b07bf8 100644 --- a/types/interfaces_packagingInterfacesAndType.PackageAncestryOptions.html +++ b/types/interfaces_packagingInterfacesAndType.PackageAncestryOptions.html @@ -1 +1 @@ -PackageAncestryOptions | @salesforce/packaging

    Type Alias PackageAncestryOptions

    PackageAncestryOptions: {
        connection: Connection;
        packageId: string;
        project?: SfProject;
    }

    Settings

    Member Visibility
    +PackageAncestryOptions | @salesforce/packaging

    Type Alias PackageAncestryOptions

    PackageAncestryOptions: {
        connection: Connection;
        packageId: string;
        project?: SfProject;
    }

    Settings

    Member Visibility
    diff --git a/types/interfaces_packagingInterfacesAndType.PackageCreateOptions.html b/types/interfaces_packagingInterfacesAndType.PackageCreateOptions.html index 464e5de8d..874a89242 100644 --- a/types/interfaces_packagingInterfacesAndType.PackageCreateOptions.html +++ b/types/interfaces_packagingInterfacesAndType.PackageCreateOptions.html @@ -1 +1 @@ -PackageCreateOptions | @salesforce/packaging

    Type Alias PackageCreateOptions

    PackageCreateOptions: {
        description: string;
        errorNotificationUsername: string;
        name: string;
        noNamespace: boolean;
        orgDependent: boolean;
        packageType: PackageType;
        path: string;
    }

    Settings

    Member Visibility
    +PackageCreateOptions | @salesforce/packaging

    Type Alias PackageCreateOptions

    PackageCreateOptions: {
        description: string;
        errorNotificationUsername: string;
        name: string;
        noNamespace: boolean;
        orgDependent: boolean;
        packageType: PackageType;
        path: string;
    }

    Settings

    Member Visibility
    diff --git a/types/interfaces_packagingInterfacesAndType.PackageDescriptorJson.html b/types/interfaces_packagingInterfacesAndType.PackageDescriptorJson.html index 5b40b2fe0..49add1a36 100644 --- a/types/interfaces_packagingInterfacesAndType.PackageDescriptorJson.html +++ b/types/interfaces_packagingInterfacesAndType.PackageDescriptorJson.html @@ -1 +1 @@ -PackageDescriptorJson | @salesforce/packaging

    Type Alias PackageDescriptorJson

    PackageDescriptorJson: Partial<NamedPackagingDir> & Partial<{
        apexTestAccess: {
            permissionSetLicenses: string[] | string;
            permissionSets: string[] | string;
        };
        branch: string;
        features: string[];
        id: string;
        language?: string;
        orgPreferences: string[];
        packageId: string;
        packageMetadataAccess: {
            permissionSetLicenses: string[] | string;
            permissionSets: string[] | string;
        };
        packageMetadataPermissionSetLicenseNames: string[];
        packageMetadataPermissionSetNames: string[];
        permissionSetLicenseDeveloperNames: string[];
        permissionSetNames: string[];
        snapshot: string;
        subscriberPackageVersionId: string;
        versionName: string;
    }>

    Settings

    Member Visibility
    +PackageDescriptorJson | @salesforce/packaging

    Type Alias PackageDescriptorJson

    PackageDescriptorJson: Partial<NamedPackagingDir> & Partial<{
        apexTestAccess: {
            permissionSetLicenses: string[] | string;
            permissionSets: string[] | string;
        };
        branch: string;
        features: string[];
        id: string;
        language?: string;
        orgPreferences: string[];
        packageId: string;
        packageMetadataAccess: {
            permissionSetLicenses: string[] | string;
            permissionSets: string[] | string;
        };
        packageMetadataPermissionSetLicenseNames: string[];
        packageMetadataPermissionSetNames: string[];
        permissionSetLicenseDeveloperNames: string[];
        permissionSetNames: string[];
        snapshot: string;
        subscriberPackageVersionId: string;
        versionName: string;
    }>

    Settings

    Member Visibility
    diff --git a/types/interfaces_packagingInterfacesAndType.PackageIdType.html b/types/interfaces_packagingInterfacesAndType.PackageIdType.html index 9744b2790..2134bf983 100644 --- a/types/interfaces_packagingInterfacesAndType.PackageIdType.html +++ b/types/interfaces_packagingInterfacesAndType.PackageIdType.html @@ -1 +1 @@ -PackageIdType | @salesforce/packaging

    Type Alias PackageIdType

    PackageIdType:
        | "PackageId"
        | "SubscriberPackageVersionId"
        | "PackageInstallRequestId"
        | "PackageUninstallRequestId"

    Settings

    Member Visibility
    +PackageIdType | @salesforce/packaging

    Type Alias PackageIdType

    PackageIdType:
        | "PackageId"
        | "SubscriberPackageVersionId"
        | "PackageInstallRequestId"
        | "PackageUninstallRequestId"

    Settings

    Member Visibility
    diff --git a/types/interfaces_packagingInterfacesAndType.PackageInstallCreateRequest.html b/types/interfaces_packagingInterfacesAndType.PackageInstallCreateRequest.html index 13a9104d5..0cf45c467 100644 --- a/types/interfaces_packagingInterfacesAndType.PackageInstallCreateRequest.html +++ b/types/interfaces_packagingInterfacesAndType.PackageInstallCreateRequest.html @@ -1 +1 @@ -PackageInstallCreateRequest | @salesforce/packaging

    Type Alias PackageInstallCreateRequest

    PackageInstallCreateRequest: Partial<Pick<PackageInstallRequest,
        | "ApexCompileType"
        | "EnableRss"
        | "NameConflictResolution"
        | "PackageInstallSource"
        | "Password"
        | "SecurityType"
        | "SkipHandlers"
        | "UpgradeType">> & Pick<PackageInstallRequest, "SubscriberPackageVersionKey">

    Settings

    Member Visibility
    +PackageInstallCreateRequest | @salesforce/packaging

    Type Alias PackageInstallCreateRequest

    PackageInstallCreateRequest: Partial<Pick<PackageInstallRequest,
        | "ApexCompileType"
        | "EnableRss"
        | "NameConflictResolution"
        | "PackageInstallSource"
        | "Password"
        | "SecurityType"
        | "SkipHandlers"
        | "UpgradeType">> & Pick<PackageInstallRequest, "SubscriberPackageVersionKey">

    Settings

    Member Visibility
    diff --git a/types/interfaces_packagingInterfacesAndType.PackageInstallOptions.html b/types/interfaces_packagingInterfacesAndType.PackageInstallOptions.html index 1093e2ae4..1bbcff277 100644 --- a/types/interfaces_packagingInterfacesAndType.PackageInstallOptions.html +++ b/types/interfaces_packagingInterfacesAndType.PackageInstallOptions.html @@ -6,4 +6,4 @@ it is interpreted in milliseconds.

  • OptionalpublishTimeout?: number | Duration

    The amount of time to wait for package publish to complete. If providing a number it is interpreted in minutes.

    -

    • Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/types/interfaces_packagingInterfacesAndType.PackageOptions.html b/types/interfaces_packagingInterfacesAndType.PackageOptions.html index 5427f2523..5f09210d9 100644 --- a/types/interfaces_packagingInterfacesAndType.PackageOptions.html +++ b/types/interfaces_packagingInterfacesAndType.PackageOptions.html @@ -1 +1 @@ -PackageOptions | @salesforce/packaging

    Type Alias PackageOptions

    PackageOptions: {
        connection: Connection;
        packageAliasOrId: string;
        project?: SfProject;
    }

    Settings

    Member Visibility
    +PackageOptions | @salesforce/packaging

    Type Alias PackageOptions

    PackageOptions: {
        connection: Connection;
        packageAliasOrId: string;
        project?: SfProject;
    }

    Settings

    Member Visibility
    diff --git a/types/interfaces_packagingInterfacesAndType.PackageSaveResult.html b/types/interfaces_packagingInterfacesAndType.PackageSaveResult.html index 54fc33b13..3d85a872e 100644 --- a/types/interfaces_packagingInterfacesAndType.PackageSaveResult.html +++ b/types/interfaces_packagingInterfacesAndType.PackageSaveResult.html @@ -1 +1 @@ -PackageSaveResult | @salesforce/packaging

    Type Alias PackageSaveResult

    PackageSaveResult: SaveResult

    Settings

    Member Visibility
    +PackageSaveResult | @salesforce/packaging

    Type Alias PackageSaveResult

    PackageSaveResult: SaveResult

    Settings

    Member Visibility
    diff --git a/types/interfaces_packagingInterfacesAndType.PackageType.html b/types/interfaces_packagingInterfacesAndType.PackageType.html index 390610b12..89cc82b70 100644 --- a/types/interfaces_packagingInterfacesAndType.PackageType.html +++ b/types/interfaces_packagingInterfacesAndType.PackageType.html @@ -1 +1 @@ -PackageType | @salesforce/packaging

    Type Alias PackageType

    PackageType: "Managed" | "Unlocked"

    Settings

    Member Visibility
    +PackageType | @salesforce/packaging

    Type Alias PackageType

    PackageType: "Managed" | "Unlocked"

    Settings

    Member Visibility
    diff --git a/types/interfaces_packagingInterfacesAndType.PackageUpdateOptions.html b/types/interfaces_packagingInterfacesAndType.PackageUpdateOptions.html index 9d1a6781f..3f9305a5f 100644 --- a/types/interfaces_packagingInterfacesAndType.PackageUpdateOptions.html +++ b/types/interfaces_packagingInterfacesAndType.PackageUpdateOptions.html @@ -1 +1 @@ -PackageUpdateOptions | @salesforce/packaging

    Type Alias PackageUpdateOptions

    PackageUpdateOptions: {
        AppAnalyticsEnabled?: boolean;
        Description?: string;
        Id: string;
        Name?: string;
        PackageErrorUsername?: string;
    }

    Settings

    Member Visibility
    +PackageUpdateOptions | @salesforce/packaging

    Type Alias PackageUpdateOptions

    PackageUpdateOptions: {
        AppAnalyticsEnabled?: boolean;
        Description?: string;
        Id: string;
        Name?: string;
        PackageErrorUsername?: string;
    }

    Settings

    Member Visibility
    diff --git a/types/interfaces_packagingInterfacesAndType.PackageVersionCreateEventData.html b/types/interfaces_packagingInterfacesAndType.PackageVersionCreateEventData.html index ec2a7314f..d999edcf0 100644 --- a/types/interfaces_packagingInterfacesAndType.PackageVersionCreateEventData.html +++ b/types/interfaces_packagingInterfacesAndType.PackageVersionCreateEventData.html @@ -1 +1 @@ -PackageVersionCreateEventData | @salesforce/packaging

    Type Alias PackageVersionCreateEventData

    PackageVersionCreateEventData: {
        id: string;
        message?: string;
        packageUpdated?: boolean;
        packageVersionCreateRequestResult: PackageVersionCreateRequestResult;
        timeRemaining?: Duration;
    }

    Settings

    Member Visibility
    +PackageVersionCreateEventData | @salesforce/packaging

    Type Alias PackageVersionCreateEventData

    PackageVersionCreateEventData: {
        id: string;
        message?: string;
        packageUpdated?: boolean;
        packageVersionCreateRequestResult: PackageVersionCreateRequestResult;
        timeRemaining?: Duration;
    }

    Settings

    Member Visibility
    diff --git a/types/interfaces_packagingInterfacesAndType.PackageVersionCreateOptions.html b/types/interfaces_packagingInterfacesAndType.PackageVersionCreateOptions.html index 2bede447a..3c4eec1d9 100644 --- a/types/interfaces_packagingInterfacesAndType.PackageVersionCreateOptions.html +++ b/types/interfaces_packagingInterfacesAndType.PackageVersionCreateOptions.html @@ -1 +1 @@ -PackageVersionCreateOptions | @salesforce/packaging

    Type Alias PackageVersionCreateOptions

    PackageVersionCreateOptions: {
        connection: Connection;
        project: SfProject;
    } & Partial<{
        asyncvalidation: boolean;
        branch: string;
        buildinstance: string;
        codecoverage: boolean;
        definitionfile: string;
        installationkey: string;
        installationkeybypass: boolean;
        language?: string;
        packageId: string;
        path: string;
        postinstallscript: string;
        postinstallurl: string;
        preserve: boolean;
        profileApi: PackageProfileApi;
        releasenotesurl: string;
        skipancestorcheck: boolean;
        skipvalidation: boolean;
        sourceorg: string;
        tag: string;
        uninstallscript: string;
        validateschema: boolean;
        versiondescription: string;
        versionname: string;
        versionnumber: string;
    }>

    Settings

    Member Visibility
    +PackageVersionCreateOptions | @salesforce/packaging

    Type Alias PackageVersionCreateOptions

    PackageVersionCreateOptions: {
        connection: Connection;
        project: SfProject;
    } & Partial<{
        asyncvalidation: boolean;
        branch: string;
        buildinstance: string;
        codecoverage: boolean;
        definitionfile: string;
        installationkey: string;
        installationkeybypass: boolean;
        language?: string;
        packageId: string;
        path: string;
        postinstallscript: string;
        postinstallurl: string;
        preserve: boolean;
        profileApi: PackageProfileApi;
        releasenotesurl: string;
        skipancestorcheck: boolean;
        skipvalidation: boolean;
        sourceorg: string;
        tag: string;
        uninstallscript: string;
        validateschema: boolean;
        versiondescription: string;
        versionname: string;
        versionnumber: string;
    }>

    Settings

    Member Visibility
    diff --git a/types/interfaces_packagingInterfacesAndType.PackageVersionCreateReportProgress.html b/types/interfaces_packagingInterfacesAndType.PackageVersionCreateReportProgress.html index b2eca2445..270901c70 100644 --- a/types/interfaces_packagingInterfacesAndType.PackageVersionCreateReportProgress.html +++ b/types/interfaces_packagingInterfacesAndType.PackageVersionCreateReportProgress.html @@ -1 +1 @@ -PackageVersionCreateReportProgress | @salesforce/packaging

    Type Alias PackageVersionCreateReportProgress

    PackageVersionCreateReportProgress: PackageVersionCreateRequestResult & {
        remainingWaitTime: Duration;
    }

    Settings

    Member Visibility
    +PackageVersionCreateReportProgress | @salesforce/packaging

    Type Alias PackageVersionCreateReportProgress

    PackageVersionCreateReportProgress: PackageVersionCreateRequestResult & {
        remainingWaitTime: Duration;
    }

    Settings

    Member Visibility
    diff --git a/types/interfaces_packagingInterfacesAndType.PackageVersionCreateRequest.html b/types/interfaces_packagingInterfacesAndType.PackageVersionCreateRequest.html index e0136166b..681a84f1d 100644 --- a/types/interfaces_packagingInterfacesAndType.PackageVersionCreateRequest.html +++ b/types/interfaces_packagingInterfacesAndType.PackageVersionCreateRequest.html @@ -1 +1 @@ -PackageVersionCreateRequest | @salesforce/packaging

    Type Alias PackageVersionCreateRequest

    PackageVersionCreateRequest: {
        AsyncValidation?: boolean;
        Branch?: string;
        CalculateCodeCoverage: boolean;
        InstallKey?: string;
        Instance?: string;
        Language?: string;
        Package2Id: string;
        SkipValidation: boolean;
        SourceOrg?: string;
        Tag?: string;
        VersionInfo: string;
    }

    Settings

    Member Visibility
    +PackageVersionCreateRequest | @salesforce/packaging

    Type Alias PackageVersionCreateRequest

    PackageVersionCreateRequest: {
        AsyncValidation?: boolean;
        Branch?: string;
        CalculateCodeCoverage: boolean;
        InstallKey?: string;
        Instance?: string;
        Language?: string;
        Package2Id: string;
        SkipValidation: boolean;
        SourceOrg?: string;
        Tag?: string;
        VersionInfo: string;
    }

    Settings

    Member Visibility
    diff --git a/types/interfaces_packagingInterfacesAndType.PackageVersionCreateRequestError.html b/types/interfaces_packagingInterfacesAndType.PackageVersionCreateRequestError.html index 6cf478528..d6a370a51 100644 --- a/types/interfaces_packagingInterfacesAndType.PackageVersionCreateRequestError.html +++ b/types/interfaces_packagingInterfacesAndType.PackageVersionCreateRequestError.html @@ -1 +1 @@ -PackageVersionCreateRequestError | @salesforce/packaging

    Type Alias PackageVersionCreateRequestError

    PackageVersionCreateRequestError: {
        Message: string;
    }

    Settings

    Member Visibility
    +PackageVersionCreateRequestError | @salesforce/packaging

    Type Alias PackageVersionCreateRequestError

    PackageVersionCreateRequestError: {
        Message: string;
    }

    Settings

    Member Visibility
    diff --git a/types/interfaces_packagingInterfacesAndType.PackageVersionCreateRequestOptions.html b/types/interfaces_packagingInterfacesAndType.PackageVersionCreateRequestOptions.html index 10addb99b..53034d420 100644 --- a/types/interfaces_packagingInterfacesAndType.PackageVersionCreateRequestOptions.html +++ b/types/interfaces_packagingInterfacesAndType.PackageVersionCreateRequestOptions.html @@ -1 +1 @@ -PackageVersionCreateRequestOptions | @salesforce/packaging

    Type Alias PackageVersionCreateRequestOptions

    PackageVersionCreateRequestOptions: {
        branch?: string;
        codecoverage?: boolean;
        definitionfile?: string;
        path: string;
        preserve: boolean;
        skipancestorcheck?: boolean;
    }

    Settings

    Member Visibility
    +PackageVersionCreateRequestOptions | @salesforce/packaging

    Type Alias PackageVersionCreateRequestOptions

    PackageVersionCreateRequestOptions: {
        branch?: string;
        codecoverage?: boolean;
        definitionfile?: string;
        path: string;
        preserve: boolean;
        skipancestorcheck?: boolean;
    }

    Settings

    Member Visibility
    diff --git a/types/interfaces_packagingInterfacesAndType.PackageVersionCreateRequestQueryOptions.html b/types/interfaces_packagingInterfacesAndType.PackageVersionCreateRequestQueryOptions.html index 828553a64..fc6252b3c 100644 --- a/types/interfaces_packagingInterfacesAndType.PackageVersionCreateRequestQueryOptions.html +++ b/types/interfaces_packagingInterfacesAndType.PackageVersionCreateRequestQueryOptions.html @@ -1 +1 @@ -PackageVersionCreateRequestQueryOptions | @salesforce/packaging

    Type Alias PackageVersionCreateRequestQueryOptions

    PackageVersionCreateRequestQueryOptions: {
        createdlastdays?: number;
        id?: string;
        showConversionsOnly?: boolean;
        status?:
            | "Queued"
            | "InProgress"
            | "Success"
            | "Error";
    }

    Settings

    Member Visibility
    +PackageVersionCreateRequestQueryOptions | @salesforce/packaging

    Type Alias PackageVersionCreateRequestQueryOptions

    PackageVersionCreateRequestQueryOptions: {
        createdlastdays?: number;
        id?: string;
        showConversionsOnly?: boolean;
        status?:
            | "Queued"
            | "InProgress"
            | "Success"
            | "Error";
    }

    Settings

    Member Visibility
    diff --git a/types/interfaces_packagingInterfacesAndType.PackageVersionCreateRequestResult.html b/types/interfaces_packagingInterfacesAndType.PackageVersionCreateRequestResult.html index 65af55998..be2e8b189 100644 --- a/types/interfaces_packagingInterfacesAndType.PackageVersionCreateRequestResult.html +++ b/types/interfaces_packagingInterfacesAndType.PackageVersionCreateRequestResult.html @@ -1 +1 @@ -PackageVersionCreateRequestResult | @salesforce/packaging

    Type Alias PackageVersionCreateRequestResult

    PackageVersionCreateRequestResult: {
        Branch: string;
        CodeCoverage: number | null;
        ConvertedFromVersionId: string | null;
        CreatedBy: string;
        CreatedDate: string;
        Error: any[];
        HasMetadataRemoved: boolean | null;
        HasPassedCodeCoverageCheck: boolean | null;
        Id: string;
        Package2Id: string;
        Package2Name: string | null;
        Package2VersionId: string;
        Status: Package2VersionStatus;
        SubscriberPackageVersionId: string | null;
        Tag: string;
        VersionNumber: string | null;
    }

    Settings

    Member Visibility
    +PackageVersionCreateRequestResult | @salesforce/packaging

    Type Alias PackageVersionCreateRequestResult

    PackageVersionCreateRequestResult: {
        Branch: string;
        CodeCoverage: number | null;
        ConvertedFromVersionId: string | null;
        CreatedBy: string;
        CreatedDate: string;
        Error: any[];
        HasMetadataRemoved: boolean | null;
        HasPassedCodeCoverageCheck: boolean | null;
        Id: string;
        Package2Id: string;
        Package2Name: string | null;
        Package2VersionId: string;
        Status: Package2VersionStatus;
        SubscriberPackageVersionId: string | null;
        Tag: string;
        VersionNumber: string | null;
    }

    Settings

    Member Visibility
    diff --git a/types/interfaces_packagingInterfacesAndType.PackageVersionListOptions.html b/types/interfaces_packagingInterfacesAndType.PackageVersionListOptions.html index 869bb21ec..de5e17cd8 100644 --- a/types/interfaces_packagingInterfacesAndType.PackageVersionListOptions.html +++ b/types/interfaces_packagingInterfacesAndType.PackageVersionListOptions.html @@ -1 +1 @@ -PackageVersionListOptions | @salesforce/packaging

    Type Alias PackageVersionListOptions

    PackageVersionListOptions: {
        branch?: string;
        concise?: boolean;
        createdLastDays?: number;
        isReleased?: boolean;
        modifiedLastDays?: number;
        orderBy?: string;
        packages?: string[];
        showConversionsOnly?: boolean;
        verbose?: boolean;
    }

    Settings

    Member Visibility
    +PackageVersionListOptions | @salesforce/packaging

    Type Alias PackageVersionListOptions

    PackageVersionListOptions: {
        branch?: string;
        concise?: boolean;
        createdLastDays?: number;
        isReleased?: boolean;
        modifiedLastDays?: number;
        orderBy?: string;
        packages?: string[];
        showConversionsOnly?: boolean;
        verbose?: boolean;
    }

    Settings

    Member Visibility
    diff --git a/types/interfaces_packagingInterfacesAndType.PackageVersionListResult.html b/types/interfaces_packagingInterfacesAndType.PackageVersionListResult.html index 707647d3b..3b62130ee 100644 --- a/types/interfaces_packagingInterfacesAndType.PackageVersionListResult.html +++ b/types/interfaces_packagingInterfacesAndType.PackageVersionListResult.html @@ -1 +1 @@ -PackageVersionListResult | @salesforce/packaging

    Type Alias PackageVersionListResult

    PackageVersionListResult: {
        AncestorId: string;
        Branch: string;
        BuildDurationInSeconds?: number;
        BuildNumber: string;
        CodeCoverage?: {
            apexCodeCoveragePercentage: number;
            [key: string]: unknown;
        };
        ConvertedFromVersionId?: string;
        CreatedById: string;
        CreatedDate: string;
        Description: string;
        HasMetadataRemoved?: boolean;
        HasPassedCodeCoverageCheck?: boolean;
        Id: string;
        IsPasswordProtected: boolean;
        IsReleased: boolean;
        Language?: string;
        LastModifiedDate: string;
        MajorVersion: string;
        MinorVersion: string;
        Name: string;
        Package2: {
            IsOrgDependent?: boolean;
            Name: string;
            NamespacePrefix: string;
            [key: string]: unknown;
        };
        Package2Id: string;
        PatchVersion: string;
        ReleaseVersion?: string;
        SubscriberPackageVersionId: string;
        Tag: string;
        ValidatedAsync?: boolean;
        ValidationSkipped: boolean;
    }

    Settings

    Member Visibility
    +PackageVersionListResult | @salesforce/packaging

    Type Alias PackageVersionListResult

    PackageVersionListResult: {
        AncestorId: string;
        Branch: string;
        BuildDurationInSeconds?: number;
        BuildNumber: string;
        CodeCoverage?: {
            apexCodeCoveragePercentage: number;
            [key: string]: unknown;
        };
        ConvertedFromVersionId?: string;
        CreatedById: string;
        CreatedDate: string;
        Description: string;
        HasMetadataRemoved?: boolean;
        HasPassedCodeCoverageCheck?: boolean;
        Id: string;
        IsPasswordProtected: boolean;
        IsReleased: boolean;
        Language?: string;
        LastModifiedDate: string;
        MajorVersion: string;
        MinorVersion: string;
        Name: string;
        Package2: {
            IsOrgDependent?: boolean;
            Name: string;
            NamespacePrefix: string;
            [key: string]: unknown;
        };
        Package2Id: string;
        PatchVersion: string;
        ReleaseVersion?: string;
        SubscriberPackageVersionId: string;
        Tag: string;
        ValidatedAsync?: boolean;
        ValidationSkipped: boolean;
    }

    Settings

    Member Visibility
    diff --git a/types/interfaces_packagingInterfacesAndType.PackageVersionMetadataDownloadOptions.html b/types/interfaces_packagingInterfacesAndType.PackageVersionMetadataDownloadOptions.html index 1dd2767d3..7448708c6 100644 --- a/types/interfaces_packagingInterfacesAndType.PackageVersionMetadataDownloadOptions.html +++ b/types/interfaces_packagingInterfacesAndType.PackageVersionMetadataDownloadOptions.html @@ -1 +1 @@ -PackageVersionMetadataDownloadOptions | @salesforce/packaging

    Type Alias PackageVersionMetadataDownloadOptions

    PackageVersionMetadataDownloadOptions: {
        destinationFolder?: string;
        subscriberPackageVersionId: string;
    }

    Settings

    Member Visibility
    +PackageVersionMetadataDownloadOptions | @salesforce/packaging

    Type Alias PackageVersionMetadataDownloadOptions

    PackageVersionMetadataDownloadOptions: {
        destinationFolder?: string;
        subscriberPackageVersionId: string;
    }

    Settings

    Member Visibility
    diff --git a/types/interfaces_packagingInterfacesAndType.PackageVersionMetadataDownloadResult.html b/types/interfaces_packagingInterfacesAndType.PackageVersionMetadataDownloadResult.html index e91255ae4..36f7ad5d7 100644 --- a/types/interfaces_packagingInterfacesAndType.PackageVersionMetadataDownloadResult.html +++ b/types/interfaces_packagingInterfacesAndType.PackageVersionMetadataDownloadResult.html @@ -1 +1 @@ -PackageVersionMetadataDownloadResult | @salesforce/packaging

    Type Alias PackageVersionMetadataDownloadResult

    PackageVersionMetadataDownloadResult: ConvertResult

    Settings

    Member Visibility
    +PackageVersionMetadataDownloadResult | @salesforce/packaging

    Type Alias PackageVersionMetadataDownloadResult

    PackageVersionMetadataDownloadResult: ConvertResult

    Settings

    Member Visibility
    diff --git a/types/interfaces_packagingInterfacesAndType.PackageVersionOptions.html b/types/interfaces_packagingInterfacesAndType.PackageVersionOptions.html index 8c9fde3ea..65575beba 100644 --- a/types/interfaces_packagingInterfacesAndType.PackageVersionOptions.html +++ b/types/interfaces_packagingInterfacesAndType.PackageVersionOptions.html @@ -4,4 +4,4 @@
  • PackageVersionId (05i)
  • Alias for a 04t or 05i, defined in sfdx-project.json
    • -
  • Optionalproject?: SfProject

    • Settings

    Member Visibility
    +
  • Optionalproject?: SfProject

    • Settings

    Member Visibility
    diff --git a/types/interfaces_packagingInterfacesAndType.PackageVersionOptions1GP.html b/types/interfaces_packagingInterfacesAndType.PackageVersionOptions1GP.html index 474e13ecf..4ed9e96da 100644 --- a/types/interfaces_packagingInterfacesAndType.PackageVersionOptions1GP.html +++ b/types/interfaces_packagingInterfacesAndType.PackageVersionOptions1GP.html @@ -1 +1 @@ -PackageVersionOptions1GP | @salesforce/packaging

    Type Alias PackageVersionOptions1GP

    PackageVersionOptions1GP: Record<string, unknown>

    Settings

    Member Visibility
    +PackageVersionOptions1GP | @salesforce/packaging

    Type Alias PackageVersionOptions1GP

    PackageVersionOptions1GP: Record<string, unknown>

    Settings

    Member Visibility
    diff --git a/types/interfaces_packagingInterfacesAndType.PackageVersionReportResult.html b/types/interfaces_packagingInterfacesAndType.PackageVersionReportResult.html index c97232628..68557d859 100644 --- a/types/interfaces_packagingInterfacesAndType.PackageVersionReportResult.html +++ b/types/interfaces_packagingInterfacesAndType.PackageVersionReportResult.html @@ -1 +1 @@ -PackageVersionReportResult | @salesforce/packaging

    Type Alias PackageVersionReportResult

    PackageVersionReportResult: Partial<Omit<Package2Version, "AncestorId" | "HasPassedCodeCoverageCheck" | "HasMetadataRemoved">> & {
        AncestorId?: string | null;
        AncestorVersion?: string | null;
        HasMetadataRemoved?: boolean | null;
        HasPassedCodeCoverageCheck?: boolean | null;
        Package2: Partial<Omit<Package2, "IsOrgDependent">> & {
            IsOrgDependent: boolean | null | undefined;
        };
        PackageType?: PackageType | null;
        SubscriberPackageVersion?: Pick<PackagingSObjects.SubscriberPackageVersion, "Dependencies">;
        Version: string;
    }

    Settings

    Member Visibility
    +PackageVersionReportResult | @salesforce/packaging

    Type Alias PackageVersionReportResult

    PackageVersionReportResult: Partial<Omit<Package2Version, "AncestorId" | "HasPassedCodeCoverageCheck" | "HasMetadataRemoved">> & {
        AncestorId?: string | null;
        AncestorVersion?: string | null;
        HasMetadataRemoved?: boolean | null;
        HasPassedCodeCoverageCheck?: boolean | null;
        Package2: Partial<Omit<Package2, "IsOrgDependent">> & {
            IsOrgDependent: boolean | null | undefined;
        };
        PackageType?: PackageType | null;
        SubscriberPackageVersion?: Pick<PackagingSObjects.SubscriberPackageVersion, "Dependencies">;
        Version: string;
    }

    Settings

    Member Visibility
    diff --git a/types/interfaces_packagingInterfacesAndType.PackageVersionUpdateOptions.html b/types/interfaces_packagingInterfacesAndType.PackageVersionUpdateOptions.html index cc0229fde..0ea677850 100644 --- a/types/interfaces_packagingInterfacesAndType.PackageVersionUpdateOptions.html +++ b/types/interfaces_packagingInterfacesAndType.PackageVersionUpdateOptions.html @@ -1 +1 @@ -PackageVersionUpdateOptions | @salesforce/packaging

    Type Alias PackageVersionUpdateOptions

    PackageVersionUpdateOptions: {
        Branch?: string;
        InstallKey?: string;
        Tag?: string;
        VersionDescription?: string;
        VersionName?: string;
    }

    Settings

    Member Visibility
    +PackageVersionUpdateOptions | @salesforce/packaging

    Type Alias PackageVersionUpdateOptions

    PackageVersionUpdateOptions: {
        Branch?: string;
        InstallKey?: string;
        Tag?: string;
        VersionDescription?: string;
        VersionName?: string;
    }

    Settings

    Member Visibility
    diff --git a/types/interfaces_packagingInterfacesAndType.PackageXml.html b/types/interfaces_packagingInterfacesAndType.PackageXml.html index bb17f978a..33aba88bc 100644 --- a/types/interfaces_packagingInterfacesAndType.PackageXml.html +++ b/types/interfaces_packagingInterfacesAndType.PackageXml.html @@ -1 +1 @@ -PackageXml | @salesforce/packaging

    Type Alias PackageXml

    PackageXml: Pick<Package, "types" | "version">

    Settings

    Member Visibility
    +PackageXml | @salesforce/packaging

    Type Alias PackageXml

    PackageXml: Pick<Package, "types" | "version">

    Settings

    Member Visibility
    diff --git a/types/interfaces_packagingInterfacesAndType.ProfileApiOptions.html b/types/interfaces_packagingInterfacesAndType.ProfileApiOptions.html index 6e2d0865b..11987b578 100644 --- a/types/interfaces_packagingInterfacesAndType.ProfileApiOptions.html +++ b/types/interfaces_packagingInterfacesAndType.ProfileApiOptions.html @@ -1 +1 @@ -ProfileApiOptions | @salesforce/packaging

    Type Alias ProfileApiOptions

    ProfileApiOptions: {
        includeUserLicenses: boolean;
        project: SfProject;
    }

    Settings

    Member Visibility
    +ProfileApiOptions | @salesforce/packaging

    Type Alias ProfileApiOptions

    ProfileApiOptions: {
        includeUserLicenses: boolean;
        project: SfProject;
    }

    Settings

    Member Visibility
    diff --git a/types/interfaces_packagingInterfacesAndType.SubscriberPackageVersionOptions.html b/types/interfaces_packagingInterfacesAndType.SubscriberPackageVersionOptions.html index d1f6f4625..4fd7a11ab 100644 --- a/types/interfaces_packagingInterfacesAndType.SubscriberPackageVersionOptions.html +++ b/types/interfaces_packagingInterfacesAndType.SubscriberPackageVersionOptions.html @@ -1 +1 @@ -SubscriberPackageVersionOptions | @salesforce/packaging

    Type Alias SubscriberPackageVersionOptions

    SubscriberPackageVersionOptions: {
        aliasOrId: string;
        connection: Connection;
        password: Optional<string>;
    }

    Settings

    Member Visibility
    +SubscriberPackageVersionOptions | @salesforce/packaging

    Type Alias SubscriberPackageVersionOptions

    SubscriberPackageVersionOptions: {
        aliasOrId: string;
        connection: Connection;
        password: Optional<string>;
    }

    Settings

    Member Visibility
    diff --git a/types/interfaces_packagingSObjects.PackagingSObjects.Attributes.html b/types/interfaces_packagingSObjects.PackagingSObjects.Attributes.html index 054bd874b..b719d2d88 100644 --- a/types/interfaces_packagingSObjects.PackagingSObjects.Attributes.html +++ b/types/interfaces_packagingSObjects.PackagingSObjects.Attributes.html @@ -1 +1 @@ -Attributes | @salesforce/packaging

    Type Alias Attributes

    Attributes: {
        type: string;
        url: string;
    }

    Settings

    Member Visibility
    +Attributes | @salesforce/packaging

    Type Alias Attributes

    Attributes: {
        type: string;
        url: string;
    }

    Settings

    Member Visibility
    diff --git a/types/interfaces_packagingSObjects.PackagingSObjects.InstallValidationStatus.html b/types/interfaces_packagingSObjects.PackagingSObjects.InstallValidationStatus.html index 7d15d4156..c99d1a34a 100644 --- a/types/interfaces_packagingSObjects.PackagingSObjects.InstallValidationStatus.html +++ b/types/interfaces_packagingSObjects.PackagingSObjects.InstallValidationStatus.html @@ -1 +1 @@ -InstallValidationStatus | @salesforce/packaging

    Type Alias InstallValidationStatus

    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"

    Settings

    Member Visibility
    +InstallValidationStatus | @salesforce/packaging

    Type Alias InstallValidationStatus

    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"

    Settings

    Member Visibility
    diff --git a/types/interfaces_packagingSObjects.PackagingSObjects.InstalledSubscriberPackage.html b/types/interfaces_packagingSObjects.PackagingSObjects.InstalledSubscriberPackage.html index 8e70b0858..55676e950 100644 --- a/types/interfaces_packagingSObjects.PackagingSObjects.InstalledSubscriberPackage.html +++ b/types/interfaces_packagingSObjects.PackagingSObjects.InstalledSubscriberPackage.html @@ -1 +1 @@ -InstalledSubscriberPackage | @salesforce/packaging

    Type Alias InstalledSubscriberPackage

    InstalledSubscriberPackage: {
        Id: string;
        MinPackageVersionId: string;
        SubscriberPackageId: string;
        SubscriberPackageVersionId: string;
    }

    Settings

    Member Visibility
    +InstalledSubscriberPackage | @salesforce/packaging

    Type Alias InstalledSubscriberPackage

    InstalledSubscriberPackage: {
        Id: string;
        MinPackageVersionId: string;
        SubscriberPackageId: string;
        SubscriberPackageVersionId: string;
    }

    Settings

    Member Visibility
    diff --git a/types/interfaces_packagingSObjects.PackagingSObjects.InstalledSubscriberPackageVersion.html b/types/interfaces_packagingSObjects.PackagingSObjects.InstalledSubscriberPackageVersion.html index b26b72fc1..b9d39b357 100644 --- a/types/interfaces_packagingSObjects.PackagingSObjects.InstalledSubscriberPackageVersion.html +++ b/types/interfaces_packagingSObjects.PackagingSObjects.InstalledSubscriberPackageVersion.html @@ -1 +1 @@ -InstalledSubscriberPackageVersion | @salesforce/packaging

    Type Alias InstalledSubscriberPackageVersion

    InstalledSubscriberPackageVersion: {
        AppExchangeDescription: string;
        AppExchangeLogoUrl: string;
        AppExchangePackageName: string;
        AppExchangePublisherName: string;
        BuildNumber: number;
        CspTrustedSites: unknown;
        Dependencies: unknown;
        Description: string;
        Id: string;
        InstallValidationStatus: string;
        IsBeta: boolean;
        IsDeprecated: boolean;
        IsManaged: boolean;
        IsOrgDependent: boolean;
        IsPasswordProtected: boolean;
        IsSecurityReviewed: boolean;
        MajorVersion: number;
        MinorVersion: number;
        Name: string;
        Package2ContainerOptions: string;
        PatchVersion: number;
        PostInstallUrl: string;
        Profiles: unknown;
        PublisherName: string;
        ReleaseNotesUrl: string;
        ReleaseState: string;
        RemoteSiteSettings: unknown;
        SubscriberPackageId: string;
    }

    Settings

    Member Visibility
    +InstalledSubscriberPackageVersion | @salesforce/packaging

    Type Alias InstalledSubscriberPackageVersion

    InstalledSubscriberPackageVersion: {
        AppExchangeDescription: string;
        AppExchangeLogoUrl: string;
        AppExchangePackageName: string;
        AppExchangePublisherName: string;
        BuildNumber: number;
        CspTrustedSites: unknown;
        Dependencies: unknown;
        Description: string;
        Id: string;
        InstallValidationStatus: string;
        IsBeta: boolean;
        IsDeprecated: boolean;
        IsManaged: boolean;
        IsOrgDependent: boolean;
        IsPasswordProtected: boolean;
        IsSecurityReviewed: boolean;
        MajorVersion: number;
        MinorVersion: number;
        Name: string;
        Package2ContainerOptions: string;
        PatchVersion: number;
        PostInstallUrl: string;
        Profiles: unknown;
        PublisherName: string;
        ReleaseNotesUrl: string;
        ReleaseState: string;
        RemoteSiteSettings: unknown;
        SubscriberPackageId: string;
    }

    Settings

    Member Visibility
    diff --git a/types/interfaces_packagingSObjects.PackagingSObjects.MetadataPackage.html b/types/interfaces_packagingSObjects.PackagingSObjects.MetadataPackage.html index f4888c9b4..f33fe0262 100644 --- a/types/interfaces_packagingSObjects.PackagingSObjects.MetadataPackage.html +++ b/types/interfaces_packagingSObjects.PackagingSObjects.MetadataPackage.html @@ -1 +1 @@ -MetadataPackage | @salesforce/packaging

    Type Alias MetadataPackage

    MetadataPackage: {
        Id: string;
        Name: string;
        NamespacePrefix: string;
        PackageCategory:
            | "Application"
            | "Module"
            | "Package"
            | "Package2";
    }

    Settings

    Member Visibility
    +MetadataPackage | @salesforce/packaging

    Type Alias MetadataPackage

    MetadataPackage: {
        Id: string;
        Name: string;
        NamespacePrefix: string;
        PackageCategory:
            | "Application"
            | "Module"
            | "Package"
            | "Package2";
    }

    Settings

    Member Visibility
    diff --git a/types/interfaces_packagingSObjects.PackagingSObjects.MetadataPackageVersion.html b/types/interfaces_packagingSObjects.PackagingSObjects.MetadataPackageVersion.html index e386803ef..efd44b397 100644 --- a/types/interfaces_packagingSObjects.PackagingSObjects.MetadataPackageVersion.html +++ b/types/interfaces_packagingSObjects.PackagingSObjects.MetadataPackageVersion.html @@ -1 +1 @@ -MetadataPackageVersion | @salesforce/packaging

    Type Alias MetadataPackageVersion

    MetadataPackageVersion: {
        BuildNumber: number;
        Id: string;
        IsDeprecated: boolean;
        MajorVersion: number;
        MetadataPackageId: string;
        MetadataZip?: string;
        MinorVersion: number;
        Name: string;
        PatchVersion: number;
        ReleaseState: "Beta" | "Released";
    }

    Settings

    Member Visibility
    +MetadataPackageVersion | @salesforce/packaging

    Type Alias MetadataPackageVersion

    MetadataPackageVersion: {
        BuildNumber: number;
        Id: string;
        IsDeprecated: boolean;
        MajorVersion: number;
        MetadataPackageId: string;
        MetadataZip?: string;
        MinorVersion: number;
        Name: string;
        PatchVersion: number;
        ReleaseState: "Beta" | "Released";
    }

    Settings

    Member Visibility
    diff --git a/types/interfaces_packagingSObjects.PackagingSObjects.Package2.html b/types/interfaces_packagingSObjects.PackagingSObjects.Package2.html index 25761e692..8312aaa1e 100644 --- a/types/interfaces_packagingSObjects.PackagingSObjects.Package2.html +++ b/types/interfaces_packagingSObjects.PackagingSObjects.Package2.html @@ -1 +1 @@ -Package2 | @salesforce/packaging

    Type Alias Package2

    Package2: {
        AppAnalyticsEnabled?: boolean;
        ContainerOptions: PackageType;
        ConvertedFromPackageId: string;
        CreatedById: string;
        CreatedDate: number;
        Description: string;
        Id: string;
        IsDeleted: boolean;
        IsDeprecated: boolean;
        IsOrgDependent: boolean;
        LastModifiedById: string;
        LastModifiedDate: number;
        Name: string;
        NamespacePrefix: string;
        PackageErrorUsername: string;
        SubscriberPackageId: string;
        SystemModstamp: number;
    }

    Settings

    Member Visibility
    +Package2 | @salesforce/packaging

    Type Alias Package2

    Package2: {
        AppAnalyticsEnabled?: boolean;
        ContainerOptions: PackageType;
        ConvertedFromPackageId: string;
        CreatedById: string;
        CreatedDate: number;
        Description: string;
        Id: string;
        IsDeleted: boolean;
        IsDeprecated: boolean;
        IsOrgDependent: boolean;
        LastModifiedById: string;
        LastModifiedDate: number;
        Name: string;
        NamespacePrefix: string;
        PackageErrorUsername: string;
        SubscriberPackageId: string;
        SystemModstamp: number;
    }

    Settings

    Member Visibility
    diff --git a/types/interfaces_packagingSObjects.PackagingSObjects.Package2Version.html b/types/interfaces_packagingSObjects.PackagingSObjects.Package2Version.html index e2eb1c277..a2349c537 100644 --- a/types/interfaces_packagingSObjects.PackagingSObjects.Package2Version.html +++ b/types/interfaces_packagingSObjects.PackagingSObjects.Package2Version.html @@ -1 +1 @@ -Package2Version | @salesforce/packaging

    Type Alias Package2Version

    Package2Version: {
        AncestorId: string;
        Branch: string;
        BuildDurationInSeconds: number;
        BuildNumber: number;
        CodeCoverage: CodeCoverage;
        CodeCoveragePercentages: CodeCoveragePercentages;
        ConvertedFromVersionId: string;
        CreatedById: string;
        CreatedDate: number;
        Description: string;
        EndToEndBuildDurationInSeconds?: number;
        HasMetadataRemoved: boolean;
        HasPassedCodeCoverageCheck: boolean;
        Id: string;
        InstallKey: string;
        IsDeleted: boolean;
        IsDeprecated: boolean;
        IsPasswordProtected: boolean;
        IsReleased: boolean;
        Language: string;
        LastModifiedById: string;
        LastModifiedDate: number;
        MajorVersion: number;
        MinorVersion: number;
        Name: string;
        Package2Id: string;
        PatchVersion: number;
        ReleaseVersion: number;
        SubscriberPackageVersionId: string;
        SystemModstamp: number;
        Tag: string;
        ValidatedAsync?: boolean;
        ValidationSkipped: boolean;
    }

    Settings

    Member Visibility
    +Package2Version | @salesforce/packaging

    Type Alias Package2Version

    Package2Version: {
        AncestorId: string;
        Branch: string;
        BuildDurationInSeconds: number;
        BuildNumber: number;
        CodeCoverage: CodeCoverage;
        CodeCoveragePercentages: CodeCoveragePercentages;
        ConvertedFromVersionId: string;
        CreatedById: string;
        CreatedDate: number;
        Description: string;
        EndToEndBuildDurationInSeconds?: number;
        HasMetadataRemoved: boolean;
        HasPassedCodeCoverageCheck: boolean;
        Id: string;
        InstallKey: string;
        IsDeleted: boolean;
        IsDeprecated: boolean;
        IsPasswordProtected: boolean;
        IsReleased: boolean;
        Language: string;
        LastModifiedById: string;
        LastModifiedDate: number;
        MajorVersion: number;
        MinorVersion: number;
        Name: string;
        Package2Id: string;
        PatchVersion: number;
        ReleaseVersion: number;
        SubscriberPackageVersionId: string;
        SystemModstamp: number;
        Tag: string;
        ValidatedAsync?: boolean;
        ValidationSkipped: boolean;
    }

    Settings

    Member Visibility
    diff --git a/types/interfaces_packagingSObjects.PackagingSObjects.Package2VersionCreateRequest.html b/types/interfaces_packagingSObjects.PackagingSObjects.Package2VersionCreateRequest.html index 655a2f574..af9ba5fe8 100644 --- a/types/interfaces_packagingSObjects.PackagingSObjects.Package2VersionCreateRequest.html +++ b/types/interfaces_packagingSObjects.PackagingSObjects.Package2VersionCreateRequest.html @@ -1 +1 @@ -Package2VersionCreateRequest | @salesforce/packaging

    Type Alias Package2VersionCreateRequest

    Package2VersionCreateRequest: {
        Branch: string;
        CalculateCodeCoverage: boolean;
        CreatedById: string;
        CreatedDate: number;
        Id: string;
        InstallKey: string;
        Instance: string;
        IsConversionRequest: boolean;
        IsDeleted: boolean;
        IsPasswordProtected: boolean;
        Language: string;
        LastModifiedById: string;
        LastModifiedDate: number;
        Package2Id: string;
        Package2VersionId: string;
        SkipValidation: boolean;
        Status: Package2VersionStatus;
        SystemModstamp: number;
        Tag: string;
        VersionInfo: string;
    }

    Settings

    Member Visibility
    +Package2VersionCreateRequest | @salesforce/packaging

    Type Alias Package2VersionCreateRequest

    Package2VersionCreateRequest: {
        Branch: string;
        CalculateCodeCoverage: boolean;
        CreatedById: string;
        CreatedDate: number;
        Id: string;
        InstallKey: string;
        Instance: string;
        IsConversionRequest: boolean;
        IsDeleted: boolean;
        IsPasswordProtected: boolean;
        Language: string;
        LastModifiedById: string;
        LastModifiedDate: number;
        Package2Id: string;
        Package2VersionId: string;
        SkipValidation: boolean;
        Status: Package2VersionStatus;
        SystemModstamp: number;
        Tag: string;
        VersionInfo: string;
    }

    Settings

    Member Visibility
    diff --git a/types/interfaces_packagingSObjects.PackagingSObjects.Package2VersionCreateRequestError.html b/types/interfaces_packagingSObjects.PackagingSObjects.Package2VersionCreateRequestError.html index 8565328fc..1bd77f532 100644 --- a/types/interfaces_packagingSObjects.PackagingSObjects.Package2VersionCreateRequestError.html +++ b/types/interfaces_packagingSObjects.PackagingSObjects.Package2VersionCreateRequestError.html @@ -1 +1 @@ -Package2VersionCreateRequestError | @salesforce/packaging

    Type Alias Package2VersionCreateRequestError

    Package2VersionCreateRequestError: {
        CreatedById: string;
        CreatedDate: number;
        Id: string;
        IsDeleted: boolean;
        LastModifiedById: string;
        LastModifiedDate: number;
        Message: string;
        ParentRequestId: string;
        SystemModstamp: number;
    }

    Settings

    Member Visibility
    +Package2VersionCreateRequestError | @salesforce/packaging

    Type Alias Package2VersionCreateRequestError

    Package2VersionCreateRequestError: {
        CreatedById: string;
        CreatedDate: number;
        Id: string;
        IsDeleted: boolean;
        LastModifiedById: string;
        LastModifiedDate: number;
        Message: string;
        ParentRequestId: string;
        SystemModstamp: number;
    }

    Settings

    Member Visibility
    diff --git a/types/interfaces_packagingSObjects.PackagingSObjects.PackageInstallRequest.html b/types/interfaces_packagingSObjects.PackagingSObjects.PackageInstallRequest.html index 1393bc78a..f07e468b0 100644 --- a/types/interfaces_packagingSObjects.PackagingSObjects.PackageInstallRequest.html +++ b/types/interfaces_packagingSObjects.PackagingSObjects.PackageInstallRequest.html @@ -1 +1 @@ -PackageInstallRequest | @salesforce/packaging

    Type Alias PackageInstallRequest

    PackageInstallRequest: {
        ApexCompileType: Nullable<"all" | "package">;
        CreatedById: string;
        CreatedDate: string;
        EnableRss: boolean;
        Errors: Nullable<SubscriberPackageInstallErrors>;
        Id: string;
        IsDeleted: boolean;
        LastModifiedById: string;
        LastModifiedDate: string;
        NameConflictResolution: "Block" | "RenameMetadata";
        PackageInstallSource: string;
        Password: Nullable<string>;
        ProfileMappings: Nullable<SubscriberPackageProfileMappings>;
        SecurityType: "Custom" | "Full" | "None";
        SkipHandlers: Nullable<string>;
        Status:
            | "ERROR"
            | "IN_PROGRESS"
            | "SUCCESS"
            | "UNKNOWN";
        SubscriberPackageVersionKey: string;
        SystemModstamp: string;
        UpgradeType: Nullable<"delete-only" | "deprecate-only" | "mixed-mode">;
        attributes: Attributes;
    }

    Settings

    Member Visibility
    +PackageInstallRequest | @salesforce/packaging

    Type Alias PackageInstallRequest

    PackageInstallRequest: {
        ApexCompileType: Nullable<"all" | "package">;
        CreatedById: string;
        CreatedDate: string;
        EnableRss: boolean;
        Errors: Nullable<SubscriberPackageInstallErrors>;
        Id: string;
        IsDeleted: boolean;
        LastModifiedById: string;
        LastModifiedDate: string;
        NameConflictResolution: "Block" | "RenameMetadata";
        PackageInstallSource: string;
        Password: Nullable<string>;
        ProfileMappings: Nullable<SubscriberPackageProfileMappings>;
        SecurityType: "Custom" | "Full" | "None";
        SkipHandlers: Nullable<string>;
        Status:
            | "ERROR"
            | "IN_PROGRESS"
            | "SUCCESS"
            | "UNKNOWN";
        SubscriberPackageVersionKey: string;
        SystemModstamp: string;
        UpgradeType: Nullable<"delete-only" | "deprecate-only" | "mixed-mode">;
        attributes: Attributes;
    }

    Settings

    Member Visibility
    diff --git a/types/interfaces_packagingSObjects.PackagingSObjects.PackageUploadRequest.html b/types/interfaces_packagingSObjects.PackagingSObjects.PackageUploadRequest.html index af3477906..c3c523600 100644 --- a/types/interfaces_packagingSObjects.PackagingSObjects.PackageUploadRequest.html +++ b/types/interfaces_packagingSObjects.PackagingSObjects.PackageUploadRequest.html @@ -1 +1 @@ -PackageUploadRequest | @salesforce/packaging

    Type Alias PackageUploadRequest

    PackageUploadRequest: {
        CreatedById: string;
        CreatedDate: number;
        Description: string;
        Errors: any[];
        Id: string;
        IsDeleted: boolean;
        IsReleaseVersion: boolean;
        LastModifiedById: string;
        LastModifiedDate: number;
        MajorVersion: number;
        MetadataPackageId: string;
        MetadataPackageVersionId: string;
        MinorVersion: number;
        Password: string;
        PostInstallUrl: string;
        ReleaseNotesUrl: string;
        Status: string;
        SystemModstamp: number;
        VersionName: string;
    }

    Settings

    Member Visibility
    +PackageUploadRequest | @salesforce/packaging

    Type Alias PackageUploadRequest

    PackageUploadRequest: {
        CreatedById: string;
        CreatedDate: number;
        Description: string;
        Errors: any[];
        Id: string;
        IsDeleted: boolean;
        IsReleaseVersion: boolean;
        LastModifiedById: string;
        LastModifiedDate: number;
        MajorVersion: number;
        MetadataPackageId: string;
        MetadataPackageVersionId: string;
        MinorVersion: number;
        Password: string;
        PostInstallUrl: string;
        ReleaseNotesUrl: string;
        Status: string;
        SystemModstamp: number;
        VersionName: string;
    }

    Settings

    Member Visibility
    diff --git a/types/interfaces_packagingSObjects.PackagingSObjects.PackageVersionUninstallRequestError.html b/types/interfaces_packagingSObjects.PackagingSObjects.PackageVersionUninstallRequestError.html index 0af6e6ba0..beeac152e 100644 --- a/types/interfaces_packagingSObjects.PackagingSObjects.PackageVersionUninstallRequestError.html +++ b/types/interfaces_packagingSObjects.PackagingSObjects.PackageVersionUninstallRequestError.html @@ -1 +1 @@ -PackageVersionUninstallRequestError | @salesforce/packaging

    Type Alias PackageVersionUninstallRequestError

    PackageVersionUninstallRequestError: {
        CreatedById: string;
        CreatedDate: number;
        Id: string;
        IsDeleted: boolean;
        LastModifiedById: string;
        LastModifiedDate: number;
        Status: string;
        SubscriberPackageVersionId: string;
        SystemModstamp: number;
    }

    Settings

    Member Visibility
    +PackageVersionUninstallRequestError | @salesforce/packaging

    Type Alias PackageVersionUninstallRequestError

    PackageVersionUninstallRequestError: {
        CreatedById: string;
        CreatedDate: number;
        Id: string;
        IsDeleted: boolean;
        LastModifiedById: string;
        LastModifiedDate: number;
        Status: string;
        SubscriberPackageVersionId: string;
        SystemModstamp: number;
    }

    Settings

    Member Visibility
    diff --git a/types/interfaces_packagingSObjects.PackagingSObjects.SubscriberPackage.html b/types/interfaces_packagingSObjects.PackagingSObjects.SubscriberPackage.html index e32977b68..9f4df4cbe 100644 --- a/types/interfaces_packagingSObjects.PackagingSObjects.SubscriberPackage.html +++ b/types/interfaces_packagingSObjects.PackagingSObjects.SubscriberPackage.html @@ -1 +1 @@ -SubscriberPackage | @salesforce/packaging

    Type Alias SubscriberPackage

    SubscriberPackage: {
        Description: string;
        Id: string;
        IsPackageValid: boolean;
        Name: string;
        NamespacePrefix: string;
    }

    Settings

    Member Visibility
    +SubscriberPackage | @salesforce/packaging

    Type Alias SubscriberPackage

    SubscriberPackage: {
        Description: string;
        Id: string;
        IsPackageValid: boolean;
        Name: string;
        NamespacePrefix: string;
    }

    Settings

    Member Visibility
    diff --git a/types/interfaces_packagingSObjects.PackagingSObjects.SubscriberPackageCspTrustedSite.html b/types/interfaces_packagingSObjects.PackagingSObjects.SubscriberPackageCspTrustedSite.html index 859aa6c9f..7944de7eb 100644 --- a/types/interfaces_packagingSObjects.PackagingSObjects.SubscriberPackageCspTrustedSite.html +++ b/types/interfaces_packagingSObjects.PackagingSObjects.SubscriberPackageCspTrustedSite.html @@ -1 +1 @@ -SubscriberPackageCspTrustedSite | @salesforce/packaging

    Type Alias SubscriberPackageCspTrustedSite

    SubscriberPackageCspTrustedSite: {
        endpointUrl: string;
    }

    Settings

    Member Visibility
    +SubscriberPackageCspTrustedSite | @salesforce/packaging

    Type Alias SubscriberPackageCspTrustedSite

    SubscriberPackageCspTrustedSite: {
        endpointUrl: string;
    }

    Settings

    Member Visibility
    diff --git a/types/interfaces_packagingSObjects.PackagingSObjects.SubscriberPackageCspTrustedSites.html b/types/interfaces_packagingSObjects.PackagingSObjects.SubscriberPackageCspTrustedSites.html index b085e7ad1..e9461a8b5 100644 --- a/types/interfaces_packagingSObjects.PackagingSObjects.SubscriberPackageCspTrustedSites.html +++ b/types/interfaces_packagingSObjects.PackagingSObjects.SubscriberPackageCspTrustedSites.html @@ -1 +1 @@ -SubscriberPackageCspTrustedSites | @salesforce/packaging

    Type Alias SubscriberPackageCspTrustedSites

    SubscriberPackageCspTrustedSites: {
        settings: SubscriberPackageCspTrustedSite[];
    }

    Settings

    Member Visibility
    +SubscriberPackageCspTrustedSites | @salesforce/packaging

    Type Alias SubscriberPackageCspTrustedSites

    SubscriberPackageCspTrustedSites: {
        settings: SubscriberPackageCspTrustedSite[];
    }

    Settings

    Member Visibility
    diff --git a/types/interfaces_packagingSObjects.PackagingSObjects.SubscriberPackageDependencies.html b/types/interfaces_packagingSObjects.PackagingSObjects.SubscriberPackageDependencies.html index cb9a37a26..d593fdc68 100644 --- a/types/interfaces_packagingSObjects.PackagingSObjects.SubscriberPackageDependencies.html +++ b/types/interfaces_packagingSObjects.PackagingSObjects.SubscriberPackageDependencies.html @@ -1 +1 @@ -SubscriberPackageDependencies | @salesforce/packaging

    Type Alias SubscriberPackageDependencies

    SubscriberPackageDependencies: {
        ids: {
            subscriberPackageVersionId: string;
        }[];
    }

    Settings

    Member Visibility
    +SubscriberPackageDependencies | @salesforce/packaging

    Type Alias SubscriberPackageDependencies

    SubscriberPackageDependencies: {
        ids: {
            subscriberPackageVersionId: string;
        }[];
    }

    Settings

    Member Visibility
    diff --git a/types/interfaces_packagingSObjects.PackagingSObjects.SubscriberPackageDestinationProfile.html b/types/interfaces_packagingSObjects.PackagingSObjects.SubscriberPackageDestinationProfile.html index 5b5cf2018..8147e36b8 100644 --- a/types/interfaces_packagingSObjects.PackagingSObjects.SubscriberPackageDestinationProfile.html +++ b/types/interfaces_packagingSObjects.PackagingSObjects.SubscriberPackageDestinationProfile.html @@ -1 +1 @@ -SubscriberPackageDestinationProfile | @salesforce/packaging

    Type Alias SubscriberPackageDestinationProfile

    SubscriberPackageDestinationProfile: {
        description: string;
        displayName: string;
        name: string;
        noAccess: boolean;
        profileId: string;
        type: string;
    }

    Settings

    Member Visibility
    +SubscriberPackageDestinationProfile | @salesforce/packaging

    Type Alias SubscriberPackageDestinationProfile

    SubscriberPackageDestinationProfile: {
        description: string;
        displayName: string;
        name: string;
        noAccess: boolean;
        profileId: string;
        type: string;
    }

    Settings

    Member Visibility
    diff --git a/types/interfaces_packagingSObjects.PackagingSObjects.SubscriberPackageInstallError.html b/types/interfaces_packagingSObjects.PackagingSObjects.SubscriberPackageInstallError.html index 43a8c2751..19ab4362e 100644 --- a/types/interfaces_packagingSObjects.PackagingSObjects.SubscriberPackageInstallError.html +++ b/types/interfaces_packagingSObjects.PackagingSObjects.SubscriberPackageInstallError.html @@ -1 +1 @@ -SubscriberPackageInstallError | @salesforce/packaging

    Type Alias SubscriberPackageInstallError

    SubscriberPackageInstallError: {
        message: string;
    }

    Settings

    Member Visibility
    +SubscriberPackageInstallError | @salesforce/packaging

    Type Alias SubscriberPackageInstallError

    SubscriberPackageInstallError: {
        message: string;
    }

    Settings

    Member Visibility
    diff --git a/types/interfaces_packagingSObjects.PackagingSObjects.SubscriberPackageInstallErrors.html b/types/interfaces_packagingSObjects.PackagingSObjects.SubscriberPackageInstallErrors.html index 530061e2d..64a99a431 100644 --- a/types/interfaces_packagingSObjects.PackagingSObjects.SubscriberPackageInstallErrors.html +++ b/types/interfaces_packagingSObjects.PackagingSObjects.SubscriberPackageInstallErrors.html @@ -1 +1 @@ -SubscriberPackageInstallErrors | @salesforce/packaging

    Type Alias SubscriberPackageInstallErrors

    SubscriberPackageInstallErrors: {
        errors: SubscriberPackageInstallError[];
    }

    Settings

    Member Visibility
    +SubscriberPackageInstallErrors | @salesforce/packaging

    Type Alias SubscriberPackageInstallErrors

    SubscriberPackageInstallErrors: {
        errors: SubscriberPackageInstallError[];
    }

    Settings

    Member Visibility
    diff --git a/types/interfaces_packagingSObjects.PackagingSObjects.SubscriberPackageProfileMapping.html b/types/interfaces_packagingSObjects.PackagingSObjects.SubscriberPackageProfileMapping.html index 1c5348a31..8c23d9608 100644 --- a/types/interfaces_packagingSObjects.PackagingSObjects.SubscriberPackageProfileMapping.html +++ b/types/interfaces_packagingSObjects.PackagingSObjects.SubscriberPackageProfileMapping.html @@ -1 +1 @@ -SubscriberPackageProfileMapping | @salesforce/packaging

    Type Alias SubscriberPackageProfileMapping

    SubscriberPackageProfileMapping: {
        source: string;
        target: string;
    }

    Settings

    Member Visibility
    +SubscriberPackageProfileMapping | @salesforce/packaging

    Type Alias SubscriberPackageProfileMapping

    SubscriberPackageProfileMapping: {
        source: string;
        target: string;
    }

    Settings

    Member Visibility
    diff --git a/types/interfaces_packagingSObjects.PackagingSObjects.SubscriberPackageProfileMappings.html b/types/interfaces_packagingSObjects.PackagingSObjects.SubscriberPackageProfileMappings.html index ead6f3c80..fb9c9fe4d 100644 --- a/types/interfaces_packagingSObjects.PackagingSObjects.SubscriberPackageProfileMappings.html +++ b/types/interfaces_packagingSObjects.PackagingSObjects.SubscriberPackageProfileMappings.html @@ -1 +1 @@ -SubscriberPackageProfileMappings | @salesforce/packaging

    Type Alias SubscriberPackageProfileMappings

    SubscriberPackageProfileMappings: {
        profileMappings: SubscriberPackageProfileMapping[];
    }

    Settings

    Member Visibility
    +SubscriberPackageProfileMappings | @salesforce/packaging

    Type Alias SubscriberPackageProfileMappings

    SubscriberPackageProfileMappings: {
        profileMappings: SubscriberPackageProfileMapping[];
    }

    Settings

    Member Visibility
    diff --git a/types/interfaces_packagingSObjects.PackagingSObjects.SubscriberPackageProfiles.html b/types/interfaces_packagingSObjects.PackagingSObjects.SubscriberPackageProfiles.html index 68851acee..2fe728ee6 100644 --- a/types/interfaces_packagingSObjects.PackagingSObjects.SubscriberPackageProfiles.html +++ b/types/interfaces_packagingSObjects.PackagingSObjects.SubscriberPackageProfiles.html @@ -1 +1 @@ -SubscriberPackageProfiles | @salesforce/packaging

    Type Alias SubscriberPackageProfiles

    SubscriberPackageProfiles: {
        destinationProfiles: SubscriberPackageDestinationProfile[];
        sourceProfiles: SubscriberPackageSourceProfile[];
    }

    Settings

    Member Visibility
    +SubscriberPackageProfiles | @salesforce/packaging

    Type Alias SubscriberPackageProfiles

    SubscriberPackageProfiles: {
        destinationProfiles: SubscriberPackageDestinationProfile[];
        sourceProfiles: SubscriberPackageSourceProfile[];
    }

    Settings

    Member Visibility
    diff --git a/types/interfaces_packagingSObjects.PackagingSObjects.SubscriberPackageRemoteSiteSetting.html b/types/interfaces_packagingSObjects.PackagingSObjects.SubscriberPackageRemoteSiteSetting.html index 7c2f57e5d..07baaf7ef 100644 --- a/types/interfaces_packagingSObjects.PackagingSObjects.SubscriberPackageRemoteSiteSetting.html +++ b/types/interfaces_packagingSObjects.PackagingSObjects.SubscriberPackageRemoteSiteSetting.html @@ -1 +1 @@ -SubscriberPackageRemoteSiteSetting | @salesforce/packaging

    Type Alias SubscriberPackageRemoteSiteSetting

    SubscriberPackageRemoteSiteSetting: {
        secure: boolean;
        url: string;
    }

    Settings

    Member Visibility
    +SubscriberPackageRemoteSiteSetting | @salesforce/packaging

    Type Alias SubscriberPackageRemoteSiteSetting

    SubscriberPackageRemoteSiteSetting: {
        secure: boolean;
        url: string;
    }

    Settings

    Member Visibility
    diff --git a/types/interfaces_packagingSObjects.PackagingSObjects.SubscriberPackageRemoteSiteSettings.html b/types/interfaces_packagingSObjects.PackagingSObjects.SubscriberPackageRemoteSiteSettings.html index 4bf4a0d5d..2835fbd0a 100644 --- a/types/interfaces_packagingSObjects.PackagingSObjects.SubscriberPackageRemoteSiteSettings.html +++ b/types/interfaces_packagingSObjects.PackagingSObjects.SubscriberPackageRemoteSiteSettings.html @@ -1 +1 @@ -SubscriberPackageRemoteSiteSettings | @salesforce/packaging

    Type Alias SubscriberPackageRemoteSiteSettings

    SubscriberPackageRemoteSiteSettings: {
        settings: SubscriberPackageRemoteSiteSetting[];
    }

    Settings

    Member Visibility
    +SubscriberPackageRemoteSiteSettings | @salesforce/packaging

    Type Alias SubscriberPackageRemoteSiteSettings

    SubscriberPackageRemoteSiteSettings: {
        settings: SubscriberPackageRemoteSiteSetting[];
    }

    Settings

    Member Visibility
    diff --git a/types/interfaces_packagingSObjects.PackagingSObjects.SubscriberPackageSourceProfile.html b/types/interfaces_packagingSObjects.PackagingSObjects.SubscriberPackageSourceProfile.html index 2c603a4d4..6585baf0f 100644 --- a/types/interfaces_packagingSObjects.PackagingSObjects.SubscriberPackageSourceProfile.html +++ b/types/interfaces_packagingSObjects.PackagingSObjects.SubscriberPackageSourceProfile.html @@ -1 +1 @@ -SubscriberPackageSourceProfile | @salesforce/packaging

    Type Alias SubscriberPackageSourceProfile

    SubscriberPackageSourceProfile: {
        label: string;
        value: string;
    }

    Settings

    Member Visibility
    +SubscriberPackageSourceProfile | @salesforce/packaging

    Type Alias SubscriberPackageSourceProfile

    SubscriberPackageSourceProfile: {
        label: string;
        value: string;
    }

    Settings

    Member Visibility
    diff --git a/types/interfaces_packagingSObjects.PackagingSObjects.SubscriberPackageVersion.html b/types/interfaces_packagingSObjects.PackagingSObjects.SubscriberPackageVersion.html index a4d7874a7..ba143218d 100644 --- a/types/interfaces_packagingSObjects.PackagingSObjects.SubscriberPackageVersion.html +++ b/types/interfaces_packagingSObjects.PackagingSObjects.SubscriberPackageVersion.html @@ -1 +1 @@ -SubscriberPackageVersion | @salesforce/packaging

    Type Alias SubscriberPackageVersion

    SubscriberPackageVersion: {
        AppExchangeDescription: string;
        AppExchangeLogoUrl: string;
        AppExchangePackageName: string;
        AppExchangePublisherName: string;
        BuildNumber: number;
        CspTrustedSites: SubscriberPackageCspTrustedSites;
        Dependencies: SubscriberPackageDependencies;
        Description: string;
        Id: string;
        InstallValidationStatus: InstallValidationStatus;
        IsBeta: boolean;
        IsDeprecated: boolean;
        IsManaged: boolean;
        IsOrgDependent: boolean;
        IsPasswordProtected: boolean;
        IsSecurityReviewed: boolean;
        MajorVersion: number;
        MinorVersion: number;
        Name: string;
        Package2ContainerOptions: PackageType;
        PatchVersion: number;
        PostInstallUrl: string;
        Profiles: SubscriberPackageProfiles;
        PublisherName: string;
        ReleaseNotesUrl: string;
        ReleaseState: string;
        RemoteSiteSettings: SubscriberPackageRemoteSiteSettings;
        SubscriberPackageId: string;
    }

    Settings

    Member Visibility
    +SubscriberPackageVersion | @salesforce/packaging

    Type Alias SubscriberPackageVersion

    SubscriberPackageVersion: {
        AppExchangeDescription: string;
        AppExchangeLogoUrl: string;
        AppExchangePackageName: string;
        AppExchangePublisherName: string;
        BuildNumber: number;
        CspTrustedSites: SubscriberPackageCspTrustedSites;
        Dependencies: SubscriberPackageDependencies;
        Description: string;
        Id: string;
        InstallValidationStatus: InstallValidationStatus;
        IsBeta: boolean;
        IsDeprecated: boolean;
        IsManaged: boolean;
        IsOrgDependent: boolean;
        IsPasswordProtected: boolean;
        IsSecurityReviewed: boolean;
        MajorVersion: number;
        MinorVersion: number;
        Name: string;
        Package2ContainerOptions: PackageType;
        PatchVersion: number;
        PostInstallUrl: string;
        Profiles: SubscriberPackageProfiles;
        PublisherName: string;
        ReleaseNotesUrl: string;
        ReleaseState: string;
        RemoteSiteSettings: SubscriberPackageRemoteSiteSettings;
        SubscriberPackageId: string;
    }

    Settings

    Member Visibility
    diff --git a/types/interfaces_packagingSObjects.PackagingSObjects.SubscriberPackageVersionUninstallRequest.html b/types/interfaces_packagingSObjects.PackagingSObjects.SubscriberPackageVersionUninstallRequest.html index e787711b1..826ba4998 100644 --- a/types/interfaces_packagingSObjects.PackagingSObjects.SubscriberPackageVersionUninstallRequest.html +++ b/types/interfaces_packagingSObjects.PackagingSObjects.SubscriberPackageVersionUninstallRequest.html @@ -1 +1 @@ -SubscriberPackageVersionUninstallRequest | @salesforce/packaging

    Type Alias SubscriberPackageVersionUninstallRequest

    SubscriberPackageVersionUninstallRequest: {
        CreatedById: string;
        CreatedDate: number;
        Id: string;
        IsDeleted: boolean;
        LastModifiedById: string;
        LastModifiedDate: number;
        Status:
            | "Error"
            | "InProgress"
            | "Queued"
            | "Success";
        SubscriberPackageVersionId: string;
        SystemModstamp: number;
    }

    Settings

    Member Visibility
    +SubscriberPackageVersionUninstallRequest | @salesforce/packaging

    Type Alias SubscriberPackageVersionUninstallRequest

    SubscriberPackageVersionUninstallRequest: {
        CreatedById: string;
        CreatedDate: number;
        Id: string;
        IsDeleted: boolean;
        LastModifiedById: string;
        LastModifiedDate: number;
        Status:
            | "Error"
            | "InProgress"
            | "Queued"
            | "Success";
        SubscriberPackageVersionId: string;
        SystemModstamp: number;
    }

    Settings

    Member Visibility
    diff --git a/types/package_packageVersion.Package2VersionFieldTypes.html b/types/package_packageVersion.Package2VersionFieldTypes.html index 51d877a90..f7a9ae60c 100644 --- a/types/package_packageVersion.Package2VersionFieldTypes.html +++ b/types/package_packageVersion.Package2VersionFieldTypes.html @@ -1 +1 @@ -Package2VersionFieldTypes | @salesforce/packaging

    Type Alias Package2VersionFieldTypes

    Package2VersionFieldTypes: typeof Package2VersionFields[number][]

    Settings

    Member Visibility
    +Package2VersionFieldTypes | @salesforce/packaging

    Type Alias Package2VersionFieldTypes

    Package2VersionFieldTypes: typeof Package2VersionFields[number][]

    Settings

    Member Visibility
    diff --git a/types/package_packageVersion.Package2VersionQueryOptions.html b/types/package_packageVersion.Package2VersionQueryOptions.html index 7c9fef7c1..dc9b97206 100644 --- a/types/package_packageVersion.Package2VersionQueryOptions.html +++ b/types/package_packageVersion.Package2VersionQueryOptions.html @@ -5,4 +5,4 @@ multiple queries when the query length would exceed the maximum char limit. When defining items here, the whereClause argument must use this token for the item replacement: '%IDS%'.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/types/package_profileRewriter.CorrectedProfile.html b/types/package_profileRewriter.CorrectedProfile.html index 4f6061aa7..074953d80 100644 --- a/types/package_profileRewriter.CorrectedProfile.html +++ b/types/package_profileRewriter.CorrectedProfile.html @@ -1 +1 @@ -CorrectedProfile | @salesforce/packaging

    Type Alias CorrectedProfile

    CorrectedProfile: Profile

    Settings

    Member Visibility
    +CorrectedProfile | @salesforce/packaging

    Type Alias CorrectedProfile

    CorrectedProfile: Profile

    Settings

    Member Visibility
    diff --git a/types/utils_packageUtils.IdRegistry.html b/types/utils_packageUtils.IdRegistry.html index 2f23a3a4e..cb1f4f80d 100644 --- a/types/utils_packageUtils.IdRegistry.html +++ b/types/utils_packageUtils.IdRegistry.html @@ -1 +1 @@ -IdRegistry | @salesforce/packaging

    Type Alias IdRegistry

    IdRegistry: {
        [key: string]: IdRegistryValue;
    }

    Settings

    Member Visibility
    +IdRegistry | @salesforce/packaging

    Type Alias IdRegistry

    IdRegistry: {
        [key: string]: IdRegistryValue;
    }

    Settings

    Member Visibility
    diff --git a/types/utils_packageUtils.IdRegistryValue.html b/types/utils_packageUtils.IdRegistryValue.html index 00897348e..0f44b7725 100644 --- a/types/utils_packageUtils.IdRegistryValue.html +++ b/types/utils_packageUtils.IdRegistryValue.html @@ -1 +1 @@ -IdRegistryValue | @salesforce/packaging

    Type Alias IdRegistryValue

    IdRegistryValue: {
        label: string;
        prefix: string;
    }

    Settings

    Member Visibility
    +IdRegistryValue | @salesforce/packaging

    Type Alias IdRegistryValue

    IdRegistryValue: {
        label: string;
        prefix: string;
    }

    Settings

    Member Visibility
    diff --git a/variables/interfaces_packagingInterfacesAndType.Package1VersionEvents.html b/variables/interfaces_packagingInterfacesAndType.Package1VersionEvents.html index 531f05885..97a3ef5b6 100644 --- a/variables/interfaces_packagingInterfacesAndType.Package1VersionEvents.html +++ b/variables/interfaces_packagingInterfacesAndType.Package1VersionEvents.html @@ -1 +1 @@ -Package1VersionEvents | @salesforce/packaging

    Variable Package1VersionEventsConst

    Package1VersionEvents: {
        create: {
            progress: string;
        };
    } = ...

    Settings

    Member Visibility
    +Package1VersionEvents | @salesforce/packaging

    Variable Package1VersionEventsConst

    Package1VersionEvents: {
        create: {
            progress: string;
        };
    } = ...

    Settings

    Member Visibility
    diff --git a/variables/interfaces_packagingInterfacesAndType.PackageEvents.html b/variables/interfaces_packagingInterfacesAndType.PackageEvents.html index e153b186b..d43a0291e 100644 --- a/variables/interfaces_packagingInterfacesAndType.PackageEvents.html +++ b/variables/interfaces_packagingInterfacesAndType.PackageEvents.html @@ -1 +1 @@ -PackageEvents | @salesforce/packaging

    Variable PackageEventsConst

    PackageEvents: {
        convert: {
            error: string;
            progress: string;
            success: string;
        };
        install: {
            postsend: string;
            presend: string;
            status: string;
            subscriber-status: string;
            warning: string;
        };
        uninstall: string;
    } = ...

    Settings

    Member Visibility
    +PackageEvents | @salesforce/packaging

    Variable PackageEventsConst

    PackageEvents: {
        convert: {
            error: string;
            progress: string;
            success: string;
        };
        install: {
            postsend: string;
            presend: string;
            status: string;
            subscriber-status: string;
            warning: string;
        };
        uninstall: string;
    } = ...

    Settings

    Member Visibility
    diff --git a/variables/interfaces_packagingInterfacesAndType.PackageVersionCreateRequestResultInProgressStatuses.html b/variables/interfaces_packagingInterfacesAndType.PackageVersionCreateRequestResultInProgressStatuses.html index 8483bb888..9499bbf6d 100644 --- a/variables/interfaces_packagingInterfacesAndType.PackageVersionCreateRequestResultInProgressStatuses.html +++ b/variables/interfaces_packagingInterfacesAndType.PackageVersionCreateRequestResultInProgressStatuses.html @@ -1 +1 @@ -PackageVersionCreateRequestResultInProgressStatuses | @salesforce/packaging

    Variable PackageVersionCreateRequestResultInProgressStatusesConst

    PackageVersionCreateRequestResultInProgressStatuses: Package2VersionStatus[] = ...

    Settings

    Member Visibility
    +PackageVersionCreateRequestResultInProgressStatuses | @salesforce/packaging

    Variable PackageVersionCreateRequestResultInProgressStatusesConst

    PackageVersionCreateRequestResultInProgressStatuses: Package2VersionStatus[] = ...

    Settings

    Member Visibility
    diff --git a/variables/interfaces_packagingInterfacesAndType.PackageVersionEvents.html b/variables/interfaces_packagingInterfacesAndType.PackageVersionEvents.html index 688891f2f..a1a945010 100644 --- a/variables/interfaces_packagingInterfacesAndType.PackageVersionEvents.html +++ b/variables/interfaces_packagingInterfacesAndType.PackageVersionEvents.html @@ -1 +1 @@ -PackageVersionEvents | @salesforce/packaging

    Variable PackageVersionEventsConst

    PackageVersionEvents: {
        create: {
            enqueued: string;
            error: string;
            preserve-files: string;
            progress: string;
            success: string;
            timed-out: string;
        };
    } = ...

    Settings

    Member Visibility
    +PackageVersionEvents | @salesforce/packaging

    Variable PackageVersionEventsConst

    PackageVersionEvents: {
        create: {
            enqueued: string;
            error: string;
            preserve-files: string;
            progress: string;
            success: string;
            timed-out: string;
        };
    } = ...

    Settings

    Member Visibility
    diff --git a/variables/package_package.Package2Fields.html b/variables/package_package.Package2Fields.html index f914b697f..a250d12ce 100644 --- a/variables/package_package.Package2Fields.html +++ b/variables/package_package.Package2Fields.html @@ -1 +1 @@ -Package2Fields | @salesforce/packaging

    Variable Package2FieldsConst

    Package2Fields: string[] = ...

    Settings

    Member Visibility
    +Package2Fields | @salesforce/packaging

    Variable Package2FieldsConst

    Package2Fields: string[] = ...

    Settings

    Member Visibility
    diff --git a/variables/package_packageVersion.Package2VersionFields.html b/variables/package_packageVersion.Package2VersionFields.html index ba46c47d7..0522df470 100644 --- a/variables/package_packageVersion.Package2VersionFields.html +++ b/variables/package_packageVersion.Package2VersionFields.html @@ -1 +1 @@ -Package2VersionFields | @salesforce/packaging

    Variable Package2VersionFieldsConst

    Package2VersionFields: (keyof Package2Version)[] = ...

    Settings

    Member Visibility
    +Package2VersionFields | @salesforce/packaging

    Variable Package2VersionFieldsConst

    Package2VersionFields: (keyof Package2Version)[] = ...

    Settings

    Member Visibility
    diff --git a/variables/package_packageVersionList.DEFAULT_ORDER_BY_FIELDS.html b/variables/package_packageVersionList.DEFAULT_ORDER_BY_FIELDS.html index 6d1d193a8..e96df740e 100644 --- a/variables/package_packageVersionList.DEFAULT_ORDER_BY_FIELDS.html +++ b/variables/package_packageVersionList.DEFAULT_ORDER_BY_FIELDS.html @@ -1 +1 @@ -DEFAULT_ORDER_BY_FIELDS | @salesforce/packaging

    Variable DEFAULT_ORDER_BY_FIELDSConst

    DEFAULT_ORDER_BY_FIELDS: "Package2Id, Branch, MajorVersion, MinorVersion, PatchVersion, BuildNumber" = 'Package2Id, Branch, MajorVersion, MinorVersion, PatchVersion, BuildNumber'

    Settings

    Member Visibility
    +DEFAULT_ORDER_BY_FIELDS | @salesforce/packaging

    Variable DEFAULT_ORDER_BY_FIELDSConst

    DEFAULT_ORDER_BY_FIELDS: "Package2Id, Branch, MajorVersion, MinorVersion, PatchVersion, BuildNumber" = 'Package2Id, Branch, MajorVersion, MinorVersion, PatchVersion, BuildNumber'

    Settings

    Member Visibility
    diff --git a/variables/package_subscriberPackageVersion.SubscriberPackageVersionFields.html b/variables/package_subscriberPackageVersion.SubscriberPackageVersionFields.html index 6c757657b..dd11c4c08 100644 --- a/variables/package_subscriberPackageVersion.SubscriberPackageVersionFields.html +++ b/variables/package_subscriberPackageVersion.SubscriberPackageVersionFields.html @@ -1 +1 @@ -SubscriberPackageVersionFields | @salesforce/packaging

    Variable SubscriberPackageVersionFieldsConst

    SubscriberPackageVersionFields: string[] = ...

    Settings

    Member Visibility
    +SubscriberPackageVersionFields | @salesforce/packaging

    Variable SubscriberPackageVersionFieldsConst

    SubscriberPackageVersionFields: string[] = ...

    Settings

    Member Visibility
    diff --git a/variables/utils_packageUtils.BY_LABEL.html b/variables/utils_packageUtils.BY_LABEL.html index 7d644c579..4314a762f 100644 --- a/variables/utils_packageUtils.BY_LABEL.html +++ b/variables/utils_packageUtils.BY_LABEL.html @@ -1 +1 @@ -BY_LABEL | @salesforce/packaging

    Variable BY_LABELConst

    BY_LABEL: IdRegistry = ...

    Settings

    Member Visibility
    +BY_LABEL | @salesforce/packaging

    Variable BY_LABELConst

    BY_LABEL: IdRegistry = ...

    Settings

    Member Visibility
    diff --git a/variables/utils_packageUtils.INSTALL_URL_BASE.html b/variables/utils_packageUtils.INSTALL_URL_BASE.html index d5acfa7b4..8ab6dec18 100644 --- a/variables/utils_packageUtils.INSTALL_URL_BASE.html +++ b/variables/utils_packageUtils.INSTALL_URL_BASE.html @@ -1 +1 @@ -INSTALL_URL_BASE | @salesforce/packaging

    Variable INSTALL_URL_BASEConst

    INSTALL_URL_BASE: SfdcUrl = ...

    Settings

    Member Visibility
    +INSTALL_URL_BASE | @salesforce/packaging

    Variable INSTALL_URL_BASEConst

    INSTALL_URL_BASE: SfdcUrl = ...

    Settings

    Member Visibility
    diff --git a/variables/utils_packageUtils.VERSION_NUMBER_SEP.html b/variables/utils_packageUtils.VERSION_NUMBER_SEP.html index 8db95a557..50386eb5a 100644 --- a/variables/utils_packageUtils.VERSION_NUMBER_SEP.html +++ b/variables/utils_packageUtils.VERSION_NUMBER_SEP.html @@ -1 +1 @@ -VERSION_NUMBER_SEP | @salesforce/packaging

    Variable VERSION_NUMBER_SEPConst

    VERSION_NUMBER_SEP: "." = '.'

    Settings

    Member Visibility
    +VERSION_NUMBER_SEP | @salesforce/packaging

    Variable VERSION_NUMBER_SEPConst

    VERSION_NUMBER_SEP: "." = '.'

    Settings

    Member Visibility