subscriptions

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

SyncAsync

ReposIssuesSubscriptions

The repos.issues.subscriptions namespace.

add

add(owner: str, repo: str, index: int, user: str) -> None

Subscribe user to 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
`user`	`str`	user to subscribe	required

Returns:

Type	Description
`None`	No content.

Raises:

Type	Description
`APIError`	User can only subscribe itself if he is no admin.
`NotFoundError`	APINotFound is a not found error response.

Operation ID: issueAddSubscription

check

check(owner: str, repo: str, index: int) -> WatchInfo

Check if user is subscribed to an 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

Returns:

Type	Description
`WatchInfo`	WatchInfo.

Raises:

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

Operation ID: issueCheckSubscription

list

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

Get users who subscribed on an 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[User]`	UserList.

Raises:

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

Operation ID: issueSubscriptions

remove

remove(owner: str, repo: str, index: int, user: str) -> None

Unsubscribe user from 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
`user`	`str`	user witch unsubscribe	required

Returns:

Type	Description
`None`	No content.

Raises:

Type	Description
`APIError`	User can only subscribe itself if he is no admin.
`NotFoundError`	APINotFound is a not found error response.

Operation ID: issueDeleteSubscription

AsyncReposIssuesSubscriptions

The repos.issues.subscriptions namespace.

add

add(owner: str, repo: str, index: int, user: str) -> None

Subscribe user to 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
`user`	`str`	user to subscribe	required

Returns:

Type	Description
`None`	No content.

Raises:

Type	Description
`APIError`	User can only subscribe itself if he is no admin.
`NotFoundError`	APINotFound is a not found error response.

Operation ID: issueAddSubscription

check

check(owner: str, repo: str, index: int) -> WatchInfo

Check if user is subscribed to an 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

Returns:

Type	Description
`WatchInfo`	WatchInfo.

Raises:

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

Operation ID: issueCheckSubscription

list

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

Get users who subscribed on an 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[User]`	UserList.

Raises:

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

Operation ID: issueSubscriptions

remove

remove(owner: str, repo: str, index: int, user: str) -> None

Unsubscribe user from 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
`user`	`str`	user witch unsubscribe	required

Returns:

Type	Description
`None`	No content.

Raises:

Type	Description
`APIError`	User can only subscribe itself if he is no admin.
`NotFoundError`	APINotFound is a not found error response.

Operation ID: issueDeleteSubscription