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

Hierarchy

MetadataApi

Implements

DeploymentApi

Index

Constructors

constructor

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

Properties

`Private` connection

connection: SalesforceConnection

`Private` deployment

deployment: DeploymentApi

`Private` soap

soap: SoapClient

Methods

cancelDeploy

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

checkDeployStatus

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

checkRetrieveStatus

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

`Private` convertArray

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

create

create<K>(type, metadata): 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:176
create<K>(type, metadata): Promise<SaveResult[]>
Type Parameters
- K extends keyof MetadataTypes
Parameters
- type: K
- metadata: MetadataTypes[K][]
Returns Promise<SaveResult[]>
- Defined in packages/salesforce/src/connection/metadata/metadataApi.ts:177
create(type, metadata): Promise<SaveResult>
Parameters
- type: string
- metadata: SalesforceMetadata
Returns Promise<SaveResult>
- Defined in packages/salesforce/src/connection/metadata/metadataApi.ts:179
create(type, metadata): Promise<SaveResult[]>
Parameters
- type: string
- metadata: SalesforceMetadata[]
Returns Promise<SaveResult[]>
- Defined in packages/salesforce/src/connection/metadata/metadataApi.ts:180

delete

delete(type, fullNames): 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:224
delete(type, fullNames): Promise<DeleteResult[]>
Parameters
- type: keyof MetadataTypes
- fullNames: string
Returns Promise<DeleteResult[]>
- Defined in packages/salesforce/src/connection/metadata/metadataApi.ts:225
delete(type, fullNames): Promise<DeleteResult>
Parameters
- type: string
- fullNames: string
Returns Promise<DeleteResult>
- Defined in packages/salesforce/src/connection/metadata/metadataApi.ts:227
delete(type, fullNames): Promise<DeleteResult[]>
Parameters
- type: string
- fullNames: string[]
Returns Promise<DeleteResult[]>
- Defined in packages/salesforce/src/connection/metadata/metadataApi.ts:228

deploy

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

describe

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

describeValueType

describeValueType(type): 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:93
describeValueType(type, namespace): Promise<DescribeValueTypeResult>
Parameters
- type: string
- namespace: ValueTypeNamespace
Returns Promise<DescribeValueTypeResult>
- Defined in packages/salesforce/src/connection/metadata/metadataApi.ts:94
describeValueType(type, namespace): Promise<DescribeValueTypeResult>
Parameters
- type: string
- namespace: string
Returns Promise<DescribeValueTypeResult>
- Defined in packages/salesforce/src/connection/metadata/metadataApi.ts:95

`Private` invoke

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

list

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

`Private` normalizeMetadata

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

read

read<K>(type, fullNames): Promise<MetadataTypes[K][]>
Reads metadata entries synchronously.
Type Parameters
- K extends keyof MetadataTypes
Parameters
- type: K
  
  Metadata type name
- fullNames: string[]
  
  list of metadata types
Returns Promise<MetadataTypes[K][]>
- Defined in packages/salesforce/src/connection/metadata/metadataApi.ts:134
read<K>(type, fullNames): Promise<MetadataTypes[K]>
Type Parameters
- K extends keyof MetadataTypes
Parameters
- type: K
- fullNames: string
Returns Promise<MetadataTypes[K]>
- Defined in packages/salesforce/src/connection/metadata/metadataApi.ts:135
read<T>(type, fullNames): Promise<T>
Type Parameters
- T extends SalesforceMetadata
Parameters
- type: string
- fullNames: string
Returns Promise<T>
- Defined in packages/salesforce/src/connection/metadata/metadataApi.ts:137
read<T>(type, fullNames): Promise<T[]>
Type Parameters
- T extends SalesforceMetadata
Parameters
- type: string
- fullNames: string[]
Returns Promise<T[]>
- Defined in packages/salesforce/src/connection/metadata/metadataApi.ts:138

readAll

readAll<K>(type): 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:163

rename

rename(type, oldFullName, newFullName): 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:123

retrieve

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

update

update<K>(type, metadata): 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:192
update<K>(type, metadata): Promise<SaveResult[]>
Type Parameters
- K extends keyof MetadataTypes
Parameters
- type: K
- metadata: MetadataTypes[K][]
Returns Promise<SaveResult[]>
- Defined in packages/salesforce/src/connection/metadata/metadataApi.ts:193
update(type, metadata): Promise<SaveResult>
Parameters
- type: string
- metadata: SalesforceMetadata
Returns Promise<SaveResult>
- Defined in packages/salesforce/src/connection/metadata/metadataApi.ts:195
update(type, metadata): Promise<SaveResult[]>
Parameters
- type: string
- metadata: SalesforceMetadata[]
Returns Promise<SaveResult[]>
- Defined in packages/salesforce/src/connection/metadata/metadataApi.ts:196

upsert

upsert<K>(type, metadata): 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:208
upsert<K>(type, metadata): Promise<UpsertResult[]>
Type Parameters
- K extends keyof MetadataTypes
Parameters
- type: K
- metadata: MetadataTypes[K][]
Returns Promise<UpsertResult[]>
- Defined in packages/salesforce/src/connection/metadata/metadataApi.ts:209
upsert(type, metadata): Promise<UpsertResult>
Parameters
- type: string
- metadata: SalesforceMetadata
Returns Promise<UpsertResult>
- Defined in packages/salesforce/src/connection/metadata/metadataApi.ts:211
upsert(type, metadata): Promise<UpsertResult[]>
Parameters
- type: string
- metadata: SalesforceMetadata[]
Returns Promise<UpsertResult[]>
- Defined in packages/salesforce/src/connection/metadata/metadataApi.ts:212

Class MetadataApi

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

connection: SalesforceConnection

Returns MetadataApi

Properties

Private connection

Private deployment

Private soap

Methods

cancelDeploy

Parameters

id: string

Returns Promise<DeployResult>

checkDeployStatus

Parameters

id: string

Optional includeDetails: boolean

Returns Promise<DeployResult>

checkRetrieveStatus

Parameters

id: string

Optional includeZip: boolean

Returns Promise<RetrieveResult>

Private convertArray

Type Parameters

T

Parameters

value: T | T[]

asArray: true

Returns T[]

Type Parameters

T

Parameters

value: T | T[]

asArray: false

Returns T

Type Parameters

T

Parameters

value: T | T[]

asArray: boolean

Returns T | T[]

create

Type Parameters

K extends keyof MetadataTypes

Parameters

type: K

metadata: MetadataTypes[K]

Returns Promise<SaveResult>

Type Parameters

K extends keyof MetadataTypes

Parameters

type: K

metadata: MetadataTypes[K][]

Returns Promise<SaveResult[]>

Parameters

type: string

metadata: SalesforceMetadata

Returns Promise<SaveResult>

Parameters

type: string

metadata: SalesforceMetadata[]

Returns Promise<SaveResult[]>

delete

Parameters

type: keyof MetadataTypes

fullNames: string

Returns Promise<DeleteResult>

Parameters

type: keyof MetadataTypes

fullNames: string

Returns Promise<DeleteResult[]>

`Private` connection

`Private` deployment

`Private` soap

`Optional` includeDetails: boolean

`Optional` includeZip: boolean

`Private` convertArray

`Optional` version: string

`Private` invoke

`Optional` responsePath: string

`Optional` asOfVersion: string | number

`Optional` asOfVersion: string | number

`Private` normalizeMetadata