rbtools.api.resource.review_reply¶

Resource definitions for review replies.

Classes

class rbtools.api.resource.review_reply.ReviewReplyItemResource(transport: Transport, payload: JSONDict, url: str, token: str | None = None, **kwargs)[source]¶

Bases: BaseReviewItemResource

Item resource for review replies.

This corresponds to Review Board’s Review Reply Resource.

Added in version 6.0.

__firstlineno__ = 20¶

__static_attributes__ = ()¶

class rbtools.api.resource.review_reply.ReviewReplyListResource(transport: Transport, payload: JSONDict, url: str, token: str | None = None, item_mime_type: str | None = None, **kwargs)[source]¶

Bases: ListResource[ReviewReplyItemResource]

List resource for review replies.

This corresponds to Review Board’s Review Reply List Resource.

Added in version 6.0.

__annotations_cache__ = {}¶

__firstlineno__ = 32¶

__static_attributes__ = ()¶

get_reply_draft(**kwargs: Unpack[BaseGetParams]) → ReviewReplyItemResource[source]¶

Get the reply draft, if any.

Parameters:

**kwargs (dict) – Query arguments to include with the request.

Returns:

The reply item resource for the draft reply.

Return type:

rbtools.api.resource.ReviewReplyItemResource

Raises:

• rbtools.api.errors.APIError – The Review Board API returned an error.

• rbtools.api.errors.ServerInterfaceError – An error occurred while communicating with the server.

get_review_reply_draft(**kwargs: Unpack[BaseGetParams]) → ReviewReplyItemResource[source]¶

Get the review reply draft, if one exists.

Parameters:

**kwargs (dict) – Query arguments to include with the request.

Returns:

The review reply item resource.

Return type:

rbtools.api.resource.ReviewReplyItemResource

Raises:

• rbtools.api.errors.APIError – The Review Board API returned an error.

• rbtools.api.errors.ServerInterfaceError – An error occurred while communicating with the server.