@salesforce/packaging/lib/package/packageBundle.d.ts

Packaging library for the Salesforce packaging platform

import { Connection, SfProject } from '@salesforce/core';
import { SaveResult } from '@jsforce/jsforce-node';
import { Duration } from '@salesforce/kit';
import { BundleCreateOptions, BundleSObjects, BundleVersionCreateOptions } from '../interfaces';
export declare class PackageBundle {
    /**
     * Create a new package bundle.
     *
     * @param connection - instance of Connection
     * @param project - instance of SfProject
     * @param options - options for creating a bundle - see BundleCreateOptions
     * @returns PackageBundle
     */
    static create(connection: Connection, project: SfProject, options: BundleCreateOptions): Promise<{
        Id: string;
    }>;
    /**
     * Create a new package bundle version.
     *
     * @param connection - instance of Connection
     * @param project - instance of SfProject
     * @param options - options for creating a bundle version - see BundleVersionCreateOptions
     * @returns PackageBundle
     */
    static createVersion(options: BundleVersionCreateOptions, polling?: {
        frequency: Duration;
        timeout: Duration;
    }): Promise<BundleSObjects.PackageBundleVersionCreateRequestResult>;
    static delete(connection: Connection, project: SfProject, idOrAlias: string): Promise<SaveResult>;
    /**
     * Returns all the package bundles that are available in the org, up to 10,000. If more records are
     * needed use the `SF_ORG_MAX_QUERY_LIMIT` env var.
     *
     * @param connection
     */
    static list(connection: Connection): Promise<BundleSObjects.Bundle[]>;
}