@rudderstack/integrations-lib
Version:
A comprehensive TypeScript library providing shared utilities, SDKs, and tools for RudderStack integrations and destinations.
55 lines • 1.39 kB
TypeScript
/**
* Authentication object for Salesforce SDK
* Requires access token and instance URL for connection
*/
export interface SalesforceAuthObject {
/**
* Salesforce access token (OAuth token or session token)
*/
accessToken: string;
/**
* Salesforce instance URL (e.g., https://yourinstance.salesforce.com)
*/
instanceUrl: string;
}
/**
* Configuration for Salesforce SDK
* Extends BaseSDKConfig for enhanced HTTP client features
*/
export interface SalesforceConfig {
/**
* API version to use (defaults to latest if not specified)
* Format: "vXX.X" (e.g., "v59.0")
*/
apiVersion?: string;
}
/**
* SOQL query result with type-safe records
* @template T - Type of the records in the result (defaults to Record<string, unknown>)
*
* Example record:
* ```json
* {
"attributes": {
"type": "User",
"url": "/services/data/v50.0/sobjects/User/005WK000006GYwjYAG"
},
"Id": "005WK000006GYwjYAG",
"Name": "Erik Bucek"
}
*/
export interface SOQLResult<T = Record<string, unknown>> {
/**
* Total number of records matching the query
*/
totalSize: number;
/**
* Whether the query was complete (all records returned)
*/
done: boolean;
/**
* Array of records matching the query
*/
records: T[];
}
//# sourceMappingURL=types.d.ts.map