cberg

# AdminApi All URIs are relative to */api/v1* |Method | HTTP request | Description| |------------- | ------------- | -------------| |[**adminAddRuleToQuotaGroup**](#adminaddruletoquotagroup) | **PUT** /admin/quota/groups/{quotagroup}/rules/{quotarule} | Adds a rule to a quota group| |[**adminAddUserToQuotaGroup**](#adminaddusertoquotagroup) | **PUT** /admin/quota/groups/{quotagroup}/users/{username} | Add a user to a quota group| |[**adminAdoptRepository**](#adminadoptrepository) | **POST** /admin/unadopted/{owner}/{repo} | Adopt unadopted files as a repository| |[**adminCreateHook**](#admincreatehook) | **POST** /admin/hooks | Create a hook| |[**adminCreateOrg**](#admincreateorg) | **POST** /admin/users/{username}/orgs | Create an organization| |[**adminCreatePublicKey**](#admincreatepublickey) | **POST** /admin/users/{username}/keys | Add a public key on behalf of a user| |[**adminCreateQuotaGroup**](#admincreatequotagroup) | **POST** /admin/quota/groups | Create a new quota group| |[**adminCreateQuotaRule**](#admincreatequotarule) | **POST** /admin/quota/rules | Create a new quota rule| |[**adminCreateRepo**](#admincreaterepo) | **POST** /admin/users/{username}/repos | Create a repository on behalf of a user| |[**adminCreateUser**](#admincreateuser) | **POST** /admin/users | Create a user| |[**adminCronList**](#admincronlist) | **GET** /admin/cron | List cron tasks| |[**adminCronRun**](#admincronrun) | **POST** /admin/cron/{task} | Run cron task| |[**adminDEleteQuotaRule**](#admindeletequotarule) | **DELETE** /admin/quota/rules/{quotarule} | Deletes a quota rule| |[**adminDeleteHook**](#admindeletehook) | **DELETE** /admin/hooks/{id} | Delete a hook| |[**adminDeleteQuotaGroup**](#admindeletequotagroup) | **DELETE** /admin/quota/groups/{quotagroup} | Delete a quota group| |[**adminDeleteUnadoptedRepository**](#admindeleteunadoptedrepository) | **DELETE** /admin/unadopted/{owner}/{repo} | Delete unadopted files| |[**adminDeleteUser**](#admindeleteuser) | **DELETE** /admin/users/{username} | Delete a user| |[**adminDeleteUserPublicKey**](#admindeleteuserpublickey) | **DELETE** /admin/users/{username}/keys/{id} | Delete a user\'s public key| |[**adminEditHook**](#adminedithook) | **PATCH** /admin/hooks/{id} | Update a hook| |[**adminEditQuotaRule**](#admineditquotarule) | **PATCH** /admin/quota/rules/{quotarule} | Change an existing quota rule| |[**adminEditUser**](#adminedituser) | **PATCH** /admin/users/{username} | Edit an existing user| |[**adminGetAllEmails**](#admingetallemails) | **GET** /admin/emails | List all emails| |[**adminGetAllOrgs**](#admingetallorgs) | **GET** /admin/orgs | List all organizations| |[**adminGetHook**](#admingethook) | **GET** /admin/hooks/{id} | Get a hook| |[**adminGetQuotaGroup**](#admingetquotagroup) | **GET** /admin/quota/groups/{quotagroup} | Get information about the quota group| |[**adminGetQuotaRule**](#admingetquotarule) | **GET** /admin/quota/rules/{quotarule} | Get information about a quota rule| |[**adminGetRunnerRegistrationToken**](#admingetrunnerregistrationtoken) | **GET** /admin/runners/registration-token | Get an global actions runner registration token| |[**adminGetUserQuota**](#admingetuserquota) | **GET** /admin/users/{username}/quota | Get the user\'s quota info| |[**adminListHooks**](#adminlisthooks) | **GET** /admin/hooks | List system\'s webhooks| |[**adminListQuotaGroups**](#adminlistquotagroups) | **GET** /admin/quota/groups | List the available quota groups| |[**adminListQuotaRules**](#adminlistquotarules) | **GET** /admin/quota/rules | List the available quota rules| |[**adminListUsersInQuotaGroup**](#adminlistusersinquotagroup) | **GET** /admin/quota/groups/{quotagroup}/users | List users in a quota group| |[**adminRemoveRuleFromQuotaGroup**](#adminremoverulefromquotagroup) | **DELETE** /admin/quota/groups/{quotagroup}/rules/{quotarule} | Removes a rule from a quota group| |[**adminRemoveUserFromQuotaGroup**](#adminremoveuserfromquotagroup) | **DELETE** /admin/quota/groups/{quotagroup}/users/{username} | Remove a user from a quota group| |[**adminRenameUser**](#adminrenameuser) | **POST** /admin/users/{username}/rename | Rename a user| |[**adminSearchEmails**](#adminsearchemails) | **GET** /admin/emails/search | Search all emails| |[**adminSearchRunJobs**](#adminsearchrunjobs) | **GET** /admin/runners/jobs | Search action jobs according filter conditions| |[**adminSearchUsers**](#adminsearchusers) | **GET** /admin/users | Search users according filter conditions| |[**adminSetUserQuotaGroups**](#adminsetuserquotagroups) | **POST** /admin/users/{username}/quota/groups | Set the user\'s quota groups to a given list.| |[**adminUnadoptedList**](#adminunadoptedlist) | **GET** /admin/unadopted | List unadopted repositories| # **adminAddRuleToQuotaGroup** > adminAddRuleToQuotaGroup() ### Example ```typescript import { AdminApi, Configuration } from 'berg'; const configuration = new Configuration(); const apiInstance = new AdminApi(configuration); let quotagroup: string; //quota group to add a rule to (default to undefined) let quotarule: string; //the name of the quota rule to add to the group (default to undefined) const { status, data } = await apiInstance.adminAddRuleToQuotaGroup( quotagroup, quotarule ); ``` ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **quotagroup** | [**string**] | quota group to add a rule to | defaults to undefined| | **quotarule** | [**string**] | the name of the quota rule to add to the group | defaults to undefined| ### Return type void (empty response body) ### Authorization [TOTPHeader](../README.md#TOTPHeader), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [SudoHeader](../README.md#SudoHeader), [BasicAuth](../README.md#BasicAuth), [AccessToken](../README.md#AccessToken), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**204** | APIEmpty is an empty response | - | |**400** | APIError is error format response | - | |**403** | APIForbiddenError is a forbidden error response | - | |**404** | APINotFound is a not found error response | - | |**409** | APIError is error format response | - | |**422** | APIValidationError is error format response related to input validation | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **adminAddUserToQuotaGroup** > adminAddUserToQuotaGroup() ### Example ```typescript import { AdminApi, Configuration } from 'berg'; const configuration = new Configuration(); const apiInstance = new AdminApi(configuration); let quotagroup: string; //quota group to add the user to (default to undefined) let username: string; //username of the user to add to the quota group (default to undefined) const { status, data } = await apiInstance.adminAddUserToQuotaGroup( quotagroup, username ); ``` ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **quotagroup** | [**string**] | quota group to add the user to | defaults to undefined| | **username** | [**string**] | username of the user to add to the quota group | defaults to undefined| ### Return type void (empty response body) ### Authorization [TOTPHeader](../README.md#TOTPHeader), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [SudoHeader](../README.md#SudoHeader), [BasicAuth](../README.md#BasicAuth), [AccessToken](../README.md#AccessToken), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**204** | APIEmpty is an empty response | - | |**400** | APIError is error format response | - | |**403** | APIForbiddenError is a forbidden error response | - | |**404** | APINotFound is a not found error response | - | |**409** | APIError is error format response | - | |**422** | APIValidationError is error format response related to input validation | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **adminAdoptRepository** > adminAdoptRepository() ### Example ```typescript import { AdminApi, Configuration } from 'berg'; const configuration = new Configuration(); const apiInstance = new AdminApi(configuration); let owner: string; //owner of the repo (default to undefined) let repo: string; //name of the repo (default to undefined) const { status, data } = await apiInstance.adminAdoptRepository( owner, repo ); ``` ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **owner** | [**string**] | owner of the repo | defaults to undefined| | **repo** | [**string**] | name of the repo | defaults to undefined| ### Return type void (empty response body) ### Authorization [TOTPHeader](../README.md#TOTPHeader), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [SudoHeader](../README.md#SudoHeader), [BasicAuth](../README.md#BasicAuth), [AccessToken](../README.md#AccessToken), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**204** | APIEmpty is an empty response | - | |**403** | APIForbiddenError is a forbidden error response | - | |**404** | APINotFound is a not found error response | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **adminCreateHook** > Hook adminCreateHook(body) ### Example ```typescript import { AdminApi, Configuration, CreateHookOption } from 'berg'; const configuration = new Configuration(); const apiInstance = new AdminApi(configuration); let body: CreateHookOption; // const { status, data } = await apiInstance.adminCreateHook( body ); ``` ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **body** | **CreateHookOption**| | | ### Return type **Hook** ### Authorization [TOTPHeader](../README.md#TOTPHeader), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [SudoHeader](../README.md#SudoHeader), [BasicAuth](../README.md#BasicAuth), [AccessToken](../README.md#AccessToken), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**201** | Hook | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **adminCreateOrg** > Organization adminCreateOrg(organization) ### Example ```typescript import { AdminApi, Configuration, CreateOrgOption } from 'berg'; const configuration = new Configuration(); const apiInstance = new AdminApi(configuration); let username: string; //username of the user that will own the created organization (default to undefined) let organization: CreateOrgOption; // const { status, data } = await apiInstance.adminCreateOrg( username, organization ); ``` ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **organization** | **CreateOrgOption**| | | | **username** | [**string**] | username of the user that will own the created organization | defaults to undefined| ### Return type **Organization** ### Authorization [TOTPHeader](../README.md#TOTPHeader), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [SudoHeader](../README.md#SudoHeader), [BasicAuth](../README.md#BasicAuth), [AccessToken](../README.md#AccessToken), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**201** | Organization | - | |**403** | APIForbiddenError is a forbidden error response | - | |**422** | APIValidationError is error format response related to input validation | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **adminCreatePublicKey** > PublicKey adminCreatePublicKey() ### Example ```typescript import { AdminApi, Configuration, CreateKeyOption } from 'berg'; const configuration = new Configuration(); const apiInstance = new AdminApi(configuration); let username: string; //username of the user (default to undefined) let key: CreateKeyOption; // (optional) const { status, data } = await apiInstance.adminCreatePublicKey( username, key ); ``` ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **key** | **CreateKeyOption**| | | | **username** | [**string**] | username of the user | defaults to undefined| ### Return type **PublicKey** ### Authorization [TOTPHeader](../README.md#TOTPHeader), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [SudoHeader](../README.md#SudoHeader), [BasicAuth](../README.md#BasicAuth), [AccessToken](../README.md#AccessToken), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**201** | PublicKey | - | |**403** | APIForbiddenError is a forbidden error response | - | |**422** | APIValidationError is error format response related to input validation | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **adminCreateQuotaGroup** > QuotaGroup adminCreateQuotaGroup(group) ### Example ```typescript import { AdminApi, Configuration, CreateQuotaGroupOptions } from 'berg'; const configuration = new Configuration(); const apiInstance = new AdminApi(configuration); let group: CreateQuotaGroupOptions; //Definition of the quota group const { status, data } = await apiInstance.adminCreateQuotaGroup( group ); ``` ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **group** | **CreateQuotaGroupOptions**| Definition of the quota group | | ### Return type **QuotaGroup** ### Authorization [TOTPHeader](../README.md#TOTPHeader), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [SudoHeader](../README.md#SudoHeader), [BasicAuth](../README.md#BasicAuth), [AccessToken](../README.md#AccessToken), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json, text/plain - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**201** | QuotaGroup | - | |**400** | APIError is error format response | - | |**403** | APIForbiddenError is a forbidden error response | - | |**409** | APIError is error format response | - | |**422** | APIValidationError is error format response related to input validation | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **adminCreateQuotaRule** > QuotaRuleInfo adminCreateQuotaRule(rule) ### Example ```typescript import { AdminApi, Configuration, CreateQuotaRuleOptions } from 'berg'; const configuration = new Configuration(); const apiInstance = new AdminApi(configuration); let rule: CreateQuotaRuleOptions; //Definition of the quota rule const { status, data } = await apiInstance.adminCreateQuotaRule( rule ); ``` ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **rule** | **CreateQuotaRuleOptions**| Definition of the quota rule | | ### Return type **QuotaRuleInfo** ### Authorization [TOTPHeader](../README.md#TOTPHeader), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [SudoHeader](../README.md#SudoHeader), [BasicAuth](../README.md#BasicAuth), [AccessToken](../README.md#AccessToken), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json, text/plain - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**201** | QuotaRuleInfo | - | |**400** | APIError is error format response | - | |**403** | APIForbiddenError is a forbidden error response | - | |**409** | APIError is error format response | - | |**422** | APIValidationError is error format response related to input validation | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **adminCreateRepo** > Repository adminCreateRepo(repository) ### Example ```typescript import { AdminApi, Configuration, CreateRepoOption } from 'berg'; const configuration = new Configuration(); const apiInstance = new AdminApi(configuration); let username: string; //username of the user. This user will own the created repository (default to undefined) let repository: CreateRepoOption; // const { status, data } = await apiInstance.adminCreateRepo( username, repository ); ``` ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **repository** | **CreateRepoOption**| | | | **username** | [**string**] | username of the user. This user will own the created repository | defaults to undefined| ### Return type **Repository** ### Authorization [TOTPHeader](../README.md#TOTPHeader), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [SudoHeader](../README.md#SudoHeader), [BasicAuth](../README.md#BasicAuth), [AccessToken](../README.md#AccessToken), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**201** | Repository | - | |**400** | APIError is error format response | - | |**403** | APIForbiddenError is a forbidden error response | - | |**404** | APINotFound is a not found error response | - | |**409** | APIError is error format response | - | |**422** | APIValidationError is error format response related to input validation | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **adminCreateUser** > User adminCreateUser() ### Example ```typescript import { AdminApi, Configuration, CreateUserOption } from 'berg'; const configuration = new Configuration(); const apiInstance = new AdminApi(configuration); let body: CreateUserOption; // (optional) const { status, data } = await apiInstance.adminCreateUser( body ); ``` ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **body** | **CreateUserOption**| | | ### Return type **User** ### Authorization [TOTPHeader](../README.md#TOTPHeader), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [SudoHeader](../README.md#SudoHeader), [BasicAuth](../README.md#BasicAuth), [AccessToken](../README.md#AccessToken), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**201** | User | - | |**400** | APIError is error format response | - | |**403** | APIForbiddenError is a forbidden error response | - | |**422** | APIValidationError is error format response related to input validation | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **adminCronList** > Array<Cron> adminCronList() ### Example ```typescript import { AdminApi, Configuration } from 'berg'; const configuration = new Configuration(); const apiInstance = new AdminApi(configuration); let page: number; //page number of results to return (1-based) (optional) (default to undefined) let limit: number; //page size of results (optional) (default to undefined) const { status, data } = await apiInstance.adminCronList( page, limit ); ``` ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **page** | [**number**] | page number of results to return (1-based) | (optional) defaults to undefined| | **limit** | [**number**] | page size of results | (optional) defaults to undefined| ### Return type **Array<Cron>** ### Authorization [TOTPHeader](../README.md#TOTPHeader), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [SudoHeader](../README.md#SudoHeader), [BasicAuth](../README.md#BasicAuth), [AccessToken](../README.md#AccessToken), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**200** | CronList | - | |**403** | APIForbiddenError is a forbidden error response | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **adminCronRun** > adminCronRun() ### Example ```typescript import { AdminApi, Configuration } from 'berg'; const configuration = new Configuration(); const apiInstance = new AdminApi(configuration); let task: string; //task to run (default to undefined) const { status, data } = await apiInstance.adminCronRun( task ); ``` ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **task** | [**string**] | task to run | defaults to undefined| ### Return type void (empty response body) ### Authorization [TOTPHeader](../README.md#TOTPHeader), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [SudoHeader](../README.md#SudoHeader), [BasicAuth](../README.md#BasicAuth), [AccessToken](../README.md#AccessToken), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**204** | APIEmpty is an empty response | - | |**404** | APINotFound is a not found error response | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **adminDEleteQuotaRule** > adminDEleteQuotaRule() ### Example ```typescript import { AdminApi, Configuration } from 'berg'; const configuration = new Configuration(); const apiInstance = new AdminApi(configuration); let quotarule: string; //quota rule to delete (default to undefined) const { status, data } = await apiInstance.adminDEleteQuotaRule( quotarule ); ``` ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **quotarule** | [**string**] | quota rule to delete | defaults to undefined| ### Return type void (empty response body) ### Authorization [TOTPHeader](../README.md#TOTPHeader), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [SudoHeader](../README.md#SudoHeader), [BasicAuth](../README.md#BasicAuth), [AccessToken](../README.md#AccessToken), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**204** | APIEmpty is an empty response | - | |**400** | APIError is error format response | - | |**403** | APIForbiddenError is a forbidden error response | - | |**404** | APINotFound is a not found error response | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **adminDeleteHook** > adminDeleteHook() ### Example ```typescript import { AdminApi, Configuration } from 'berg'; const configuration = new Configuration(); const apiInstance = new AdminApi(configuration); let id: number; //id of the hook to delete (default to undefined) const { status, data } = await apiInstance.adminDeleteHook( id ); ``` ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **id** | [**number**] | id of the hook to delete | defaults to undefined| ### Return type void (empty response body) ### Authorization [TOTPHeader](../README.md#TOTPHeader), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [SudoHeader](../README.md#SudoHeader), [BasicAuth](../README.md#BasicAuth), [AccessToken](../README.md#AccessToken), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: Not defined ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**204** | APIEmpty is an empty response | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **adminDeleteQuotaGroup** > adminDeleteQuotaGroup() ### Example ```typescript import { AdminApi, Configuration } from 'berg'; const configuration = new Configuration(); const apiInstance = new AdminApi(configuration); let quotagroup: string; //quota group to delete (default to undefined) const { status, data } = await apiInstance.adminDeleteQuotaGroup( quotagroup ); ``` ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **quotagroup** | [**string**] | quota group to delete | defaults to undefined| ### Return type void (empty response body) ### Authorization [TOTPHeader](../README.md#TOTPHeader), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [SudoHeader](../README.md#SudoHeader), [BasicAuth](../README.md#BasicAuth), [AccessToken](../README.md#AccessToken), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**204** | APIEmpty is an empty response | - | |**400** | APIError is error format response | - | |**403** | APIForbiddenError is a forbidden error response | - | |**404** | APINotFound is a not found error response | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **adminDeleteUnadoptedRepository** > adminDeleteUnadoptedRepository() ### Example ```typescript import { AdminApi, Configuration } from 'berg'; const configuration = new Configuration(); const apiInstance = new AdminApi(configuration); let owner: string; //owner of the repo (default to undefined) let repo: string; //name of the repo (default to undefined) const { status, data } = await apiInstance.adminDeleteUnadoptedRepository( owner, repo ); ``` ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **owner** | [**string**] | owner of the repo | defaults to undefined| | **repo** | [**string**] | name of the repo | defaults to undefined| ### Return type void (empty response body) ### Authorization [TOTPHeader](../README.md#TOTPHeader), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [SudoHeader](../README.md#SudoHeader), [BasicAuth](../README.md#BasicAuth), [AccessToken](../README.md#AccessToken), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**204** | APIEmpty is an empty response | - | |**403** | APIForbiddenError is a forbidden error response | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **adminDeleteUser** > adminDeleteUser() ### Example ```typescript import { AdminApi, Configuration } from 'berg'; const configuration = new Configuration(); const apiInstance = new AdminApi(configuration); let username: string; //username of user to delete (default to undefined) let purge: boolean; //purge the user from the system completely (optional) (default to undefined) const { status, data } = await apiInstance.adminDeleteUser( username, purge ); ``` ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **username** | [**string**] | username of user to delete | defaults to undefined| | **purge** | [**boolean**] | purge the user from the system completely | (optional) defaults to undefined| ### Return type void (empty response body) ### Authorization [TOTPHeader](../README.md#TOTPHeader), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [SudoHeader](../README.md#SudoHeader), [BasicAuth](../README.md#BasicAuth), [AccessToken](../README.md#AccessToken), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**204** | APIEmpty is an empty response | - | |**403** | APIForbiddenError is a forbidden error response | - | |**404** | APINotFound is a not found error response | - | |**422** | APIValidationError is error format response related to input validation | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **adminDeleteUserPublicKey** > adminDeleteUserPublicKey() ### Example ```typescript import { AdminApi, Configuration } from 'berg'; const configuration = new Configuration(); const apiInstance = new AdminApi(configuration); let username: string; //username of user (default to undefined) let id: number; //id of the key to delete (default to undefined) const { status, data } = await apiInstance.adminDeleteUserPublicKey( username, id ); ``` ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **username** | [**string**] | username of user | defaults to undefined| | **id** | [**number**] | id of the key to delete | defaults to undefined| ### Return type void (empty response body) ### Authorization [TOTPHeader](../README.md#TOTPHeader), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [SudoHeader](../README.md#SudoHeader), [BasicAuth](../README.md#BasicAuth), [AccessToken](../README.md#AccessToken), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**204** | APIEmpty is an empty response | - | |**403** | APIForbiddenError is a forbidden error response | - | |**404** | APINotFound is a not found error response | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **adminEditHook** > Hook adminEditHook() ### Example ```typescript import { AdminApi, Configuration, EditHookOption } from 'berg'; const configuration = new Configuration(); const apiInstance = new AdminApi(configuration); let id: number; //id of the hook to update (default to undefined) let body: EditHookOption; // (optional) const { status, data } = await apiInstance.adminEditHook( id, body ); ``` ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **body** | **EditHookOption**| | | | **id** | [**number**] | id of the hook to update | defaults to undefined| ### Return type **Hook** ### Authorization [TOTPHeader](../README.md#TOTPHeader), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [SudoHeader](../README.md#SudoHeader), [BasicAuth](../README.md#BasicAuth), [AccessToken](../README.md#AccessToken), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**200** | Hook | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **adminEditQuotaRule** > QuotaRuleInfo adminEditQuotaRule(rule) ### Example ```typescript import { AdminApi, Configuration, EditQuotaRuleOptions } from 'berg'; const configuration = new Configuration(); const apiInstance = new AdminApi(configuration); let quotarule: string; //Quota rule to change (default to undefined) let rule: EditQuotaRuleOptions; // const { status, data } = await apiInstance.adminEditQuotaRule( quotarule, rule ); ``` ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **rule** | **EditQuotaRuleOptions**| | | | **quotarule** | [**string**] | Quota rule to change | defaults to undefined| ### Return type **QuotaRuleInfo** ### Authorization [TOTPHeader](../README.md#TOTPHeader), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [SudoHeader](../README.md#SudoHeader), [BasicAuth](../README.md#BasicAuth), [AccessToken](../README.md#AccessToken), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json, text/plain - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**200** | QuotaRuleInfo | - | |**400** | APIError is error format response | - | |**403** | APIForbiddenError is a forbidden error response | - | |**404** | APINotFound is a not found error response | - | |**422** | APIValidationError is error format response related to input validation | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **adminEditUser** > User adminEditUser() ### Example ```typescript import { AdminApi, Configuration, EditUserOption } from 'berg'; const configuration = new Configuration(); const apiInstance = new AdminApi(configuration); let username: string; //username of user to edit (default to undefined) let body: EditUserOption; // (optional) const { status, data } = await apiInstance.adminEditUser( username, body ); ``` ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **body** | **EditUserOption**| | | | **username** | [**string**] | username of user to edit | defaults to undefined| ### Return type **User** ### Authorization [TOTPHeader](../README.md#TOTPHeader), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [SudoHeader](../README.md#SudoHeader), [BasicAuth](../README.md#BasicAuth), [AccessToken](../README.md#AccessToken), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**200** | User | - | |**400** | APIError is error format response | - | |**403** | APIForbiddenError is a forbidden error response | - | |**422** | APIValidationError is error format response related to input validation | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **adminGetAllEmails** > Array<Email> adminGetAllEmails() ### Example ```typescript import { AdminApi, Configuration } from 'berg'; const configuration = new Configuration(); const apiInstance = new AdminApi(configuration); let page: number; //page number of results to return (1-based) (optional) (default to undefined) let limit: number; //page size of results (optional) (default to undefined) const { status, data } = await apiInstance.adminGetAllEmails( page, limit ); ``` ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **page** | [**number**] | page number of results to return (1-based) | (optional) defaults to undefined| | **limit** | [**number**] | page size of results | (optional) defaults to undefined| ### Return type **Array<Email>** ### Authorization [TOTPHeader](../README.md#TOTPHeader), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [SudoHeader](../README.md#SudoHeader), [BasicAuth](../README.md#BasicAuth), [AccessToken](../README.md#AccessToken), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**200** | EmailList | - | |**403** | APIForbiddenError is a forbidden error response | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **adminGetAllOrgs** > Array<Organization> adminGetAllOrgs() ### Example ```typescript import { AdminApi, Configuration } from 'berg'; const configuration = new Configuration(); const apiInstance = new AdminApi(configuration); let page: number; //page number of results to return (1-based) (optional) (default to undefined) let limit: number; //page size of results (optional) (default to undefined) const { status, data } = await apiInstance.adminGetAllOrgs( page, limit ); ``` ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **page** | [**number**] | page number of results to return (1-based) | (optional) defaults to undefined| | **limit** | [**number**] | page size of results | (optional) defaults to undefined| ### Return type **Array<Organization>** ### Authorization [TOTPHeader](../README.md#TOTPHeader), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [SudoHeader](../README.md#SudoHeader), [BasicAuth](../README.md#BasicAuth), [AccessToken](../README.md#AccessToken), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**200** | OrganizationList | - | |**403** | APIForbiddenError is a forbidden error response | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **adminGetHook** > Hook adminGetHook() ### Example ```typescript import { AdminApi, Configuration } from 'berg'; const configuration = new Configuration(); const apiInstance = new AdminApi(configuration); let id: number; //id of the hook to get (default to undefined) const { status, data } = await apiInstance.adminGetHook( id ); ``` ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **id** | [**number**] | id of the hook to get | defaults to undefined| ### Return type **Hook** ### Authorization [TOTPHeader](../README.md#TOTPHeader), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [SudoHeader](../README.md#SudoHeader), [BasicAuth](../README.md#BasicAuth), [AccessToken](../README.md#AccessToken), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**200** | Hook | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **adminGetQuotaGroup** > QuotaGroup adminGetQuotaGroup() ### Example ```typescript import { AdminApi, Configuration } from 'berg'; const configuration = new Configuration(); const apiInstance = new AdminApi(configuration); let quotagroup: string; //quota group to query (default to undefined) const { status, data } = await apiInstance.adminGetQuotaGroup( quotagroup ); ``` ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **quotagroup** | [**string**] | quota group to query | defaults to undefined| ### Return type **QuotaGroup** ### Authorization [TOTPHeader](../README.md#TOTPHeader), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [SudoHeader](../README.md#SudoHeader), [BasicAuth](../README.md#BasicAuth), [AccessToken](../README.md#AccessToken), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**200** | QuotaGroup | - | |**400** | APIError is error format response | - | |**403** | APIForbiddenError is a forbidden error response | - | |**404** | APINotFound is a not found error response | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **adminGetQuotaRule** > QuotaRuleInfo adminGetQuotaRule() ### Example ```typescript import { AdminApi, Configuration } from 'berg'; const configuration = new Configuration(); const apiInstance = new AdminApi(configuration); let quotarule: string; //quota rule to query (default to undefined) const { status, data } = await apiInstance.adminGetQuotaRule( quotarule ); ``` ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **quotarule** | [**string**] | quota rule to query | defaults to undefined| ### Return type **QuotaRuleInfo** ### Authorization [TOTPHeader](../README.md#TOTPHeader), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [SudoHeader](../README.md#SudoHeader), [BasicAuth](../README.md#BasicAuth), [AccessToken](../README.md#AccessToken), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**200** | QuotaRuleInfo | - | |**400** | APIError is error format response | - | |**403** | APIForbiddenError is a forbidden error response | - | |**404** | APINotFound is a not found error response | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **adminGetRunnerRegistrationToken** > adminGetRunnerRegistrationToken() ### Example ```typescript import { AdminApi, Configuration } from 'berg'; const configuration = new Configuration(); const apiInstance = new AdminApi(configuration); const { status, data } = await apiInstance.adminGetRunnerRegistrationToken(); ``` ### Parameters This endpoint does not have any parameters. ### Return type void (empty response body) ### Authorization [TOTPHeader](../README.md#TOTPHeader), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [SudoHeader](../README.md#SudoHeader), [BasicAuth](../README.md#BasicAuth), [AccessToken](../README.md#AccessToken), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: Not defined ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**200** | RegistrationToken is a string used to register a runner with a server | * token - <br> | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **adminGetUserQuota** > QuotaInfo adminGetUserQuota() ### Example ```typescript import { AdminApi, Configuration } from 'berg'; const configuration = new Configuration(); const apiInstance = new AdminApi(configuration); let username: string; //username of user to query (default to undefined) const { status, data } = await apiInstance.adminGetUserQuota( username ); ``` ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **username** | [**string**] | username of user to query | defaults to undefined| ### Return type **QuotaInfo** ### Authorization [TOTPHeader](../README.md#TOTPHeader), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [SudoHeader](../README.md#SudoHeader), [BasicAuth](../README.md#BasicAuth), [AccessToken](../README.md#AccessToken), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**200** | QuotaInfo | - | |**400** | APIError is error format response | - | |**403** | APIForbiddenError is a forbidden error response | - | |**404** | APINotFound is a not found error response | - | |**422** | APIValidationError is error format response related to input validation | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **adminListHooks** > Array<Hook> adminListHooks() ### Example ```typescript import { AdminApi, Configuration } from 'berg'; const configuration = new C