UNPKG

1.1 kBTypeScriptView Raw
1import { Stream } from "stream";
2
3import { Connection } from "./connection";
4import { RecordResult } from "./record-result";
5import { SalesforceId } from "./salesforce-id";
6
7export class RecordReference<T = any> {
8 constructor(conn: Connection, type: string, id: SalesforceId);
9
10 blob(fieldName: string): Stream;
11 del(options?: Object, callback?: (err: Error, result: RecordResult) => void): Promise<RecordResult>;
12 delete(options?: Object, callback?: (err: Error, result: RecordResult) => void): Promise<RecordResult>;
13 destroy(options?: Object, callback?: (err: Error, result: RecordResult) => void): Promise<RecordResult>;
14 retrieve(options?: Object, callback?: (err: Error, record: Record<T>) => void): Promise<Record<T>>;
15 update(
16 record: Partial<T>,
17 options?: Object,
18 callback?: (err: Error, result: RecordResult) => void,
19 ): Promise<RecordResult>;
20}
21
22export interface RecordAttributes {
23 type: string;
24 url: string;
25}
26
27export type Record<T = any> = {
28 Id?: SalesforceId | undefined;
29 attributes?: RecordAttributes | undefined;
30} & T;