CommentService#

class CommentService[source]#

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, *, extra_parameters=None)[source]#

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

Parameters:

json_body (Union[dict, list, 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.
extra_parameters (Optional[Mapping[str, Union[str, bool, int, float]]]) – The extra query parameters you might want to add. By default no extra query parameters are added.
self (CommentService[AuthenticatedClient]) –

Returns:

The just created comment base.

Return type:

InlineFeedbackCommentBaseWithExtendedReplies | GeneralFeedbackCommentBaseWithExtendedReplies

create_reply(json_body, *, comment_base_id, extra_parameters=None)[source]#

Add a reply to a comment base.

Parameters:

json_body (Union[dict, list, 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.
extra_parameters (Optional[Mapping[str, Union[str, bool, int, float]]]) – The extra query parameters you might want to add. By default no extra query parameters are added.
self (CommentService[AuthenticatedClient]) –

Returns:

The just created reply.

Return type:

ExtendedNonDeletedCommentReply | DeletedCommentReply

delete_reply(*, comment_base_id, reply_id, extra_parameters=None)[source]#

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.
extra_parameters (Optional[Mapping[str, Union[str, bool, int, float]]]) – The extra query parameters you might want to add. By default no extra query parameters are added.
self (CommentService[AuthenticatedClient]) –

Returns:

Nothing.

Return type:

None

patch_reply(json_body, *, comment_base_id, reply_id, extra_parameters=None)[source]#

Update the content of a reply.

Parameters:

json_body (Union[dict, list, 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.
extra_parameters (Optional[Mapping[str, Union[str, bool, int, float]]]) – The extra query parameters you might want to add. By default no extra query parameters are added.
self (CommentService[AuthenticatedClient]) –

Returns:

The just updated reply.

Return type:

ExtendedNonDeletedCommentReply | DeletedCommentReply

get_all_reply_edits(*, comment_base_id, reply_id, extra_parameters=None)[source]#

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.
extra_parameters (Optional[Mapping[str, Union[str, bool, int, float]]]) – The extra query parameters you might want to add. By default no extra query parameters are added.
self (CommentService[AuthenticatedClient]) –

Returns:

A list of edits, sorted from newest to oldest.

Return type:

Sequence[CommentReplyEdit]

approve_reply(*, comment_base_id, reply_id, extra_parameters=None)[source]#

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.
extra_parameters (Optional[Mapping[str, Union[str, bool, int, float]]]) – The extra query parameters you might want to add. By default no extra query parameters are added.
self (CommentService[AuthenticatedClient]) –

Returns:

The just updated reply.

Return type:

ExtendedNonDeletedCommentReply | DeletedCommentReply

disapprove_reply(*, comment_base_id, reply_id, extra_parameters=None)[source]#

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.
extra_parameters (Optional[Mapping[str, Union[str, bool, int, float]]]) – The extra query parameters you might want to add. By default no extra query parameters are added.
self (CommentService[AuthenticatedClient]) –

Returns:

The just updated reply.

Return type:

ExtendedNonDeletedCommentReply | DeletedCommentReply

`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.