sf-composite-call/dist/src/CompositeSubrequestQuery.d.ts

Support for making Salesforce composite call requests with integration for JSforce.

import { CompositeSubrequest, CompositeSubrequestBody } from './CompositeSubrequest';
/**
 * @description Class for SOQL query and queryAll Composite Subrequests.
 * @augments CompositeSubrequest
 * @param {string} query - A SOQL query.
 * @param {string} [referenceId] - The reference ID of the query subrequest.
 * @param {string} [version] - The version of the Salesforce API to use.
 */
export declare class CompositeSubrequestQuery extends CompositeSubrequest {
    constructor(query: string, referenceId?: string, version?: string);
    soql: string;
    verb: string;
    url(): string;
    get subrequest(): CompositeSubrequestBody;
    /**
     * @description Base request method for query operations.
     * @param {string} [queryId] - **Optional.** The word `explain` or the `nextRecordsUrl` of a query.
     * @param {object} [httpHeaders] - **Optional.** Additional HTTP headers to include in the request.
     * @returns {CompositeSubrequestBody} - A subrequest object.
     */
    get(queryId?: string, httpHeaders?: any): CompositeSubrequestBody;
    /**
     * @description Method for creating an `explain` operation.
     * @param {object} [httpHeaders] - **Optional.** Additional HTTP headers to include in the request.
     * @returns {CompositeSubrequestBody} - A subrequest object.
     */
    explain(httpHeaders?: any): CompositeSubrequestBody;
    /**
     * @description Method for creating an `explain` operation with queryAll.
     * @param {object} [httpHeaders] - **Optional.** Additional HTTP headers to include in the request.
     * @returns {CompositeSubrequestBody} - A subrequest object.
     */
    explainAll(httpHeaders?: any): CompositeSubrequestBody;
    /**
     * @description Method for creating an operation to obtain next records.
     * @param {string} nextRecordsUrl - The `nextRecordsUrl` of a query.
     * @param {object} [httpHeaders] - **Optional.** Additional HTTP headers to include in the request.
     * @returns {CompositeSubrequestBody} - A subrequest object.
     */
    nextRecords(nextRecordsUrl: string, httpHeaders?: any): CompositeSubrequestBody;
    /**
     * @description Method for creating an operation to obtain next records with queryAll.
     * @param {string} nextRecordsUrl - The `nextRecordsUrl` of a query.
     * @param {object} [httpHeaders] - **Optional.** Additional HTTP headers to include in the request.
     * @returns {CompositeSubrequestBody} - A subrequest object.
     */
    nextRecordsAll(nextRecordsUrl: string, httpHeaders?: any): CompositeSubrequestBody;
    /**
     * @description Method for creating a `query` operation.
     * @param {object} [httpHeaders] - **Optional.** Additional HTTP headers to include in the request.
     * @returns {CompositeSubrequestBody} - A subrequest object.
     */
    query(httpHeaders?: any): CompositeSubrequestBody;
    /**
     * @description Method for creating a `query` operation with queryAll.
     * @param {object} [httpHeaders] - **Optional.** Additional HTTP headers to include in the request.
     * @returns {CompositeSubrequestBody} - A subrequest object.
     */
    queryAll(httpHeaders?: any): CompositeSubrequestBody;
}