rbtools.api.resource.root¶

Resource definitions for the API root.

Added in version 6.0: This was moved from rbtools.api.resource.

Classes

RootResource(transport, payload, url, **kwargs)

The Root resource.

class rbtools.api.resource.root.RootResource(transport: Transport, payload: JSONDict, url: str, **kwargs)[source]¶

Bases: ItemResource

The Root resource.

Provides additional methods for fetching any resource directly using the uri templates. A method of the form “get_<uri-template-name>” is called to retrieve the HttpRequest corresponding to the resource. Template replacement values should be passed in as a dictionary to the values parameter.

This corresponds to Review Board’s Root List Resource.

__firstlineno__ = 232¶

__init__(transport: Transport, payload: JSONDict, url: str, **kwargs) → None[source]¶

Initialize the resource.

Parameters:

transport (rbtools.api.transport.Transport) – The API transport.
payload (dict) – The resource payload.
url (str) – The resource URL.
**kwargs (dict, unused) – Unused keyword arguments.

__static_attributes__ = ()¶

capabilities: ResourceDictField¶: Capabilities for the Review Board server.

get_all_diff_comments(**kwargs: Unpack[AllDiffCommentsGetListParams]) → DiffCommentListResource[source]¶

Get the root diff comment list resource.

Parameters:

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

Returns:

The diff comment list resource.

Return type:

rbtools.api.resource.DiffCommentListResource

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_all_file_attachment_comments(**kwargs: Unpack[AllFileAttachmentCommentsGetListParams]) → FileAttachmentCommentListResource[source]¶

Get the root file attachment comment list resource.

Parameters:

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

Returns:

The file attachment comment list resource.

Return type:

rbtools.api.resource.FileAttachmentCommentListResource

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_all_general_comments(**kwargs: Unpack[AllGeneralCommentsGetListParams]) → GeneralCommentListResource[source]¶

Get the root general comment list resource.

Parameters:

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

Returns:

The general comment list resource.

Return type:

rbtools.api.resource.GeneralCommentListResource

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_all_reviews(**kwargs: Unpack[AllReviewsGetListParams]) → ReviewListResource[source]¶

Get the root review list resource.

Parameters:

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

Returns:

The review list.

Return type:

rbtools.api.resource.ReviewListResource

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_api_token(*, username: str, api_token_id: int, **kwargs: Unpack[BaseGetParams]) → APITokenItemResource[source]¶

Get an API token item resource.

Parameters:

username (str) – The name of the user to get the API token for.
api_token_id (int) – The ID of the API token to get.
**kwargs (dict) – Query arguments to include with the request.

Returns:

The API token item resource.

Return type:

rbtools.api.resource.APITokenItemResource

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_api_tokens(*, username: str, **kwargs: Unpack[BaseGetListParams]) → APITokenListResource[source]¶

Get an API token list resource.

Parameters:

username (str) – The name of the user to get the API token list for.
**kwargs (dict) – Query arguments to include with the request.

Returns:

The API token list resource.

Return type:

rbtools.api.resource.APITokenListResource

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_archived_review_request(*, username: str, review_request_id: int, **kwargs: QueryArgs) → ArchivedReviewRequestItemResource[source]¶

Get an archived review request item resource.

Parameters:

username (str) – The name of the user to get the archived review request item for.
review_request_id (int) – The review request
**kwargs (dict) – Query arguments to include with the request.

Returns:

The archived review request item resource.

Return type:

rbtools.api.resource.ArchivedReviewRequestItemResource

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_archived_review_requests(*, username: str, **kwargs: QueryArgs) → ArchivedReviewRequestListResource[source]¶

Get an archived review requests list resource.

Parameters:

username (str) – The name of the user to get the archived review requests list for.
**kwargs (dict) – Query arguments to include with the request.

Returns:

The archived review request list resource.

Return type:

rbtools.api.resource.ArchivedReviewRequestListResource

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_branches(*, repository_id: int, **kwargs: Unpack[BaseGetParams]) → RepositoryBranchListResource[source]¶

Get the repository branches resource.

This method exists for compatibility with versions of Review Board prior to 5.0.2. get_repository_branches() should be used instead.

Parameters:

repository_id (int) – The ID of the repository to fetch commits for.
**kwargs (dict) – Query arguments to include with the request.

Returns:

The repository branches.

Return type:

rbtools.api.resource.RepositoryBranchListResource

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_change(*, review_request_id: int, change_id: int, **kwargs: Unpack[BaseGetParams]) → ChangeItemResource[source]¶

Get a change description item resource.

This method is for compatibility with versions of Review Board prior to 5.0.2. get_review_request_change() should be used instead.

Parameters:

review_request_id (int) – The review request ID.
change_id (int) – The change description ID.
**kwargs (dict) – Query arguments to include with the request.

Returns:

The change description item resource.

Return type:

rbtools.api.resource.ChangeItemResource

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_changes(*, review_request_id: int, **kwargs: Unpack[BaseGetListParams]) → ChangeListResource[source]¶

Get a change description list resource.

This method is for compatibility with versions of Review Board prior to 5.0.2. get_review_request_changes() should be used instead.

Parameters:

review_request_id (int) – The review request ID.
**kwargs (dict) – Query arguments to include with the request.

Returns:

The change description list resource.

Return type:

rbtools.api.resource.ChangeListResource

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_commit(*, review_request_id: int, diff_revision: int, commit_id: int, **kwargs: Unpack[BaseGetParams]) → DiffCommitItemResource[source]¶

Get a diff commit item resource.

This method exists for compatibility with versions of Review Board prior to 5.0.2. get_diff_commit() should be used instead.

Parameters:

review_request_id (int) – The review request ID.
diff_revision (int) – The revision of the diff.
commit_id (int) – The ID of the commit to fetch.
**kwargs (dict) – Query arguments to include with the request.

Returns:

The diff commit item resource.

Return type:

rbtools.api.resource.DiffItemResource

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_commit_validation(**kwargs: Unpack[BaseGetParams]) → ValidateDiffCommitResource[source]¶

Get the diff commit validation resource.

Parameters:

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

Returns:

The diff commit validation resource.

Return type:

rbtools.api.resource.ValidateDiffCommitResource

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_commits(*, repository_id: int, **kwargs: Unpack[RepositoryCommitGetListParams]) → RepositoryCommitListResource[source]¶

Get the repository commits resource.

This method exists for compatibility with versions of Review Board prior to 5.0.2. get_repository_commits() should be used instead.

Parameters:

repository_id (int) – The ID of the repository to fetch commits for.
**kwargs (dict) – Query arguments to include with the request.

Returns:

The repository commits.

Return type:

rbtools.api.resource.RepositoryCommitListResource

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_default_reviewer(*, default_reviewer_id: int, **kwargs: Unpack[BaseGetParams]) → DefaultReviewerItemResource[source]¶

Get a default reviewer item resource.

Parameters:

default_reviewer_id (int) – The ID of the default reviewer to get.
**kwargs (dict) – Query arguments to include with the request.

Returns:

The default reviewer item resource.

Return type:

rbtools.api.resource.DefaultReviewerItemResource

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_default_reviewers(**kwargs: Unpack[DefaultReviewerGetListParams]) → DefaultReviewerListResource[source]¶

Get the default reviewer list resource.

Parameters:

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

Returns:

The default reviewer list resource.

Return type:

rbtools.api.resource.DefaultReviewerListResource

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_diff(*, review_request_id: int, diff_revision: int, **kwargs: Unpack[BaseGetParams]) → DiffItemResource[source]¶

Get a diff item resource.

Parameters:

review_request_id (int) – The review request ID.
diff_revision (int) – The revision of the diff to fetch.
**kwargs (dict) – Query arguments to include with the request.

Returns:

The diff item resource.

Return type:

rbtools.api.resource.DiffItemResource

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_diff_comment(*, review_request_id: int, review_id: int, comment_id: int, **kwargs: Unpack[BaseGetParams]) → DiffCommentItemResource[source]¶

Get a reply diff comment item resource.

This method is for compatibility with versions of Review Board prior to 5.0.2. get_review_reply_diff_comment() should be used instead.

Parameters:

review_request_id (int) – The review request ID.
review_id (int) – The review ID.
comment_id (int) – The comment ID.
**kwargs (dict) – Query arguments to include with the request.

Returns:

The diff comment item resource.

Return type:

rbtools.api.resource.DiffCommentItemResource

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_diff_comments(*, review_request_id: int, review_id: int, **kwargs: Unpack[DiffCommentGetListParams]) → DiffCommentListResource[source]¶

Get a reply diff comment list resource.

This method is for compatibility with versions of Review Board prior to 5.0.2. get_review_reply_diff_comments() should be used instead.

Parameters:

review_request_id (int) – The review request ID.
review_id (int) – The review ID.
**kwargs (dict) – Query arguments to include with the request.

Returns:

The diff comment list resource.

Return type:

rbtools.api.resource.DiffCommentListResource

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_diff_commit(*, review_request_id: int, diff_revision: int, commit_id: int, **kwargs: Unpack[BaseGetParams]) → DiffCommitItemResource[source]¶

Get a diff commit item resource.

Parameters:

review_request_id (int) – The review request ID.
diff_revision (int) – The revision of the diff.
commit_id (int) – The ID of the commit to fetch.
**kwargs (dict) – Query arguments to include with the request.

Returns:

The diff commit item resource.

Return type:

rbtools.api.resource.DiffItemResource

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_diff_commits(*, review_request_id: int, diff_revision: int, **kwargs: Unpack[BaseGetListParams]) → DiffCommitListResource[source]¶

Get the diff commits list.

Parameters:

review_request_id (int) – The review request ID.
diff_revision (int) – The revision of the diff.
**kwargs (dict) – Query arguments to include with the request.

Returns:

The diff commits list resource.

Return type:

rbtools.api.resource.DiffListResource

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_diff_context(*, review_request_id: int, **kwargs: Unpack[DiffContextGetParams]) → DiffContextResource[source]¶

Get the diff context resource.

Parameters:

review_request_id (int) – The review request ID.
**kwargs (dict) – Query arguments to include with the request.

Returns:

The diff context resource.

Return type:

rbtools.api.resource.DiffContextResource

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_diff_file_attachment(*, repository_id: int, **kwargs: Unpack[BaseGetParams]) → DiffFileAttachmentItemResource[source]¶

Get a diff file attachment item resource.

Parameters:

repository_id (int) – The repository for the diff file attachments.
file_attachment_id (int) – The ID of the file attachment.
**kwargs (dict) – Query arguments to include with the request.

Returns:

The diff file attachment item resource.

Return type:

rbtools.api.resource.DiffFileAttachmentItemResource

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_diff_file_attachments(*, repository_id: int, **kwargs: Unpack[DiffFileAttachmentGetListParams]) → DiffFileAttachmentListResource[source]¶

Get a diff file attachments list resource.

Parameters:

repository_id (int) – The repository for the diff file attachments.
**kwargs (dict) – Query arguments to include with the request.

Returns:

The extensions list resource.

Return type:

rbtools.api.resource.DiffFileAttachmentListResource

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_diff_validation(**kwargs: Unpack[BaseGetParams]) → ValidateDiffResource[source]¶

Get the diff validation resource.

Parameters:

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

Returns:

The diff validation resource.

Return type:

rbtools.api.resource.ValidateDiffResource

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_diffs(*, review_request_id: int, **kwargs: Unpack[BaseGetListParams]) → DiffListResource[source]¶

Get a diff list resource.

Parameters:

review_request_id (int) – The review request ID.
**kwargs (dict) – Query arguments to include with the request.

Returns:

The diff list resource.

Return type:

rbtools.api.resource.DiffListResource

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_draft(*, review_request_id: int, **kwargs: Unpack[BaseGetParams]) → ReviewRequestDraftResource[source]¶

Get a review request draft.

This method is for compatibility with versions of Review Board prior to 5.0.2. get_review_request_draft() should be used instead.

Parameters:

review_request_id (int) – The ID of the review request.
**kwargs (dict) – Query arguments to include with the request.

Returns:

The draft resource.

Return type:

rbtools.api.resource.ReviewRequestDraftResource

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_extension(*, extension_name: str, **kwargs: Unpack[BaseGetParams]) → ExtensionItemResource[source]¶

Get an extension item resource.

Parameters:

extension_name (str) – The class path of the extension class (for example, rbintegrations.extension.RBIntegrationsExtension).
**kwargs (dict) – Query arguments to include with the request.

Returns:

The extension item resource.

Return type:

rbtools.api.resource.ExtensionItemResource

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_extensions(**kwargs: Unpack[BaseGetListParams]) → ExtensionListResource[source]¶

Get the extensions list resource.

Parameters:

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

Returns:

The diff file attachments list resource.

Return type:

rbtools.api.resource.ExtensionListResource

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_file(*, review_request_id: int, diff_revision: int, filediff_id: int, **kwargs: Unpack[BaseGetParams]) → FileDiffItemResource[source]¶

Get a file diff item resource.

This method is for compatibility with versions of Review Board prior to 5.0.2. get_file_diff() should be used instead.

Parameters:

review_request_id (int) – The review request ID.
diff_revision (int) – The diff revision.
filediff_id (int) – The file diff ID.
**kwargs (dict) – Query arguments to include with the request.

Returns:

The file diff item resource.

Return type:

rbtools.api.resource.FileDiffItemResource

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_file_attachment(*, review_request_id: int, file_attachment_id: int, **kwargs: Unpack[BaseGetParams]) → FileAttachmentItemResource[source]¶

Get a file attachment item resource.

This method is for compatibility with versions of Review Board prior to 5.0.2. get_review_request_file_attachment() should be used instead.

Parameters:

review_request_id (int) – The review request ID.
file_attachment_id (int) – The file attachment ID.
**kwargs (dict) – Query arguments to include with the request.

Returns:

The file attachment item resource.

Return type:

rbtools.api.resource.FileAttachmentItemResource

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_file_attachment_comment(*, review_request_id: int, review_id: int, comment_id: int, **kwargs: Unpack[BaseGetParams]) → FileAttachmentCommentItemResource[source]¶

Get a file attachment comment item resource.

Parameters:

review_request_id (int) – The review request ID.
review_id (int) – The review ID.
comment_id (int) – The comment ID.
**kwargs (dict) – Query arguments to include with the request.

Returns:

The file attachment comment item resource.

Return type:

rbtools.api.resource.FileAttachmentCommentItemResource

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_file_attachment_comments(*, review_request_id: int, review_id: int, **kwargs: Unpack[BaseGetListParams]) → FileAttachmentCommentListResource[source]¶

Get a file attachment comment list resource.

Parameters:

review_request_id (int) – The review request ID.
review_id (int) – The review ID.
**kwargs (dict) – Query arguments to include with the request.

Returns:

The file attachment comment list resource.

Return type:

rbtools.api.resource.FileAttachmentCommentListResource

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_file_attachments(*, review_request_id: int, **kwargs: Unpack[BaseGetListParams]) → FileAttachmentListResource[source]¶

Get a file attachment list resource.

This method is for compatibility with versions of Review Board prior to 5.0.2. get_review_request_file_attachments() should be used instead.

Parameters:

review_request_id (int) – The review request ID.
**kwargs (dict) – Query arguments to include with the request.

Returns:

The file attachments list resource.

Return type:

rbtools.api.resource.FileAttachmentListResource

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_file_diff(*, review_request_id: int, diff_revision: int, filediff_id: int, **kwargs: Unpack[BaseGetParams]) → FileDiffItemResource[source]¶

Get a file diff item resource.

Parameters:

review_request_id (int) – The review request ID.
diff_revision (int) – The diff revision.
filediff_id (int) – The file diff ID.
**kwargs (dict) – Query arguments to include with the request.

Returns:

The file diff item resource.

Return type:

rbtools.api.resource.FileDiffItemResource

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_file_diff_comments(review_request_id: int, diff_revision: int, filediff_id: int, **kwargs: Unpack[DiffCommentGetListParams]) → DiffCommentListResource[source]¶

Get the comments for a file diff.

Parameters:

review_request_id (int) – The review request ID.
diff_revision (int) – The diff revision.
filediff_id (int) – The ID of the file diff to fetch comments for.
**kwargs (dict) – Query arguments to include with the request.

Returns:

The comments on this file diff.

Return type:

rbtools.api.resource.DiffCommentListResource

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_file_diff_original_file(*, review_request_id: int, diff_revision: int, filediff_id: int, **kwargs: QueryArgs) → PlainTextResource[source]¶

Get the original version of a file from a diff.

Parameters:

review_request_id (int) – The review request ID.
diff_revision (int) – The diff revision.
filediff_id (int) – The file diff ID.
**kwargs (dict) – Query arguments to include with the request.

Returns:

The original file.

Return type:

rbtools.api.resource.PlainTextResource

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_file_diff_patched_file(*, review_request_id: int, diff_revision: int, filediff_id: int, **kwargs: QueryArgs) → PlainTextResource[source]¶

Get the patched version of a file from a diff.

Parameters:

review_request_id (int) – The review request ID.
diff_revision (int) – The diff revision.
filediff_id (int) – The file diff ID.
**kwargs (dict) – Query arguments to include with the request.

Returns:

The patched file.

Return type:

rbtools.api.resource.PlainTextResource

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_file_diffs(*, review_request_id: int, diff_revision: int, **kwargs: Unpack[FileDiffGetListParams]) → FileDiffListResource[source]¶

Get the file diffs for a diff revision.

Parameters:

review_request_id (int) – The review request ID.
diff_revision (int) – The diff revision.
**kwargs (dict) – Query arguments to include with the request.

Returns:

The file diff list resource.

Return type:

rbtools.api.resource.FileDiffListResource

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_files(*, review_request_id: int, diff_revision: int, **kwargs: Unpack[FileDiffGetListParams]) → FileDiffListResource[source]¶

Get the file diffs for a diff revision.

This method is for compatibility with versions of Review Board prior to 5.0.2. get_file_diffs() should be used instead.

Parameters:

review_request_id (int) – The review request ID.
diff_revision (int) – The diff revision.
**kwargs (dict) – Query arguments to include with the request.

Returns:

The file diff list resource.

Return type:

rbtools.api.resource.FileDiffListResource

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_general_comment(*, review_request_id: int, review_id: int, comment_id: int, **kwargs: Unpack[BaseGetParams]) → GeneralCommentItemResource[source]¶

Get a general comment item resource.

This method is for compatibility with versions of Review Board prior to 5.0.2. get_review_general_comment() should be used instead.

Parameters:

review_request_id (int) – The review request ID.
review_id (int) – The review ID.
comment_id (int) – The comment ID.
**kwargs (dict) – Query arguments to include with the request.

Returns:

The general comment item resource.

Return type:

rbtools.api.resource.GeneralCommentItemResource

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_general_comments(*, review_request_id: int, review_id: int, **kwargs: Unpack[BaseGetListParams]) → GeneralCommentListResource[source]¶

Get a general comment list resource.

This method is for compatibility with versions of Review Board prior to 5.0.2. get_review_general_comments() should be used instead.

Parameters:

review_request_id (int) – The review request ID.
review_id (int) – The review ID.
**kwargs (dict) – Query arguments to include with the request.

Returns:

The general comment list resource.

Return type:

rbtools.api.resource.GeneralCommentListResource

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_group(*, group_name: str, **kwargs: Unpack[BaseGetParams]) → ReviewGroupItemResource[source]¶

Get a review group item resource.

Parameters:

group_name (str) – The review group name.
**kwargs (dict) – Query arguments to include with the request.

Returns:

The review group item resource.

Return type:

rbtools.api.resource.ReviewGroupItemResource

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_groups(**kwargs: Unpack[ReviewGroupGetListParams]) → ReviewGroupListResource[source]¶

Get the review group list resource.

Parameters:

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

Returns:

The review group list resource.

Return type:

rbtools.api.resource.ReviewGroupListResource

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_hosting_service(*, hosting_service_id: str, **kwargs: Unpack[BaseGetParams]) → HostingServiceItemResource[source]¶

Get a hosting service item resource.

Parameters:

hosting_service_id (str) – The ID of the hosting service.
**kwargs (dict) – Query arguments to include with the request.

Returns:

The hosting service item resource.

Return type:

rbtools.api.resource.HostingServiceItemResource

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_hosting_service_account(*, account_id: int, **kwargs: Unpack[BaseGetParams]) → HostingServiceAccountItemResource[source]¶

Get a hosting service account item resource.

Parameters:

account_id (int) – The ID of the hosting service account.
**kwargs (dict) – Query arguments to include with the request.

Returns:

The hosting service account item resource.

Return type:

rbtools.api.resource.HostingServiceAccountItemResource

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_hosting_service_accounts(**kwargs: Unpack[HostingServiceAccountGetListParams]) → HostingServiceAccountListResource[source]¶

Get the hosting service account list resource.

Parameters:

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

Returns:

The hosting service account list resource.

Return type:

rbtools.api.resource.HostingServiceAccountListResource

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_hosting_services(**kwargs: Unpack[BaseGetListParams]) → HostingServiceListResource[source]¶

Get the hosting service list resource.

Parameters:

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

Returns:

The hosting service list resource.

Return type:

rbtools.api.resource.HostingServiceListResource

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_info(**kwargs: Unpack[BaseGetParams]) → ServerInfoResource[source]¶

Get the server info resource.

Parameters:

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

Returns:

The server info resource.

Return type:

rbtools.api.resource.ServerInfoResource

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_last_update(*, review_request_id: int, **kwargs: Unpack[BaseGetParams]) → LastUpdateResource[source]¶

Get the last update resource for a review request.

This method is for compatibility with versions of Review Board prior to 5.0.2. get_review_request_last_update() should be used instead.

Parameters:

review_request_id (int) – The review request ID.
**kwargs (dict) – Query arguments to include with the request.

Returns:

The last update resource.

Return type:

rbtools.api.resource.LastUpdateResource

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_muted_review_request(*, username: str, review_request_id: int, **kwargs: QueryArgs) → MutedReviewRequestItemResource[source]¶

Get a muted review request item resource.

Parameters:

username (str) – The name of the user to get the muted review request item for.
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.

get_muted_review_requests(*, username: str, **kwargs: QueryArgs) → MutedReviewRequestListResource[source]¶

Get a muted review requests list resource.

Parameters:

username (str) – The name of the user to get the muted review requests list for.
**kwargs (dict) – Query arguments to include with the request.

Returns:

The muted review request list resource.

Return type:

rbtools.api.resource.MutedReviewRequestListResource

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_oauth_app(*, app_id: int, **kwargs: Unpack[BaseGetParams]) → OAuthApplicationItemResource[source]¶

Get an OAuth2 application item resource.

Parameters:

app_id (int) – The application ID.
**kwargs (dict) – Query arguments to include with the request.

Returns:

The application item resource.

Return type:

rbtools.api.resource.OAuthApplicationItemResource

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_oauth_apps(**kwargs: Unpack[OAuthApplicationGetListParams]) → OAuthApplicationListResource[source]¶

Get the OAuth2 application list resource.

Parameters:

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

Returns:

The application list resource.

Return type:

rbtools.api.resource.OAuthApplicationListResource

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_oauth_token(*, oauth_token_id: int, **kwargs: Unpack[BaseGetParams]) → OAuthTokenItemResource[source]¶

Get an OAuth2 token item resource.

Parameters:

oauth_token_id (int) – The ID of the OAuth token.
**kwargs (dict) – Query arguments to include with the request.

Returns:

The token item resource.

Return type:

rbtools.api.resource.OAuthTokenItemResource

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_oauth_tokens(**kwargs: Unpack[BaseGetListParams]) → OAuthTokenListResource[source]¶

Get the OAuth2 token list resource.

Parameters:

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

Returns:

The token list resource.

Return type:

rbtools.api.resource.OAuthTokenListResource

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_original_file(*, review_request_id: int, diff_revision: int, filediff_id: int, **kwargs: QueryArgs) → PlainTextResource[source]¶

Get the original version of a file.

This method is for compatibility with versions of Review Board prior to 5.0.2. get_file_diff_original_file() should be used instead.

Parameters:

review_request_id (int) – The review request ID.
diff_revision (int) – The diff revision.
filediff_id (int) – The file diff ID.
**kwargs (dict) – Query arguments to include with the request.

Returns:

The original file.

Return type:

rbtools.api.resource.PlainTextResource

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_patched_file(*, review_request_id: int, diff_revision: int, filediff_id: int, **kwargs: QueryArgs) → PlainTextResource[source]¶

Get the patched version of a file.

This method is for compatibility with versions of Review Board prior to 5.0.2. get_file_diff_patched_file() should be used instead.

Parameters:

review_request_id (int) – The review request ID.
diff_revision (int) – The diff revision.
filediff_id (int) – The file diff ID.
**kwargs (dict) – Query arguments to include with the request.

Returns:

The patched file.

Return type:

rbtools.api.resource.PlainTextResource

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_remote_repositories(*, account_id: int, **kwargs: Unpack[RemoteRepositoryGetListParams]) → RemoteRepositoryListResource[source]¶

Get a remote repository list resource.

Parameters:

account_id (int) – The ID of the hosting service account.
**kwargs (dict) – Query arguments to include with the request.

Returns:

The remote repository list resource.

Return type:

rbtools.api.resource.RemoteRepositoryListResource

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_remote_repository(*, account_id: int, repository_id: str, **kwargs: Unpack[BaseGetParams]) → RemoteRepositoryItemResource[source]¶

Get a remote repository item resource.

Parameters:

account_id (int) – The ID of the hosting service account.
repository_id (str) – The ID of the remote repository.
**kwargs (dict) – Query arguments to include with the request.

Returns:

The remote repository item resource.

Return type:

rbtools.api.resource.RemoteRepositoryItemResource

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_replies(*, review_request_id: int, review_id: int, **kwargs: Unpack[BaseGetListParams]) → ReviewReplyListResource[source]¶

Get a review reply list resource.

This method is for compatibility with versions of Review Board prior to 5.0.2. get_review_replies() should be used instead.

Parameters:

review_request_id (int) – The review request ID.
review_id (int) – The ID of the review being replied to.
**kwargs (dict) – Query arguments to include with the request.

Returns:

The review reply list resource.

Return type:

rbtools.api.resource.ReviewReplyListResource

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_reply(*, review_request_id: int, review_id: int, reply_id: int, **kwargs: Unpack[BaseGetParams]) → ReviewReplyItemResource[source]¶

Get a review reply item resource.

This method is for compatibility with versions of Review Board prior to 5.0.2. get_review_reply() should be used instead.

Parameters:

review_request_id (int) – The review request ID.
review_id (int) – The ID of the review being replied to.
reply_id (int) – The ID of the reply.
**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.

get_reply_draft(*, review_request_id: int, review_id: int, **kwargs: Unpack[BaseGetParams]) → ReviewReplyItemResource[source]¶

Get a review reply draft item resource, if present.

This method is for compatibility with versions of Review Board prior to 5.0.2. get_review_reply_draft() should be used instead.

Parameters:

review_request_id (int) – The review request ID.
review_id (int) – The ID of the review being replied to.
**kwargs (dict) – Query arguments to include with the request.

Returns:

The review reply draft 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.

get_repositories(**kwargs: Unpack[RepositoryGetListParams]) → RepositoryListResource[source]¶

Get a repository list resource.

Parameters:

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

Returns:

The repository list resource.

Return type:

rbtools.api.resource.RepositoryListResource

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_repository(*, repository_id: int, **kwargs: Unpack[BaseGetParams]) → RepositoryItemResource[source]¶

Get a repository item resource.

Parameters:

repository_id (int) – The ID of the repository.
**kwargs (dict) – Query arguments to include with the request.

Returns:

The repository item resource.

Return type:

rbtools.api.resource.RepositoryItemResource

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_repository_branches(*, repository_id: int, **kwargs: Unpack[BaseGetParams]) → RepositoryBranchListResource[source]¶

Get the repository branches resource.

Parameters:

repository_id (int) – The ID of the repository to fetch commits for.
**kwargs (dict) – Query arguments to include with the request.

Returns:

The repository branches.

Return type:

rbtools.api.resource.RepositoryBranchListResource

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_repository_commits(*, repository_id: int, **kwargs: Unpack[RepositoryCommitGetListParams]) → RepositoryCommitListResource[source]¶

Get the repository commits resource.

Parameters:

repository_id (int) – The ID of the repository to fetch commits for.
**kwargs (dict) – Query arguments to include with the request.

Returns:

The repository commits.

Return type:

rbtools.api.resource.RepositoryCommitListResource

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_repository_group(*, repository_id: int, group_name: str, **kwargs: Unpack[BaseGetParams]) → RepositoryGroupItemResource[source]¶

Get a repository group item resource.

Parameters:

repository_id (int) – The ID of the repository to fetch groups for.
group_name (str) – The name of the group to fetch.
**kwargs (dict) – Query arguments to include with the request.

Returns:

The repository group item resource.

Return type:

rbtools.api.resource.RepositoryGroupItemResource

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_repository_groups(*, repository_id: int, **kwargs: Unpack[ReviewGroupGetListParams]) → RepositoryGroupListResource[source]¶

Get a repository group list resource.

Parameters:

repository_id (int) – The ID of the repository to fetch groups for.
**kwargs (dict) – Query arguments to include with the request.

Returns:

The repository group list resource.

Return type:

rbtools.api.resource.RepositoryGroupListResource

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_repository_info(*, repository_id: int, **kwargs: Unpack[BaseGetParams]) → RepositoryInfoResource[source]¶

Get the repository info resource.

Parameters:

repository_id (int) – The ID of the repository to fetch commits for.
**kwargs (dict) – Query arguments to include with the request.

Returns:

The repository commits.

Return type:

rbtools.api.resource.RepositoryInfoResource

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_repository_user(*, repository_id: int, **kwargs: Unpack[UserGetParams]) → RepositoryUserItemResource[source]¶

Get a repository user item resource.

Parameters:

repository_id (int) – The ID of the repository to fetch users for.
username (str) – The username to fetch.
**kwargs (dict) – Query arguments to include with the request.

Returns:

The repo

Return type:

rbtools.api.resource.RepositoryUserItemResource

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_repository_users(*, repository_id: int, **kwargs: Unpack[UserGetListParams]) → RepositoryUserListResource[source]¶

Get a repository user list resource.

Parameters:

repository_id (int) – The ID of the repository to fetch users for.
**kwargs (dict) – Query arguments to include with the request.

Returns:

The repository user list resource.

Return type:

rbtools.api.resource.RepositoryUserListResource

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(*, review_request_id: int, review_id: int, **kwargs: Unpack[BaseGetParams]) → ReviewItemResource[source]¶

Get a review item resource.

Parameters:

review_request_id (int) – The ID of the review request.
review_id (int) – The ID of the review.
**kwargs (dict) – Query arguments to include with the request.

Returns:

The review item resource.

Return type:

rbtools.api.resource.ReviewItemResource

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_diff_comment(*, review_request_id: int, review_id: int, comment_id: int, **kwargs: Unpack[BaseGetParams]) → DiffCommentItemResource[source]¶

Get a diff comment item resource.

Parameters:

review_request_id (int) – The review request ID.
review_id (int) – The review ID.
comment_id (int) – The comment ID.
**kwargs (dict) – Query arguments to include with the request.

Returns:

The diff comment item resource.

Return type:

rbtools.api.resource.DiffCommentItemResource

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_diff_comments(*, review_request_id: int, review_id: int, **kwargs: Unpack[DiffCommentGetListParams]) → DiffCommentListResource[source]¶

Get a diff comment list resource.

Parameters:

review_request_id (int) – The review request ID.
review_id (int) – The review ID.
**kwargs (dict) – Query arguments to include with the request.

Returns:

The diff comment list resource.

Return type:

rbtools.api.resource.DiffCommentListResource

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_draft(*, review_request_id: int, **kwargs: Unpack[BaseGetParams]) → ReviewItemResource[source]¶

Get a review draft item resource.

Parameters:

review_request_id (int) – The ID of the review request.
**kwargs (dict) – Query arguments to include with the request.

Returns:

The review item resource for the user’s draft, if any.

Return type:

rbtools.api.resource.ReviewItemResource

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_general_comment(*, review_request_id: int, review_id: int, comment_id: int, **kwargs: Unpack[BaseGetParams]) → GeneralCommentItemResource[source]¶

Get a general comment item resource.

Parameters:

review_request_id (int) – The review request ID.
review_id (int) – The review ID.
comment_id (int) – The comment ID.
**kwargs (dict) – Query arguments to include with the request.

Returns:

The general comment item resource.

Return type:

rbtools.api.resource.GeneralCommentItemResource

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_general_comments(*, review_request_id: int, review_id: int, **kwargs: Unpack[BaseGetListParams]) → GeneralCommentListResource[source]¶

Get a general comment list resource.

Parameters:

review_request_id (int) – The review request ID.
review_id (int) – The review ID.
**kwargs (dict) – Query arguments to include with the request.

Returns:

The general comment list resource.

Return type:

rbtools.api.resource.GeneralCommentListResource

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_group_user(*, group_name: str, username: str, **kwargs: Unpack[UserGetParams]) → ReviewGroupUserItemResource[source]¶

Get a review group user item resource.

Parameters:

group_name (str) – The name of the review group.
username (str) – The username of the user.
**kwargs (dict) – Query arguments to include with the request.

Returns:

The review group user item resource.

Return type:

rbtools.api.resource.ReviewGroupUserItemResource

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_group_users(*, group_name: str, **kwargs: Unpack[UserGetParams]) → ReviewGroupUserListResource[source]¶

Get a review group user list resource.

Parameters:

group_name (str) – The name of the review group.
**kwargs (dict) – Query arguments to include with the request.

Returns:

The review group user list resource.

Return type:

rbtools.api.resource.ReviewGroupUserListResource

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_replies(*, review_request_id: int, review_id: int, **kwargs: Unpack[BaseGetListParams]) → ReviewReplyListResource[source]¶

Get a review reply list resource.

Parameters:

review_request_id (int) – The review request ID.
review_id (int) – The ID of the review being replied to.
**kwargs (dict) – Query arguments to include with the request.

Returns:

The review reply list resource.

Return type:

rbtools.api.resource.ReviewReplyListResource

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(*, review_request_id: int, review_id: int, reply_id: int, **kwargs: Unpack[BaseGetParams]) → ReviewReplyItemResource[source]¶

Get a review reply item resource.

Parameters:

review_request_id (int) – The review request ID.
review_id (int) – The ID of the review being replied to.
reply_id (int) – The ID of the reply.
**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.

get_review_reply_diff_comment(*, review_request_id: int, review_id: int, reply_id: int, comment_id: int, **kwargs: Unpack[BaseGetParams]) → DiffCommentItemResource[source]¶

Get a reply diff comment item resource.

Parameters:

review_request_id (int) – The review request ID.
review_id (int) – The review ID.
reply_id (int) – The reply ID.
comment_id (int) – The comment ID.
**kwargs (dict) – Query arguments to include with the request.

Returns:

The diff comment item resource.

Return type:

rbtools.api.resource.DiffCommentItemResource

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_diff_comments(*, review_request_id: int, review_id: int, reply_id: int, **kwargs: Unpack[DiffCommentGetListParams]) → DiffCommentListResource[source]¶

Get a reply diff comment list resource.

Parameters:

review_request_id (int) – The review request ID.
review_id (int) – The review ID.
reply_id (int) – The reply ID.
**kwargs (dict) – Query arguments to include with the request.

Returns:

The diff comment list resource.

Return type:

rbtools.api.resource.DiffCommentListResource

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(*, review_request_id: int, review_id: int, **kwargs: Unpack[BaseGetParams]) → ReviewReplyItemResource[source]¶

Get a review reply draft item resource, if present.

Parameters:

review_request_id (int) – The review request ID.
review_id (int) – The ID of the review being replied to.
**kwargs (dict) – Query arguments to include with the request.

Returns:

The review reply draft 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.

get_review_reply_file_attachment_comment(*, review_request_id: int, review_id: int, reply_id: int, comment_id: int, **kwargs: Unpack[BaseGetParams]) → FileAttachmentCommentItemResource[source]¶

Get a reply file attachment comment item resource.

Parameters:

review_request_id (int) – The review request ID.
review_id (int) – The review ID.
reply_id (int) – The review reply ID.
comment_id (int) – The comment ID.
**kwargs (dict) – Query arguments to include with the request.

Returns:

The file attachment comment item resource.

Return type:

rbtools.api.resource.FileAttachmentCommentItemResource

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_file_attachment_comments(*, review_request_id: int, review_id: int, reply_id: int, **kwargs: Unpack[BaseGetListParams]) → FileAttachmentCommentListResource[source]¶

Get a reply file attachment comment list resource.

Parameters:

review_request_id (int) – The review request ID.
review_id (int) – The review ID.
reply_id (int) – The review reply ID.
**kwargs (dict) – Query arguments to include with the request.

Returns:

The file attachment comment list resource.

Return type:

rbtools.api.resource.FileAttachmentCommentListResource

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_general_comment(*, review_request_id: int, review_id: int, reply_id: int, comment_id: int, **kwargs: Unpack[BaseGetParams]) → GeneralCommentItemResource[source]¶

Get a reply general comment item resource.

Parameters:

review_request_id (int) – The review request ID.
review_id (int) – The review ID.
reply_id (int) – The reply ID.
comment_id (int) – The comment ID.
**kwargs (dict) – Query arguments to include with the request.

Returns:

The general comment item resource.

Return type:

rbtools.api.resource.GeneralCommentItemResource

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_general_comments(*, review_request_id: int, review_id: int, reply_id: int, **kwargs: Unpack[BaseGetListParams]) → GeneralCommentListResource[source]¶

Get a reply general comment list resource.

Parameters:

review_request_id (int) – The review request ID.
review_id (int) – The review ID.
reply_id (int) – The reply ID.
**kwargs (dict) – Query arguments to include with the request.

Returns:

The general comment list resource.

Return type:

rbtools.api.resource.GeneralCommentListResource

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_screenshot_comment(*, review_request_id: int, review_id: int, reply_id: int, comment_id: int, **kwargs: Unpack[BaseGetParams]) → ScreenshotCommentItemResource[source]¶

Get a reply screenshot comment item resource.

Parameters:

review_request_id (int) – The review request ID.
review_id (int) – The review ID.
reply_id (int) – The reply ID.
comment_id (int) – The comment ID.
**kwargs (dict) – Query arguments to include with the request.

Returns:

The screenshot comment item resource.

Return type:

rbtools.api.resource.ScreenshotCommentItemResource

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_screenshot_comments(*, review_request_id: int, review_id: int, reply_id: int, **kwargs: Unpack[BaseGetParams]) → ScreenshotCommentListResource[source]¶

Get a reply screenshot comment list resource.

Parameters:

review_request_id (int) – The review request ID.
review_id (int) – The review ID.
reply_id (int) – The reply ID.
**kwargs (dict) – Query arguments to include with the request.

Returns:

The screenshot comment list resource.

Return type:

rbtools.api.resource.ScreenshotCommentListResource

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_request(*, review_request_id: int, **kwargs: Unpack[BaseGetParams]) → ReviewRequestItemResource[source]¶

Get a review request item resource.

Parameters:

review_request_id (int) – The review request ID.
**kwargs (dict) – Query arguments to include with the request.

Returns:

The review request item resource.

Return type:

rbtools.api.resource.ReviewRequestItemResource

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_request_change(*, review_request_id: int, change_id: int, **kwargs: Unpack[BaseGetParams]) → ChangeItemResource[source]¶

Get a change description item resource.

Parameters:

review_request_id (int) – The review request ID.
change_id (int) – The change description ID.
**kwargs (dict) – Query arguments to include with the request.

Returns:

The change description item resource.

Return type:

rbtools.api.resource.ChangeItemResource

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_request_changes(*, review_request_id: int, **kwargs: Unpack[BaseGetListParams]) → ChangeListResource[source]¶

Get a change description list resource.

Parameters:

review_request_id (int) – The review request ID.
**kwargs (dict) – Query arguments to include with the request.

Returns:

The change description list resource.

Return type:

rbtools.api.resource.ChangeListResource

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_request_draft(*, review_request_id: int, **kwargs: Unpack[BaseGetParams]) → ReviewRequestDraftResource[source]¶

Get a review request draft.

Parameters:

review_request_id (int) – The ID of the review request.
**kwargs (dict) – Query arguments to include with the request.

Returns:

The draft resource.

Return type:

rbtools.api.resource.ReviewRequestDraftResource

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_request_file_attachment(*, review_request_id: int, file_attachment_id: int, **kwargs: Unpack[BaseGetParams]) → FileAttachmentItemResource[source]¶

Get a file attachment item resource.

Parameters:

review_request_id (int) – The review request ID.
file_attachment_id (int) – The file attachment ID.
**kwargs (dict) – Query arguments to include with the request.

Returns:

The file attachment item resource.

Return type:

rbtools.api.resource.FileAttachmentItemResource

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_request_file_attachment_comments(*, review_request_id: int, file_attachment_id: int, **kwargs: Unpack[BaseGetListParams]) → FileAttachmentCommentListResource[source]¶

Get the comments on a specific file attachment.

Parameters:

review_request_id (int) – The ID of the review request.
file_attachment_id (int) – The ID of the file attachment.
**kwargs (dict) – Query arguments to include with the request.

Returns:

The file attachment comment list resource.

Return type:

rbtools.api.resource.FileAttachmentCommentListResource

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_request_file_attachments(*, review_request_id: int, **kwargs: Unpack[BaseGetListParams]) → FileAttachmentListResource[source]¶

Get a file attachment list resource.

Parameters:

review_request_id (int) – The review request ID.
**kwargs (dict) – Query arguments to include with the request.

Returns:

The file attachments list resource.

Return type:

rbtools.api.resource.FileAttachmentListResource

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_request_last_update(*, review_request_id: int, **kwargs: Unpack[BaseGetParams]) → LastUpdateResource[source]¶

Get the last update resource for a review request.

Parameters:

review_request_id (int) – The review request ID.
**kwargs (dict) – Query arguments to include with the request.

Returns:

The last update resource.

Return type:

rbtools.api.resource.LastUpdateResource

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_request_status_update(*, review_request_id: int, status_update_id: int, **kwargs: Unpack[BaseGetParams]) → StatusUpdateItemResource[source]¶

Get a status update item resource.

Parameters:

review_request_id (int) – The review request ID.
status_update_id (int) – The status update ID.
**kwargs (dict) – Query arguments to include with the request.

Returns:

The status update item resource.

Return type:

rbtools.api.resource.StatusUpdateItemResource

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_request_status_updates(*, review_request_id: int, **kwargs: Unpack[StatusUpdateGetListParams]) → StatusUpdateListResource[source]¶

Get a status update list resource.

Parameters:

review_request_id (int) – The review request ID.
**kwargs (dict) – Query arguments to include with the request.

Returns:

The status update list resource.

Return type:

rbtools.api.resource.StatusUpdateListResource

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_requests(**kwargs: Unpack[ReviewRequestGetListParams]) → ReviewRequestListResource[source]¶

Get the review request list resource.

Parameters:

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

Returns:

The review request list resource.

Return type:

rbtools.api.resource.ReviewRequestListResource

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_reviews(*, review_request_id: int, **kwargs: Unpack[BaseGetListParams]) → ReviewListResource[source]¶

Get a review list resource.

Parameters:

review_request_id (int) – The ID of the review request.
**kwargs (dict) – Query arguments to include with the request.

Returns:

The review list resource.

Return type:

rbtools.api.resource.ReviewListResource

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_root(**kwargs: Unpack[BaseGetParams]) → RootResource[source]¶

Get the root resource.

Parameters:

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

Returns:

The root resource.

Return type:

RootResource

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_screenshot(*, review_request_id: int, screenshot_id: int, **kwargs: Unpack[BaseGetParams]) → ScreenshotItemResource[source]¶

Get a screenshot list resource.

Parameters:

review_request_id (int) – The review request ID.
screenshot_id (int) – The ID of the screenshot.
**kwargs (dict) – Query arguments to include with the request.

Returns:

The screenshot item resource.

Return type:

rbtools.api.resource.ScreenshotItemResource

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_screenshot_comment(*, review_request_id: int, review_id: int, comment_id: int, **kwargs: Unpack[BaseGetParams]) → ScreenshotCommentItemResource[source]¶

Get the screenshot comments in a review.

Parameters:

review_request_id (int) – The review request ID.
review_id (int) – The review ID.
comment_id (int) – The comment ID.
**kwargs (dict) – Query arguments to include with the request.

Returns:

The screenshot comment item resource.

Return type:

rbtools.api.resource.ScreenshotCommentItemResource

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_screenshot_comments(*, review_request_id: int, screenshot_id: int, **kwargs: Unpack[BaseGetListParams]) → ScreenshotCommentListResource[source]¶

Get the comments on a screenshot.

This is not a list analog to get_screenshot_comment() due to a bug in Review Board’s URI templates. If for some reason you really need to get the screenshot comments on a review, fetch the review first and then get the screenshot comments from that.

Parameters:

review_request_id (int) – The review request ID.
screenshot_id (int) – The screenshot ID.
**kwargs (dict) – Query arguments to include with the request.

Returns:

The screenshot comment item resource.

Return type:

rbtools.api.resource.ScreenshotCommentListResource

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_screenshots(*, review_request_id: int, **kwargs: Unpack[BaseGetListParams]) → ScreenshotListResource[source]¶

Get a screenshot list resource.

Parameters:

review_request_id (int) – The review request ID.
**kwargs (dict) – Query arguments to include with the request.

Returns:

The screenshot list resource.

Return type:

rbtools.api.resource.ScreenshotListResource

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_search(**kwargs: Unpack[SearchGetParams]) → SearchResource[source]¶

Get the search resource.

Parameters:

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

Returns:

The search results.

Return type:

rbtools.api.resource.SearchResource

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_session(**kwargs: Unpack[BaseGetParams]) → SessionResource[source]¶

Get the session resource.

Parameters:

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

Returns:

The session resource.

Return type:

rbtools.api.resource.SessionResource

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_status_update(*, review_request_id: int, status_update_id: int, **kwargs: Unpack[BaseGetParams]) → StatusUpdateItemResource[source]¶

Get a status update item resource.

This method is for compatibility with versions of Review Board prior to 5.0.2. get_review_request_status_update() should be used instead.

Parameters:

review_request_id (int) – The review request ID.
status_update_id (int) – The status update ID.
**kwargs (dict) – Query arguments to include with the request.

Returns:

The status update item resource.

Return type:

rbtools.api.resource.StatusUpdateItemResource

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_status_updates(*, review_request_id: int, **kwargs: Unpack[StatusUpdateGetListParams]) → StatusUpdateListResource[source]¶

Get a status update list resource.

This method is for compatibility with versions of Review Board prior to 5.0.2. get_review_request_status_updates() should be used instead.

Parameters:

review_request_id (int) – The review request ID.
**kwargs (dict) – Query arguments to include with the request.

Returns:

The status update list resource.

Return type:

rbtools.api.resource.StatusUpdateListResource

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_user(*, username: str, **kwargs: Unpack[UserGetParams]) → UserItemResource[source]¶

Get a user item resource.

Parameters:

username (str) – The username of the user.
**kwargs (dict) – Query arguments to include with the request.

Returns:

The user item resource.

Return type:

rbtools.api.resource.UserItemResource

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_user_file_attachment(*, username: str, file_attachment_id: int, **kwargs: Unpack[BaseGetParams]) → UserFileAttachmentItemResource[source]¶

Get a user file attachment item resource.

Parameters:

username (str) – The username of the user.
file_attachment_id (int) – The ID of the file attachment.
**kwargs (dict) – Query arguments to include with the request.

Returns:

The user file attachment item resource.

Return type:

rbtools.api.resource.UserFileAttachmentItemResource

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_user_file_attachments(*, username: str, **kwargs: Unpack[BaseGetListParams]) → UserFileAttachmentListResource[source]¶

Get a user file attachment list resource.

Parameters:

username (str) – The username of the user.
**kwargs (dict) – Query arguments to include with the request.

Returns:

The user file attachment list resource.

Return type:

rbtools.api.resource.UserFileAttachmentListResource

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_users(**kwargs: Unpack[UserGetListParams]) → UserListResource[source]¶

Get the user list resource.

Parameters:

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

Returns:

The user list resource.

Return type:

rbtools.api.resource.UserListResource

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_validation(**kwargs: Unpack[BaseGetParams]) → ValidationResource[source]¶

Get the validation list resource.

Parameters:

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

Returns:

The validation list resource.

Return type:

rbtools.api.resource.ValidationResource

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_watched(*, username: str, **kwargs: Unpack[BaseGetParams]) → WatchedResource[source]¶

Get the watched resource.

Parameters:

username (str) – The name of the user to get the watched resource for.
**kwargs (dict) – Query arguments to include with the request.

Returns:

The watched resource.

Return type:

rbtools.api.resource.WatchedResource

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_watched_review_group(*, username: str, watched_obj_id: int, **kwargs: Unpack[BaseGetParams]) → WatchedReviewGroupItemResource[source]¶

Get a watched review group item resource.

Parameters:

username (str) – The username for the user.
watched_obj_id (int) – The ID of the watched review group.
**kwargs (dict) – Query arguments to include with the request.

Returns:

The watched review group item resource.

Return type:

rbtools.api.resource.WatchedReviewGroupItemResource

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_watched_review_groups(*, username: str, **kwargs: Unpack[BaseGetListParams]) → WatchedReviewGroupListResource[source]¶

Get a watched review group list resource.

Parameters:

username (str) – The username for the user.
**kwargs (dict) – Query arguments to include with the request.

Returns:

The watched review group list resource.

Return type:

rbtools.api.resource.WatchedReviewGroupListResource

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_watched_review_request(*, username: str, watched_obj_id: int, **kwargs: Unpack[BaseGetParams]) → WatchedReviewRequestItemResource[source]¶

Get a watched review request item resource.

Parameters:

username (str) – The username for the user.
watched_obj_id (int) – The ID of the watched review request.
**kwargs (dict) – Query arguments to include with the request.

Returns:

The watched review request item resource.

Return type:

rbtools.api.resource.WatchedReviewRequestItemResource

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_watched_review_requests(*, username: str, **kwargs: Unpack[BaseGetListParams]) → WatchedReviewRequestListResource[source]¶

Get a watched review request list resource.

Parameters:

username (str) – The username for the user.
**kwargs (dict) – Query arguments to include with the request.

Returns:

The watched review request list resource.

Return type:

rbtools.api.resource.WatchedReviewRequestListResource

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_webhook(*, webhook_id: int, **kwargs: Unpack[BaseGetParams]) → WebHookItemResource[source]¶

Get a WebHook item resource.

Parameters:

webhook_id (int) – The ID of the WebHook.
**kwargs (dict) – Query arguments to include with the request.

Returns:

The WebHook item resource.

Return type:

rbtools.api.resource.WebHookItemResource

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_webhooks(**kwargs: Unpack[BaseGetParams]) → WebHookListResource[source]¶

Get the WebHook list resource.

Parameters:

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

Returns:

The WebHook list resource.

Return type:

rbtools.api.resource.WebHookListResource

Raises:

rbtools.api.errors.APIError – The Review Board API returned an error.
rbtools.api.errors.ServerInterfaceError – An error occurred while communicating with the server.