blocks

Accessed as client.repos.issues.blocks; the async client mirrors it.

SyncAsync

ReposIssuesBlocks

The repos.issues.blocks namespace.

create

create(owner: str, repo: str, index: int, *, body_index: int, body_owner: str, body_repo: str) -> Issue

Block the issue given in the body by the issue in path.

Parameters:

Name	Type	Description	Default
`owner`	`str`	owner of the repo	required
`repo`	`str`	name of the repo	required
`index`	`int`	index of the issue	required
`body_index`	`int`	Wire field `index`.	required
`body_owner`	`str`	Wire field `owner`.	required
`body_repo`	`str`	Wire field `repo`.	required

Returns:

Type	Description
`Issue`	Issue.

Raises:

Type	Description
`NotFoundError`	the issue does not exist.

Operation ID: issueCreateIssueBlocking

delete

delete(owner: str, repo: str, index: int, *, body_index: int, body_owner: str, body_repo: str) -> Issue

Unblock the issue given in the body by the issue in path.

Parameters:

Name	Type	Description	Default
`owner`	`str`	owner of the repo	required
`repo`	`str`	name of the repo	required
`index`	`int`	index of the issue	required
`body_index`	`int`	Wire field `index`.	required
`body_owner`	`str`	Wire field `owner`.	required
`body_repo`	`str`	Wire field `repo`.	required

Returns:

Type	Description
`Issue`	Issue.

Raises:

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

Operation ID: issueRemoveIssueBlocking

list

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

List issues that are blocked by this issue.

Parameters:

Name	Type	Description	Default
`owner`	`str`	owner of the repo	required
`repo`	`str`	name of the repo	required
`index`	`int`	index of the issue	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[Issue]`	IssueListWithoutPagination - Issues without pagination headers (used for pinned issues, dependencies, etc.).

Raises:

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

Operation ID: issueListBlocks

AsyncReposIssuesBlocks

The repos.issues.blocks namespace.

create

create(owner: str, repo: str, index: int, *, body_index: int, body_owner: str, body_repo: str) -> Issue

Block the issue given in the body by the issue in path.

Parameters:

Name	Type	Description	Default
`owner`	`str`	owner of the repo	required
`repo`	`str`	name of the repo	required
`index`	`int`	index of the issue	required
`body_index`	`int`	Wire field `index`.	required
`body_owner`	`str`	Wire field `owner`.	required
`body_repo`	`str`	Wire field `repo`.	required

Returns:

Type	Description
`Issue`	Issue.

Raises:

Type	Description
`NotFoundError`	the issue does not exist.

Operation ID: issueCreateIssueBlocking

delete

delete(owner: str, repo: str, index: int, *, body_index: int, body_owner: str, body_repo: str) -> Issue

Unblock the issue given in the body by the issue in path.

Parameters:

Name	Type	Description	Default
`owner`	`str`	owner of the repo	required
`repo`	`str`	name of the repo	required
`index`	`int`	index of the issue	required
`body_index`	`int`	Wire field `index`.	required
`body_owner`	`str`	Wire field `owner`.	required
`body_repo`	`str`	Wire field `repo`.	required

Returns:

Type	Description
`Issue`	Issue.

Raises:

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

Operation ID: issueRemoveIssueBlocking

list

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

List issues that are blocked by this issue.

Parameters:

Name	Type	Description	Default
`owner`	`str`	owner of the repo	required
`repo`	`str`	name of the repo	required
`index`	`int`	index of the issue	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[Issue]`	IssueListWithoutPagination - Issues without pagination headers (used for pinned issues, dependencies, etc.).

Raises:

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

Operation ID: issueListBlocks