Class PythonApi

Hierarchy

PythonApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new PythonApi(basePath?: string): PythonApi

- Defined in api/api.ts:61745
Parameters
- Optional basePath: string
Returns PythonApi

Properties

Protected basePath

basePath: string = "https://dev.azure.com/"

defaultHeaders

defaultHeaders: any

Methods

deletePackageVersion

deletePackageVersion(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ModelPackage>

- Defined in api/api.ts:61762
Delete a package version, moving it to the recycle bin.

Parameters
- params: object
  - apiVersion: string
  - feedId: string
  - organization: string
  - packageName: string
  - packageVersion: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<ModelPackage>

deletePackageVersionFromRecycleBin

deletePackageVersionFromRecycleBin(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<__type>

- Defined in api/api.ts:61826
Delete a package version from the feed, moving it to the recycle bin.

Parameters
- params: object
  - apiVersion: string
  - feedId: string
  - organization: string
  - packageName: string
  - packageVersion: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<__type>

downloadPackage

downloadPackage(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<string>

- Defined in api/api.ts:61891
Download a python package file directly. This API is intended for manual UI download options, not for programmatic access and scripting.

Parameters
- params: object
  - apiVersion: string
  - feedId: string
  - fileName: string
  - organization: string
  - packageName: string
  - packageVersion: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<string>

getPackageVersion

getPackageVersion(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ModelPackage>

- Defined in api/api.ts:61961
Get information about a package version.

Parameters
- params: object
  - apiVersion: string
  - feedId: string
  - organization: string
  - packageName: string
  - packageVersion: string
  - Optional showDeleted?: boolean
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<ModelPackage>

getPackageVersionMetadataFromRecycleBin

getPackageVersionMetadataFromRecycleBin(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<PyPiPackageVersionDeletionState>

- Defined in api/api.ts:62029
Get information about a package version in the recycle bin.

Parameters
- params: object
  - apiVersion: string
  - feedId: string
  - organization: string
  - packageName: string
  - packageVersion: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<PyPiPackageVersionDeletionState>

restorePackageVersionFromRecycleBin

restorePackageVersionFromRecycleBin(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<__type>

- Defined in api/api.ts:62094
Restore a package version from the recycle bin to its associated feed.

Parameters
- params: object
  - apiVersion: string
  - body: PyPiRecycleBinPackageVersionDetails
  - feedId: string
  - organization: string
  - packageName: string
  - packageVersion: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<__type>

updatePackageVersion

updatePackageVersion(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<__type>

- Defined in api/api.ts:62166
Update state for a package version.

Parameters
- params: object
  - apiVersion: string
  - body: PackageVersionDetails
  - feedId: string
  - organization: string
  - packageName: string
  - packageVersion: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<__type>

Generated using TypeDoc