CommentService

class CommentService

Methods

create_base	Create a new comment base, or retrieve an existing one.
create_reply	Add a reply to a comment base.
delete_reply	Delete the given reply.
patch_reply	Update the content of a reply.
get_all_reply_edits	Get the edits of a reply.
approve_reply	Update the approval status of a reply.
disapprove_reply	Update the approval status of a reply.

create_base(json_body)

Create a new comment base, or retrieve an existing one.

Parameters:

• json_body (Union[CreateInlineCommentData, CreateGeneralCommentData]) – The body of the request. See CreateCommentData for information about the possible fields. You can provide this data as a CreateCommentData or as a dictionary.

• self (CommentService[AuthenticatedClient]) –

Returns:

The just created comment base.

Return type:

InlineFeedbackCommentBaseWithExtendedReplies | GeneralFeedbackCommentBaseWithExtendedReplies

create_reply(json_body, *, comment_base_id)

Add a reply to a comment base.

Parameters:

• json_body (CreateCommentReplyData) – The body of the request. See CreateCommentReplyData for information about the possible fields. You can provide this data as a CreateCommentReplyData or as a dictionary.

• comment_base_id (int) – The id of the base to which you want to add a reply.

• self (CommentService[AuthenticatedClient]) –

Returns:

The just created reply.

Return type:

ExtendedNonDeletedCommentReply | DeletedCommentReply

delete_reply(*, comment_base_id, reply_id)

Delete the given reply.

Parameters:

• comment_base_id (int) – The base of the given reply.

• reply_id (int) – The id of the reply to delete.

• self (CommentService[AuthenticatedClient]) –

Returns:

Nothing.

Return type:

None

patch_reply(json_body, *, comment_base_id, reply_id)

Update the content of a reply.

Parameters:

• json_body (PatchCommentReplyData) – The body of the request. See PatchCommentReplyData for information about the possible fields. You can provide this data as a PatchCommentReplyData or as a dictionary.

• comment_base_id (int) – The base of the given reply.

• reply_id (int) – The id of the reply for which you want to update.

• self (CommentService[AuthenticatedClient]) –

Returns:

The just updated reply.

Return type:

ExtendedNonDeletedCommentReply | DeletedCommentReply

get_all_reply_edits(*, comment_base_id, reply_id, page_size=20)

Get the edits of a reply.

Parameters:

• comment_base_id (int) – The base of the given reply.

• reply_id (int) – The id of the reply for which you want to get the edits.

• page_size (int) – The size of a single page, maximum is 50.

• self (CommentService[AuthenticatedClient]) –

Returns:

A list of edits, sorted from newest to oldest.

Return type:

Response[CommentReplyEdit]

approve_reply(*, comment_base_id, reply_id)

Update the approval status of a reply.

Parameters:

• comment_base_id (int) – The base of the given reply.

• reply_id (int) – The id of the reply for which you want to update the approval.

• self (CommentService[AuthenticatedClient]) –

Returns:

The just updated reply.

Return type:

ExtendedNonDeletedCommentReply | DeletedCommentReply

disapprove_reply(*, comment_base_id, reply_id)

Update the approval status of a reply.

Parameters:

• comment_base_id (int) – The base of the given reply.

• reply_id (int) – The id of the reply for which you want to update the approval.

• self (CommentService[AuthenticatedClient]) –

Returns:

The just updated reply.

Return type:

ExtendedNonDeletedCommentReply | DeletedCommentReply