Class AdminApi

AdminApi - object-oriented interface

export

Hierarchy

BaseAPI
- AdminApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

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

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

Properties

Protected axios

axios: AxiosInstance = globalAxios

Protected basePath

basePath: string = BASE_PATH

Protected configuration

configuration: Configuration

Methods

adminAdoptRepository

adminAdoptRepository(requestParameters: AdminApiAdminAdoptRepositoryRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>

- Defined in apis/admin-api.ts:1558
summary
Adopt unadopted files as a repository

throws
{RequiredError}

memberof
AdminApi

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

adminCreateOrg

adminCreateOrg(requestParameters: AdminApiAdminCreateOrgRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<Organization>>

- Defined in apis/admin-api.ts:1570
summary
Create an organization

throws
{RequiredError}

memberof
AdminApi

Parameters
- requestParameters: AdminApiAdminCreateOrgRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<Organization>>

adminCreatePublicKey

adminCreatePublicKey(requestParameters: AdminApiAdminCreatePublicKeyRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<PublicKey>>

- Defined in apis/admin-api.ts:1582
summary
Add a public key on behalf of a user

throws
{RequiredError}

memberof
AdminApi

Parameters
- requestParameters: AdminApiAdminCreatePublicKeyRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<PublicKey>>

adminCreateRepo

adminCreateRepo(requestParameters: AdminApiAdminCreateRepoRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<Repository>>

- Defined in apis/admin-api.ts:1594
summary
Create a repository on behalf of a user

throws
{RequiredError}

memberof
AdminApi

Parameters
- requestParameters: AdminApiAdminCreateRepoRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<Repository>>

adminCreateUser

adminCreateUser(requestParameters?: AdminApiAdminCreateUserRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<User>>

- Defined in apis/admin-api.ts:1606
summary
Create a user

throws
{RequiredError}

memberof
AdminApi

Parameters
- requestParameters: AdminApiAdminCreateUserRequest = {}
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<User>>

adminCronList

adminCronList(requestParameters?: AdminApiAdminCronListRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<Cron[]>>

- Defined in apis/admin-api.ts:1618
summary
List cron tasks

throws
{RequiredError}

memberof
AdminApi

Parameters
- requestParameters: AdminApiAdminCronListRequest = {}
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<Cron[]>>

adminCronRun

adminCronRun(requestParameters: AdminApiAdminCronRunRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>

- Defined in apis/admin-api.ts:1630
summary
Run cron task

throws
{RequiredError}

memberof
AdminApi

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

adminDeleteUnadoptedRepository

adminDeleteUnadoptedRepository(requestParameters: AdminApiAdminDeleteUnadoptedRepositoryRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>

- Defined in apis/admin-api.ts:1642
summary
Delete unadopted files

throws
{RequiredError}

memberof
AdminApi

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

adminDeleteUser

adminDeleteUser(requestParameters: AdminApiAdminDeleteUserRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>

- Defined in apis/admin-api.ts:1654
summary
Delete a user

throws
{RequiredError}

memberof
AdminApi

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

adminDeleteUserPublicKey

adminDeleteUserPublicKey(requestParameters: AdminApiAdminDeleteUserPublicKeyRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>

- Defined in apis/admin-api.ts:1666
summary
Delete a user's public key

throws
{RequiredError}

memberof
AdminApi

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

adminEditUser

adminEditUser(requestParameters: AdminApiAdminEditUserRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<User>>

- Defined in apis/admin-api.ts:1678
summary
Edit an existing user

throws
{RequiredError}

memberof
AdminApi

Parameters
- requestParameters: AdminApiAdminEditUserRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<User>>

adminGetAllOrgs

adminGetAllOrgs(requestParameters?: AdminApiAdminGetAllOrgsRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<Organization[]>>

- Defined in apis/admin-api.ts:1690
summary
List all organizations

throws
{RequiredError}

memberof
AdminApi

Parameters
- requestParameters: AdminApiAdminGetAllOrgsRequest = {}
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<Organization[]>>

adminGetAllUsers

adminGetAllUsers(requestParameters?: AdminApiAdminGetAllUsersRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<User[]>>

- Defined in apis/admin-api.ts:1702
summary
List all users

throws
{RequiredError}

memberof
AdminApi

Parameters
- requestParameters: AdminApiAdminGetAllUsersRequest = {}
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<User[]>>

adminUnadoptedList

adminUnadoptedList(requestParameters?: AdminApiAdminUnadoptedListRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<string[]>>

- Defined in apis/admin-api.ts:1714
summary
List unadopted repositories

throws
{RequiredError}

memberof
AdminApi

Parameters
- requestParameters: AdminApiAdminUnadoptedListRequest = {}
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<string[]>>

Generated using TypeDoc