reviews

Accessed as client.repos.pulls.reviews; the async client mirrors it.

SyncAsync

ReposPullsReviews

The repos.pulls.reviews namespace.

comments

comments: ReposPullsReviewsComments = ReposPullsReviewsComments(client)

create

create(
    owner: str,
    repo: str,
    index: int,
    *,
    body: str | None = None,
    comments: list[CreatePullReviewComment] | None = None,
    commit_id: str | None = None,
    event: str | None = None,
) -> PullReview

Create a review to an pull request.

Parameters:

Name	Type	Description	Default
`owner`	`str`	owner of the repo	required
`repo`	`str`	name of the repo	required
`index`	`int`	index of the pull request	required
`body`	`str \| None`		`None`
`comments`	`list[CreatePullReviewComment] \| None`		`None`
`commit_id`	`str \| None`		`None`
`event`	`str \| None`		`None`

Returns:

Type	Description
`PullReview`	PullReview.

Raises:

Type	Description
`NotFoundError`	APINotFound is a not found error response.
`UnprocessableEntityError`	APIValidationError is error format response related to input validation.

Operation ID: repoCreatePullReview

delete

delete(owner: str, repo: str, index: int, id: int) -> None

Delete a specific review from a pull request.

Parameters:

Name	Type	Description	Default
`owner`	`str`	owner of the repo	required
`repo`	`str`	name of the repo	required
`index`	`int`	index of the pull request	required
`id`	`int`	id of the review	required

Returns:

Type	Description
`None`	No content.

Raises:

Type	Description
`ForbiddenError`	APIForbiddenError is a forbidden error response.
`NotFoundError`	APINotFound is a not found error response.

Operation ID: repoDeletePullReview

dismiss

dismiss(
    owner: str, repo: str, index: int, id: int, *, message: str | None = None, priors: bool | None = None
) -> PullReview

Dismiss a review for a pull request.

Parameters:

Name	Type	Description	Default
`owner`	`str`	owner of the repo	required
`repo`	`str`	name of the repo	required
`index`	`int`	index of the pull request	required
`id`	`int`	id of the review	required
`message`	`str \| None`		`None`
`priors`	`bool \| None`		`None`

Returns:

Type	Description
`PullReview`	PullReview.

Raises:

Type	Description
`ForbiddenError`	APIForbiddenError is a forbidden error response.
`NotFoundError`	APINotFound is a not found error response.
`UnprocessableEntityError`	APIValidationError is error format response related to input validation.

Operation ID: repoDismissPullReview

get

get(owner: str, repo: str, index: int, id: int) -> PullReview

Get a specific review for a pull request.

Parameters:

Name	Type	Description	Default
`owner`	`str`	owner of the repo	required
`repo`	`str`	name of the repo	required
`index`	`int`	index of the pull request	required
`id`	`int`	id of the review	required

Returns:

Type	Description
`PullReview`	PullReview.

Raises:

Type	Description
`NotFoundError`	APINotFound is a not found error response.

Operation ID: repoGetPullReview

list

list(owner: str, repo: str, index: int, *, page: int | None = None, limit: int | None = None) -> Paginated[PullReview]

List all reviews for a pull request.

Parameters:

Name	Type	Description	Default
`owner`	`str`	owner of the repo	required
`repo`	`str`	name of the repo	required
`index`	`int`	index of the pull request	required
`page`	`int \| None`	1-based page to start iteration at.	`None`
`limit`	`int \| None`	Page size; the instance caps it server-side.	`None`

Returns:

Type	Description
`Paginated[PullReview]`	PullReviewList.

Raises:

Type	Description
`NotFoundError`	APINotFound is a not found error response.

Operation ID: repoListPullReviews

submit

submit(owner: str, repo: str, index: int, id: int, *, body: str | None = None, event: str | None = None) -> PullReview

Submit a pending review to an pull request.

Parameters:

Name	Type	Description	Default
`owner`	`str`	owner of the repo	required
`repo`	`str`	name of the repo	required
`index`	`int`	index of the pull request	required
`id`	`int`	id of the review	required
`body`	`str \| None`		`None`
`event`	`str \| None`		`None`

Returns:

Type	Description
`PullReview`	PullReview.

Raises:

Type	Description
`NotFoundError`	APINotFound is a not found error response.
`UnprocessableEntityError`	APIValidationError is error format response related to input validation.

Operation ID: repoSubmitPullReview

undismiss

undismiss(owner: str, repo: str, index: int, id: int) -> PullReview

Cancel to dismiss a review for a pull request.

Parameters:

Name	Type	Description	Default
`owner`	`str`	owner of the repo	required
`repo`	`str`	name of the repo	required
`index`	`int`	index of the pull request	required
`id`	`int`	id of the review	required

Returns:

Type	Description
`PullReview`	PullReview.

Raises:

Type	Description
`ForbiddenError`	APIForbiddenError is a forbidden error response.
`NotFoundError`	APINotFound is a not found error response.
`UnprocessableEntityError`	APIValidationError is error format response related to input validation.

Operation ID: repoUnDismissPullReview

AsyncReposPullsReviews

The repos.pulls.reviews namespace.

comments

comments: AsyncReposPullsReviewsComments = AsyncReposPullsReviewsComments(client)

create

create(
    owner: str,
    repo: str,
    index: int,
    *,
    body: str | None = None,
    comments: list[CreatePullReviewComment] | None = None,
    commit_id: str | None = None,
    event: str | None = None,
) -> PullReview

Create a review to an pull request.

Parameters:

Name	Type	Description	Default
`owner`	`str`	owner of the repo	required
`repo`	`str`	name of the repo	required
`index`	`int`	index of the pull request	required
`body`	`str \| None`		`None`
`comments`	`list[CreatePullReviewComment] \| None`		`None`
`commit_id`	`str \| None`		`None`
`event`	`str \| None`		`None`

Returns:

Type	Description
`PullReview`	PullReview.

Raises:

Type	Description
`NotFoundError`	APINotFound is a not found error response.
`UnprocessableEntityError`	APIValidationError is error format response related to input validation.

Operation ID: repoCreatePullReview

delete

delete(owner: str, repo: str, index: int, id: int) -> None

Delete a specific review from a pull request.

Parameters:

Name	Type	Description	Default
`owner`	`str`	owner of the repo	required
`repo`	`str`	name of the repo	required
`index`	`int`	index of the pull request	required
`id`	`int`	id of the review	required

Returns:

Type	Description
`None`	No content.

Raises:

Type	Description
`ForbiddenError`	APIForbiddenError is a forbidden error response.
`NotFoundError`	APINotFound is a not found error response.

Operation ID: repoDeletePullReview

dismiss

dismiss(
    owner: str, repo: str, index: int, id: int, *, message: str | None = None, priors: bool | None = None
) -> PullReview

Dismiss a review for a pull request.

Parameters:

Name	Type	Description	Default
`owner`	`str`	owner of the repo	required
`repo`	`str`	name of the repo	required
`index`	`int`	index of the pull request	required
`id`	`int`	id of the review	required
`message`	`str \| None`		`None`
`priors`	`bool \| None`		`None`

Returns:

Type	Description
`PullReview`	PullReview.

Raises:

Type	Description
`ForbiddenError`	APIForbiddenError is a forbidden error response.
`NotFoundError`	APINotFound is a not found error response.
`UnprocessableEntityError`	APIValidationError is error format response related to input validation.

Operation ID: repoDismissPullReview

get

get(owner: str, repo: str, index: int, id: int) -> PullReview

Get a specific review for a pull request.

Parameters:

Name	Type	Description	Default
`owner`	`str`	owner of the repo	required
`repo`	`str`	name of the repo	required
`index`	`int`	index of the pull request	required
`id`	`int`	id of the review	required

Returns:

Type	Description
`PullReview`	PullReview.

Raises:

Type	Description
`NotFoundError`	APINotFound is a not found error response.

Operation ID: repoGetPullReview

list

list(
    owner: str, repo: str, index: int, *, page: int | None = None, limit: int | None = None
) -> AsyncPaginated[PullReview]

List all reviews for a pull request.

Parameters:

Name	Type	Description	Default
`owner`	`str`	owner of the repo	required
`repo`	`str`	name of the repo	required
`index`	`int`	index of the pull request	required
`page`	`int \| None`	1-based page to start iteration at.	`None`
`limit`	`int \| None`	Page size; the instance caps it server-side.	`None`

Returns:

Type	Description
`AsyncPaginated[PullReview]`	PullReviewList.

Raises:

Type	Description
`NotFoundError`	APINotFound is a not found error response.

Operation ID: repoListPullReviews

submit

submit(owner: str, repo: str, index: int, id: int, *, body: str | None = None, event: str | None = None) -> PullReview

Submit a pending review to an pull request.

Parameters:

Name	Type	Description	Default
`owner`	`str`	owner of the repo	required
`repo`	`str`	name of the repo	required
`index`	`int`	index of the pull request	required
`id`	`int`	id of the review	required
`body`	`str \| None`		`None`
`event`	`str \| None`		`None`

Returns:

Type	Description
`PullReview`	PullReview.

Raises:

Type	Description
`NotFoundError`	APINotFound is a not found error response.
`UnprocessableEntityError`	APIValidationError is error format response related to input validation.

Operation ID: repoSubmitPullReview

undismiss

undismiss(owner: str, repo: str, index: int, id: int) -> PullReview

Cancel to dismiss a review for a pull request.

Parameters:

Name	Type	Description	Default
`owner`	`str`	owner of the repo	required
`repo`	`str`	name of the repo	required
`index`	`int`	index of the pull request	required
`id`	`int`	id of the review	required

Returns:

Type	Description
`PullReview`	PullReview.

Raises:

Type	Description
`ForbiddenError`	APIForbiddenError is a forbidden error response.
`NotFoundError`	APINotFound is a not found error response.
`UnprocessableEntityError`	APIValidationError is error format response related to input validation.

Operation ID: repoUnDismissPullReview