Class MetadataApi

Metadata API implementation for Vlocode partially compatible with Metadata API class from JSforce.

Key differences between the JSforce implementation:

Does not support async Metadata API calls as these are deprecated by Salesforce since API version 31.0
Support strongly typed metadata APIs with IDE type completion
Support for both REST as well as SOAP Metadata API
Support deployment cancellation
Support rename of metadata
Support describe value type
Does not support old nodejs callback style; all calls return an awaitable promise

Implements

DeploymentApi

Constructors

constructor

new MetadataApi(connection: SalesforceConnection): MetadataApi
Parameters
- connection: SalesforceConnection
Returns MetadataApi
- Defined in packages/salesforce/src/connection/metadata/metadataApi.ts:62

Properties

Methods

cancelDeploy

cancelDeploy(id: string): Promise<DeployResult>
Parameters
- id: string
Returns Promise<DeployResult>
Implementation of DeploymentApi.cancelDeploy
- Defined in packages/salesforce/src/connection/metadata/metadataApi.ts:274

checkDeployStatus

checkDeployStatus(id: string, includeDetails?: boolean): Promise<DeployResult>
Parameters
- id: string
- OptionalincludeDetails: boolean
Returns Promise<DeployResult>
Implementation of DeploymentApi.checkDeployStatus
- Defined in packages/salesforce/src/connection/metadata/metadataApi.ts:270

checkRetrieveStatus

checkRetrieveStatus(id: string, includeZip?: boolean): Promise<RetrieveResult>
Parameters
- id: string
- OptionalincludeZip: boolean
Returns Promise<RetrieveResult>
- Defined in packages/salesforce/src/connection/metadata/metadataApi.ts:255

`Private`convertArray

convertArray<T>(value: T | T[], asArray: true): T[]
Type Parameters
- T
Parameters
- value: T | T[]
- asArray: true
Returns T[]
- Defined in packages/salesforce/src/connection/metadata/metadataApi.ts:84
convertArray<T>(value: T | T[], asArray: false): T
Type Parameters
- T
Parameters
- value: T | T[]
- asArray: false
Returns T
- Defined in packages/salesforce/src/connection/metadata/metadataApi.ts:85
convertArray<T>(value: T | T[], asArray: boolean): T | T[]
Type Parameters
- T
Parameters
- value: T | T[]
- asArray: boolean
Returns T | T[]
- Defined in packages/salesforce/src/connection/metadata/metadataApi.ts:86

create

create<K extends keyof MetadataTypes>(
type: K,
metadata: MetadataTypes[K],
): Promise<SaveResult>
Creates metadata entries synchronously.
Type Parameters
- K extends keyof MetadataTypes
Parameters
- type: K
  Metadata type name
- metadata: MetadataTypes[K]
  Metadata entry to create
Returns Promise<SaveResult>
- Defined in packages/salesforce/src/connection/metadata/metadataApi.ts:192
create<K extends keyof MetadataTypes>(
type: K,
metadata: MetadataTypes[K][],
): Promise<SaveResult[]>
Creates metadata entries synchronously.
Type Parameters
- K extends keyof MetadataTypes
Parameters
- type: K
  Metadata type name
- metadata: MetadataTypes[K][]
  Metadata entry to create
Returns Promise<SaveResult[]>
- Defined in packages/salesforce/src/connection/metadata/metadataApi.ts:193
create(type: string, metadata: SalesforceMetadata): Promise<SaveResult>
Creates metadata entries synchronously.
Parameters
- type: string
  Metadata type name
- metadata: SalesforceMetadata
  Metadata entry to create
Returns Promise<SaveResult>
- Defined in packages/salesforce/src/connection/metadata/metadataApi.ts:195
create(type: string, metadata: SalesforceMetadata[]): Promise<SaveResult[]>
Creates metadata entries synchronously.
Parameters
- type: string
  Metadata type name
- metadata: SalesforceMetadata[]
  Metadata entry to create
Returns Promise<SaveResult[]>
- Defined in packages/salesforce/src/connection/metadata/metadataApi.ts:196

delete

delete(type: keyof MetadataTypes, fullNames: string): Promise<DeleteResult>
Delete metadata entries synchronously.
Parameters
- type: keyof MetadataTypes
  Metadata type name
- fullNames: string
  Dull name of the metadata to delete
Returns Promise<DeleteResult>
- Defined in packages/salesforce/src/connection/metadata/metadataApi.ts:240
delete(type: keyof MetadataTypes, fullNames: string): Promise<DeleteResult[]>
Delete metadata entries synchronously.
Parameters
- type: keyof MetadataTypes
  Metadata type name
- fullNames: string
  Dull name of the metadata to delete
Returns Promise<DeleteResult[]>
- Defined in packages/salesforce/src/connection/metadata/metadataApi.ts:241
delete(type: string, fullNames: string): Promise<DeleteResult>
Delete metadata entries synchronously.
Parameters
- type: string
  Metadata type name
- fullNames: string
  Dull name of the metadata to delete
Returns Promise<DeleteResult>
- Defined in packages/salesforce/src/connection/metadata/metadataApi.ts:243
delete(type: string, fullNames: string[]): Promise<DeleteResult[]>
Delete metadata entries synchronously.
Parameters
- type: string
  Metadata type name
- fullNames: string[]
  Dull name of the metadata to delete
Returns Promise<DeleteResult[]>
- Defined in packages/salesforce/src/connection/metadata/metadataApi.ts:244

deploy

deploy(
data: string | Buffer<ArrayBufferLike> | Stream,
deployOptions: DeployOptions,
): Promise<DeployResult>
Parameters
- data: string | Buffer<ArrayBufferLike> | Stream
- deployOptions: DeployOptions
Returns Promise<DeployResult>
Implementation of DeploymentApi.deploy
- Defined in packages/salesforce/src/connection/metadata/metadataApi.ts:262

deployRecentValidation

deployRecentValidation(id: string): Promise<DeployResult>
Parameters
- id: string
Returns Promise<DeployResult>
Implementation of DeploymentApi.deployRecentValidation
- Defined in packages/salesforce/src/connection/metadata/metadataApi.ts:266

describe

describe(version?: string): Promise<DescribeMetadataResult>
Describes features of the metadata API.
Parameters
- Optionalversion: string
  API version
Returns Promise<DescribeMetadataResult>
- Defined in packages/salesforce/src/connection/metadata/metadataApi.ts:101

describeValueType

describeValueType(type: string): Promise<DescribeValueTypeResult>
Describe a complex value type
Parameters
- type: string
  name of the type to describe
Returns Promise<DescribeValueTypeResult>
- Defined in packages/salesforce/src/connection/metadata/metadataApi.ts:111
describeValueType(
type: string,
namespace: ValueTypeNamespace,
): Promise<DescribeValueTypeResult>
Describe a complex value type
Parameters
- type: string
  name of the type to describe
- namespace: ValueTypeNamespace
Returns Promise<DescribeValueTypeResult>
- Defined in packages/salesforce/src/connection/metadata/metadataApi.ts:112
describeValueType(
type: string,
namespace: string,
): Promise<DescribeValueTypeResult>
Describe a complex value type
Parameters
- type: string
  name of the type to describe
- namespace: string
Returns Promise<DescribeValueTypeResult>
- Defined in packages/salesforce/src/connection/metadata/metadataApi.ts:113

`Private`invoke

invoke<K extends keyof MetadataResponses>(
    method: K,
    message: object,
    responsePath?: string,
): Promise<MetadataResponses[K]>
Type Parameters
- K extends keyof MetadataResponses
Parameters
- method: K
- message: object
- OptionalresponsePath: string
Returns Promise<MetadataResponses[K]>
- Defined in packages/salesforce/src/connection/metadata/metadataApi.ts:70

list

list(
    queries:
        | ListMetadataQuery<keyof MetadataTypes>
        | ListMetadataQuery<keyof MetadataTypes>[],
    asOfVersion?: string | number,
): Promise<FileProperties[]>
Lists the available metadata components.
Parameters
- queries:
  | ListMetadataQuery<keyof MetadataTypes>
  | ListMetadataQuery<keyof MetadataTypes>[]
  Queries used to filter
- OptionalasOfVersion: string | number
  API version; optional
Returns Promise<FileProperties[]>
- Defined in packages/salesforce/src/connection/metadata/metadataApi.ts:126
list(
queries: ListMetadataQuery<string> | ListMetadataQuery<string>[],
asOfVersion?: string | number,
): Promise<FileProperties[]>
Lists the available metadata components.
Parameters
- queries: ListMetadataQuery<string> | ListMetadataQuery<string>[]
  Queries used to filter
- OptionalasOfVersion: string | number
  API version; optional
Returns Promise<FileProperties[]>
- Defined in packages/salesforce/src/connection/metadata/metadataApi.ts:127

listRecentDeployments

listRecentDeployments(): Promise<Deployment[]>
Returns Promise<Deployment[]>
- Defined in packages/salesforce/src/connection/metadata/metadataApi.ts:278

`Private`normalizeMetadata

normalizeMetadata(
type: string,
metadata: SalesforceMetadata | SalesforceMetadata[],
): SalesforceMetadata[]
Parameters
- type: string
- metadata: SalesforceMetadata | SalesforceMetadata[]
Returns SalesforceMetadata[]
- Defined in packages/salesforce/src/connection/metadata/metadataApi.ts:93

read

read<K extends keyof MetadataTypes>(
type: K,
fullNames: string[],
): Promise<MetadataTypes[K][]>
Reads metadata entries synchronously.
Type Parameters
- K extends keyof MetadataTypes
Parameters
- type: K
  Metadata type name
- fullNames: string[]
Returns Promise<MetadataTypes[K][]>
- Defined in packages/salesforce/src/connection/metadata/metadataApi.ts:151
read<K extends keyof MetadataTypes>(
type: K,
fullNames: string,
): Promise<MetadataTypes[K]>
Reads metadata entries synchronously.
Type Parameters
- K extends keyof MetadataTypes
Parameters
- type: K
  Metadata type name
- fullNames: string
Returns Promise<MetadataTypes[K]>
- Defined in packages/salesforce/src/connection/metadata/metadataApi.ts:152
read<T extends SalesforceMetadata>(type: string, fullNames: string): Promise<T>
Reads metadata entries synchronously.
Type Parameters
- T extends SalesforceMetadata
Parameters
- type: string
  Metadata type name
- fullNames: string
Returns Promise<T>
- Defined in packages/salesforce/src/connection/metadata/metadataApi.ts:154
read<T extends SalesforceMetadata>(
type: string,
fullNames: string[],
): Promise<T[]>
Reads metadata entries synchronously.
Type Parameters
- T extends SalesforceMetadata
Parameters
- type: string
  Metadata type name
- fullNames: string[]
Returns Promise<T[]>
- Defined in packages/salesforce/src/connection/metadata/metadataApi.ts:155

readAll

readAll<K extends keyof MetadataTypes>(
type: K,
): AsyncGenerator<MetadataTypes[K], any, undefined>
Reads ALL metadata entries of a specific type synchronously and yields the results.
Type Parameters
- K extends keyof MetadataTypes
Parameters
- type: K
  Metadata type name
Returns AsyncGenerator<MetadataTypes[K], any, undefined>
- Defined in packages/salesforce/src/connection/metadata/metadataApi.ts:179

rename

rename(
    type: string,
    oldFullName: string,
    newFullName: string,
): Promise<SaveResult>
Renames a metadata entry synchronously.
Parameters
- type: string
  Metadata type
- oldFullName: string
  Current full name
- newFullName: string
  New full name
Returns Promise<SaveResult>
- Defined in packages/salesforce/src/connection/metadata/metadataApi.ts:141

retrieve

retrieve(retrieveRequest: RetrieveRequest): Promise<string>
Parameters
- retrieveRequest: RetrieveRequest
Returns Promise<string>
- Defined in packages/salesforce/src/connection/metadata/metadataApi.ts:251

update

update<K extends keyof MetadataTypes>(
type: K,
metadata: MetadataTypes[K],
): Promise<SaveResult>
Updates metadata entries synchronously.
Type Parameters
- K extends keyof MetadataTypes
Parameters
- type: K
  Metadata type name
- metadata: MetadataTypes[K]
  Metadata entry to update
Returns Promise<SaveResult>
- Defined in packages/salesforce/src/connection/metadata/metadataApi.ts:208
update<K extends keyof MetadataTypes>(
type: K,
metadata: MetadataTypes[K][],
): Promise<SaveResult[]>
Updates metadata entries synchronously.
Type Parameters
- K extends keyof MetadataTypes
Parameters
- type: K
  Metadata type name
- metadata: MetadataTypes[K][]
  Metadata entry to update
Returns Promise<SaveResult[]>
- Defined in packages/salesforce/src/connection/metadata/metadataApi.ts:209
update(type: string, metadata: SalesforceMetadata): Promise<SaveResult>
Updates metadata entries synchronously.
Parameters
- type: string
  Metadata type name
- metadata: SalesforceMetadata
  Metadata entry to update
Returns Promise<SaveResult>
- Defined in packages/salesforce/src/connection/metadata/metadataApi.ts:211
update(type: string, metadata: SalesforceMetadata[]): Promise<SaveResult[]>
Updates metadata entries synchronously.
Parameters
- type: string
  Metadata type name
- metadata: SalesforceMetadata[]
  Metadata entry to update
Returns Promise<SaveResult[]>
- Defined in packages/salesforce/src/connection/metadata/metadataApi.ts:212

upsert

upsert<K extends keyof MetadataTypes>(
type: K,
metadata: MetadataTypes[K],
): Promise<UpsertResult>
Updates or inserts metadata entries synchronously.
Type Parameters
- K extends keyof MetadataTypes
Parameters
- type: K
  Metadata type name
- metadata: MetadataTypes[K]
  Metadata entry to update insert
Returns Promise<UpsertResult>
- Defined in packages/salesforce/src/connection/metadata/metadataApi.ts:224
upsert<K extends keyof MetadataTypes>(
type: K,
metadata: MetadataTypes[K][],
): Promise<UpsertResult[]>
Updates or inserts metadata entries synchronously.
Type Parameters
- K extends keyof MetadataTypes
Parameters
- type: K
  Metadata type name
- metadata: MetadataTypes[K][]
  Metadata entry to update insert
Returns Promise<UpsertResult[]>
- Defined in packages/salesforce/src/connection/metadata/metadataApi.ts:225
upsert(type: string, metadata: SalesforceMetadata): Promise<UpsertResult>
Updates or inserts metadata entries synchronously.
Parameters
- type: string
  Metadata type name
- metadata: SalesforceMetadata
  Metadata entry to update insert
Returns Promise<UpsertResult>
- Defined in packages/salesforce/src/connection/metadata/metadataApi.ts:227
upsert(type: string, metadata: SalesforceMetadata[]): Promise<UpsertResult[]>
Updates or inserts metadata entries synchronously.
Parameters
- type: string
  Metadata type name
- metadata: SalesforceMetadata[]
  Metadata entry to update insert
Returns Promise<UpsertResult[]>
- Defined in packages/salesforce/src/connection/metadata/metadataApi.ts:228

Class MetadataApi

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns MetadataApi

Properties

Privateconnection

Privatedeployment

Privatesoap

Methods

cancelDeploy

Parameters

Returns Promise<DeployResult>

checkDeployStatus

Parameters

Returns Promise<DeployResult>

checkRetrieveStatus

Parameters

Returns Promise<RetrieveResult>

PrivateconvertArray

Type Parameters

Parameters

Returns T[]

Type Parameters

Parameters

Returns T

Type Parameters

Parameters

Returns T | T[]

create

Type Parameters

Parameters

Returns Promise<SaveResult>

Type Parameters

Parameters

Returns Promise<SaveResult[]>

Parameters

Returns Promise<SaveResult>

Parameters

Returns Promise<SaveResult[]>

delete

Parameters

Returns Promise<DeleteResult>

Parameters

Returns Promise<DeleteResult[]>

Parameters

Returns Promise<DeleteResult>

Parameters

Returns Promise<DeleteResult[]>

deploy

Parameters

Returns Promise<DeployResult>

deployRecentValidation

Parameters

Returns Promise<DeployResult>

describe

Parameters

Returns Promise<DescribeMetadataResult>

describeValueType

Parameters

Returns Promise<DescribeValueTypeResult>

Parameters

Returns Promise<DescribeValueTypeResult>

Parameters

Returns Promise<DescribeValueTypeResult>

Privateinvoke

Type Parameters

Parameters

Returns Promise<MetadataResponses[K]>

list

Parameters

Returns Promise<FileProperties[]>

Parameters

Returns Promise<FileProperties[]>

listRecentDeployments

`Private`connection

`Private`deployment

`Private`soap

`Private`convertArray

`Private`invoke

`Private`normalizeMetadata