import { AuraHelperCLICompareBetweenOptions, AuraHelperCLICompareOptions, AuraHelperCLICompressFolderOptions, AuraHelperCLICompressFileOptions, AuraHelperCLIDependenciesOptions, AuraHelperCLIDescribeOptions, AuraHelperCLIIgnoreOptions, AuraHelperCLIPackageGeneratorOptions, AuraHelperCLIPermissionsOptions, AuraHelperCLIRetrieveSpecialOptions, AuraHelperSFDXCompareBetweenOptions, AuraHelperSFDXCompareOptions, AuraHelperSFDXCompressFileOptions, AuraHelperSFDXDependenciesOptions, AuraHelperSFDXDescribeOptions, AuraHelperSFDXGitPackageOptions, AuraHelperSFDXIgnoreOptions, AuraHelperSFDXJSONPackageOptions, AuraHelperSFDXMergePackageOptions, AuraHelperSFDXPermissionsOptions, AuraHelperSFDXRetrieveSpecialOptions, AuraHelperSFDXCompressFolderOptions } from ".."; import { Process } from "../types/process"; /** * Class with several static methods to create to many system processes to handle Aura Helper operations */ export declare class ProcessFactory { /** * Method to create the SFDX process to retrieve data to a project from a package file in a Source format * @param {string} usernameOrAlias Username or Org Alias to connect (Required) * @param {string} packageFile Package file path (Required) * @param {string} projectFolder Project folder path (Required) * @param {string | number} [apiVersion] API version number to use custom API version. By default use the latest API version (Optional) * @param {string | number} [waitMinutes] Minutes to wait until command end (Optional) * * @returns {Process} Returns the process to run * * @throws {DataRequiredException} Throws exception when required data is not provided * @throws {OSNotSupportedException} Throw exception when create process with not supported Operative System. "Operative System Not Supported" * @throws {WrongDatatypeException} If the api version is not a Number or String. Can be undefined */ static sourceRetrievePackageSFDX(usernameOrAlias: string, packageFile: string, projectFolder: string, apiVersion?: string | number, waitMinutes?: string | number): Process; /** * Method to create the SF process to retrieve data to a project from a package file in a Source format * @param {string} usernameOrAlias Username or Org Alias to connect (Required) * @param {string} packageFile Package file path (Required) * @param {string} projectFolder Project folder path (Required) * @param {string | number} [apiVersion] API version number to use custom API version. By default use the latest API version (Optional) * @param {string | number} [waitMinutes] Minutes to wait until command end (Optional) * * @returns {Process} Returns the process to run * * @throws {DataRequiredException} Throws exception when required data is not provided * @throws {OSNotSupportedException} Throw exception when create process with not supported Operative System. "Operative System Not Supported" * @throws {WrongDatatypeException} If the api version is not a Number or String. Can be undefined */ static sourceRetrievePackageSF(usernameOrAlias: string, packageFile: string, projectFolder: string, apiVersion?: string | number, waitMinutes?: string | number): Process; /** * Method to create the SFDX process to Validate a package in a Source format * @param {string} usernameOrAlias Username or Org Alias to connect (Required) * @param {string} packageFile Package file path (Required) * @param {string} projectFolder Project folder path (Required) * @param {string} [testLevel] Test Level to execute test on validate (Optional) * @param {string} [runTests] Run tests mode to execute test on validate (Optional) * @param {string | number} [apiVersion] API version number to use custom API version. By default use the latest API version (Optional) * @param {string | number} [waitMinutes] Minutes to wait until command end (33 By default) (Optional) * * @returns {Process} Returns the process to run * * @throws {DataRequiredException} Throws exception when required data is not provided * @throws {OSNotSupportedException} Throw exception when create process with not supported Operative System. "Operative System Not Supported" * @throws {WrongDatatypeException} If the api version is not a Number or String. Can be undefined */ static sourceValidatePackageSFDX(usernameOrAlias: string, packageFile: string, projectFolder: string, testLevel?: string, runTests?: string, apiVersion?: string | number, waitMinutes?: string | number): Process; /** * Method to create the SF process to Validate a package in a Source format * @param {string} usernameOrAlias Username or Org Alias to connect (Required) * @param {string} packageFile Package file path (Required) * @param {string} projectFolder Project folder path (Required) * @param {string} [testLevel] Test Level to execute test on validate (Optional) * @param {string} [runTests] Run tests mode to execute test on validate (Optional) * @param {string | number} [apiVersion] API version number to use custom API version. By default use the latest API version (Optional) * @param {string | number} [waitMinutes] Minutes to wait until command end (33 By default) (Optional) * * @returns {Process} Returns the process to run * * @throws {DataRequiredException} Throws exception when required data is not provided * @throws {OSNotSupportedException} Throw exception when create process with not supported Operative System. "Operative System Not Supported" * @throws {WrongDatatypeException} If the api version is not a Number or String. Can be undefined */ static sourceValidatePackageSF(usernameOrAlias: string, packageFile: string, projectFolder: string, testLevel?: string, runTests?: string, apiVersion?: string | number, waitMinutes?: string | number): Process; /** * Method to create the SFDX process to Deploy a package in a Source format * @param {string} usernameOrAlias Username or Org Alias to connect (Required) * @param {string} packageFile Package file path (Required) * @param {string} projectFolder Project folder path (Required) * @param {string} [testLevel] Test Level to execute test on validate (Optional) * @param {string} [runTests] Run tests mode to execute test on validate (Optional) * @param {string | number} [apiVersion] API version number to use custom API version. By default use the latest API version (Optional) * @param {string | number} [waitMinutes] Minutes to wait until command end (33 By default) (Optional) * * @returns {Process} Returns the process to run * * @throws {DataRequiredException} Throws exception when required data is not provided * @throws {OSNotSupportedException} Throw exception when create process with not supported Operative System. "Operative System Not Supported" * @throws {WrongDatatypeException} If the api version is not a Number or String. Can be undefined */ static sourceDeployPackageSFDX(usernameOrAlias: string, packageFile: string, projectFolder: string, testLevel?: string, runTests?: string, apiVersion?: string | number, waitMinutes?: string | number): Process; /** * Method to create the SF process to Deploy a package in a Source format * @param {string} usernameOrAlias Username or Org Alias to connect (Required) * @param {string} packageFile Package file path (Required) * @param {string} projectFolder Project folder path (Required) * @param {string} [testLevel] Test Level to execute test on validate (Optional) * @param {string} [runTests] Run tests mode to execute test on validate (Optional) * @param {string | number} [apiVersion] API version number to use custom API version. By default use the latest API version (Optional) * @param {string | number} [waitMinutes] Minutes to wait until command end (33 By default) (Optional) * * @returns {Process} Returns the process to run * * @throws {DataRequiredException} Throws exception when required data is not provided * @throws {OSNotSupportedException} Throw exception when create process with not supported Operative System. "Operative System Not Supported" * @throws {WrongDatatypeException} If the api version is not a Number or String. Can be undefined */ static sourceDeployPackageSF(usernameOrAlias: string, packageFile: string, projectFolder: string, testLevel?: string, runTests?: string, apiVersion?: string | number, waitMinutes?: string | number): Process; /** * Method to create the SFDX process to Deploy a package in a Source format * @param {string} usernameOrAlias Username or Org Alias to connect (Required) * @param {string} projectFolder Project folder path (Required) * @param {string} types Types to deploy separated by commas * @param {string} [testLevel] Test Level to execute test on validate (Optional) * @param {string} [runTests] Run tests mode to execute test on validate (Optional) * @param {string | number} [apiVersion] API version number to use custom API version. By default use the latest API version (Optional) * @param {string | number} [waitMinutes] Minutes to wait until command end (33 By default) (Optional) * * @returns {Process} Returns the process to run * * @throws {DataRequiredException} Throws exception when required data is not provided * @throws {OSNotSupportedException} Throw exception when create process with not supported Operative System. "Operative System Not Supported" * @throws {WrongDatatypeException} If the api version is not a Number or String. Can be undefined */ static sourceDeploySFDX(usernameOrAlias: string, projectFolder: string, types: string, testLevel?: string, runTests?: string, apiVersion?: string | number, waitMinutes?: string | number): Process; /** * Method to create the SF process to Deploy a package in a Source format * @param {string} usernameOrAlias Username or Org Alias to connect (Required) * @param {string} projectFolder Project folder path (Required) * @param {string} types Types to deploy separated by commas * @param {string} [testLevel] Test Level to execute test on validate (Optional) * @param {string} [runTests] Run tests mode to execute test on validate (Optional) * @param {string | number} [apiVersion] API version number to use custom API version. By default use the latest API version (Optional) * @param {string | number} [waitMinutes] Minutes to wait until command end (33 By default) (Optional) * * @returns {Process} Returns the process to run * * @throws {DataRequiredException} Throws exception when required data is not provided * @throws {OSNotSupportedException} Throw exception when create process with not supported Operative System. "Operative System Not Supported" * @throws {WrongDatatypeException} If the api version is not a Number or String. Can be undefined */ static sourceDeploySF(usernameOrAlias: string, projectFolder: string, types: string, testLevel?: string, runTests?: string, apiVersion?: string | number, waitMinutes?: string | number): Process; /** * Method to create the SFDX process to quick deploy a validated deployment in a Source format * @param {string} usernameOrAlias Username or Org Alias to connect (Required) * @param {string} deployId Deployment Id (Required) * @param {string} projectFolder Project folder path (Required) * @param {string | number} [apiVersion] API version number to use custom API version. By default use the latest API version (Optional) * * @returns {Process} Returns the process to run * * @throws {DataRequiredException} Throws exception when required data is not provided * @throws {OSNotSupportedException} Throw exception when create process with not supported Operative System. "Operative System Not Supported" * @throws {WrongDatatypeException} If the api version is not a Number or String. Can be undefined */ static sourceQuickDeploySFDX(usernameOrAlias: string, deployId: string, projectFolder: string, apiVersion?: string | number): Process; /** * Method to create the SF process to quick deploy a validated deployment in a Source format * @param {string} usernameOrAlias Username or Org Alias to connect (Required) * @param {string} deployId Deployment Id (Required) * @param {string} projectFolder Project folder path (Required) * @param {string | number} [apiVersion] API version number to use custom API version. By default use the latest API version (Optional) * * @returns {Process} Returns the process to run * * @throws {DataRequiredException} Throws exception when required data is not provided * @throws {OSNotSupportedException} Throw exception when create process with not supported Operative System. "Operative System Not Supported" * @throws {WrongDatatypeException} If the api version is not a Number or String. Can be undefined */ static sourceQuickDeploySF(usernameOrAlias: string, deployId: string, projectFolder: string, apiVersion?: string | number): Process; /** * Method to create the SFDX process to quick get an status of deployment in a Source format * @param {string} usernameOrAlias Username or Org Alias to connect (Required) * @param {string} deployId Deployment Id (Required) * @param {string | number} [waitMinutes] Minutes to wait until command end (33 By default) (Optional) * * @returns {Process} Returns the process to run * * @throws {DataRequiredException} Throws exception when required data is not provided * @throws {OSNotSupportedException} Throw exception when create process with not supported Operative System. "Operative System Not Supported" * @throws {WrongDatatypeException} If the api version is not a Number or String. Can be undefined */ static sourceDeployReportSFDX(usernameOrAlias: string, deployId: string, waitMinutes?: string | number): Process; /** * Method to create the SF process to quick get an status of deployment in a Source format * @param {string} usernameOrAlias Username or Org Alias to connect (Required) * @param {string} deployId Deployment Id (Required) * @param {string | number} [waitMinutes] Minutes to wait until command end (33 By default) (Optional) * * @returns {Process} Returns the process to run * * @throws {DataRequiredException} Throws exception when required data is not provided * @throws {OSNotSupportedException} Throw exception when create process with not supported Operative System. "Operative System Not Supported" * @throws {WrongDatatypeException} If the api version is not a Number or String. Can be undefined */ static sourceDeployReportSF(usernameOrAlias: string, deployId: string, waitMinutes?: string | number): Process; /** * Method to create the SFDX process to quick cancel a deployment in a Source format * @param {string} usernameOrAlias Username or Org Alias to connect (Required) * @param {string} deployId Deployment Id (Required) * @param {string | number} [waitMinutes] Minutes to wait until command end (33 By default) (Optional) * * @returns {Process} Returns the process to run * * @throws {DataRequiredException} Throws exception when required data is not provided * @throws {OSNotSupportedException} Throw exception when create process with not supported Operative System. "Operative System Not Supported" * @throws {WrongDatatypeException} If the api version is not a Number or String. Can be undefined */ static mdapiCancelDeploySFDX(usernameOrAlias: string, deployId: string, waitMinutes?: string | number): Process; /** * Method to create the SFDX process to quick cancel a deployment in a Source format * @param {string} usernameOrAlias Username or Org Alias to connect (Required) * @param {string} deployId Deployment Id (Required) * @param {string | number} [waitMinutes] Minutes to wait until command end (33 By default) (Optional) * * @returns {Process} Returns the process to run * * @throws {DataRequiredException} Throws exception when required data is not provided * @throws {OSNotSupportedException} Throw exception when create process with not supported Operative System. "Operative System Not Supported" * @throws {WrongDatatypeException} If the api version is not a Number or String. Can be undefined */ static sourceCancelDeploySFDX(usernameOrAlias: string, deployId: string, waitMinutes?: string | number): Process; /** * Method to create the SF process to quick cancel a deployment in a Source format * @param {string} usernameOrAlias Username or Org Alias to connect (Required) * @param {string} deployId Deployment Id (Required) * @param {string | number} [waitMinutes] Minutes to wait until command end (33 By default) (Optional) * * @returns {Process} Returns the process to run * * @throws {DataRequiredException} Throws exception when required data is not provided * @throws {OSNotSupportedException} Throw exception when create process with not supported Operative System. "Operative System Not Supported" * @throws {WrongDatatypeException} If the api version is not a Number or String. Can be undefined */ static sourceCancelDeploySF(usernameOrAlias: string, deployId: string, waitMinutes?: string | number): Process; /** * Method to create the SF process to quick cancel a deployment in a Source format * @param {string} usernameOrAlias Username or Org Alias to connect (Required) * @param {string} deployId Deployment Id (Required) * @param {string | number} [waitMinutes] Minutes to wait until command end (33 By default) (Optional) * * @returns {Process} Returns the process to run * * @throws {DataRequiredException} Throws exception when required data is not provided * @throws {OSNotSupportedException} Throw exception when create process with not supported Operative System. "Operative System Not Supported" * @throws {WrongDatatypeException} If the api version is not a Number or String. Can be undefined */ static mdapiCancelDeploySF(usernameOrAlias: string, deployId: string, waitMinutes?: string | number): Process; /** * Method to create the SFDX process to retrieve data to a project from a package file in a Metadata API format * @param {string} usernameOrAlias Username or Org Alias to connect (Required) * @param {string} packageFolder Package folder path (Required) * @param {string} projectFolder Project folder path (Required) * @param {string} targetDir The root of the directory structure where the retrieved .zip or metadata files are put. (Required) * @param {string | number} [apiVersion] API version number to use custom API version. By default use the latest API version (Optional) * @param {string | number} [waitMinutes] Minutes to wait until command end (33 By default) (Optional) * * @returns {Process} Returns the process to run * * @throws {DataRequiredException} Throws exception when required data is not provided * @throws {OSNotSupportedException} Throw exception when create process with not supported Operative System. "Operative System Not Supported" * @throws {WrongDatatypeException} If the api version is not a Number or String. Can be undefined */ static mdapiRetrievePackageSFDX(usernameOrAlias: string, packageFolder: string, projectFolder: string, targetDir: string, apiVersion?: string | number, waitMinutes?: string | number): Process; /** * Method to create the SF process to retrieve data to a project from a package file in a Metadata API format * @param {string} usernameOrAlias Username or Org Alias to connect (Required) * @param {string} packageFolder Package folder path (Required) * @param {string} projectFolder Project folder path (Required) * @param {string} targetDir The root of the directory structure where the retrieved .zip or metadata files are put. (Required) * @param {string | number} [apiVersion] API version number to use custom API version. By default use the latest API version (Optional) * @param {string | number} [waitMinutes] Minutes to wait until command end (33 By default) (Optional) * * @returns {Process} Returns the process to run * * @throws {DataRequiredException} Throws exception when required data is not provided * @throws {OSNotSupportedException} Throw exception when create process with not supported Operative System. "Operative System Not Supported" * @throws {WrongDatatypeException} If the api version is not a Number or String. Can be undefined */ static mdapiRetrievePackageSF(usernameOrAlias: string, packageFolder: string, projectFolder: string, targetDir: string, apiVersion?: string | number, waitMinutes?: string | number): Process; /** * Method to create the SFDX process to Validate a package in a Metadata API format * @param {string} usernameOrAlias Username or Org Alias to connect (Required) * @param {string} packageFolder Package folder path to deploy (Required) * @param {string} projectFolder Project folder path (Required) * @param {string} [testLevel] Test Level to execute test on validate (Optional) * @param {string} [runTests] Run tests mode to execute test on validate (Optional) * @param {string | number} [apiVersion] API version number to use custom API version. By default use the latest API version (Optional) * @param {string | number} [waitMinutes] Minutes to wait until command end (33 By default) (Optional) * * @returns {Process} Returns the process to run * * @throws {DataRequiredException} Throws exception when required data is not provided * @throws {OSNotSupportedException} Throw exception when create process with not supported Operative System. "Operative System Not Supported" * @throws {WrongDatatypeException} If the api version is not a Number or String. Can be undefined */ static mdapiValidatePackageSFDX(usernameOrAlias: string, packageFolder: string, projectFolder: string, testLevel?: string, runTests?: string, apiVersion?: string | number, waitMinutes?: string | number): Process; /** * Method to create the SF process to Validate a package in a Metadata API format * @param {string} usernameOrAlias Username or Org Alias to connect (Required) * @param {string} packageFolder Package folder path to deploy (Required) * @param {string} projectFolder Project folder path (Required) * @param {string} [testLevel] Test Level to execute test on validate (Optional) * @param {string} [runTests] Run tests mode to execute test on validate (Optional) * @param {string | number} [apiVersion] API version number to use custom API version. By default use the latest API version (Optional) * @param {string | number} [waitMinutes] Minutes to wait until command end (33 By default) (Optional) * * @returns {Process} Returns the process to run * * @throws {DataRequiredException} Throws exception when required data is not provided * @throws {OSNotSupportedException} Throw exception when create process with not supported Operative System. "Operative System Not Supported" * @throws {WrongDatatypeException} If the api version is not a Number or String. Can be undefined */ static mdapiValidatePackageSF(usernameOrAlias: string, packageFolder: string, projectFolder: string, testLevel?: string, runTests?: string, apiVersion?: string | number, waitMinutes?: string | number): Process; /** * Method to create the SFDX process to Deploy a package in a Metadata API format * @param {string} usernameOrAlias Username or Org Alias to connect (Required) * @param {string} packageFolder Package folder path (Required) * @param {string} projectFolder Project folder path (Required) * @param {string} [runTests] Run tests mode to execute test on validate (Optional) * @param {string} [testLevel] Test Level to execute test on validate (Optional * @param {string | number} [apiVersion] API version number to use custom API version. By default use the latest API version (Optional) * @param {string | number} [waitMinutes] Minutes to wait until command end (33 By default) (Optional) * * @returns {Process} Returns the process to run * * @throws {DataRequiredException} Throws exception when required data is not provided * @throws {OSNotSupportedException} Throw exception when create process with not supported Operative System. "Operative System Not Supported" * @throws {WrongDatatypeException} If the api version is not a Number or String. Can be undefined */ static mdapiDeployPackageSFDX(usernameOrAlias: string, packageFolder: string, projectFolder: string, testLevel?: string, runTests?: string, apiVersion?: string | number, waitMinutes?: string | number): Process; /** * Method to create the SF process to Deploy a package in a Metadata API format * @param {string} usernameOrAlias Username or Org Alias to connect (Required) * @param {string} packageFolder Package folder path (Required) * @param {string} projectFolder Project folder path (Required) * @param {string} [runTests] Run tests mode to execute test on validate (Optional) * @param {string} [testLevel] Test Level to execute test on validate (Optional * @param {string | number} [apiVersion] API version number to use custom API version. By default use the latest API version (Optional) * @param {string | number} [waitMinutes] Minutes to wait until command end (33 By default) (Optional) * * @returns {Process} Returns the process to run * * @throws {DataRequiredException} Throws exception when required data is not provided * @throws {OSNotSupportedException} Throw exception when create process with not supported Operative System. "Operative System Not Supported" * @throws {WrongDatatypeException} If the api version is not a Number or String. Can be undefined */ static mdapiDeployPackageSF(usernameOrAlias: string, packageFolder: string, projectFolder: string, testLevel?: string, runTests?: string, apiVersion?: string | number, waitMinutes?: string | number): Process; /** * Method to create the SFDX process to quick deploy a validated deployment in a Metadata API format * @param {string} usernameOrAlias Username or Org Alias to connect (Required) * @param {string} deployId Deployment Id (Required) * @param {string} projectFolder Project folder path (Required) * @param {string | number} [apiVersion] API version number to use custom API version. By default use the latest API version (Optional) * * @returns {Process} Returns the process to run * * @throws {DataRequiredException} Throws exception when required data is not provided * @throws {OSNotSupportedException} Throw exception when create process with not supported Operative System. "Operative System Not Supported" * @throws {WrongDatatypeException} If the api version is not a Number or String. Can be undefined */ static mdapiQuickDeploySDFX(usernameOrAlias: string, deployId: string, projectFolder: string, apiVersion?: string | number): Process; /** * Method to create the SF process to quick deploy a validated deployment in a Metadata API format * @param {string} usernameOrAlias Username or Org Alias to connect (Required) * @param {string} deployId Deployment Id (Required) * @param {string} projectFolder Project folder path (Required) * @param {string | number} [apiVersion] API version number to use custom API version. By default use the latest API version (Optional) * * @returns {Process} Returns the process to run * * @throws {DataRequiredException} Throws exception when required data is not provided * @throws {OSNotSupportedException} Throw exception when create process with not supported Operative System. "Operative System Not Supported" * @throws {WrongDatatypeException} If the api version is not a Number or String. Can be undefined */ static mdapiQuickDeploySF(usernameOrAlias: string, deployId: string, projectFolder: string, apiVersion?: string | number): Process; /** * Method to create the SFDX process to get an status of a retrieve in a Metadata API format * @param {string} usernameOrAlias Username or Org Alias to connect (Required) * @param {string} retrieveId Retrieve Id (Required) * @param {string} targetDir The root of the directory structure where the retrieved .zip or metadata files are put. (Required) * * @returns {Process} Returns the process to run * * @throws {DataRequiredException} Throws exception when required data is not provided * @throws {OSNotSupportedException} Throw exception when create process with not supported Operative System. "Operative System Not Supported" */ static mdapiRetrieveReportSFDX(usernameOrAlias: string, retrieveId: string, targetDir: string): Process; /** * Method to create the SF process to get an status of a retrieve in a Metadata API format * @param {string} usernameOrAlias Username or Org Alias to connect (Required) * @param {string} retrieveId Retrieve Id (Required) * @param {string} targetDir The root of the directory structure where the retrieved .zip or metadata files are put. (Required) * * @returns {Process} Returns the process to run * * @throws {DataRequiredException} Throws exception when required data is not provided * @throws {OSNotSupportedException} Throw exception when create process with not supported Operative System. "Operative System Not Supported" */ static mdapiRetrieveReportSF(usernameOrAlias: string, retrieveId: string, targetDir: string): Process; /** * Method to create the SFDX process to get an status of a Deploy in a Metadata API format * @param {string} usernameOrAlias Username or Org Alias to connect (Required) * @param {string} deployId Deployment Id (Required) * @param {string | number} [waitMinutes] Minutes to wait until command end (33 By default) (Optional) * * @returns {Process} Returns the process to run * * @throws {DataRequiredException} Throws exception when required data is not provided * @throws {OSNotSupportedException} Throw exception when create process with not supported Operative System. "Operative System Not Supported" */ static mdapiDeployReportSFDX(usernameOrAlias: string, deployId: string, waitMinutes?: string | number): Process; /** * Method to create the SFDX process to execute a query in the auth org * @param {string} usernameOrAlias Username or Org Alias to connect (Required) * @param {string} query Query to execute (Required) * @param {boolean} [useToolingApi] True for use Tooling API, false in otherwise (false by default) (Optional) * * @returns {Process} Returns the process to run * * @throws {DataRequiredException} Throws exception when required data is not provided * @throws {OSNotSupportedException} Throw exception when create process with not supported Operative System. "Operative System Not Supported" */ static querySFDX(usernameOrAlias: string, query: string, useToolingApi?: boolean): Process; /** * Method to create the SF process to execute a query in the auth org * @param {string} usernameOrAlias Username or Org Alias to connect (Required) * @param {string} query Query to execute (Required) * @param {boolean} [useToolingApi] True for use Tooling API, false in otherwise (false by default) (Optional) * * @returns {Process} Returns the process to run * * @throws {DataRequiredException} Throws exception when required data is not provided * @throws {OSNotSupportedException} Throw exception when create process with not supported Operative System. "Operative System Not Supported" */ static querySF(usernameOrAlias: string, query: string, useToolingApi?: boolean): Process; /** * Method to create the SFDX process to Convert a Metadata API format project into Source format project * @param {string} packageFolder Package folder path (Required) * @param {string} packageFile Package file path (Required) * @param {string} targetFolder Target folder to save the converted project (Required) * @param {string | number} [apiVersion] API version number to use custom API version. By default use the latest API version (Optional) * * @returns {Process} Returns the process to run * * @throws {DataRequiredException} Throws exception when required data is not provided * @throws {OSNotSupportedException} Throw exception when create process with not supported Operative System. "Operative System Not Supported" * @throws {WrongDatatypeException} If the api version is not a Number or String. Can be undefined */ static convertMdApiToSFDX(packageFolder: string, packageFile: string, targetFolder: string, apiVersion?: string | number): Process; /** * Method to create the SF process to Convert a Metadata API format project into Source format project * @param {string} packageFolder Package folder path (Required) * @param {string} packageFile Package file path (Required) * @param {string} targetFolder Target folder to save the converted project (Required) * @param {string | number} [apiVersion] API version number to use custom API version. By default use the latest API version (Optional) * * @returns {Process} Returns the process to run * * @throws {DataRequiredException} Throws exception when required data is not provided * @throws {OSNotSupportedException} Throw exception when create process with not supported Operative System. "Operative System Not Supported" * @throws {WrongDatatypeException} If the api version is not a Number or String. Can be undefined */ static convertMdApiToSF(packageFolder: string, packageFile: string, targetFolder: string, apiVersion?: string | number): Process; /** * Method to create the SFDX process to Convert a Source format project into Metadata API format project * @param {string} packageFile Package file path (Required) * @param {string} projectFolder Project folder path (Required) * @param {string} targetFolder Target folder to save the converted project (Required) * @param {string | number} [apiVersion] API version number to use custom API version. By default use the latest API version (Optional) * * @returns {Process} Returns the process to run * * @throws {DataRequiredException} Throws exception when required data is not provided * @throws {OSNotSupportedException} Throw exception when create process with not supported Operative System. "Operative System Not Supported" * @throws {WrongDatatypeException} If the api version is not a Number or String. Can be undefined */ static convertSFDXToMetadataAPI(packageFile: string, projectFolder: string, targetFolder: string, apiVersion?: string | number): Process; /** * Method to create the SF process to Convert a Source format project into Metadata API format project * @param {string} packageFile Package file path (Required) * @param {string} projectFolder Project folder path (Required) * @param {string} targetFolder Target folder to save the converted project (Required) * @param {string | number} [apiVersion] API version number to use custom API version. By default use the latest API version (Optional) * * @returns {Process} Returns the process to run * * @throws {DataRequiredException} Throws exception when required data is not provided * @throws {OSNotSupportedException} Throw exception when create process with not supported Operative System. "Operative System Not Supported" * @throws {WrongDatatypeException} If the api version is not a Number or String. Can be undefined */ static convertSFToMetadataAPI(packageFile: string, projectFolder: string, targetFolder: string, apiVersion?: string | number): Process; /** * Method to create the SFDX process to create a SFDX Project * @param {string} projectName Project Name to create (Required) * @param {string} projectFolder Folder to save the project (Required) * @param {string} [template] Template for create the project. Empty template bu default (Optional) * @param {string} [namespace] Org's namespace (Optional) * @param {boolean} [withManifest] true to create a project with manifest folder, false in otherwise. True by defult (Optional) * * @returns {Process} Returns the process to run * * @throws {DataRequiredException} Throws exception when required data is not provided * @throws {OSNotSupportedException} Throw exception when create process with not supported Operative System. "Operative System Not Supported" */ static createSFDXProject(projectName: string, projectFolder: string, template?: string, namespace?: string, withManifest?: boolean): Process; /** * Method to create the SF process to create a SFDX Project * @param {string} projectName Project Name to create (Required) * @param {string} projectFolder Folder to save the project (Required) * @param {string} [template] Template for create the project. Empty template bu default (Optional) * @param {string} [namespace] Org's namespace (Optional) * @param {boolean} [withManifest] true to create a project with manifest folder, false in otherwise. True by defult (Optional) * * @returns {Process} Returns the process to run * * @throws {DataRequiredException} Throws exception when required data is not provided * @throws {OSNotSupportedException} Throw exception when create process with not supported Operative System. "Operative System Not Supported" */ static createSFProject(projectName: string, projectFolder: string, template?: string, namespace?: string, withManifest?: boolean): Process; /** * Method to create the SFDX process set an auth org in a project * @param {string} usernameOrAlias Username or Org Alias to connect (Required) * @param {string} projectFolder Project folder path (Required) * * @returns {Process} Returns the process to run * * @throws {DataRequiredException} Throws exception when required data is not provided * @throws {OSNotSupportedException} Throw exception when create process with not supported Operative System. "Operative System Not Supported" */ static setAuthOrgSFDX(usernameOrAlias: string, projectFolder: string): Process; /** * Method to create the SF process set an auth org in a project * @param {string} usernameOrAlias Username or Org Alias to connect (Required) * @param {string} projectFolder Project folder path (Required) * * @returns {Process} Returns the process to run * * @throws {DataRequiredException} Throws exception when required data is not provided * @throws {OSNotSupportedException} Throw exception when create process with not supported Operative System. "Operative System Not Supported" */ static setAuthOrgSF(usernameOrAlias: string, projectFolder: string): Process; /** * Method to create the SFDX process to create the SFDX command to export tree data from an org with a plan * @param {string} usernameOrAlias Username or Org Alias to connect (Required) * @param {string} query query to extract the data (accept subqueries as fields to exports related records) (Required) * @param {string} outputPath Path to save the exported files (Required) * @param {string} [prefix] Prefix to add to file names (Optional) * @param {string | number} [apiVersion] API version number to use custom API version. By default use the latest API version (Optional) * * @returns {Process} Returns the process to run * * @throws {DataRequiredException} Throws exception when required data is not provided * @throws {OSNotSupportedException} Throw exception when create process with not supported Operative System. "Operative System Not Supported" * @throws {WrongDatatypeException} If the api version is not a Number or String. Can be undefined */ static exportTreeDataSFDX(usernameOrAlias: string, query: string, outputPath: string, prefix?: string, apiVersion?: string | number): Process; /** * Method to create the SF process to create the SFDX command to export tree data from an org with a plan * @param {string} usernameOrAlias Username or Org Alias to connect (Required) * @param {string} query query to extract the data (accept subqueries as fields to exports related records) (Required) * @param {string} outputPath Path to save the exported files (Required) * @param {string} [prefix] Prefix to add to file names (Optional) * @param {string | number} [apiVersion] API version number to use custom API version. By default use the latest API version (Optional) * * @returns {Process} Returns the process to run * * @throws {DataRequiredException} Throws exception when required data is not provided * @throws {OSNotSupportedException} Throw exception when create process with not supported Operative System. "Operative System Not Supported" * @throws {WrongDatatypeException} If the api version is not a Number or String. Can be undefined */ static exportTreeDataSF(usernameOrAlias: string, query: string, outputPath: string, prefix?: string, apiVersion?: string | number): Process; /** * Method to create the SFDX process to import data extrated with tree export into an org * @param {string} usernameOrAlias Username or Org Alias to connect (Required) * @param {string} file File to import (Required) * @param {string | number} [apiVersion] API version number to use custom API version. By default use the latest API version (Optional) * * @returns {Process} Returns the process to run * * @throws {DataRequiredException} Throws exception when required data is not provided * @throws {OSNotSupportedException} Throw exception when create process with not supported Operative System. "Operative System Not Supported" * @throws {WrongDatatypeException} If the api version is not a Number or String. Can be undefined */ static importTreeDataSFDX(usernameOrAlias: string, file: string, apiVersion?: string | number): Process; /** * Method to create the SF process to import data extrated with tree export into an org * @param {string} usernameOrAlias Username or Org Alias to connect (Required) * @param {string} file File to import (Required) * @param {string | number} [apiVersion] API version number to use custom API version. By default use the latest API version (Optional) * * @returns {Process} Returns the process to run * * @throws {DataRequiredException} Throws exception when required data is not provided * @throws {OSNotSupportedException} Throw exception when create process with not supported Operative System. "Operative System Not Supported" * @throws {WrongDatatypeException} If the api version is not a Number or String. Can be undefined */ static importTreeDataSF(usernameOrAlias: string, file: string, apiVersion?: string | number): Process; /** * Method to create the SFDX process to execute a bulk delete on org * @param {string} usernameOrAlias Username or Org Alias to connect (Required) * @param {string} csvFile CSV File with the record Ids to delete (Required) * @param {string} sObject SObject API Name to delete records (Required) * @param {string} projectFolder Project folder path (Required) * @param {string | number} [apiVersion] API version number to use custom API version. By default use the latest API version (Optional) * * @returns {Process} Returns the process to run * * @throws {DataRequiredException} Throws exception when required data is not provided * @throws {OSNotSupportedException} Throw exception when create process with not supported Operative System. "Operative System Not Supported" * @throws {WrongDatatypeException} If the api version is not a Number or String. Can be undefined */ static bulkDeleteSFDX(usernameOrAlias: string, csvFile: string, sObject: string, projectFolder: string, apiVersion?: string | number): Process; /** * Method to create the SF process to execute a bulk delete on org * @param {string} usernameOrAlias Username or Org Alias to connect (Required) * @param {string} csvFile CSV File with the record Ids to delete (Required) * @param {string} sObject SObject API Name to delete records (Required) * @param {string} projectFolder Project folder path (Required) * @param {string | number} [apiVersion] API version number to use custom API version. By default use the latest API version (Optional) * * @returns {Process} Returns the process to run * * @throws {DataRequiredException} Throws exception when required data is not provided * @throws {OSNotSupportedException} Throw exception when create process with not supported Operative System. "Operative System Not Supported" * @throws {WrongDatatypeException} If the api version is not a Number or String. Can be undefined */ static bulkDeleteSF(usernameOrAlias: string, csvFile: string, sObject: string, projectFolder: string, apiVersion?: string | number): Process; /** * Method to create the SFDX process to execute an Apex Anonymous script file * @param {string} usernameOrAlias Username or Org Alias to connect (Required) * @param {string} scriptFile Apex script File to execute (Required) * @param {string} projectFolder Project folder path (Required) * @param {string | number} [apiVersion] API version number to use custom API version. By default use the latest API version (Optional) * * @returns {Process} Returns the process to run * * @throws {DataRequiredException} Throws exception when required data is not provided * @throws {OSNotSupportedException} Throw exception when create process with not supported Operative System. "Operative System Not Supported" * @throws {WrongDatatypeException} If the api version is not a Number or String. Can be undefined */ static executeApexAnonymousSFDX(usernameOrAlias: string, scriptFile: string, projectFolder: string, apiVersion?: string | number): Process; /** * Method to create the SF process to execute an Apex Anonymous script file * @param {string} usernameOrAlias Username or Org Alias to connect (Required) * @param {string} scriptFile Apex script File to execute (Required) * @param {string} projectFolder Project folder path (Required) * @param {string | number} [apiVersion] API version number to use custom API version. By default use the latest API version (Optional) * * @returns {Process} Returns the process to run * * @throws {DataRequiredException} Throws exception when required data is not provided * @throws {OSNotSupportedException} Throw exception when create process with not supported Operative System. "Operative System Not Supported" * @throws {WrongDatatypeException} If the api version is not a Number or String. Can be undefined */ static executeApexAnonymousSF(usernameOrAlias: string, scriptFile: string, projectFolder: string, apiVersion?: string | number): Process; /** * Method to create the GIT process to get any config value or list all configs * @param {string} projectFolder Project folder path (Required) * @param {string} [configName] GIT config name (if not provided, list all configs) (Optional) * * @returns {Process} Returns the process to run * * @throws {DataRequiredException} Throws exception when required data is not provided * @throws {OSNotSupportedException} Throw exception when create process with not supported Operative System. "Operative System Not Supported" */ static gitGetConfig(projectFolder: string, configName?: string): Process; /** * Method to create the GIT process to execute a GIT Log with --pretty=medium option * @param {string} projectFolder Project folder path (Required) * @param {string} [logPrettyLevel] GIT Log pretty level (Medium by default) (Optional) * @param {string} [sourceDiff] Source Commit, Branch, Tag to compare (Optional) * @param {string} [targetDiff] Target Commit, Branch, Tag to compare (Optional) * * @returns {Process} Returns the process to run * * @throws {DataRequiredException} Throws exception when required data is not provided * @throws {OSNotSupportedException} Throw exception when create process with not supported Operative System. "Operative System Not Supported" */ static gitLog(projectFolder: string, logPrettyLevel?: string, sourceDiff?: string, targetDiff?: string): Process; /** * Method to create the GIT process to get list all tags * @param {string} projectFolder Project folder path (Required) * @param {string} [sortField] Sort field to sort tags (Optional) * * @returns {Process} Returns the process to run * * @throws {DataRequiredException} Throws exception when required data is not provided * @throws {OSNotSupportedException} Throw exception when create process with not supported Operative System. "Operative System Not Supported" */ static gitGetTags(projectFolder: string, sortField?: string): Process; /** * Method to create the GIT process to get all branches data * @param {string} projectFolder Project folder path (Required) * * @returns {Process} Returns the process to run * * @throws {DataRequiredException} Throws exception when required data is not provided * @throws {OSNotSupportedException} Throw exception when create process with not supported Operative System. "Operative System Not Supported" */ static gitGetBranches(projectFolder: string): Process; /** * Method to create the GIT process to fetch git data * @param {string} projectFolder Project folder path (Required) * * @returns {Process} Returns the process to run * * @throws {DataRequiredException} Throws exception when required data is not provided * @throws {OSNotSupportedException} Throw exception when create process with not supported Operative System. "Operative System Not Supported" */ static gitFetch(projectFolder: string): Process; /** * Method to create the GIT process to get diff data between two branches, tags, commits... * @param {string} projectFolder Project folder path (Required) * @param {string} source Source to get the diff (Required) * @param {string} [target] Target to get the diff. (If not select target, the process will execute the command "git diff source") (Optional) * * @returns {Process} Returns the process to run * * @throws {DataRequiredException} Throws exception when required data is not provided * @throws {OSNotSupportedException} Throw exception when create process with not supported Operative System. "Operative System Not Supported" */ static gitDiff(projectFolder: string, source: string, target?: string): Process; /** * Method to create he GIT process to get all files under GIT control * @param {string} projectFolder Project folder path (Required) * * @returns {Process} Returns the process to run * * @throws {DataRequiredException} Throws exception when required data is not provided * @throws {OSNotSupportedException} Throw exception when create process with not supported Operative System. "Operative System Not Supported" */ static gitListFiles(projectFolder: string): Process; /** * Method to create the Aura Helper CLI process to compress all XML files from a folder (and subfolders) * @param {string} projectFolder Project folder path (Required) * @param {AuraHelperCLICompressFolderOptions} options Options object to run the command (Required) * @param {(data: any) => void} [callback] Callback to handle progress * * @returns {Process} Returns the process to run * * @throws {DataRequiredException} Throws exception when required data is not provided * @throws {OSNotSupportedException} Throw exception when create process with not supported Operative System. "Operative System Not Supported" */ static auraHelperCompressFolder(projectFolder: string, options: AuraHelperCLICompressFolderOptions, callback?: (data: any) => void): Process; /** * Method to create the Aura Helper CLI process to one file or a list of files * @param {string} projectFolder Project folder path (Required) * @param {AuraHelperCLICompressFileOptions} options Options object to run the command (Required) * @param {(data: any) => void} [callback] Callback to handle progress * * @returns {Process} Returns the process to run * * @throws {DataRequiredException} Throws exception when required data is not provided * @throws {OSNotSupportedException} Throw exception when create process with not supported Operative System. "Operative System Not Supported" */ static auraHelperCompressFile(projectFolder: string, options: AuraHelperCLICompressFileOptions, callback?: (data: any) => void): Process; /** * Method to create the Aura Helper CLI process to compare the the local project with the auth org * @param {string} projectFolder Project folder path (Required) * @param {AuraHelperCLICompareOptions} options Options object to run the command (Required) * @param {(data: any) => void} [callback] Callback to handle progress * * @returns {Process} Returns the process to run * * @throws {DataRequiredException} Throws exception when required data is not provided * @throws {OSNotSupportedException} Throw exception when create process with not supported Operative System. "Operative System Not Supported" * @throws {WrongDatatypeException} If the api version is not a Number or String. Can be undefined */ static auraHelperOrgCompare(projectFolder: string, options: AuraHelperCLICompareOptions, callback?: (data: any) => void): Process; /** * Method to create the Aura Helper CLI process to compare two orgs between * @param {string} projectFolder Project folder path (Required) * @param {AuraHelperCLICompareBetweenOptions} options Options object to run the command (Required) * @param {(data: any) => void} [callback] Callback to handle progress * * @returns {Process} Returns the process to run * * @throws {DataRequiredException} Throws exception when required data is not provided * @throws {OSNotSupportedException} Throw exception when create process with not supported Operative System. "Operative System Not Supported" * @throws {WrongDatatypeException} If the api version is not a Number or String. Can be undefined */ static auraHelperOrgCompareBetween(projectFolder: string, options: AuraHelperCLICompareBetweenOptions, callback?: (data: any) => void): Process; /** * Method to create the Aura Helper CLI process to describe metadata types from your local project or the auth org * @param {string} projectFolder Project folder path (Required) * @param {AuraHelperCLIDescribeOptions} options Options object to run the command (Required) * @param {(data: any) => void} [callback] Callback to handle progress * * @returns {Process} Returns the process to run * * @throws {DataRequiredException} Throws exception when required data is not provided * @throws {OSNotSupportedException} Throw exception when create process with not supported Operative System. "Operative System Not Supported" * @throws {WrongDatatypeException} If the api version is not a Number or String. Can be undefined */ static auraHelperDescribeMetadata(projectFolder: string, options: AuraHelperCLIDescribeOptions, callback?: (data: any) => void): Process; /** * Method to create the Aura Helper CLI process to Retrieve special types * @param {string} projectFolder Project folder path (Required) * @param {AuraHelperCLIRetrieveSpecialOptions} [options] Options object to run the command (Required) * @param {(data: any) => void} [callback] Callback to handle progress * * @returns {Process} Returns the process to run * * @throws {DataRequiredException} Throws exception when required data is not provided * @throws {OSNotSupportedException} Throw exception when create process with not supported Operative System. "Operative System Not Supported" * @throws {WrongDatatypeException} If the api version is not a Number or String. Can be undefined */ static auraHelperRetrieveSpecial(projectFolder: string, options: AuraHelperCLIRetrieveSpecialOptions, callback?: (data: any) => void): Process; /** * Method to create the Aura Helper CLI process to load user premissions from auth org * @param {string} projectFolder Project folder path (Required) * @param {AuraHelperCLIPermissionsOptions} [options] Options object to run the command * @param {(data: any) => void} [callback] Callback to handle progress * * @returns {Process} Returns the process to run * * @throws {DataRequiredException} Throws exception when required data is not provided * @throws {OSNotSupportedException} Throw exception when create process with not supported Operative System. "Operative System Not Supported" * @throws {WrongDatatypeException} If the api version is not a Number or String. Can be undefined */ static auraHelperLoadPermissions(projectFolder: string, options?: AuraHelperCLIPermissionsOptions, callback?: (data: any) => void): Process; /** * Method to create the Aura Helper CLI process to create the package file * @param {string} projectFolder Project folder path (Required) * @param {AuraHelperCLIPackageGeneratorOptions} options Options object to run the command (Required) * @param {(data: any) => void} [callback] Callback to handle progress * * @returns {Process} Returns the process to run * * @throws {DataRequiredException} Throws exception when required data is not provided * @throws {OSNotSupportedException} Throw exception when create process with not supported Operative System. "Operative System Not Supported" * @throws {WrongDatatypeException} If the api version is not a Number or String. Can be undefined */ static auraHelperPackageGenerator(projectFolder: string, options: AuraHelperCLIPackageGeneratorOptions, callback?: (data: any) => void): Process; /** * Method to create the Aura Helper CLI process to repair the project dependencies * @param {string} projectFolder Project folder path (Required) * @param {AuraHelperCLIDependenciesOptions} [options] Options object to run the command * @param {(data: any) => void} [callback] Callback to handle progress * * @returns {Process} Returns the process to run * * @throws {DataRequiredException} Throws exception when required data is not provided * @throws {OSNotSupportedException} Throw exception when create process with not supported Operative System. "Operative System Not Supported" */ static auraHelperRepairDependencies(projectFolder: string, options?: AuraHelperCLIDependenciesOptions, callback?: (data: any) => void): Process; /** * Method to create the Aura Helper CLI process to ignore metadata from your project * @param {string} projectFolder Project folder path (Required) * @param {AuraHelperCLIIgnoreOptions} [options] Options object to run the command * @param {(data: any) => void} [callback] Callback to handle progress * * @returns {Process} Returns the process to run * * @throws {DataRequiredException} Throws exception when required data is not provided * @throws {OSNotSupportedException} Throw exception when create process with not supported Operative System. "Operative System Not Supported" */ static auraHelperIgnore(projectFolder: string, options?: AuraHelperCLIIgnoreOptions, callback?: (data: any) => void): Process; /** * Method to create the Aura Helper CLI process to check if is installed * @returns {Process} Returns the process to run * * @throws {OSNotSupportedException} Throw exception when create process with not supported Operative System. "Operative System Not Supported" */ static isAuraHelperInstalled(): Process; /** * Method to create the Aura Helper CLI process to get the Aura Helper CLI version * @returns {Process} Returns the process to run * * @throws {OSNotSupportedException} Throw exception when create process with not supported Operative System. "Operative System Not Supported" */ static auraHelperVersion(): Process; /** * Method to create the Aura Helper CLI process to update Aura Helper CLI * @returns {Process} Returns the process to run * * @throws {OSNotSupportedException} Throw exception when create process with not supported Operative System. "Operative System Not Supported" */ static auraHelperUpdate(): Process; /** * Method to create the Aura Helper SFDX process to compress all XML files from a folder (and subfolders) * @param {string} projectFolder Project folder path (Required) * @param {AuraHelperSFDXCompressFolderOptions} options Options object to run the command (Required) * @param {(data: any) => void} [callback] Callback to handle progress * * @returns {Process} Returns the process to run * * @throws {DataRequiredException} Throws exception when required data is not provided * @throws {OSNotSupportedException} Throw exception when create process with not supported Operative System. "Operative System Not Supported" */ static auraHelperSFDXCompressFolder(projectFolder: string, options: AuraHelperSFDXCompressFolderOptions, callback?: (data: any) => void): Process; /** * Method to create the Aura Helper SF process to compress all XML files from a folder (and subfolders) * @param {string} projectFolder Project folder path (Required) * @param {AuraHelperSFDXCompressFolderOptions} options Options object to run the command (Required) * @param {(data: any) => void} [callback] Callback to handle progress * * @returns {Process} Returns the process to run * * @throws {DataRequiredException} Throws exception when required data is not provided * @throws {OSNotSupportedException} Throw exception when create process with not supported Operative System. "Operative System Not Supported" */ static auraHelperSFCompressFolder(projectFolder: string, options: AuraHelperSFDXCompressFolderOptions, callback?: (data: any) => void): Process; /** * Method to create the Aura Helper SFDX process to one file or a list of files * @param {string} projectFolder Project folder path (Required) * @param {AuraHelperSFDXCompressFileOptions} options Options object to run the command (Required) * @param {(data: any) => void} [callback] Callback to handle progress * * @returns {Process} Returns the process to run * * @throws {DataRequiredException} Throws exception when required data is not provided * @throws {OSNotSupportedException} Throw exception when create process with not supported Operative System. "Operative System Not Supported" */ static auraHelperSFDXCompressFile(projectFolder: string, options: AuraHelperSFDXCompressFileOptions, callback?: (data: any) => void): Process; /** * Method to create the Aura Helper SF process to one file or a list of files * @param {string} projectFolder Project folder path (Required) * @param {AuraHelperSFDXCompressFileOptions} options Options object to run the command (Required) * @param {(data: any) => void} [callback] Callback to handle progress * * @returns {Process} Returns the process to run * * @throws {DataRequiredException} Throws exception when required data is not provided * @throws {OSNotSupportedException} Throw exception when create process with not supported Operative System. "Operative System Not Supported" */ static auraHelperSFCompressFile(projectFolder: string, options: AuraHelperSFDXCompressFileOptions, callback?: (data: any) => void): Process; /** * Method to create the Aura Helper SFDX process to compare the the local project with the auth org * @param {string} projectFolder Project folder path (Required) * @param {AuraHelperSFDXCompareOptions} options Options object to run the command (Required) * @param {(data: any) => void} [callback] Callback to handle progress * * @returns {Process} Returns the process to run * * @throws {DataRequiredException} Throws exception when required data is not provided * @throws {OSNotSupportedException} Throw exception when create process with not supported Operative System. "Operative System Not Supported" * @throws {WrongDatatypeException} If the api version is not a Number or String. Can be undefined */ static auraHelperSFDXOrgCompare(projectFolder: string, options: AuraHelperSFDXCompareOptions, callback?: (data: any) => void): Process; /** * Method to create the Aura Helper SF process to compare the the local project with the auth org * @param {string} projectFolder Project folder path (Required) * @param {AuraHelperSFDXCompareOptions} options Options object to run the command (Required) * @param {(data: any) => void} [callback] Callback to handle progress * * @returns {Process} Returns the process to run * * @throws {DataRequiredException} Throws exception when required data is not provided * @throws {OSNotSupportedException} Throw exception when create process with not supported Operative System. "Operative System Not Supported" * @throws {WrongDatatypeException} If the api version is not a Number or String. Can be undefined */ static auraHelperSFOrgCompare(projectFolder: string, options: AuraHelperSFDXCompareOptions, callback?: (data: any) => void): Process; /** * Method to create the Aura Helper SFDX process to compare two orgs between * @param {string} projectFolder Project folder path (Required) * @param {AuraHelperCLICompareBetweenOptions} options Options object to run the command (Required) * @param {(data: any) => void} [callback] Callback to handle progress * * @returns {Process} Returns the process to run * * @throws {DataRequiredException} Throws exception when required data is not provided * @throws {OSNotSupportedException} Throw exception when create process with not supported Operative System. "Operative System Not Supported" * @throws {WrongDatatypeException} If the api version is not a Number or String. Can be undefined */ static auraHelperSFDXOrgCompareBetween(projectFolder: string, options: AuraHelperSFDXCompareBetweenOptions, callback?: (data: any) => void): Process; /** * Method to create the Aura Helper SF process to compare two orgs between * @param {string} projectFolder Project folder path (Required) * @param {AuraHelperCLICompareBetweenOptions} options Options object to run the command (Required) * @param {(data: any) => void} [callback] Callback to handle progress * * @returns {Process} Returns the process to run * * @throws {DataRequiredException} Throws exception when required data is not provided * @throws {OSNotSupportedException} Throw exception when create process with not supported Operative System. "Operative System Not Supported" * @throws {WrongDatatypeException} If the api version is not a Number or String. Can be undefined */ static auraHelperSFOrgCompareBetween(projectFolder: string, options: AuraHelperSFDXCompareBetweenOptions, callback?: (data: any) => void): Process; /** * Method to create the Aura Helper SFDX process to describe metadata types from your local project or the auth org * @param {string} projectFolder Project folder path (Required) * @param {AuraHelperSFDXDescribeOptions} options Options object to run the command (Required) * @param {(data: any) => void} [callback] Callback to handle progress * * @returns {Process} Returns the process to run * * @throws {DataRequiredException} Throws exception when required data is not provided * @throws {OSNotSupportedException} Throw exception when create process with not supported Operative System. "Operative System Not Supported" * @throws {WrongDatatypeException} If the api version is not a Number or String. Can be undefined */ static auraHelperSFDXDescribeMetadata(projectFolder: string, options: AuraHelperSFDXDescribeOptions, callback?: (data: any) => void): Process; /** * Method to create the Aura Helper SF process to describe metadata types from your local project or the auth org * @param {string} projectFolder Project folder path (Required) * @param {AuraHelperSFDXDescribeOptions} options Options object to run the command (Required) * @param {(data: any) => void} [callback] Callback to handle progress * * @returns {Process} Returns the process to run * * @throws {DataRequiredException} Throws exception when required data is not provided * @throws {OSNotSupportedException} Throw exception when create process with not supported Operative System. "Operative System Not Supported" * @throws {WrongDatatypeException} If the api version is not a Number or String. Can be undefined */ static auraHelperSFDescribeMetadata(projectFolder: string, options: AuraHelperSFDXDescribeOptions, callback?: (data: any) => void): Process; /** * Method to create the Aura Helper SFDX process to Retrieve special types * @param {string} projectFolder Project folder path (Required) * @param {AuraHelperSFDXRetrieveSpecialOptions} options Options object to run the command (Required) * @param {(data: any) => void} [callback] Callback to handle progress * * @returns {Process} Returns the process to run * * @throws {DataRequiredException} Throws exception when required data is not provided * @throws {OSNotSupportedException} Throw exception when create process with not supported Operative System. "Operative System Not Supported" * @throws {WrongDatatypeException} If the api version is not a Number or String. Can be undefined */ static auraHelperSFDXRetrieveSpecial(projectFolder: string, options: AuraHelperSFDXRetrieveSpecialOptions, callback?: (data: any) => void): Process; /** * Method to create the Aura Helper SF process to Retrieve special types * @param {string} projectFolder Project folder path (Required) * @param {AuraHelperSFDXRetrieveSpecialOptions} options Options object to run the command (Required) * @param {(data: any) => void} [callback] Callback to handle progress * * @returns {Process} Returns the process to run * * @throws {DataRequiredException} Throws exception when required data is not provided * @throws {OSNotSupportedException} Throw exception when create process with not supported Operative System. "Operative System Not Supported" * @throws {WrongDatatypeException} If the api version is not a Number or String. Can be undefined */ static auraHelperSFRetrieveSpecial(projectFolder: string, options: AuraHelperSFDXRetrieveSpecialOptions, callback?: (data: any) => void): Process; /** * Method to create the Aura Helper SFDX process to load user premissions from auth org * @param {string} projectFolder Project folder path (Required) * @param {any} [options] Options object to run the command * @param {(data: any) => void} [callback] Callback to handle progress * * @returns {Process} Returns the process to run * * @throws {DataRequiredException} Throws exception when required data is not provided * @throws {OSNotSupportedException} Throw exception when create process with not supported Operative System. "Operative System Not Supported" * @throws {WrongDatatypeException} If the api version is not a Number or String. Can be undefined */ static auraHelperSFDXLoadPermissions(projectFolder: string, options?: AuraHelperSFDXPermissionsOptions, callback?: (data: any) => void): Process; /** * Method to create the Aura Helper SF process to load user premissions from auth org * @param {string} projectFolder Project folder path (Required) * @param {any} [options] Options object to run the command * @param {(data: any) => void} [callback] Callback to handle progress * * @returns {Process} Returns the process to run * * @throws {DataRequiredException} Throws exception when required data is not provided * @throws {OSNotSupportedException} Throw exception when create process with not supported Operative System. "Operative System Not Supported" * @throws {WrongDatatypeException} If the api version is not a Number or String. Can be undefined */ static auraHelperSFLoadPermissions(projectFolder: string, options?: AuraHelperSFDXPermissionsOptions, callback?: (data: any) => void): Process; /** * Method to create the Aura Helper SFDX process to create packages from GIT * @param {string} projectFolder Project folder path (Required) * @param {AuraHelperSFDXGitPackageOptions} [options] Options object to run the command * @param {(data: any) => void} [callback] Callback to handle progress * * @returns {Process} Returns the process to run * * @throws {DataRequiredException} Throws exception when required data is not provided * @throws {OSNotSupportedException} Throw exception when create process with not supported Operative System. "Operative System Not Supported" */ static auraHelperSFDXGitPackage(projectFolder: string, options?: AuraHelperSFDXGitPackageOptions, callback?: (data: any) => void): Process; /** * Method to create the Aura Helper SF process to create packages from GIT * @param {string} projectFolder Project folder path (Required) * @param {AuraHelperSFDXGitPackageOptions} [options] Options object to run the command * @param {(data: any) => void} [callback] Callback to handle progress * * @returns {Process} Returns the process to run * * @throws {DataRequiredException} Throws exception when required data is not provided * @throws {OSNotSupportedException} Throw exception when create process with not supported Operative System. "Operative System Not Supported" */ static auraHelperSFGitPackage(projectFolder: string, options?: AuraHelperSFDXGitPackageOptions, callback?: (data: any) => void): Process; /** * Method to create the Aura Helper SFDX process to create packages from JSON * @param {string} projectFolder Project folder path (Required) * @param {AuraHelperSFDXJSONPackageOptions} options Options object to run the command * @param {(data: any) => void} [callback] Callback to handle progress * * @returns {Process} Returns the process to run * * @throws {DataRequiredException} Throws exception when required data is not provided * @throws {OSNotSupportedException} Throw exception when create process with not supported Operative System. "Operative System Not Supported" */ static auraHelperSFDXJSONPackage(projectFolder: string, options: AuraHelperSFDXJSONPackageOptions, callback?: (data: any) => void): Process; /** * Method to create the Aura Helper SF process to create packages from JSON * @param {string} projectFolder Project folder path (Required) * @param {AuraHelperSFDXJSONPackageOptions} options Options object to run the command * @param {(data: any) => void} [callback] Callback to handle progress * * @returns {Process} Returns the process to run * * @throws {DataRequiredException} Throws exception when required data is not provided * @throws {OSNotSupportedException} Throw exception when create process with not supported Operative System. "Operative System Not Supported" */ static auraHelperSFJSONPackage(projectFolder: string, options: AuraHelperSFDXJSONPackageOptions, callback?: (data: any) => void): Process; /** * Method to create the Aura Helper SFDX process to merge package files * @param {string} projectFolder Project folder path (Required) * @param {AuraHelperSFDXMergePackageOptions} options Options object to run the command * @param {(data: any) => void} [callback] Callback to handle progress * * @returns {Process} Returns the process to run * * @throws {DataRequiredException} Throws exception when required data is not provided * @throws {OSNotSupportedException} Throw exception when create process with not supported Operative System. "Operative System Not Supported" */ static auraHelperSFDXMergePackage(projectFolder: string, options: AuraHelperSFDXMergePackageOptions, callback?: (data: any) => void): Process; /** * Method to create the Aura Helper SF process to merge package files * @param {string} projectFolder Project folder path (Required) * @param {AuraHelperSFDXMergePackageOptions} options Options object to run the command * @param {(data: any) => void} [callback] Callback to handle progress * * @returns {Process} Returns the process to run * * @throws {DataRequiredException} Throws exception when required data is not provided * @throws {OSNotSupportedException} Throw exception when create process with not supported Operative System. "Operative System Not Supported" */ static auraHelperSFMergePackage(projectFolder: string, options: AuraHelperSFDXMergePackageOptions, callback?: (data: any) => void): Process; /** * Method to create the Aura Helper SFDX process to repair the project dependencies * @param {string} projectFolder Project folder path (Required) * @param {AuraHelperSFDXDependenciesOptions} [options] Options object to run the command * @param {(data: any) => void} [callback] Callback to handle progress * * @returns {Process} Returns the process to run * * @throws {DataRequiredException} Throws exception when required data is not provided * @throws {OSNotSupportedException} Throw exception when create process with not supported Operative System. "Operative System Not Supported" */ static auraHelperSFDXRepairDependencies(projectFolder: string, options?: AuraHelperSFDXDependenciesOptions, callback?: (data: any) => void): Process; /** * Method to create the Aura Helper SF process to repair the project dependencies * @param {string} projectFolder Project folder path (Required) * @param {AuraHelperSFDXDependenciesOptions} [options] Options object to run the command * @param {(data: any) => void} [callback] Callback to handle progress * * @returns {Process} Returns the process to run * * @throws {DataRequiredException} Throws exception when required data is not provided * @throws {OSNotSupportedException} Throw exception when create process with not supported Operative System. "Operative System Not Supported" */ static auraHelperSFRepairDependencies(projectFolder: string, options?: AuraHelperSFDXDependenciesOptions, callback?: (data: any) => void): Process; /** * Method to create the Aura Helper SFDX process to ignore metadata from your project * @param {string} projectFolder Project folder path (Required) * @param {AuraHelperSFDXIgnoreOptions} [options] Options object to run the command * @param {(data: any) => void} [callback] Callback to handle progress * * @returns {Process} Returns the process to run * * @throws {DataRequiredException} Throws exception when required data is not provided * @throws {OSNotSupportedException} Throw exception when create process with not supported Operative System. "Operative System Not Supported" */ static auraHelperSFDXIgnore(projectFolder: string, options?: AuraHelperSFDXIgnoreOptions, callback?: (data: any) => void): Process; /** * Method to create the Aura Helper SF process to ignore metadata from your project * @param {string} projectFolder Project folder path (Required) * @param {AuraHelperSFDXIgnoreOptions} [options] Options object to run the command * @param {(data: any) => void} [callback] Callback to handle progress * * @returns {Process} Returns the process to run * * @throws {DataRequiredException} Throws exception when required data is not provided * @throws {OSNotSupportedException} Throw exception when create process with not supported Operative System. "Operative System Not Supported" */ static auraHelperSFIgnore(projectFolder: string, options?: AuraHelperSFDXIgnoreOptions, callback?: (data: any) => void): Process; /** * Method to create the Aura Helper SFDX process to get the Aura Helper SFDX version * @returns {Process} Returns the process to run * * @throws {OSNotSupportedException} Throw exception when create process with not supported Operative System. "Operative System Not Supported" */ static getSFDXPlugins(): Process; /** * Method to create the Aura Helper SFDX process to get the Aura Helper SFDX version * @returns {Process} Returns the process to run * * @throws {OSNotSupportedException} Throw exception when create process with not supported Operative System. "Operative System Not Supported" */ static getSFPlugins(): Process; /** * Method to create the Aura Helper SFDX process to get the Aura Helper SFDX version * @returns {Process} Returns the process to run * * @throws {OSNotSupportedException} Throw exception when create process with not supported Operative System. "Operative System Not Supported" */ static auraHelperSFDXVersion(): Process; /** * Method to create the Aura Helper SFDX process to get the Aura Helper SFDX version * @returns {Process} Returns the process to run * * @throws {OSNotSupportedException} Throw exception when create process with not supported Operative System. "Operative System Not Supported" */ static auraHelperSFVersion(): Process; /** * Method to create the SFDX process to update Aura Helper SFDX * @returns {Process} Returns the process to run * * @throws {OSNotSupportedException} Throw exception when create process with not supported Operative System. "Operative System Not Supported" */ static auraHelperSFDXUpdate(): Process; /** * Method to create the SFDX process to update Aura Helper SFDX * @returns {Process} Returns the process to run * * @throws {OSNotSupportedException} Throw exception when create process with not supported Operative System. "Operative System Not Supported" */ static auraHelperSFUpdate(): Process; /** * Method to create the SFDX process to update Aura Helper SFDX * @returns {Process} Returns the process to run * * @throws {OSNotSupportedException} Throw exception when create process with not supported Operative System. "Operative System Not Supported" */ static installUpdateSFDXScanner(): Process; /** * Method to create the Update NPM process for Aura Helper CLI * @returns {Process} Returns the process to run * * @throws {OSNotSupportedException} Throw exception when create process with not supported Operative System. "Operative System Not Supported" */ static auraHelperCLIInstallNPM(): Process; /** * Method to create the NPM process to update Aura Helper CLI * @returns {Process} Returns the process to run * * @throws {OSNotSupportedException} Throw exception when create process with not supported Operative System. "Operative System Not Supported" */ static auraHelperCLIUpdateNPM(): Process; /** * Method to create the SFDX Scanner command * @param {string} target File or folder targe to analize * @param {Array} [categories] Categories to include on analisys * @param {string} [outputFile] Output file to redirect the output * @returns */ static runSFDXScanner(target: string, categories?: string[], pmdRuleSetPath?: string, esLintRuleSetPath?: string, outputFile?: string): Process; /** * Method to create the SF Scanner command * @param {string} target File or folder targe to analize * @param {Array} [categories] Categories to include on analisys * @param {string} [outputFile] Output file to redirect the output * @returns */ static runSFScanner(target: string, categories?: string[], pmdRuleSetPath?: string, esLintRuleSetPath?: string, outputFile?: string): Process; }