Class PackageApi

PackageApi - object-oriented interface

export

Hierarchy

BaseAPI
- PackageApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new PackageApi(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): PackageApi

Inherited from BaseAPI.constructor
- Defined in base.ts:52
Parameters
- Optional configuration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns PackageApi

Properties

Protected axios

axios: AxiosInstance = globalAxios

Protected basePath

basePath: string = BASE_PATH

Protected configuration

configuration: Configuration

Methods

deletePackage

deletePackage(requestParameters: PackageApiDeletePackageRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>

- Defined in apis/package-api.ts:892
summary
Delete a package

throws
{RequiredError}

memberof
PackageApi

Parameters
- requestParameters: PackageApiDeletePackageRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<void>>

getPackage

getPackage(requestParameters: PackageApiGetPackageRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<Package>>

- Defined in apis/package-api.ts:915
summary
Gets a package

throws
{RequiredError}

memberof
PackageApi

Parameters
- requestParameters: PackageApiGetPackageRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<Package>>

listPackageFiles

listPackageFiles(requestParameters: PackageApiListPackageFilesRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<PackageFile[]>>

- Defined in apis/package-api.ts:938
summary
Gets all files of a package

throws
{RequiredError}

memberof
PackageApi

Parameters
- requestParameters: PackageApiListPackageFilesRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<PackageFile[]>>

listPackages

listPackages(requestParameters: PackageApiListPackagesRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<Package[]>>

- Defined in apis/package-api.ts:961
summary
Gets all packages of an owner

throws
{RequiredError}

memberof
PackageApi

Parameters
- requestParameters: PackageApiListPackagesRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<Package[]>>

Generated using TypeDoc