import { Comment } from '../../models/base/comment/index'; import { DeleteComment200Response } from '../../models/base/delete-comment200-response/index'; import { GetComments200Response } from '../../models/base/get-comments200-response/index'; import { PostCommentRequest } from '../../models/base/post-comment-request/index'; import { Api, ApiClient, RequestMetadata } from '@ama-sdk/core'; /** Parameters object to CommentsApi's deleteComment function */ export interface CommentsApiDeleteCommentRequestData { /** File to delete comment from. This can be a file key or branch key. Use `GET /v1/files/:key` with the `branch_data` query param to get the branch key. */ 'file_key': string; /** Comment id of comment to delete */ 'comment_id': string; } /** Parameters object to CommentsApi's getComments function */ export interface CommentsApiGetCommentsRequestData { /** File to get comments from. This can be a file key or branch key. Use `GET /v1/files/:key` with the `branch_data` query param to get the branch key. */ 'file_key': string; /** If enabled, will return comments as their markdown equivalents when applicable. */ 'as_md'?: boolean; } /** Parameters object to CommentsApi's postComment function */ export interface CommentsApiPostCommentRequestData { /** File to add comments in. This can be a file key or branch key. Use `GET /v1/files/:key` with the `branch_data` query param to get the branch key. */ 'file_key': string; /** Comment to post. */ 'PostCommentRequest': PostCommentRequest; } export declare class CommentsApi implements Api { /** API name */ static readonly apiName = "CommentsApi"; /** @inheritDoc */ readonly apiName = "CommentsApi"; /** Tokens of the parameters containing PII */ readonly piiParamTokens: { [key: string]: string; }; /** @inheritDoc */ client: ApiClient; /** * Initialize your interface * * @param apiClient Client used to process call to the API */ constructor(apiClient: ApiClient); /** * Delete a comment * Deletes a specific comment. Only the person who made the comment is allowed to delete it. * @param data Data to provide to the API call * @param metadata Metadata to pass to the API call */ deleteComment(data: CommentsApiDeleteCommentRequestData, metadata?: RequestMetadata): Promise; /** * Get comments in a file * Gets a list of comments left on the file. * @param data Data to provide to the API call * @param metadata Metadata to pass to the API call */ getComments(data: CommentsApiGetCommentsRequestData, metadata?: RequestMetadata): Promise; /** * Add a comment to a file * Posts a new comment on the file. * @param data Data to provide to the API call * @param metadata Metadata to pass to the API call */ postComment(data: CommentsApiPostCommentRequestData, metadata?: RequestMetadata<'application/json', 'application/json'>): Promise; } //# sourceMappingURL=comments-api.d.ts.map