rbtools.api.resource.muted_review_request¶

Resource definitions for muted review requests.

Classes

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

Bases: BaseArchivedObjectItemResource

Item resource for a muted review request.

This cannot be used to get any information about the muted item, but using the delete() method can un-archive a review request.

This corresponds to Review Board’s Muted Review Request Resource.

Added in version 6.0.

__annotations_cache__ = {}¶

__firstlineno__ = 21¶

__static_attributes__ = ()¶

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

Bases: BaseArchivedObjectListResource[MutedReviewRequestItemResource]

List resource for a muted review request.

This cannot be used to get a list of the muted items, but using the create() method can archive a review request.

This corresponds to Review Board’s Muted Review Request List Resource.

Added in version 6.0.

__annotations_cache__ = {}¶

__firstlineno__ = 36¶

__static_attributes__ = ()¶

get_item(*, review_request_id: int, **kwargs: QueryArgs) → MutedReviewRequestItemResource[source]¶

Get a muted review request item resource.

Parameters:

• review_request_id (int) – The review request.

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

Returns:

The muted review request item resource.

Return type:

rbtools.api.resource.MutedReviewRequestItemResource

Raises:

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

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