attio-js
Version:
Developer-friendly & type-safe JS/TS SDK based on the official OpenAPI spec of Attio.
23 lines • 1.44 kB
TypeScript
import { AttioCore } from "../core.js";
import { RequestOptions } from "../lib/sdks.js";
import { APIError } from "../models/errors/apierror.js";
import { PostV2CommentsInvalidRequestError } from "../models/errors/getv2objectsobject.js";
import { ConnectionError, InvalidRequestError, RequestAbortedError, RequestTimeoutError, UnexpectedClientError } from "../models/errors/httpclienterrors.js";
import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
import { PostV2CommentsRequest, PostV2CommentsResponse } from "../models/operations/postv2comments.js";
import { APIPromise } from "../types/async.js";
import { Result } from "../types/fp.js";
/**
* Create a comment
*
* @remarks
* Creates a new comment related to an existing thread, record or entry.
*
* To create comments on records, you will need the `object_configuration:read` and `record_permission:read` scopes.
*
* To create comments on list entries, you will need the `list_configuration:read` and `list_entry:read` scopes.
*
* Required scopes: `comment:read-write`.
*/
export declare function commentsCreate(client: AttioCore, request: PostV2CommentsRequest, options?: RequestOptions): APIPromise<Result<PostV2CommentsResponse, PostV2CommentsInvalidRequestError | APIError | SDKValidationError | UnexpectedClientError | InvalidRequestError | RequestAbortedError | RequestTimeoutError | ConnectionError>>;
//# sourceMappingURL=commentsCreate.d.ts.map