attio-js
Version:
Developer-friendly & type-safe JS/TS SDK based on the official OpenAPI spec of Attio.
23 lines • 1.43 kB
TypeScript
import { AttioCore } from "../core.js";
import { RequestOptions } from "../lib/sdks.js";
import { APIError } from "../models/errors/apierror.js";
import { GetV2CommentsCommentIdNotFoundError } from "../models/errors/getv2objectsobject.js";
import { ConnectionError, InvalidRequestError, RequestAbortedError, RequestTimeoutError, UnexpectedClientError } from "../models/errors/httpclienterrors.js";
import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
import { GetV2CommentsCommentIdRequest, GetV2CommentsCommentIdResponse } from "../models/operations/getv2commentscommentid.js";
import { APIPromise } from "../types/async.js";
import { Result } from "../types/fp.js";
/**
* Get a comment
*
* @remarks
* Get a single comment by ID.
*
* To view comments on records, you will need the `object_configuration:read` and `record_permission:read` scopes.
*
* To view comments on list entries, you will need the `list_configuration:read` and `list_entry:read` scopes.
*
* Required scopes: `comment:read`.
*/
export declare function commentsGet(client: AttioCore, request: GetV2CommentsCommentIdRequest, options?: RequestOptions): APIPromise<Result<GetV2CommentsCommentIdResponse, GetV2CommentsCommentIdNotFoundError | APIError | SDKValidationError | UnexpectedClientError | InvalidRequestError | RequestAbortedError | RequestTimeoutError | ConnectionError>>;
//# sourceMappingURL=commentsGet.d.ts.map