milestones

Accessed as client.repos.milestones; the async client mirrors it.

SyncAsync

ReposMilestones

The repos.milestones namespace.

create

create(
    owner: str,
    repo: str,
    *,
    description: str | None = None,
    due_on: datetime | None = None,
    state: CreateMilestoneOptionState | None = None,
    title: str | None = None,
) -> Milestone

Create a milestone.

Parameters:

Name	Type	Description	Default
`owner`	`str`	owner of the repo	required
`repo`	`str`	name of the repo	required
`description`	`str \| None`		`None`
`due_on`	`datetime \| None`		`None`
`state`	`CreateMilestoneOptionState \| None`		`None`
`title`	`str \| None`		`None`

Returns:

Type	Description
`Milestone`	Milestone.

Raises:

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

Operation ID: issueCreateMilestone

delete

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

Delete a milestone.

Parameters:

Name	Type	Description	Default
`owner`	`str`	owner of the repo	required
`repo`	`str`	name of the repo	required
`id`	`int`	the milestone to delete, identified by ID and if not available by name	required

Returns:

Type	Description
`None`	No content.

Raises:

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

Operation ID: issueDeleteMilestone

get

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

Get a milestone.

Parameters:

Name	Type	Description	Default
`owner`	`str`	owner of the repo	required
`repo`	`str`	name of the repo	required
`id`	`int`	the milestone to get, identified by ID and if not available by name	required

Returns:

Type	Description
`Milestone`	Milestone.

Raises:

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

Operation ID: issueGetMilestone

list

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

Get all of a repository's opened milestones.

Parameters:

Name	Type	Description	Default
`owner`	`str`	owner of the repo	required
`repo`	`str`	name of the repo	required
`state`	`str \| None`	Milestone state, Recognized values are open, closed and all. Defaults to "open"	`None`
`name`	`str \| None`	filter by milestone name	`None`
`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[Milestone]`	MilestoneList.

Raises:

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

Operation ID: issueGetMilestonesList

update

update(
    owner: str,
    repo: str,
    id: int,
    *,
    description: str | None = None,
    due_on: datetime | None = None,
    state: str | None = None,
    title: str | None = None,
) -> Milestone

Update a milestone.

Parameters:

Name	Type	Description	Default
`owner`	`str`	owner of the repo	required
`repo`	`str`	name of the repo	required
`id`	`int`	the milestone to edit, identified by ID and if not available by name	required
`description`	`str \| None`		`None`
`due_on`	`datetime \| None`		`None`
`state`	`str \| None`		`None`
`title`	`str \| None`		`None`

Returns:

Type	Description
`Milestone`	Milestone.

Raises:

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

Operation ID: issueEditMilestone

AsyncReposMilestones

The repos.milestones namespace.

create

create(
    owner: str,
    repo: str,
    *,
    description: str | None = None,
    due_on: datetime | None = None,
    state: CreateMilestoneOptionState | None = None,
    title: str | None = None,
) -> Milestone

Create a milestone.

Parameters:

Name	Type	Description	Default
`owner`	`str`	owner of the repo	required
`repo`	`str`	name of the repo	required
`description`	`str \| None`		`None`
`due_on`	`datetime \| None`		`None`
`state`	`CreateMilestoneOptionState \| None`		`None`
`title`	`str \| None`		`None`

Returns:

Type	Description
`Milestone`	Milestone.

Raises:

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

Operation ID: issueCreateMilestone

delete

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

Delete a milestone.

Parameters:

Name	Type	Description	Default
`owner`	`str`	owner of the repo	required
`repo`	`str`	name of the repo	required
`id`	`int`	the milestone to delete, identified by ID and if not available by name	required

Returns:

Type	Description
`None`	No content.

Raises:

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

Operation ID: issueDeleteMilestone

get

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

Get a milestone.

Parameters:

Name	Type	Description	Default
`owner`	`str`	owner of the repo	required
`repo`	`str`	name of the repo	required
`id`	`int`	the milestone to get, identified by ID and if not available by name	required

Returns:

Type	Description
`Milestone`	Milestone.

Raises:

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

Operation ID: issueGetMilestone

list

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

Get all of a repository's opened milestones.

Parameters:

Name	Type	Description	Default
`owner`	`str`	owner of the repo	required
`repo`	`str`	name of the repo	required
`state`	`str \| None`	Milestone state, Recognized values are open, closed and all. Defaults to "open"	`None`
`name`	`str \| None`	filter by milestone name	`None`
`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[Milestone]`	MilestoneList.

Raises:

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

Operation ID: issueGetMilestonesList

update

update(
    owner: str,
    repo: str,
    id: int,
    *,
    description: str | None = None,
    due_on: datetime | None = None,
    state: str | None = None,
    title: str | None = None,
) -> Milestone

Update a milestone.

Parameters:

Name	Type	Description	Default
`owner`	`str`	owner of the repo	required
`repo`	`str`	name of the repo	required
`id`	`int`	the milestone to edit, identified by ID and if not available by name	required
`description`	`str \| None`		`None`
`due_on`	`datetime \| None`		`None`
`state`	`str \| None`		`None`
`title`	`str \| None`		`None`

Returns:

Type	Description
`Milestone`	Milestone.

Raises:

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

Operation ID: issueEditMilestone