@salesforce/acu-pack
Version:
SFDX CLI Extensions
52 lines (51 loc) • 2.43 kB
TypeScript
import { RestAction, RestResult } from './utils';
export declare const NO_CONTENT_CODE = 204;
export declare enum ApiKind {
DEFAULT = "",
TOOLING = "tooling",
COMPOSITE = "composite"
}
export declare class SfdxClient {
static readonly metaDataInfo: {
ContentVersion: {
MetaName: string;
DataName: string;
Filename: string;
};
Document: {
MetaName: string;
DataName: string;
Filename: string;
};
Attachment: {
MetaName: string;
DataName: string;
Filename: string;
};
};
private static defailtIdField;
private headers;
private orgAliasOrUsername;
private orgInfo;
private apiVersion;
constructor(orgAliasOrUsername: string);
initialize(forceRefresh?: boolean): Promise<void>;
setApiVersion(apiVersion: number): void;
getMetadataSchemas(apiKind?: ApiKind): AsyncGenerator<any, void, void>;
getMetadataSchema(metaDataType: string, apiKind?: ApiKind): Promise<RestResult>;
getById(metaDataType: string, id: string, apiKind?: ApiKind): Promise<RestResult>;
getByIds(metaDataType: string, ids: string[], apiKind?: ApiKind): AsyncGenerator<RestResult, void, void>;
getByRecords(metaDataType: string, records: any[], recordIdField?: string, apiKind?: ApiKind): AsyncGenerator<RestResult, void, void>;
updateByRecord(metaDataType: string, record: any, recordIdField?: string, apiKind?: ApiKind): Promise<RestResult>;
updateByRecords(metaDataType: string, records: any[], recordIdField?: string, apiKind?: ApiKind): AsyncGenerator<RestResult, void, void>;
doMultiPart(action: RestAction, record: any, filePath: string, validStatusCodes?: number[]): Promise<RestResult>;
postObjectMultipart(objectName: string, objectRecord: any, fileName: string, filePath: string): Promise<any>;
do(action: RestAction, metaDataType: string, records?: any[], recordIdField?: string, apiKind?: ApiKind, validStatusCodes?: number[]): AsyncGenerator<RestResult, void, void>;
doComposite(action: RestAction, record: any, validStatusCodes?: number[]): Promise<RestResult>;
getMaxApiVersion(): Promise<string>;
getUri(metaDataType?: string, id?: string, apiKind?: ApiKind): Promise<string>;
private doInternal;
private doInternalByIds;
private doInternalById;
private handleResponse;
}