packages

Accessed as client.packages; the async client mirrors it.

SyncAsync

Packages

The packages namespace.

delete

delete(owner: str, type: str, name: str, version: str) -> None

Delete a package.

Parameters:

Name	Type	Description	Default
`owner`	`str`	owner of the package	required
`type`	`str`	type of the package	required
`name`	`str`	name of the package	required
`version`	`str`	version of the package	required

Returns:

Type	Description
`None`	No content.

Raises:

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

Operation ID: deletePackage

files

files(owner: str, type: str, name: str, version: str) -> list[PackageFile]

Gets all files of a package.

Parameters:

Name	Type	Description	Default
`owner`	`str`	owner of the package	required
`type`	`str`	type of the package	required
`name`	`str`	name of the package	required
`version`	`str`	version of the package	required

Returns:

Type	Description
`list[PackageFile]`	PackageFileList.

Raises:

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

Operation ID: listPackageFiles

get

get(owner: str, type: str, name: str, version: str) -> Package

Gets a package.

Parameters:

Name	Type	Description	Default
`owner`	`str`	owner of the package	required
`type`	`str`	type of the package	required
`name`	`str`	name of the package	required
`version`	`str`	version of the package	required

Returns:

Type	Description
`Package`	Package.

Raises:

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

Operation ID: getPackage

link

link(owner: str, type: str, name: str, repo_name: str) -> None

Link a package to a repository.

Parameters:

Name	Type	Description	Default
`owner`	`str`	owner of the package	required
`type`	`str`	type of the package	required
`name`	`str`	name of the package	required
`repo_name`	`str`	name of the repository to link.	required

Returns:

Type	Description
`None`	No content.

Raises:

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

Operation ID: linkPackage

list

list(
    owner: str,
    *,
    type: Literal[
        "alpine",
        "cargo",
        "chef",
        "composer",
        "conan",
        "conda",
        "container",
        "cran",
        "debian",
        "generic",
        "go",
        "helm",
        "maven",
        "npm",
        "nuget",
        "pub",
        "pypi",
        "rpm",
        "rubygems",
        "swift",
        "vagrant",
    ]
    | None = None,
    q: str | None = None,
    page: int | None = None,
    limit: int | None = None,
) -> Paginated[Package]

Gets all packages of an owner.

Parameters:

Name	Type	Description	Default
`owner`	`str`	owner of the packages	required
`type`	`Literal['alpine', 'cargo', 'chef', 'composer', 'conan', 'conda', 'container', 'cran', 'debian', 'generic', 'go', 'helm', 'maven', 'npm', 'nuget', 'pub', 'pypi', 'rpm', 'rubygems', 'swift', 'vagrant'] \| None`	package type filter	`None`
`q`	`str \| None`	name filter	`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[Package]`	PackageList.

Raises:

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

Operation ID: listPackages

unlink

unlink(owner: str, type: str, name: str) -> None

Unlink a package from a repository.

Parameters:

Name	Type	Description	Default
`owner`	`str`	owner of the package	required
`type`	`str`	type of the package	required
`name`	`str`	name of the package	required

Returns:

Type	Description
`None`	No content.

Raises:

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

Operation ID: unlinkPackage

AsyncPackages

The packages namespace.

delete

delete(owner: str, type: str, name: str, version: str) -> None

Delete a package.

Parameters:

Name	Type	Description	Default
`owner`	`str`	owner of the package	required
`type`	`str`	type of the package	required
`name`	`str`	name of the package	required
`version`	`str`	version of the package	required

Returns:

Type	Description
`None`	No content.

Raises:

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

Operation ID: deletePackage

files

files(owner: str, type: str, name: str, version: str) -> list[PackageFile]

Gets all files of a package.

Parameters:

Name	Type	Description	Default
`owner`	`str`	owner of the package	required
`type`	`str`	type of the package	required
`name`	`str`	name of the package	required
`version`	`str`	version of the package	required

Returns:

Type	Description
`list[PackageFile]`	PackageFileList.

Raises:

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

Operation ID: listPackageFiles

get

get(owner: str, type: str, name: str, version: str) -> Package

Gets a package.

Parameters:

Name	Type	Description	Default
`owner`	`str`	owner of the package	required
`type`	`str`	type of the package	required
`name`	`str`	name of the package	required
`version`	`str`	version of the package	required

Returns:

Type	Description
`Package`	Package.

Raises:

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

Operation ID: getPackage

link

link(owner: str, type: str, name: str, repo_name: str) -> None

Link a package to a repository.

Parameters:

Name	Type	Description	Default
`owner`	`str`	owner of the package	required
`type`	`str`	type of the package	required
`name`	`str`	name of the package	required
`repo_name`	`str`	name of the repository to link.	required

Returns:

Type	Description
`None`	No content.

Raises:

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

Operation ID: linkPackage

list

list(
    owner: str,
    *,
    type: Literal[
        "alpine",
        "cargo",
        "chef",
        "composer",
        "conan",
        "conda",
        "container",
        "cran",
        "debian",
        "generic",
        "go",
        "helm",
        "maven",
        "npm",
        "nuget",
        "pub",
        "pypi",
        "rpm",
        "rubygems",
        "swift",
        "vagrant",
    ]
    | None = None,
    q: str | None = None,
    page: int | None = None,
    limit: int | None = None,
) -> AsyncPaginated[Package]

Gets all packages of an owner.

Parameters:

Name	Type	Description	Default
`owner`	`str`	owner of the packages	required
`type`	`Literal['alpine', 'cargo', 'chef', 'composer', 'conan', 'conda', 'container', 'cran', 'debian', 'generic', 'go', 'helm', 'maven', 'npm', 'nuget', 'pub', 'pypi', 'rpm', 'rubygems', 'swift', 'vagrant'] \| None`	package type filter	`None`
`q`	`str \| None`	name filter	`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[Package]`	PackageList.

Raises:

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

Operation ID: listPackages

unlink

unlink(owner: str, type: str, name: str) -> None

Unlink a package from a repository.

Parameters:

Name	Type	Description	Default
`owner`	`str`	owner of the package	required
`type`	`str`	type of the package	required
`name`	`str`	name of the package	required

Returns:

Type	Description
`None`	No content.

Raises:

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

Operation ID: unlinkPackage