attio-js
Version:
Developer-friendly & type-safe JS/TS SDK based on the official OpenAPI spec of Attio.
19 lines • 1.38 kB
TypeScript
import { AttioCore } from "../core.js";
import { RequestOptions } from "../lib/sdks.js";
import { APIError } from "../models/errors/apierror.js";
import { FilterError, PostV2ObjectsObjectRecordsQueryNotFoundError } from "../models/errors/getv2objectsobject.js";
import { ConnectionError, InvalidRequestError, RequestAbortedError, RequestTimeoutError, UnexpectedClientError } from "../models/errors/httpclienterrors.js";
import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
import { PostV2ObjectsObjectRecordsQueryRequest, PostV2ObjectsObjectRecordsQueryResponse } from "../models/operations/postv2objectsobjectrecordsquery.js";
import { APIPromise } from "../types/async.js";
import { Result } from "../types/fp.js";
/**
* List records
*
* @remarks
* Lists people, company or other records, with the option to filter and sort results.
*
* Required scopes: `record_permission:read`, `object_configuration:read`.
*/
export declare function recordsQuery(client: AttioCore, request: PostV2ObjectsObjectRecordsQueryRequest, options?: RequestOptions): APIPromise<Result<PostV2ObjectsObjectRecordsQueryResponse, FilterError | PostV2ObjectsObjectRecordsQueryNotFoundError | APIError | SDKValidationError | UnexpectedClientError | InvalidRequestError | RequestAbortedError | RequestTimeoutError | ConnectionError>>;
//# sourceMappingURL=recordsQuery.d.ts.map