attio-js
Version:
Developer-friendly & type-safe JS/TS SDK based on the official OpenAPI spec of Attio.
42 lines • 1.94 kB
TypeScript
import { ClientSDK, RequestOptions } from "../lib/sdks.js";
import { DeleteV2CommentsCommentIdRequest, DeleteV2CommentsCommentIdResponse } from "../models/operations/deletev2commentscommentid.js";
import { GetV2CommentsCommentIdRequest, GetV2CommentsCommentIdResponse } from "../models/operations/getv2commentscommentid.js";
import { PostV2CommentsRequest, PostV2CommentsResponse } from "../models/operations/postv2comments.js";
export declare class Comments extends ClientSDK {
/**
* 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`.
*/
create(request: PostV2CommentsRequest, options?: RequestOptions): Promise<PostV2CommentsResponse>;
/**
* 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`.
*/
get(request: GetV2CommentsCommentIdRequest, options?: RequestOptions): Promise<GetV2CommentsCommentIdResponse>;
/**
* Delete a comment
*
* @remarks
* Deletes a comment by ID. If deleting a comment at the head of a thread, all messages in the thread are also deleted.
*
* Required scopes: `comment:read-write`.
*/
delete(request: DeleteV2CommentsCommentIdRequest, options?: RequestOptions): Promise<DeleteV2CommentsCommentIdResponse>;
}
//# sourceMappingURL=comments.d.ts.map