Class Tooling<S>

API class for Tooling API call

Type Parameters

S extends Schema

Constructors

constructor

new Tooling<S extends Schema>(conn: Connection<S>): Tooling<S>
Type Parameters
- S extends Schema
Parameters
- conn: Connection<S>
Returns Tooling<S>
- Defined in src/api/tooling.ts:343

Properties

_conn

_conn: Connection<S>

_createMany

_createMany: Object = _createMany

_createParallel

_createParallel: Object = _createParallel

_createSingle

_createSingle: Object = _createSingle

_destroyMany

_destroyMany: Object = _destroyMany

_destroyParallel

_destroyParallel: Object = _destroyParallel

_destroySingle

_destroySingle: Object = _destroySingle

_ensureVersion

_ensureVersion: (majorVersion: number) => boolean = _ensureVersion

_retrieveMany

_retrieveMany: Object = _retrieveMany

_retrieveParallel

_retrieveParallel: Object = _retrieveParallel

_retrieveSingle

_retrieveSingle: Object = _retrieveSingle

_updateMany

_updateMany: Object = _updateMany

_updateParallel

_updateParallel: Object = _updateParallel

_updateSingle

_updateSingle: Object = _updateSingle

cache

cache: Cache = ...

create

create: {
    <
        N extends string,
        InputRecord extends
            Partial<SObjectRecord<S, N, "*", Record, {}>> = Partial<
            SObjectRecord<S, N, "*", Record, {}>,
        >,
    >(
        type: N,
        records: InputRecord[],
        options?: DmlOptions,
    ): Promise<SaveResult[]>;
    <
        N extends string,
        InputRecord extends
            Partial<SObjectRecord<S, N, "*", Record, {}>> = Partial<
            SObjectRecord<S, N, "*", Record, {}>,
        >,
    >(
        type: N,
        record: InputRecord,
        options?: DmlOptions,
    ): Promise<SaveResult>;
    <
        N extends string,
        InputRecord extends
            Partial<SObjectRecord<S, N, "*", Record, {}>> = Partial<
            SObjectRecord<S, N, "*", Record, {}>,
        >,
    >(
        type: N,
        records: InputRecord | InputRecord[],
        options?: DmlOptions,
    ): Promise<SaveResult | SaveResult[]>;
} = create

Create records

Type Declaration

- <
      N extends string,
      InputRecord extends
          Partial<SObjectRecord<S, N, "*", Record, {}>> = Partial<
          SObjectRecord<S, N, "*", Record, {}>,
      >,
  >(
      type: N,
      records: InputRecord[],
      options?: DmlOptions,
  ): Promise<SaveResult[]>
- Create records
  Type Parameters
  - N extends string
  - InputRecord extends Partial<SObjectRecord<S, N, "*", Record, {}>> = Partial<SObjectRecord<S, N, "*", Record, {}>>
  Parameters
  - type: N
  - records: InputRecord[]
  - Optionaloptions: DmlOptions
  Returns Promise<SaveResult[]>
- <
      N extends string,
      InputRecord extends
          Partial<SObjectRecord<S, N, "*", Record, {}>> = Partial<
          SObjectRecord<S, N, "*", Record, {}>,
      >,
  >(
      type: N,
      record: InputRecord,
      options?: DmlOptions,
  ): Promise<SaveResult>
- Create records
  Type Parameters
  - N extends string
  - InputRecord extends Partial<SObjectRecord<S, N, "*", Record, {}>> = Partial<SObjectRecord<S, N, "*", Record, {}>>
  Parameters
  - type: N
  - record: InputRecord
  - Optionaloptions: DmlOptions
  Returns Promise<SaveResult>
- <
      N extends string,
      InputRecord extends
          Partial<SObjectRecord<S, N, "*", Record, {}>> = Partial<
          SObjectRecord<S, N, "*", Record, {}>,
      >,
  >(
      type: N,
      records: InputRecord | InputRecord[],
      options?: DmlOptions,
  ): Promise<SaveResult | SaveResult[]>
- Create records
  Type Parameters
  - N extends string
  - InputRecord extends Partial<SObjectRecord<S, N, "*", Record, {}>> = Partial<SObjectRecord<S, N, "*", Record, {}>>
  Parameters
  - type: N
  - records: InputRecord | InputRecord[]
  - Optionaloptions: DmlOptions
  Returns Promise<SaveResult | SaveResult[]>

del

del: {
    <N extends string>(
        type: N,
        ids: string[],
        options?: DmlOptions,
    ): Promise<SaveResult[]>;
    <N extends string>(
        type: N,
        id: string,
        options?: DmlOptions,
    ): Promise<SaveResult>;
    <N extends string>(
        type: N,
        ids: string | string[],
        options?: DmlOptions,
    ): Promise<SaveResult | SaveResult[]>;
} = destroy

Synonym of Tooling#destroy()

Type Declaration

- <N extends string>(
      type: N,
      ids: string[],
      options?: DmlOptions,
  ): Promise<SaveResult[]>
- Delete records
  Type Parameters
  - N extends string
  Parameters
  - type: N
  - ids: string[]
  - Optionaloptions: DmlOptions
  Returns Promise<SaveResult[]>
- <N extends string>(
      type: N,
      id: string,
      options?: DmlOptions,
  ): Promise<SaveResult>
- Delete records
  Type Parameters
  - N extends string
  Parameters
  - type: N
  - id: string
  - Optionaloptions: DmlOptions
  Returns Promise<SaveResult>
- <N extends string>(
      type: N,
      ids: string | string[],
      options?: DmlOptions,
  ): Promise<SaveResult | SaveResult[]>
- Delete records
  Type Parameters
  - N extends string
  Parameters
  - type: N
  - ids: string | string[]
  - Optionaloptions: DmlOptions
  Returns Promise<SaveResult | SaveResult[]>

delete

delete: {
    <N extends string>(
        type: N,
        ids: string[],
        options?: DmlOptions,
    ): Promise<SaveResult[]>;
    <N extends string>(
        type: N,
        id: string,
        options?: DmlOptions,
    ): Promise<SaveResult>;
    <N extends string>(
        type: N,
        ids: string | string[],
        options?: DmlOptions,
    ): Promise<SaveResult | SaveResult[]>;
} = destroy

Synonym of Tooling#destroy()

Type Declaration

- <N extends string>(
      type: N,
      ids: string[],
      options?: DmlOptions,
  ): Promise<SaveResult[]>
- Delete records
  Type Parameters
  - N extends string
  Parameters
  - type: N
  - ids: string[]
  - Optionaloptions: DmlOptions
  Returns Promise<SaveResult[]>
- <N extends string>(
      type: N,
      id: string,
      options?: DmlOptions,
  ): Promise<SaveResult>
- Delete records
  Type Parameters
  - N extends string
  Parameters
  - type: N
  - id: string
  - Optionaloptions: DmlOptions
  Returns Promise<SaveResult>
- <N extends string>(
      type: N,
      ids: string | string[],
      options?: DmlOptions,
  ): Promise<SaveResult | SaveResult[]>
- Delete records
  Type Parameters
  - N extends string
  Parameters
  - type: N
  - ids: string | string[]
  - Optionaloptions: DmlOptions
  Returns Promise<SaveResult | SaveResult[]>

describe

describe: CachedFunction<(type: string) => Promise<DescribeSObjectResult>> = ...

Describe SObject metadata

describe$

describe$: CachedFunction<(type: string) => Promise<DescribeSObjectResult>> = ...

describe$$

describe$$: CachedFunction<(name: string) => DescribeSObjectResult> = ...

describeGlobal

describeGlobal: CachedFunction<() => Promise<DescribeGlobalResult>> = ...

Describe global SObjects

describeGlobal$

describeGlobal$: CachedFunction<() => Promise<DescribeGlobalResult>> = ...

describeGlobal$$

describeGlobal$$: CachedFunction<(name: string) => DescribeGlobalResult> = ...

describeSObject

describeSObject: CachedFunction<
(type: string) => Promise<DescribeSObjectResult>,
> = ...

Synonym of Tooling#describe()

describeSObject$

describeSObject$: CachedFunction<
(type: string) => Promise<DescribeSObjectResult>,
> = ...

describeSObject$$

describeSObject$$: CachedFunction<(name: string) => DescribeSObjectResult> = ...

destroy

destroy: {
    <N extends string>(
        type: N,
        ids: string[],
        options?: DmlOptions,
    ): Promise<SaveResult[]>;
    <N extends string>(
        type: N,
        id: string,
        options?: DmlOptions,
    ): Promise<SaveResult>;
    <N extends string>(
        type: N,
        ids: string | string[],
        options?: DmlOptions,
    ): Promise<SaveResult | SaveResult[]>;
} = destroy

Delete records

Type Declaration

- <N extends string>(
      type: N,
      ids: string[],
      options?: DmlOptions,
  ): Promise<SaveResult[]>
- Delete records
  Type Parameters
  - N extends string
  Parameters
  - type: N
  - ids: string[]
  - Optionaloptions: DmlOptions
  Returns Promise<SaveResult[]>
- <N extends string>(
      type: N,
      id: string,
      options?: DmlOptions,
  ): Promise<SaveResult>
- Delete records
  Type Parameters
  - N extends string
  Parameters
  - type: N
  - id: string
  - Optionaloptions: DmlOptions
  Returns Promise<SaveResult>
- <N extends string>(
      type: N,
      ids: string | string[],
      options?: DmlOptions,
  ): Promise<SaveResult | SaveResult[]>
- Delete records
  Type Parameters
  - N extends string
  Parameters
  - type: N
  - ids: string | string[]
  - Optionaloptions: DmlOptions
  Returns Promise<SaveResult | SaveResult[]>

insert

insert: {
    <
        N extends string,
        InputRecord extends
            Partial<SObjectRecord<any, N, "*", Record, {}>> = Partial<
            SObjectRecord<any, N, "*", Record, {}>,
        >,
    >(
        type: N,
        records: InputRecord[],
        options?: DmlOptions,
    ): Promise<SaveResult[]>;
    <
        N extends string,
        InputRecord extends
            Partial<SObjectRecord<any, N, "*", Record, {}>> = Partial<
            SObjectRecord<any, N, "*", Record, {}>,
        >,
    >(
        type: N,
        record: InputRecord,
        options?: DmlOptions,
    ): Promise<SaveResult>;
    <
        N extends string,
        InputRecord extends
            Partial<SObjectRecord<any, N, "*", Record, {}>> = Partial<
            SObjectRecord<any, N, "*", Record, {}>,
        >,
    >(
        type: N,
        records: InputRecord | InputRecord[],
        options?: DmlOptions,
    ): Promise<SaveResult | SaveResult[]>;
} = create

Synonym of Tooling#create()

Type Declaration

- <
      N extends string,
      InputRecord extends
          Partial<SObjectRecord<any, N, "*", Record, {}>> = Partial<
          SObjectRecord<any, N, "*", Record, {}>,
      >,
  >(
      type: N,
      records: InputRecord[],
      options?: DmlOptions,
  ): Promise<SaveResult[]>
- Create records
  Type Parameters
  - N extends string
  - InputRecord extends Partial<SObjectRecord<any, N, "*", Record, {}>> = Partial<SObjectRecord<any, N, "*", Record, {}>>
  Parameters
  - type: N
  - records: InputRecord[]
  - Optionaloptions: DmlOptions
  Returns Promise<SaveResult[]>
- <
      N extends string,
      InputRecord extends
          Partial<SObjectRecord<any, N, "*", Record, {}>> = Partial<
          SObjectRecord<any, N, "*", Record, {}>,
      >,
  >(
      type: N,
      record: InputRecord,
      options?: DmlOptions,
  ): Promise<SaveResult>
- Create records
  Type Parameters
  - N extends string
  - InputRecord extends Partial<SObjectRecord<any, N, "*", Record, {}>> = Partial<SObjectRecord<any, N, "*", Record, {}>>
  Parameters
  - type: N
  - record: InputRecord
  - Optionaloptions: DmlOptions
  Returns Promise<SaveResult>
- <
      N extends string,
      InputRecord extends
          Partial<SObjectRecord<any, N, "*", Record, {}>> = Partial<
          SObjectRecord<any, N, "*", Record, {}>,
      >,
  >(
      type: N,
      records: InputRecord | InputRecord[],
      options?: DmlOptions,
  ): Promise<SaveResult | SaveResult[]>
- Create records
  Type Parameters
  - N extends string
  - InputRecord extends Partial<SObjectRecord<any, N, "*", Record, {}>> = Partial<SObjectRecord<any, N, "*", Record, {}>>
  Parameters
  - type: N
  - records: InputRecord | InputRecord[]
  - Optionaloptions: DmlOptions
  Returns Promise<SaveResult | SaveResult[]>

query

query: <T extends Record>(
soql: string,
options?: Partial<QueryOptions>,
) => Query<S, Extract<keyof S["SObjects"], string>, T, "QueryResult"> = query

Execute query by using SOQL

queryMore

queryMore: <T extends Record>(
locator: string,
options?: QueryOptions,
) => Query<S, Extract<keyof S["SObjects"], string>, T, "QueryResult"> = queryMore

Query next record set by using query locator

retrieve

retrieve: {
    <N extends string>(
        type: N,
        ids: string,
        options?: RetrieveOptions,
    ): Promise<Record>;
    <N extends string>(
        type: N,
        ids: string[],
        options?: RetrieveOptions,
    ): Promise<Record[]>;
    <N extends string>(
        type: N,
        ids: string | string[],
        options?: RetrieveOptions,
    ): Promise<Record | Record[]>;
} = retrieve

Retrieve specified records

Type Declaration

- <N extends string>(
      type: N,
      ids: string,
      options?: RetrieveOptions,
  ): Promise<Record>
- Retrieve specified records
  Type Parameters
  - N extends string
  Parameters
  - type: N
  - ids: string
  - Optionaloptions: RetrieveOptions
  Returns Promise<Record>
- <N extends string>(
      type: N,
      ids: string[],
      options?: RetrieveOptions,
  ): Promise<Record[]>
- Retrieve specified records
  Type Parameters
  - N extends string
  Parameters
  - type: N
  - ids: string[]
  - Optionaloptions: RetrieveOptions
  Returns Promise<Record[]>
- <N extends string>(
      type: N,
      ids: string | string[],
      options?: RetrieveOptions,
  ): Promise<Record | Record[]>
- Retrieve specified records
  Type Parameters
  - N extends string
  Parameters
  - type: N
  - ids: string | string[]
  - Optionaloptions: RetrieveOptions
  Returns Promise<Record | Record[]>

sobject

sobject: <N extends string>(type: string | N) => SObject<S, N> = sobject

Get SObject instance

Type Declaration

- <N extends string>(type: string | N): SObject<S, N>
- Get SObject instance
  Type Parameters
  - N extends string
  Parameters
  - type: string | N
  Returns SObject<S, N>

sobjects

sobjects: {
    [N in string]?: SObject<
        S,
        N,
        Extract<keyof S["SObjects"][N]["Fields"], string>,
        SObjectRecord<S, N, "*", Record, {}>,
        Partial<SObjectRecord<S, N, "*", Record, {}>>,
        SObjectUpdateRecord<S, N>,
    >
} = {}

update

update: {
    <
        N extends string,
        UpdateRecord extends SObjectUpdateRecord<S, N> = SObjectUpdateRecord<S, N>,
    >(
        type: N,
        records: UpdateRecord[],
        options?: DmlOptions,
    ): Promise<SaveResult[]>;
    <
        N extends string,
        UpdateRecord extends SObjectUpdateRecord<S, N> = SObjectUpdateRecord<S, N>,
    >(
        type: N,
        record: UpdateRecord,
        options?: DmlOptions,
    ): Promise<SaveResult>;
    <
        N extends string,
        UpdateRecord extends SObjectUpdateRecord<S, N> = SObjectUpdateRecord<S, N>,
    >(
        type: N,
        records: UpdateRecord | UpdateRecord[],
        options?: DmlOptions,
    ): Promise<SaveResult | SaveResult[]>;
} = update

Update records

Type Declaration

- <
      N extends string,
      UpdateRecord extends SObjectUpdateRecord<S, N> = SObjectUpdateRecord<S, N>,
  >(
      type: N,
      records: UpdateRecord[],
      options?: DmlOptions,
  ): Promise<SaveResult[]>
- Update records
  Type Parameters
  - N extends string
  - UpdateRecord extends SObjectUpdateRecord<S, N> = SObjectUpdateRecord<S, N>
  Parameters
  - type: N
  - records: UpdateRecord[]
  - Optionaloptions: DmlOptions
  Returns Promise<SaveResult[]>
- <
      N extends string,
      UpdateRecord extends SObjectUpdateRecord<S, N> = SObjectUpdateRecord<S, N>,
  >(
      type: N,
      record: UpdateRecord,
      options?: DmlOptions,
  ): Promise<SaveResult>
- Update records
  Type Parameters
  - N extends string
  - UpdateRecord extends SObjectUpdateRecord<S, N> = SObjectUpdateRecord<S, N>
  Parameters
  - type: N
  - record: UpdateRecord
  - Optionaloptions: DmlOptions
  Returns Promise<SaveResult>
- <
      N extends string,
      UpdateRecord extends SObjectUpdateRecord<S, N> = SObjectUpdateRecord<S, N>,
  >(
      type: N,
      records: UpdateRecord | UpdateRecord[],
      options?: DmlOptions,
  ): Promise<SaveResult | SaveResult[]>
- Update records
  Type Parameters
  - N extends string
  - UpdateRecord extends SObjectUpdateRecord<S, N> = SObjectUpdateRecord<S, N>
  Parameters
  - type: N
  - records: UpdateRecord | UpdateRecord[]
  - Optionaloptions: DmlOptions
  Returns Promise<SaveResult | SaveResult[]>

upsert

upsert: {
    <
        N extends string,
        InputRecord extends
            Partial<SObjectRecord<S, N, "*", Record, {}>> = Partial<
            SObjectRecord<S, N, "*", Record, {}>,
        >,
        FieldNames extends
            string = Extract<keyof S["SObjects"][N]["Fields"], string>,
    >(
        type: N,
        records: InputRecord[],
        extIdField: FieldNames,
        options?: DmlOptions,
    ): Promise<UpsertResult[]>;
    <
        N extends string,
        InputRecord extends
            Partial<SObjectRecord<S, N, "*", Record, {}>> = Partial<
            SObjectRecord<S, N, "*", Record, {}>,
        >,
        FieldNames extends
            string = Extract<keyof S["SObjects"][N]["Fields"], string>,
    >(
        type: N,
        record: InputRecord,
        extIdField: FieldNames,
        options?: DmlOptions,
    ): Promise<UpsertResult>;
    <
        N extends string,
        InputRecord extends
            Partial<SObjectRecord<S, N, "*", Record, {}>> = Partial<
            SObjectRecord<S, N, "*", Record, {}>,
        >,
        FieldNames extends
            string = Extract<keyof S["SObjects"][N]["Fields"], string>,
    >(
        type: N,
        records: InputRecord | InputRecord[],
        extIdField: FieldNames,
        options?: DmlOptions,
    ): Promise<UpsertResult | UpsertResult[]>;
} = upsert

Upsert records

Type Declaration

- <
      N extends string,
      InputRecord extends
          Partial<SObjectRecord<S, N, "*", Record, {}>> = Partial<
          SObjectRecord<S, N, "*", Record, {}>,
      >,
      FieldNames extends
          string = Extract<keyof S["SObjects"][N]["Fields"], string>,
  >(
      type: N,
      records: InputRecord[],
      extIdField: FieldNames,
      options?: DmlOptions,
  ): Promise<UpsertResult[]>
- Upsert records
  Type Parameters
  - N extends string
  - InputRecord extends Partial<SObjectRecord<S, N, "*", Record, {}>> = Partial<SObjectRecord<S, N, "*", Record, {}>>
  - FieldNames extends string = Extract<keyof S["SObjects"][N]["Fields"], string>
  Parameters
  - type: N
  - records: InputRecord[]
  - extIdField: FieldNames
  - Optionaloptions: DmlOptions
  Returns Promise<UpsertResult[]>
- <
      N extends string,
      InputRecord extends
          Partial<SObjectRecord<S, N, "*", Record, {}>> = Partial<
          SObjectRecord<S, N, "*", Record, {}>,
      >,
      FieldNames extends
          string = Extract<keyof S["SObjects"][N]["Fields"], string>,
  >(
      type: N,
      record: InputRecord,
      extIdField: FieldNames,
      options?: DmlOptions,
  ): Promise<UpsertResult>
- Upsert records
  Type Parameters
  - N extends string
  - InputRecord extends Partial<SObjectRecord<S, N, "*", Record, {}>> = Partial<SObjectRecord<S, N, "*", Record, {}>>
  - FieldNames extends string = Extract<keyof S["SObjects"][N]["Fields"], string>
  Parameters
  - type: N
  - record: InputRecord
  - extIdField: FieldNames
  - Optionaloptions: DmlOptions
  Returns Promise<UpsertResult>
- <
      N extends string,
      InputRecord extends
          Partial<SObjectRecord<S, N, "*", Record, {}>> = Partial<
          SObjectRecord<S, N, "*", Record, {}>,
      >,
      FieldNames extends
          string = Extract<keyof S["SObjects"][N]["Fields"], string>,
  >(
      type: N,
      records: InputRecord | InputRecord[],
      extIdField: FieldNames,
      options?: DmlOptions,
  ): Promise<UpsertResult | UpsertResult[]>
- Upsert records
  Type Parameters
  - N extends string
  - InputRecord extends Partial<SObjectRecord<S, N, "*", Record, {}>> = Partial<SObjectRecord<S, N, "*", Record, {}>>
  - FieldNames extends string = Extract<keyof S["SObjects"][N]["Fields"], string>
  Parameters
  - type: N
  - records: InputRecord | InputRecord[]
  - extIdField: FieldNames
  - Optionaloptions: DmlOptions
  Returns Promise<UpsertResult | UpsertResult[]>

Accessors

version

get version(): string
Returns string
- Defined in src/api/tooling.ts:224

Methods

completions

completions(type?: "apex" | "visualforce"): StreamPromise<CompletionsResult>
Retrieves available code completions of the referenced type
Parameters
- type: "apex" | "visualforce" = 'apex'
Returns StreamPromise<CompletionsResult>
- Defined in src/api/tooling.ts:414

executeAnonymous

executeAnonymous(body: string): StreamPromise<ExecuteAnonymousResult>
Executes Apex code anonymously
Parameters
- body: string
Returns StreamPromise<ExecuteAnonymousResult>
- Defined in src/api/tooling.ts:387

request

request<R = unknown>(
request: string | HttpRequest,
options?: Object,
): StreamPromise<R>
Type Parameters
- R = unknown
Parameters
- request: string | HttpRequest
- Optionaloptions: Object
Returns StreamPromise<R>
- Defined in src/api/tooling.ts:380

runTestsAsynchronous

runTestsAsynchronous(req: RunTestsAsyncRequest): StreamPromise<string | null>
Executes Apex tests asynchronously
Parameters
- req: RunTestsAsyncRequest
Returns StreamPromise<string | null>
- Defined in src/api/tooling.ts:398

runTestsSynchronous

runTestsSynchronous(req: RunTestsRequest): StreamPromise<RunTestsResult | null>
Executes Apex tests synchronously
Parameters
- req: RunTestsRequest
Returns StreamPromise<RunTestsResult | null>
- Defined in src/api/tooling.ts:406

Class Tooling<S>

Type Parameters

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Tooling<S>

Properties

_conn

_createMany

_createParallel

_createSingle

_destroyMany

_destroyParallel

_destroySingle

_ensureVersion

_retrieveMany

_retrieveParallel

_retrieveSingle

_updateMany

_updateParallel

_updateSingle

cache

create

Type Declaration

Type Parameters

Parameters

Returns Promise<SaveResult[]>

Type Parameters

Parameters

Returns Promise<SaveResult>

Type Parameters

Parameters

Returns Promise<SaveResult | SaveResult[]>

del

Type Declaration

Type Parameters

Parameters

Returns Promise<SaveResult[]>

Type Parameters

Parameters

Returns Promise<SaveResult>

Type Parameters

Parameters

Returns Promise<SaveResult | SaveResult[]>

delete

Type Declaration

Type Parameters

Parameters

Returns Promise<SaveResult[]>

Type Parameters

Parameters

Returns Promise<SaveResult>

Type Parameters

Parameters

Returns Promise<SaveResult | SaveResult[]>

describe

describe$

describe$$

describeGlobal

describeGlobal$

describeGlobal$$

describeSObject

describeSObject$

describeSObject$$

destroy

Type Declaration

Type Parameters

Parameters

Returns Promise<SaveResult[]>

Type Parameters

Parameters

Returns Promise<SaveResult>

Type Parameters

Parameters