Class AdminApi

java.lang.Object
build.cursed.genapi.forgejo.api.AdminApi

public class AdminApi extends Object
  • Constructor Details

    • AdminApi

      public AdminApi()
    • AdminApi

      public AdminApi(ApiClient apiClient)
  • Method Details

    • getApiClient

      public ApiClient getApiClient()
    • setApiClient

      public void setApiClient(ApiClient apiClient)
    • getHostIndex

      public int getHostIndex()
    • setHostIndex

      public void setHostIndex(int hostIndex)
    • getCustomBaseUrl

      public String getCustomBaseUrl()
    • setCustomBaseUrl

      public void setCustomBaseUrl(String customBaseUrl)
    • adminAddRuleToQuotaGroupCall

      public okhttp3.Call adminAddRuleToQuotaGroupCall(@Nonnull String quotagroup, @Nonnull String quotarule, ApiCallback _callback) throws ApiException
      Build call for adminAddRuleToQuotaGroup
      Parameters:
      quotagroup - quota group to add a rule to (required)
      quotarule - the name of the quota rule to add to the group (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details
      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 -
    • adminAddRuleToQuotaGroup

      public void adminAddRuleToQuotaGroup(@Nonnull String quotagroup, @Nonnull String quotarule) throws ApiException
      Adds a rule to a quota group
      Parameters:
      quotagroup - quota group to add a rule to (required)
      quotarule - the name of the quota rule to add to the group (required)
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      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 -
    • adminAddRuleToQuotaGroupWithHttpInfo

      public ApiResponse<Void> adminAddRuleToQuotaGroupWithHttpInfo(@Nonnull String quotagroup, @Nonnull String quotarule) throws ApiException
      Adds a rule to a quota group
      Parameters:
      quotagroup - quota group to add a rule to (required)
      quotarule - the name of the quota rule to add to the group (required)
      Returns:
      ApiResponse<Void>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      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 -
    • adminAddRuleToQuotaGroupAsync

      public okhttp3.Call adminAddRuleToQuotaGroupAsync(@Nonnull String quotagroup, @Nonnull String quotarule, ApiCallback<Void> _callback) throws ApiException
      Adds a rule to a quota group (asynchronously)
      Parameters:
      quotagroup - quota group to add a rule to (required)
      quotarule - the name of the quota rule to add to the group (required)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details
      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 -
    • adminAddUserToQuotaGroupCall

      public okhttp3.Call adminAddUserToQuotaGroupCall(@Nonnull String quotagroup, @Nonnull String username, ApiCallback _callback) throws ApiException
      Build call for adminAddUserToQuotaGroup
      Parameters:
      quotagroup - quota group to add the user to (required)
      username - username of the user to add to the quota group (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details
      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 -
    • adminAddUserToQuotaGroup

      public void adminAddUserToQuotaGroup(@Nonnull String quotagroup, @Nonnull String username) throws ApiException
      Add a user to a quota group
      Parameters:
      quotagroup - quota group to add the user to (required)
      username - username of the user to add to the quota group (required)
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      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 -
    • adminAddUserToQuotaGroupWithHttpInfo

      public ApiResponse<Void> adminAddUserToQuotaGroupWithHttpInfo(@Nonnull String quotagroup, @Nonnull String username) throws ApiException
      Add a user to a quota group
      Parameters:
      quotagroup - quota group to add the user to (required)
      username - username of the user to add to the quota group (required)
      Returns:
      ApiResponse<Void>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      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 -
    • adminAddUserToQuotaGroupAsync

      public okhttp3.Call adminAddUserToQuotaGroupAsync(@Nonnull String quotagroup, @Nonnull String username, ApiCallback<Void> _callback) throws ApiException
      Add a user to a quota group (asynchronously)
      Parameters:
      quotagroup - quota group to add the user to (required)
      username - username of the user to add to the quota group (required)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details
      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 -
    • adminAdoptRepositoryCall

      public okhttp3.Call adminAdoptRepositoryCall(@Nonnull String owner, @Nonnull String repo, ApiCallback _callback) throws ApiException
      Build call for adminAdoptRepository
      Parameters:
      owner - owner of the repo (required)
      repo - name of the repo (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details
      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 -
    • adminAdoptRepository

      public void adminAdoptRepository(@Nonnull String owner, @Nonnull String repo) throws ApiException
      Adopt unadopted files as a repository
      Parameters:
      owner - owner of the repo (required)
      repo - name of the repo (required)
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      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 -
    • adminAdoptRepositoryWithHttpInfo

      public ApiResponse<Void> adminAdoptRepositoryWithHttpInfo(@Nonnull String owner, @Nonnull String repo) throws ApiException
      Adopt unadopted files as a repository
      Parameters:
      owner - owner of the repo (required)
      repo - name of the repo (required)
      Returns:
      ApiResponse<Void>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      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 -
    • adminAdoptRepositoryAsync

      public okhttp3.Call adminAdoptRepositoryAsync(@Nonnull String owner, @Nonnull String repo, ApiCallback<Void> _callback) throws ApiException
      Adopt unadopted files as a repository (asynchronously)
      Parameters:
      owner - owner of the repo (required)
      repo - name of the repo (required)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details
      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 -
    • adminCreateHookCall

      public okhttp3.Call adminCreateHookCall(@Nonnull CreateHookOption body, ApiCallback _callback) throws ApiException
      Build call for adminCreateHook
      Parameters:
      body - (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details
      Response Details
      Status Code Description Response Headers
      201 Hook -
    • adminCreateHook

      public Hook adminCreateHook(@Nonnull CreateHookOption body) throws ApiException
      Create a hook
      Parameters:
      body - (required)
      Returns:
      Hook
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      Response Details
      Status Code Description Response Headers
      201 Hook -
    • adminCreateHookWithHttpInfo

      public ApiResponse<Hook> adminCreateHookWithHttpInfo(@Nonnull CreateHookOption body) throws ApiException
      Create a hook
      Parameters:
      body - (required)
      Returns:
      ApiResponse<Hook>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      Response Details
      Status Code Description Response Headers
      201 Hook -
    • adminCreateHookAsync

      public okhttp3.Call adminCreateHookAsync(@Nonnull CreateHookOption body, ApiCallback<Hook> _callback) throws ApiException
      Create a hook (asynchronously)
      Parameters:
      body - (required)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details
      Response Details
      Status Code Description Response Headers
      201 Hook -
    • adminCreateOrgCall

      public okhttp3.Call adminCreateOrgCall(@Nonnull String username, @Nonnull CreateOrgOption organization, ApiCallback _callback) throws ApiException
      Build call for adminCreateOrg
      Parameters:
      username - username of the user that will own the created organization (required)
      organization - (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details
      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 -
    • adminCreateOrg

      public Organization adminCreateOrg(@Nonnull String username, @Nonnull CreateOrgOption organization) throws ApiException
      Create an organization
      Parameters:
      username - username of the user that will own the created organization (required)
      organization - (required)
      Returns:
      Organization
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      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 -
    • adminCreateOrgWithHttpInfo

      public ApiResponse<Organization> adminCreateOrgWithHttpInfo(@Nonnull String username, @Nonnull CreateOrgOption organization) throws ApiException
      Create an organization
      Parameters:
      username - username of the user that will own the created organization (required)
      organization - (required)
      Returns:
      ApiResponse<Organization>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      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 -
    • adminCreateOrgAsync

      public okhttp3.Call adminCreateOrgAsync(@Nonnull String username, @Nonnull CreateOrgOption organization, ApiCallback<Organization> _callback) throws ApiException
      Create an organization (asynchronously)
      Parameters:
      username - username of the user that will own the created organization (required)
      organization - (required)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details
      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 -
    • adminCreatePublicKeyCall

      public okhttp3.Call adminCreatePublicKeyCall(@Nonnull String username, @Nullable CreateKeyOption key, ApiCallback _callback) throws ApiException
      Build call for adminCreatePublicKey
      Parameters:
      username - username of the user (required)
      key - (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details
      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 -
    • adminCreatePublicKey

      public PublicKey adminCreatePublicKey(@Nonnull String username, @Nullable CreateKeyOption key) throws ApiException
      Add an SSH public key to user's account
      Parameters:
      username - username of the user (required)
      key - (optional)
      Returns:
      PublicKey
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      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 -
    • adminCreatePublicKeyWithHttpInfo

      public ApiResponse<PublicKey> adminCreatePublicKeyWithHttpInfo(@Nonnull String username, @Nullable CreateKeyOption key) throws ApiException
      Add an SSH public key to user's account
      Parameters:
      username - username of the user (required)
      key - (optional)
      Returns:
      ApiResponse<PublicKey>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      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 -
    • adminCreatePublicKeyAsync

      public okhttp3.Call adminCreatePublicKeyAsync(@Nonnull String username, @Nullable CreateKeyOption key, ApiCallback<PublicKey> _callback) throws ApiException
      Add an SSH public key to user's account (asynchronously)
      Parameters:
      username - username of the user (required)
      key - (optional)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details
      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 -
    • adminCreateQuotaGroupCall

      public okhttp3.Call adminCreateQuotaGroupCall(@Nonnull CreateQuotaGroupOptions group, ApiCallback _callback) throws ApiException
      Build call for adminCreateQuotaGroup
      Parameters:
      group - Definition of the quota group (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details
      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 -
    • adminCreateQuotaGroup

      public QuotaGroup adminCreateQuotaGroup(@Nonnull CreateQuotaGroupOptions group) throws ApiException
      Create a new quota group
      Parameters:
      group - Definition of the quota group (required)
      Returns:
      QuotaGroup
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      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 -
    • adminCreateQuotaGroupWithHttpInfo

      public ApiResponse<QuotaGroup> adminCreateQuotaGroupWithHttpInfo(@Nonnull CreateQuotaGroupOptions group) throws ApiException
      Create a new quota group
      Parameters:
      group - Definition of the quota group (required)
      Returns:
      ApiResponse<QuotaGroup>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      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 -
    • adminCreateQuotaGroupAsync

      public okhttp3.Call adminCreateQuotaGroupAsync(@Nonnull CreateQuotaGroupOptions group, ApiCallback<QuotaGroup> _callback) throws ApiException
      Create a new quota group (asynchronously)
      Parameters:
      group - Definition of the quota group (required)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details
      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 -
    • adminCreateQuotaRuleCall

      public okhttp3.Call adminCreateQuotaRuleCall(@Nonnull CreateQuotaRuleOptions rule, ApiCallback _callback) throws ApiException
      Build call for adminCreateQuotaRule
      Parameters:
      rule - Definition of the quota rule (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details
      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 -
    • adminCreateQuotaRule

      public QuotaRuleInfo adminCreateQuotaRule(@Nonnull CreateQuotaRuleOptions rule) throws ApiException
      Create a new quota rule
      Parameters:
      rule - Definition of the quota rule (required)
      Returns:
      QuotaRuleInfo
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      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 -
    • adminCreateQuotaRuleWithHttpInfo

      public ApiResponse<QuotaRuleInfo> adminCreateQuotaRuleWithHttpInfo(@Nonnull CreateQuotaRuleOptions rule) throws ApiException
      Create a new quota rule
      Parameters:
      rule - Definition of the quota rule (required)
      Returns:
      ApiResponse<QuotaRuleInfo>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      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 -
    • adminCreateQuotaRuleAsync

      public okhttp3.Call adminCreateQuotaRuleAsync(@Nonnull CreateQuotaRuleOptions rule, ApiCallback<QuotaRuleInfo> _callback) throws ApiException
      Create a new quota rule (asynchronously)
      Parameters:
      rule - Definition of the quota rule (required)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details
      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 -
    • adminCreateRepoCall

      public okhttp3.Call adminCreateRepoCall(@Nonnull String username, @Nonnull CreateRepoOption repository, ApiCallback _callback) throws ApiException
      Build call for adminCreateRepo
      Parameters:
      username - username of the user. This user will own the created repository (required)
      repository - (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details
      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 -
    • adminCreateRepo

      public Repository adminCreateRepo(@Nonnull String username, @Nonnull CreateRepoOption repository) throws ApiException
      Create a repository on behalf of a user
      Parameters:
      username - username of the user. This user will own the created repository (required)
      repository - (required)
      Returns:
      Repository
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      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 -
    • adminCreateRepoWithHttpInfo

      public ApiResponse<Repository> adminCreateRepoWithHttpInfo(@Nonnull String username, @Nonnull CreateRepoOption repository) throws ApiException
      Create a repository on behalf of a user
      Parameters:
      username - username of the user. This user will own the created repository (required)
      repository - (required)
      Returns:
      ApiResponse<Repository>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      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 -
    • adminCreateRepoAsync

      public okhttp3.Call adminCreateRepoAsync(@Nonnull String username, @Nonnull CreateRepoOption repository, ApiCallback<Repository> _callback) throws ApiException
      Create a repository on behalf of a user (asynchronously)
      Parameters:
      username - username of the user. This user will own the created repository (required)
      repository - (required)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details
      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 -
    • adminCreateUserCall

      public okhttp3.Call adminCreateUserCall(@Nullable CreateUserOption body, ApiCallback _callback) throws ApiException
      Build call for adminCreateUser
      Parameters:
      body - (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details
      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 -
    • adminCreateUser

      public User adminCreateUser(@Nullable CreateUserOption body) throws ApiException
      Create a user account
      Parameters:
      body - (optional)
      Returns:
      User
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      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 -
    • adminCreateUserWithHttpInfo

      public ApiResponse<User> adminCreateUserWithHttpInfo(@Nullable CreateUserOption body) throws ApiException
      Create a user account
      Parameters:
      body - (optional)
      Returns:
      ApiResponse<User>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      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 -
    • adminCreateUserAsync

      public okhttp3.Call adminCreateUserAsync(@Nullable CreateUserOption body, ApiCallback<User> _callback) throws ApiException
      Create a user account (asynchronously)
      Parameters:
      body - (optional)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details
      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 -
    • adminCronListCall

      public okhttp3.Call adminCronListCall(@Nullable Integer page, @Nullable Integer limit, ApiCallback _callback) throws ApiException
      Build call for adminCronList
      Parameters:
      page - page number of results to return (1-based) (optional)
      limit - page size of results (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 CronList * X-Total-Count - The total number of access tokens
      403 APIForbiddenError is a forbidden error response -
    • adminCronList

      public List<Cron> adminCronList(@Nullable Integer page, @Nullable Integer limit) throws ApiException
      List cron tasks
      Parameters:
      page - page number of results to return (1-based) (optional)
      limit - page size of results (optional)
      Returns:
      List<Cron>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 CronList * X-Total-Count - The total number of access tokens
      403 APIForbiddenError is a forbidden error response -
    • adminCronListWithHttpInfo

      public ApiResponse<List<Cron>> adminCronListWithHttpInfo(@Nullable Integer page, @Nullable Integer limit) throws ApiException
      List cron tasks
      Parameters:
      page - page number of results to return (1-based) (optional)
      limit - page size of results (optional)
      Returns:
      ApiResponse<List<Cron>>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 CronList * X-Total-Count - The total number of access tokens
      403 APIForbiddenError is a forbidden error response -
    • adminCronListAsync

      public okhttp3.Call adminCronListAsync(@Nullable Integer page, @Nullable Integer limit, ApiCallback<List<Cron>> _callback) throws ApiException
      List cron tasks (asynchronously)
      Parameters:
      page - page number of results to return (1-based) (optional)
      limit - page size of results (optional)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 CronList * X-Total-Count - The total number of access tokens
      403 APIForbiddenError is a forbidden error response -
    • adminCronRunCall

      public okhttp3.Call adminCronRunCall(@Nonnull String task, ApiCallback _callback) throws ApiException
      Build call for adminCronRun
      Parameters:
      task - task to run (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details
      Response Details
      Status Code Description Response Headers
      204 APIEmpty is an empty response -
      404 APINotFound is a not found error response -
    • adminCronRun

      public void adminCronRun(@Nonnull String task) throws ApiException
      Run cron task
      Parameters:
      task - task to run (required)
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      Response Details
      Status Code Description Response Headers
      204 APIEmpty is an empty response -
      404 APINotFound is a not found error response -
    • adminCronRunWithHttpInfo

      public ApiResponse<Void> adminCronRunWithHttpInfo(@Nonnull String task) throws ApiException
      Run cron task
      Parameters:
      task - task to run (required)
      Returns:
      ApiResponse<Void>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      Response Details
      Status Code Description Response Headers
      204 APIEmpty is an empty response -
      404 APINotFound is a not found error response -
    • adminCronRunAsync

      public okhttp3.Call adminCronRunAsync(@Nonnull String task, ApiCallback<Void> _callback) throws ApiException
      Run cron task (asynchronously)
      Parameters:
      task - task to run (required)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details
      Response Details
      Status Code Description Response Headers
      204 APIEmpty is an empty response -
      404 APINotFound is a not found error response -
    • adminDeleteHookCall

      public okhttp3.Call adminDeleteHookCall(@Nonnull Long id, ApiCallback _callback) throws ApiException
      Build call for adminDeleteHook
      Parameters:
      id - id of the hook to delete (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details
      Response Details
      Status Code Description Response Headers
      204 APIEmpty is an empty response -
    • adminDeleteHook

      public void adminDeleteHook(@Nonnull Long id) throws ApiException
      Delete a hook
      Parameters:
      id - id of the hook to delete (required)
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      Response Details
      Status Code Description Response Headers
      204 APIEmpty is an empty response -
    • adminDeleteHookWithHttpInfo

      public ApiResponse<Void> adminDeleteHookWithHttpInfo(@Nonnull Long id) throws ApiException
      Delete a hook
      Parameters:
      id - id of the hook to delete (required)
      Returns:
      ApiResponse<Void>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      Response Details
      Status Code Description Response Headers
      204 APIEmpty is an empty response -
    • adminDeleteHookAsync

      public okhttp3.Call adminDeleteHookAsync(@Nonnull Long id, ApiCallback<Void> _callback) throws ApiException
      Delete a hook (asynchronously)
      Parameters:
      id - id of the hook to delete (required)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details
      Response Details
      Status Code Description Response Headers
      204 APIEmpty is an empty response -
    • adminDeleteQuotaGroupCall

      public okhttp3.Call adminDeleteQuotaGroupCall(@Nonnull String quotagroup, ApiCallback _callback) throws ApiException
      Build call for adminDeleteQuotaGroup
      Parameters:
      quotagroup - quota group to delete (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details
      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 -
    • adminDeleteQuotaGroup

      public void adminDeleteQuotaGroup(@Nonnull String quotagroup) throws ApiException
      Delete a quota group
      Parameters:
      quotagroup - quota group to delete (required)
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      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 -
    • adminDeleteQuotaGroupWithHttpInfo

      public ApiResponse<Void> adminDeleteQuotaGroupWithHttpInfo(@Nonnull String quotagroup) throws ApiException
      Delete a quota group
      Parameters:
      quotagroup - quota group to delete (required)
      Returns:
      ApiResponse<Void>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      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 -
    • adminDeleteQuotaGroupAsync

      public okhttp3.Call adminDeleteQuotaGroupAsync(@Nonnull String quotagroup, ApiCallback<Void> _callback) throws ApiException
      Delete a quota group (asynchronously)
      Parameters:
      quotagroup - quota group to delete (required)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details
      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 -
    • adminDeleteQuotaRuleCall

      public okhttp3.Call adminDeleteQuotaRuleCall(@Nonnull String quotarule, ApiCallback _callback) throws ApiException
      Build call for adminDeleteQuotaRule
      Parameters:
      quotarule - quota rule to delete (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details
      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 -
    • adminDeleteQuotaRule

      public void adminDeleteQuotaRule(@Nonnull String quotarule) throws ApiException
      Deletes a quota rule
      Parameters:
      quotarule - quota rule to delete (required)
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      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 -
    • adminDeleteQuotaRuleWithHttpInfo

      public ApiResponse<Void> adminDeleteQuotaRuleWithHttpInfo(@Nonnull String quotarule) throws ApiException
      Deletes a quota rule
      Parameters:
      quotarule - quota rule to delete (required)
      Returns:
      ApiResponse<Void>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      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 -
    • adminDeleteQuotaRuleAsync

      public okhttp3.Call adminDeleteQuotaRuleAsync(@Nonnull String quotarule, ApiCallback<Void> _callback) throws ApiException
      Deletes a quota rule (asynchronously)
      Parameters:
      quotarule - quota rule to delete (required)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details
      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 -
    • adminDeleteUnadoptedRepositoryCall

      public okhttp3.Call adminDeleteUnadoptedRepositoryCall(@Nonnull String owner, @Nonnull String repo, ApiCallback _callback) throws ApiException
      Build call for adminDeleteUnadoptedRepository
      Parameters:
      owner - owner of the repo (required)
      repo - name of the repo (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details
      Response Details
      Status Code Description Response Headers
      204 APIEmpty is an empty response -
      403 APIForbiddenError is a forbidden error response -
    • adminDeleteUnadoptedRepository

      public void adminDeleteUnadoptedRepository(@Nonnull String owner, @Nonnull String repo) throws ApiException
      Delete unadopted files
      Parameters:
      owner - owner of the repo (required)
      repo - name of the repo (required)
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      Response Details
      Status Code Description Response Headers
      204 APIEmpty is an empty response -
      403 APIForbiddenError is a forbidden error response -
    • adminDeleteUnadoptedRepositoryWithHttpInfo

      public ApiResponse<Void> adminDeleteUnadoptedRepositoryWithHttpInfo(@Nonnull String owner, @Nonnull String repo) throws ApiException
      Delete unadopted files
      Parameters:
      owner - owner of the repo (required)
      repo - name of the repo (required)
      Returns:
      ApiResponse<Void>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      Response Details
      Status Code Description Response Headers
      204 APIEmpty is an empty response -
      403 APIForbiddenError is a forbidden error response -
    • adminDeleteUnadoptedRepositoryAsync

      public okhttp3.Call adminDeleteUnadoptedRepositoryAsync(@Nonnull String owner, @Nonnull String repo, ApiCallback<Void> _callback) throws ApiException
      Delete unadopted files (asynchronously)
      Parameters:
      owner - owner of the repo (required)
      repo - name of the repo (required)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details
      Response Details
      Status Code Description Response Headers
      204 APIEmpty is an empty response -
      403 APIForbiddenError is a forbidden error response -
    • adminDeleteUserCall

      public okhttp3.Call adminDeleteUserCall(@Nonnull String username, @Nullable Boolean purge, ApiCallback _callback) throws ApiException
      Build call for adminDeleteUser
      Parameters:
      username - username of user to delete (required)
      purge - purge the user from the system completely (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details
      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 -
    • adminDeleteUser

      public void adminDeleteUser(@Nonnull String username, @Nullable Boolean purge) throws ApiException
      Delete user account
      Parameters:
      username - username of user to delete (required)
      purge - purge the user from the system completely (optional)
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      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 -
    • adminDeleteUserWithHttpInfo

      public ApiResponse<Void> adminDeleteUserWithHttpInfo(@Nonnull String username, @Nullable Boolean purge) throws ApiException
      Delete user account
      Parameters:
      username - username of user to delete (required)
      purge - purge the user from the system completely (optional)
      Returns:
      ApiResponse<Void>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      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 -
    • adminDeleteUserAsync

      public okhttp3.Call adminDeleteUserAsync(@Nonnull String username, @Nullable Boolean purge, ApiCallback<Void> _callback) throws ApiException
      Delete user account (asynchronously)
      Parameters:
      username - username of user to delete (required)
      purge - purge the user from the system completely (optional)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details
      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 -
    • adminDeleteUserEmailsCall

      public okhttp3.Call adminDeleteUserEmailsCall(@Nonnull String username, @Nullable DeleteEmailOption body, ApiCallback _callback) throws ApiException
      Build call for adminDeleteUserEmails
      Parameters:
      username - username of user to delete email addresses from (required)
      body - (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details
      Response Details
      Status Code Description Response Headers
      204 APIEmpty is an empty response -
      403 APIForbiddenError is a forbidden error response -
      422 APIValidationError is error format response related to input validation -
    • adminDeleteUserEmails

      public void adminDeleteUserEmails(@Nonnull String username, @Nullable DeleteEmailOption body) throws ApiException
      Delete email addresses from a user's account
      Parameters:
      username - username of user to delete email addresses from (required)
      body - (optional)
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      Response Details
      Status Code Description Response Headers
      204 APIEmpty is an empty response -
      403 APIForbiddenError is a forbidden error response -
      422 APIValidationError is error format response related to input validation -
    • adminDeleteUserEmailsWithHttpInfo

      public ApiResponse<Void> adminDeleteUserEmailsWithHttpInfo(@Nonnull String username, @Nullable DeleteEmailOption body) throws ApiException
      Delete email addresses from a user's account
      Parameters:
      username - username of user to delete email addresses from (required)
      body - (optional)
      Returns:
      ApiResponse<Void>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      Response Details
      Status Code Description Response Headers
      204 APIEmpty is an empty response -
      403 APIForbiddenError is a forbidden error response -
      422 APIValidationError is error format response related to input validation -
    • adminDeleteUserEmailsAsync

      public okhttp3.Call adminDeleteUserEmailsAsync(@Nonnull String username, @Nullable DeleteEmailOption body, ApiCallback<Void> _callback) throws ApiException
      Delete email addresses from a user's account (asynchronously)
      Parameters:
      username - username of user to delete email addresses from (required)
      body - (optional)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details
      Response Details
      Status Code Description Response Headers
      204 APIEmpty is an empty response -
      403 APIForbiddenError is a forbidden error response -
      422 APIValidationError is error format response related to input validation -
    • adminDeleteUserPublicKeyCall

      public okhttp3.Call adminDeleteUserPublicKeyCall(@Nonnull String username, @Nonnull Long id, ApiCallback _callback) throws ApiException
      Build call for adminDeleteUserPublicKey
      Parameters:
      username - username of user (required)
      id - id of the key to delete (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details
      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 -
    • adminDeleteUserPublicKey

      public void adminDeleteUserPublicKey(@Nonnull String username, @Nonnull Long id) throws ApiException
      Remove a public key from user's account
      Parameters:
      username - username of user (required)
      id - id of the key to delete (required)
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      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 -
    • adminDeleteUserPublicKeyWithHttpInfo

      public ApiResponse<Void> adminDeleteUserPublicKeyWithHttpInfo(@Nonnull String username, @Nonnull Long id) throws ApiException
      Remove a public key from user's account
      Parameters:
      username - username of user (required)
      id - id of the key to delete (required)
      Returns:
      ApiResponse<Void>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      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 -
    • adminDeleteUserPublicKeyAsync

      public okhttp3.Call adminDeleteUserPublicKeyAsync(@Nonnull String username, @Nonnull Long id, ApiCallback<Void> _callback) throws ApiException
      Remove a public key from user's account (asynchronously)
      Parameters:
      username - username of user (required)
      id - id of the key to delete (required)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details
      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 -
    • adminEditHookCall

      public okhttp3.Call adminEditHookCall(@Nonnull Long id, @Nullable EditHookOption body, ApiCallback _callback) throws ApiException
      Build call for adminEditHook
      Parameters:
      id - id of the hook to update (required)
      body - (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 Hook -
    • adminEditHook

      public Hook adminEditHook(@Nonnull Long id, @Nullable EditHookOption body) throws ApiException
      Update a hook
      Parameters:
      id - id of the hook to update (required)
      body - (optional)
      Returns:
      Hook
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 Hook -
    • adminEditHookWithHttpInfo

      public ApiResponse<Hook> adminEditHookWithHttpInfo(@Nonnull Long id, @Nullable EditHookOption body) throws ApiException
      Update a hook
      Parameters:
      id - id of the hook to update (required)
      body - (optional)
      Returns:
      ApiResponse<Hook>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 Hook -
    • adminEditHookAsync

      public okhttp3.Call adminEditHookAsync(@Nonnull Long id, @Nullable EditHookOption body, ApiCallback<Hook> _callback) throws ApiException
      Update a hook (asynchronously)
      Parameters:
      id - id of the hook to update (required)
      body - (optional)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 Hook -
    • adminEditQuotaRuleCall

      public okhttp3.Call adminEditQuotaRuleCall(@Nonnull String quotarule, @Nonnull EditQuotaRuleOptions rule, ApiCallback _callback) throws ApiException
      Build call for adminEditQuotaRule
      Parameters:
      quotarule - Quota rule to change (required)
      rule - (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details
      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 -
    • adminEditQuotaRule

      public QuotaRuleInfo adminEditQuotaRule(@Nonnull String quotarule, @Nonnull EditQuotaRuleOptions rule) throws ApiException
      Change an existing quota rule
      Parameters:
      quotarule - Quota rule to change (required)
      rule - (required)
      Returns:
      QuotaRuleInfo
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      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 -
    • adminEditQuotaRuleWithHttpInfo

      public ApiResponse<QuotaRuleInfo> adminEditQuotaRuleWithHttpInfo(@Nonnull String quotarule, @Nonnull EditQuotaRuleOptions rule) throws ApiException
      Change an existing quota rule
      Parameters:
      quotarule - Quota rule to change (required)
      rule - (required)
      Returns:
      ApiResponse<QuotaRuleInfo>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      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 -
    • adminEditQuotaRuleAsync

      public okhttp3.Call adminEditQuotaRuleAsync(@Nonnull String quotarule, @Nonnull EditQuotaRuleOptions rule, ApiCallback<QuotaRuleInfo> _callback) throws ApiException
      Change an existing quota rule (asynchronously)
      Parameters:
      quotarule - Quota rule to change (required)
      rule - (required)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details
      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 -
    • adminEditUserCall

      public okhttp3.Call adminEditUserCall(@Nonnull String username, @Nullable EditUserOption body, ApiCallback _callback) throws ApiException
      Build call for adminEditUser
      Parameters:
      username - username of user to edit (required)
      body - (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details
      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 -
    • adminEditUser

      public User adminEditUser(@Nonnull String username, @Nullable EditUserOption body) throws ApiException
      Edit an existing user
      Parameters:
      username - username of user to edit (required)
      body - (optional)
      Returns:
      User
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      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 -
    • adminEditUserWithHttpInfo

      public ApiResponse<User> adminEditUserWithHttpInfo(@Nonnull String username, @Nullable EditUserOption body) throws ApiException
      Edit an existing user
      Parameters:
      username - username of user to edit (required)
      body - (optional)
      Returns:
      ApiResponse<User>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      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 -
    • adminEditUserAsync

      public okhttp3.Call adminEditUserAsync(@Nonnull String username, @Nullable EditUserOption body, ApiCallback<User> _callback) throws ApiException
      Edit an existing user (asynchronously)
      Parameters:
      username - username of user to edit (required)
      body - (optional)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details
      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 -
    • adminGetActionRunJobsCall

      public okhttp3.Call adminGetActionRunJobsCall(@Nullable String labels, ApiCallback _callback) throws ApiException
      Build call for adminGetActionRunJobs
      Parameters:
      labels - a comma separated list of labels to search for (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 RunJobList is a list of action run jobs -
      403 APIForbiddenError is a forbidden error response -
    • adminGetActionRunJobs

      public List<ActionRunJob> adminGetActionRunJobs(@Nullable String labels) throws ApiException
      Get action run jobs
      Parameters:
      labels - a comma separated list of labels to search for (optional)
      Returns:
      List<ActionRunJob>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 RunJobList is a list of action run jobs -
      403 APIForbiddenError is a forbidden error response -
    • adminGetActionRunJobsWithHttpInfo

      public ApiResponse<List<ActionRunJob>> adminGetActionRunJobsWithHttpInfo(@Nullable String labels) throws ApiException
      Get action run jobs
      Parameters:
      labels - a comma separated list of labels to search for (optional)
      Returns:
      ApiResponse<List<ActionRunJob>>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 RunJobList is a list of action run jobs -
      403 APIForbiddenError is a forbidden error response -
    • adminGetActionRunJobsAsync

      public okhttp3.Call adminGetActionRunJobsAsync(@Nullable String labels, ApiCallback<List<ActionRunJob>> _callback) throws ApiException
      Get action run jobs (asynchronously)
      Parameters:
      labels - a comma separated list of labels to search for (optional)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 RunJobList is a list of action run jobs -
      403 APIForbiddenError is a forbidden error response -
    • adminGetAllEmailsCall

      public okhttp3.Call adminGetAllEmailsCall(@Nullable Integer page, @Nullable Integer limit, ApiCallback _callback) throws ApiException
      Build call for adminGetAllEmails
      Parameters:
      page - page number of results to return (1-based) (optional)
      limit - page size of results (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 EmailList -
      403 APIForbiddenError is a forbidden error response -
    • adminGetAllEmails

      public List<Email> adminGetAllEmails(@Nullable Integer page, @Nullable Integer limit) throws ApiException
      List all users' email addresses
      Parameters:
      page - page number of results to return (1-based) (optional)
      limit - page size of results (optional)
      Returns:
      List<Email>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 EmailList -
      403 APIForbiddenError is a forbidden error response -
    • adminGetAllEmailsWithHttpInfo

      public ApiResponse<List<Email>> adminGetAllEmailsWithHttpInfo(@Nullable Integer page, @Nullable Integer limit) throws ApiException
      List all users' email addresses
      Parameters:
      page - page number of results to return (1-based) (optional)
      limit - page size of results (optional)
      Returns:
      ApiResponse<List<Email>>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 EmailList -
      403 APIForbiddenError is a forbidden error response -
    • adminGetAllEmailsAsync

      public okhttp3.Call adminGetAllEmailsAsync(@Nullable Integer page, @Nullable Integer limit, ApiCallback<List<Email>> _callback) throws ApiException
      List all users' email addresses (asynchronously)
      Parameters:
      page - page number of results to return (1-based) (optional)
      limit - page size of results (optional)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 EmailList -
      403 APIForbiddenError is a forbidden error response -
    • adminGetAllOrgsCall

      public okhttp3.Call adminGetAllOrgsCall(@Nullable Integer page, @Nullable Integer limit, ApiCallback _callback) throws ApiException
      Build call for adminGetAllOrgs
      Parameters:
      page - page number of results to return (1-based) (optional)
      limit - page size of results (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 OrganizationList * X-Total-Count - The total number of access tokens
      403 APIForbiddenError is a forbidden error response -
    • adminGetAllOrgs

      public List<Organization> adminGetAllOrgs(@Nullable Integer page, @Nullable Integer limit) throws ApiException
      List all organizations
      Parameters:
      page - page number of results to return (1-based) (optional)
      limit - page size of results (optional)
      Returns:
      List<Organization>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 OrganizationList * X-Total-Count - The total number of access tokens
      403 APIForbiddenError is a forbidden error response -
    • adminGetAllOrgsWithHttpInfo

      public ApiResponse<List<Organization>> adminGetAllOrgsWithHttpInfo(@Nullable Integer page, @Nullable Integer limit) throws ApiException
      List all organizations
      Parameters:
      page - page number of results to return (1-based) (optional)
      limit - page size of results (optional)
      Returns:
      ApiResponse<List<Organization>>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 OrganizationList * X-Total-Count - The total number of access tokens
      403 APIForbiddenError is a forbidden error response -
    • adminGetAllOrgsAsync

      public okhttp3.Call adminGetAllOrgsAsync(@Nullable Integer page, @Nullable Integer limit, ApiCallback<List<Organization>> _callback) throws ApiException
      List all organizations (asynchronously)
      Parameters:
      page - page number of results to return (1-based) (optional)
      limit - page size of results (optional)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 OrganizationList * X-Total-Count - The total number of access tokens
      403 APIForbiddenError is a forbidden error response -
    • adminGetHookCall

      public okhttp3.Call adminGetHookCall(@Nonnull Long id, ApiCallback _callback) throws ApiException
      Build call for adminGetHook
      Parameters:
      id - id of the hook to get (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 Hook -
    • adminGetHook

      public Hook adminGetHook(@Nonnull Long id) throws ApiException
      Get a hook
      Parameters:
      id - id of the hook to get (required)
      Returns:
      Hook
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 Hook -
    • adminGetHookWithHttpInfo

      public ApiResponse<Hook> adminGetHookWithHttpInfo(@Nonnull Long id) throws ApiException
      Get a hook
      Parameters:
      id - id of the hook to get (required)
      Returns:
      ApiResponse<Hook>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 Hook -
    • adminGetHookAsync

      public okhttp3.Call adminGetHookAsync(@Nonnull Long id, ApiCallback<Hook> _callback) throws ApiException
      Get a hook (asynchronously)
      Parameters:
      id - id of the hook to get (required)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 Hook -
    • adminGetQuotaGroupCall

      public okhttp3.Call adminGetQuotaGroupCall(@Nonnull String quotagroup, ApiCallback _callback) throws ApiException
      Build call for adminGetQuotaGroup
      Parameters:
      quotagroup - quota group to query (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details
      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 -
    • adminGetQuotaGroup

      public QuotaGroup adminGetQuotaGroup(@Nonnull String quotagroup) throws ApiException
      Get information about the quota group
      Parameters:
      quotagroup - quota group to query (required)
      Returns:
      QuotaGroup
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      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 -
    • adminGetQuotaGroupWithHttpInfo

      public ApiResponse<QuotaGroup> adminGetQuotaGroupWithHttpInfo(@Nonnull String quotagroup) throws ApiException
      Get information about the quota group
      Parameters:
      quotagroup - quota group to query (required)
      Returns:
      ApiResponse<QuotaGroup>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      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 -
    • adminGetQuotaGroupAsync

      public okhttp3.Call adminGetQuotaGroupAsync(@Nonnull String quotagroup, ApiCallback<QuotaGroup> _callback) throws ApiException
      Get information about the quota group (asynchronously)
      Parameters:
      quotagroup - quota group to query (required)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details
      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 -
    • adminGetQuotaRuleCall

      public okhttp3.Call adminGetQuotaRuleCall(@Nonnull String quotarule, ApiCallback _callback) throws ApiException
      Build call for adminGetQuotaRule
      Parameters:
      quotarule - quota rule to query (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details
      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 -
    • adminGetQuotaRule

      public QuotaRuleInfo adminGetQuotaRule(@Nonnull String quotarule) throws ApiException
      Get information about a quota rule
      Parameters:
      quotarule - quota rule to query (required)
      Returns:
      QuotaRuleInfo
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      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 -
    • adminGetQuotaRuleWithHttpInfo

      public ApiResponse<QuotaRuleInfo> adminGetQuotaRuleWithHttpInfo(@Nonnull String quotarule) throws ApiException
      Get information about a quota rule
      Parameters:
      quotarule - quota rule to query (required)
      Returns:
      ApiResponse<QuotaRuleInfo>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      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 -
    • adminGetQuotaRuleAsync

      public okhttp3.Call adminGetQuotaRuleAsync(@Nonnull String quotarule, ApiCallback<QuotaRuleInfo> _callback) throws ApiException
      Get information about a quota rule (asynchronously)
      Parameters:
      quotarule - quota rule to query (required)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details
      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 -
    • adminGetRegistrationTokenCall

      @Deprecated public okhttp3.Call adminGetRegistrationTokenCall(ApiCallback _callback) throws ApiException
      Deprecated.
      Build call for adminGetRegistrationToken
      Parameters:
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 RegistrationToken is a string used to register a runner with a server -
    • adminGetRegistrationToken

      @Deprecated public RegistrationToken adminGetRegistrationToken() throws ApiException
      Deprecated.
      Get a runner registration token for registering global runners This operation has been deprecated in Forgejo 15. Use the web UI or [`/admin/actions/runners`](#/admin/registerAdminRunner) instead.
      Returns:
      RegistrationToken
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 RegistrationToken is a string used to register a runner with a server -
    • adminGetRegistrationTokenWithHttpInfo

      @Deprecated public ApiResponse<RegistrationToken> adminGetRegistrationTokenWithHttpInfo() throws ApiException
      Deprecated.
      Get a runner registration token for registering global runners This operation has been deprecated in Forgejo 15. Use the web UI or [`/admin/actions/runners`](#/admin/registerAdminRunner) instead.
      Returns:
      ApiResponse<RegistrationToken>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 RegistrationToken is a string used to register a runner with a server -
    • adminGetRegistrationTokenAsync

      @Deprecated public okhttp3.Call adminGetRegistrationTokenAsync(ApiCallback<RegistrationToken> _callback) throws ApiException
      Deprecated.
      Get a runner registration token for registering global runners (asynchronously) This operation has been deprecated in Forgejo 15. Use the web UI or [`/admin/actions/runners`](#/admin/registerAdminRunner) instead.
      Parameters:
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 RegistrationToken is a string used to register a runner with a server -
    • adminGetRunnerRegistrationTokenCall

      @Deprecated public okhttp3.Call adminGetRunnerRegistrationTokenCall(ApiCallback _callback) throws ApiException
      Deprecated.
      Build call for adminGetRunnerRegistrationToken
      Parameters:
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 RegistrationToken is a string used to register a runner with a server -
    • adminGetRunnerRegistrationToken

      @Deprecated public RegistrationToken adminGetRunnerRegistrationToken() throws ApiException
      Deprecated.
      Get a runner registration token for registering global runners This operation has been deprecated in Forgejo 15. Use the web UI or [`/admin/actions/runners`](#/admin/registerAdminRunner) instead.
      Returns:
      RegistrationToken
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 RegistrationToken is a string used to register a runner with a server -
    • adminGetRunnerRegistrationTokenWithHttpInfo

      @Deprecated public ApiResponse<RegistrationToken> adminGetRunnerRegistrationTokenWithHttpInfo() throws ApiException
      Deprecated.
      Get a runner registration token for registering global runners This operation has been deprecated in Forgejo 15. Use the web UI or [`/admin/actions/runners`](#/admin/registerAdminRunner) instead.
      Returns:
      ApiResponse<RegistrationToken>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 RegistrationToken is a string used to register a runner with a server -
    • adminGetRunnerRegistrationTokenAsync

      @Deprecated public okhttp3.Call adminGetRunnerRegistrationTokenAsync(ApiCallback<RegistrationToken> _callback) throws ApiException
      Deprecated.
      Get a runner registration token for registering global runners (asynchronously) This operation has been deprecated in Forgejo 15. Use the web UI or [`/admin/actions/runners`](#/admin/registerAdminRunner) instead.
      Parameters:
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 RegistrationToken is a string used to register a runner with a server -
    • adminGetUserQuotaCall

      public okhttp3.Call adminGetUserQuotaCall(@Nonnull String username, ApiCallback _callback) throws ApiException
      Build call for adminGetUserQuota
      Parameters:
      username - username of user to query (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details
      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 -
    • adminGetUserQuota

      public QuotaInfo adminGetUserQuota(@Nonnull String username) throws ApiException
      Get the user's quota info
      Parameters:
      username - username of user to query (required)
      Returns:
      QuotaInfo
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      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 -
    • adminGetUserQuotaWithHttpInfo

      public ApiResponse<QuotaInfo> adminGetUserQuotaWithHttpInfo(@Nonnull String username) throws ApiException
      Get the user's quota info
      Parameters:
      username - username of user to query (required)
      Returns:
      ApiResponse<QuotaInfo>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      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 -
    • adminGetUserQuotaAsync

      public okhttp3.Call adminGetUserQuotaAsync(@Nonnull String username, ApiCallback<QuotaInfo> _callback) throws ApiException
      Get the user's quota info (asynchronously)
      Parameters:
      username - username of user to query (required)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details
      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 -
    • adminListHooksCall

      public okhttp3.Call adminListHooksCall(@Nullable Integer page, @Nullable Integer limit, ApiCallback _callback) throws ApiException
      Build call for adminListHooks
      Parameters:
      page - page number of results to return (1-based) (optional)
      limit - page size of results (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 HookListWithoutPagination - Hooks without pagination headers -
    • adminListHooks

      public List<Hook> adminListHooks(@Nullable Integer page, @Nullable Integer limit) throws ApiException
      List global (system) webhooks
      Parameters:
      page - page number of results to return (1-based) (optional)
      limit - page size of results (optional)
      Returns:
      List<Hook>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 HookListWithoutPagination - Hooks without pagination headers -
    • adminListHooksWithHttpInfo

      public ApiResponse<List<Hook>> adminListHooksWithHttpInfo(@Nullable Integer page, @Nullable Integer limit) throws ApiException
      List global (system) webhooks
      Parameters:
      page - page number of results to return (1-based) (optional)
      limit - page size of results (optional)
      Returns:
      ApiResponse<List<Hook>>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 HookListWithoutPagination - Hooks without pagination headers -
    • adminListHooksAsync

      public okhttp3.Call adminListHooksAsync(@Nullable Integer page, @Nullable Integer limit, ApiCallback<List<Hook>> _callback) throws ApiException
      List global (system) webhooks (asynchronously)
      Parameters:
      page - page number of results to return (1-based) (optional)
      limit - page size of results (optional)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 HookListWithoutPagination - Hooks without pagination headers -
    • adminListQuotaGroupsCall

      public okhttp3.Call adminListQuotaGroupsCall(ApiCallback _callback) throws ApiException
      Build call for adminListQuotaGroups
      Parameters:
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 QuotaGroupList -
      403 APIForbiddenError is a forbidden error response -
    • adminListQuotaGroups

      public List<QuotaGroup> adminListQuotaGroups() throws ApiException
      List the available quota groups
      Returns:
      List<QuotaGroup>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 QuotaGroupList -
      403 APIForbiddenError is a forbidden error response -
    • adminListQuotaGroupsWithHttpInfo

      public ApiResponse<List<QuotaGroup>> adminListQuotaGroupsWithHttpInfo() throws ApiException
      List the available quota groups
      Returns:
      ApiResponse<List<QuotaGroup>>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 QuotaGroupList -
      403 APIForbiddenError is a forbidden error response -
    • adminListQuotaGroupsAsync

      public okhttp3.Call adminListQuotaGroupsAsync(ApiCallback<List<QuotaGroup>> _callback) throws ApiException
      List the available quota groups (asynchronously)
      Parameters:
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 QuotaGroupList -
      403 APIForbiddenError is a forbidden error response -
    • adminListQuotaRulesCall

      public okhttp3.Call adminListQuotaRulesCall(ApiCallback _callback) throws ApiException
      Build call for adminListQuotaRules
      Parameters:
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 QuotaRuleInfoList -
      403 APIForbiddenError is a forbidden error response -
    • adminListQuotaRules

      public List<QuotaRuleInfo> adminListQuotaRules() throws ApiException
      List the available quota rules
      Returns:
      List<QuotaRuleInfo>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 QuotaRuleInfoList -
      403 APIForbiddenError is a forbidden error response -
    • adminListQuotaRulesWithHttpInfo

      public ApiResponse<List<QuotaRuleInfo>> adminListQuotaRulesWithHttpInfo() throws ApiException
      List the available quota rules
      Returns:
      ApiResponse<List<QuotaRuleInfo>>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 QuotaRuleInfoList -
      403 APIForbiddenError is a forbidden error response -
    • adminListQuotaRulesAsync

      public okhttp3.Call adminListQuotaRulesAsync(ApiCallback<List<QuotaRuleInfo>> _callback) throws ApiException
      List the available quota rules (asynchronously)
      Parameters:
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 QuotaRuleInfoList -
      403 APIForbiddenError is a forbidden error response -
    • adminListUserEmailsCall

      public okhttp3.Call adminListUserEmailsCall(@Nonnull String username, ApiCallback _callback) throws ApiException
      Build call for adminListUserEmails
      Parameters:
      username - username of user to get email addresses of (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 EmailList -
      403 APIForbiddenError is a forbidden error response -
      404 APINotFound is a not found error response -
    • adminListUserEmails

      public List<Email> adminListUserEmails(@Nonnull String username) throws ApiException
      List all email addresses for a user
      Parameters:
      username - username of user to get email addresses of (required)
      Returns:
      List<Email>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 EmailList -
      403 APIForbiddenError is a forbidden error response -
      404 APINotFound is a not found error response -
    • adminListUserEmailsWithHttpInfo

      public ApiResponse<List<Email>> adminListUserEmailsWithHttpInfo(@Nonnull String username) throws ApiException
      List all email addresses for a user
      Parameters:
      username - username of user to get email addresses of (required)
      Returns:
      ApiResponse<List<Email>>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 EmailList -
      403 APIForbiddenError is a forbidden error response -
      404 APINotFound is a not found error response -
    • adminListUserEmailsAsync

      public okhttp3.Call adminListUserEmailsAsync(@Nonnull String username, ApiCallback<List<Email>> _callback) throws ApiException
      List all email addresses for a user (asynchronously)
      Parameters:
      username - username of user to get email addresses of (required)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 EmailList -
      403 APIForbiddenError is a forbidden error response -
      404 APINotFound is a not found error response -
    • adminListUsersInQuotaGroupCall

      public okhttp3.Call adminListUsersInQuotaGroupCall(@Nonnull String quotagroup, ApiCallback _callback) throws ApiException
      Build call for adminListUsersInQuotaGroup
      Parameters:
      quotagroup - quota group to list members of (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 UserList -
      400 APIError is error format response -
      403 APIForbiddenError is a forbidden error response -
      404 APINotFound is a not found error response -
    • adminListUsersInQuotaGroup

      public List<User> adminListUsersInQuotaGroup(@Nonnull String quotagroup) throws ApiException
      List users in a quota group
      Parameters:
      quotagroup - quota group to list members of (required)
      Returns:
      List<User>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 UserList -
      400 APIError is error format response -
      403 APIForbiddenError is a forbidden error response -
      404 APINotFound is a not found error response -
    • adminListUsersInQuotaGroupWithHttpInfo

      public ApiResponse<List<User>> adminListUsersInQuotaGroupWithHttpInfo(@Nonnull String quotagroup) throws ApiException
      List users in a quota group
      Parameters:
      quotagroup - quota group to list members of (required)
      Returns:
      ApiResponse<List<User>>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 UserList -
      400 APIError is error format response -
      403 APIForbiddenError is a forbidden error response -
      404 APINotFound is a not found error response -
    • adminListUsersInQuotaGroupAsync

      public okhttp3.Call adminListUsersInQuotaGroupAsync(@Nonnull String quotagroup, ApiCallback<List<User>> _callback) throws ApiException
      List users in a quota group (asynchronously)
      Parameters:
      quotagroup - quota group to list members of (required)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 UserList -
      400 APIError is error format response -
      403 APIForbiddenError is a forbidden error response -
      404 APINotFound is a not found error response -
    • adminRemoveRuleFromQuotaGroupCall

      public okhttp3.Call adminRemoveRuleFromQuotaGroupCall(@Nonnull String quotagroup, @Nonnull String quotarule, ApiCallback _callback) throws ApiException
      Build call for adminRemoveRuleFromQuotaGroup
      Parameters:
      quotagroup - quota group to remove a rule from (required)
      quotarule - the name of the quota rule to remove from the group (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details
      Response Details
      Status Code Description Response Headers
      201 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 -
    • adminRemoveRuleFromQuotaGroup

      public void adminRemoveRuleFromQuotaGroup(@Nonnull String quotagroup, @Nonnull String quotarule) throws ApiException
      Removes a rule from a quota group
      Parameters:
      quotagroup - quota group to remove a rule from (required)
      quotarule - the name of the quota rule to remove from the group (required)
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      Response Details
      Status Code Description Response Headers
      201 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 -
    • adminRemoveRuleFromQuotaGroupWithHttpInfo

      public ApiResponse<Void> adminRemoveRuleFromQuotaGroupWithHttpInfo(@Nonnull String quotagroup, @Nonnull String quotarule) throws ApiException
      Removes a rule from a quota group
      Parameters:
      quotagroup - quota group to remove a rule from (required)
      quotarule - the name of the quota rule to remove from the group (required)
      Returns:
      ApiResponse<Void>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      Response Details
      Status Code Description Response Headers
      201 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 -
    • adminRemoveRuleFromQuotaGroupAsync

      public okhttp3.Call adminRemoveRuleFromQuotaGroupAsync(@Nonnull String quotagroup, @Nonnull String quotarule, ApiCallback<Void> _callback) throws ApiException
      Removes a rule from a quota group (asynchronously)
      Parameters:
      quotagroup - quota group to remove a rule from (required)
      quotarule - the name of the quota rule to remove from the group (required)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details
      Response Details
      Status Code Description Response Headers
      201 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 -
    • adminRemoveUserFromQuotaGroupCall

      public okhttp3.Call adminRemoveUserFromQuotaGroupCall(@Nonnull String quotagroup, @Nonnull String username, ApiCallback _callback) throws ApiException
      Build call for adminRemoveUserFromQuotaGroup
      Parameters:
      quotagroup - quota group to remove a user from (required)
      username - username of the user to remove from the quota group (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details
      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 -
    • adminRemoveUserFromQuotaGroup

      public void adminRemoveUserFromQuotaGroup(@Nonnull String quotagroup, @Nonnull String username) throws ApiException
      Remove a user from a quota group
      Parameters:
      quotagroup - quota group to remove a user from (required)
      username - username of the user to remove from the quota group (required)
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      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 -
    • adminRemoveUserFromQuotaGroupWithHttpInfo

      public ApiResponse<Void> adminRemoveUserFromQuotaGroupWithHttpInfo(@Nonnull String quotagroup, @Nonnull String username) throws ApiException
      Remove a user from a quota group
      Parameters:
      quotagroup - quota group to remove a user from (required)
      username - username of the user to remove from the quota group (required)
      Returns:
      ApiResponse<Void>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      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 -
    • adminRemoveUserFromQuotaGroupAsync

      public okhttp3.Call adminRemoveUserFromQuotaGroupAsync(@Nonnull String quotagroup, @Nonnull String username, ApiCallback<Void> _callback) throws ApiException
      Remove a user from a quota group (asynchronously)
      Parameters:
      quotagroup - quota group to remove a user from (required)
      username - username of the user to remove from the quota group (required)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details
      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 -
    • adminRenameUserCall

      public okhttp3.Call adminRenameUserCall(@Nonnull String username, @Nonnull RenameUserOption body, ApiCallback _callback) throws ApiException
      Build call for adminRenameUser
      Parameters:
      username - existing username of user (required)
      body - (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details
      Response Details
      Status Code Description Response Headers
      204 APIEmpty is an empty response -
      403 APIForbiddenError is a forbidden error response -
      422 APIValidationError is error format response related to input validation -
    • adminRenameUser

      public void adminRenameUser(@Nonnull String username, @Nonnull RenameUserOption body) throws ApiException
      Rename a user
      Parameters:
      username - existing username of user (required)
      body - (required)
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      Response Details
      Status Code Description Response Headers
      204 APIEmpty is an empty response -
      403 APIForbiddenError is a forbidden error response -
      422 APIValidationError is error format response related to input validation -
    • adminRenameUserWithHttpInfo

      public ApiResponse<Void> adminRenameUserWithHttpInfo(@Nonnull String username, @Nonnull RenameUserOption body) throws ApiException
      Rename a user
      Parameters:
      username - existing username of user (required)
      body - (required)
      Returns:
      ApiResponse<Void>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      Response Details
      Status Code Description Response Headers
      204 APIEmpty is an empty response -
      403 APIForbiddenError is a forbidden error response -
      422 APIValidationError is error format response related to input validation -
    • adminRenameUserAsync

      public okhttp3.Call adminRenameUserAsync(@Nonnull String username, @Nonnull RenameUserOption body, ApiCallback<Void> _callback) throws ApiException
      Rename a user (asynchronously)
      Parameters:
      username - existing username of user (required)
      body - (required)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details
      Response Details
      Status Code Description Response Headers
      204 APIEmpty is an empty response -
      403 APIForbiddenError is a forbidden error response -
      422 APIValidationError is error format response related to input validation -
    • adminSearchEmailsCall

      public okhttp3.Call adminSearchEmailsCall(@Nullable String q, @Nullable Integer page, @Nullable Integer limit, ApiCallback _callback) throws ApiException
      Build call for adminSearchEmails
      Parameters:
      q - keyword (optional)
      page - page number of results to return (1-based) (optional)
      limit - page size of results (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 EmailList -
      403 APIForbiddenError is a forbidden error response -
    • adminSearchEmails

      public List<Email> adminSearchEmails(@Nullable String q, @Nullable Integer page, @Nullable Integer limit) throws ApiException
      Search users' email addresses
      Parameters:
      q - keyword (optional)
      page - page number of results to return (1-based) (optional)
      limit - page size of results (optional)
      Returns:
      List<Email>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 EmailList -
      403 APIForbiddenError is a forbidden error response -
    • adminSearchEmailsWithHttpInfo

      public ApiResponse<List<Email>> adminSearchEmailsWithHttpInfo(@Nullable String q, @Nullable Integer page, @Nullable Integer limit) throws ApiException
      Search users' email addresses
      Parameters:
      q - keyword (optional)
      page - page number of results to return (1-based) (optional)
      limit - page size of results (optional)
      Returns:
      ApiResponse<List<Email>>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 EmailList -
      403 APIForbiddenError is a forbidden error response -
    • adminSearchEmailsAsync

      public okhttp3.Call adminSearchEmailsAsync(@Nullable String q, @Nullable Integer page, @Nullable Integer limit, ApiCallback<List<Email>> _callback) throws ApiException
      Search users' email addresses (asynchronously)
      Parameters:
      q - keyword (optional)
      page - page number of results to return (1-based) (optional)
      limit - page size of results (optional)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 EmailList -
      403 APIForbiddenError is a forbidden error response -
    • adminSearchRunJobsCall

      @Deprecated public okhttp3.Call adminSearchRunJobsCall(@Nullable String labels, ApiCallback _callback) throws ApiException
      Deprecated.
      Build call for adminSearchRunJobs
      Parameters:
      labels - a comma separated list of run job labels to search for (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 RunJobList is a list of action run jobs -
      403 APIForbiddenError is a forbidden error response -
    • adminSearchRunJobs

      @Deprecated public List<ActionRunJob> adminSearchRunJobs(@Nullable String labels) throws ApiException
      Deprecated.
      Search action jobs according to filter conditions This operation has been deprecated in Forgejo 15. Use [`/admin/actions/runners/jobs`](#/admin/adminGetActionRunJobs) instead.
      Parameters:
      labels - a comma separated list of run job labels to search for (optional)
      Returns:
      List<ActionRunJob>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 RunJobList is a list of action run jobs -
      403 APIForbiddenError is a forbidden error response -
    • adminSearchRunJobsWithHttpInfo

      @Deprecated public ApiResponse<List<ActionRunJob>> adminSearchRunJobsWithHttpInfo(@Nullable String labels) throws ApiException
      Deprecated.
      Search action jobs according to filter conditions This operation has been deprecated in Forgejo 15. Use [`/admin/actions/runners/jobs`](#/admin/adminGetActionRunJobs) instead.
      Parameters:
      labels - a comma separated list of run job labels to search for (optional)
      Returns:
      ApiResponse<List<ActionRunJob>>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 RunJobList is a list of action run jobs -
      403 APIForbiddenError is a forbidden error response -
    • adminSearchRunJobsAsync

      @Deprecated public okhttp3.Call adminSearchRunJobsAsync(@Nullable String labels, ApiCallback<List<ActionRunJob>> _callback) throws ApiException
      Deprecated.
      Search action jobs according to filter conditions (asynchronously) This operation has been deprecated in Forgejo 15. Use [`/admin/actions/runners/jobs`](#/admin/adminGetActionRunJobs) instead.
      Parameters:
      labels - a comma separated list of run job labels to search for (optional)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 RunJobList is a list of action run jobs -
      403 APIForbiddenError is a forbidden error response -
    • adminSearchUsersCall

      public okhttp3.Call adminSearchUsersCall(@Nullable Long sourceId, @Nullable String loginName, @Nullable String sort, @Nullable Integer page, @Nullable Integer limit, ApiCallback _callback) throws ApiException
      Build call for adminSearchUsers
      Parameters:
      sourceId - ID of the user's login source to search for (optional)
      loginName - user's login name to search for (optional)
      sort - sort order of results (optional)
      page - page number of results to return (1-based) (optional)
      limit - page size of results (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 UserList -
      403 APIForbiddenError is a forbidden error response -
    • adminSearchUsers

      public List<User> adminSearchUsers(@Nullable Long sourceId, @Nullable String loginName, @Nullable String sort, @Nullable Integer page, @Nullable Integer limit) throws ApiException
      Search users according filter conditions
      Parameters:
      sourceId - ID of the user's login source to search for (optional)
      loginName - user's login name to search for (optional)
      sort - sort order of results (optional)
      page - page number of results to return (1-based) (optional)
      limit - page size of results (optional)
      Returns:
      List<User>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 UserList -
      403 APIForbiddenError is a forbidden error response -
    • adminSearchUsersWithHttpInfo

      public ApiResponse<List<User>> adminSearchUsersWithHttpInfo(@Nullable Long sourceId, @Nullable String loginName, @Nullable String sort, @Nullable Integer page, @Nullable Integer limit) throws ApiException
      Search users according filter conditions
      Parameters:
      sourceId - ID of the user's login source to search for (optional)
      loginName - user's login name to search for (optional)
      sort - sort order of results (optional)
      page - page number of results to return (1-based) (optional)
      limit - page size of results (optional)
      Returns:
      ApiResponse<List<User>>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 UserList -
      403 APIForbiddenError is a forbidden error response -
    • adminSearchUsersAsync

      public okhttp3.Call adminSearchUsersAsync(@Nullable Long sourceId, @Nullable String loginName, @Nullable String sort, @Nullable Integer page, @Nullable Integer limit, ApiCallback<List<User>> _callback) throws ApiException
      Search users according filter conditions (asynchronously)
      Parameters:
      sourceId - ID of the user's login source to search for (optional)
      loginName - user's login name to search for (optional)
      sort - sort order of results (optional)
      page - page number of results to return (1-based) (optional)
      limit - page size of results (optional)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 UserList -
      403 APIForbiddenError is a forbidden error response -
    • adminSetUserQuotaGroupsCall

      public okhttp3.Call adminSetUserQuotaGroupsCall(@Nonnull String username, @Nonnull SetUserQuotaGroupsOptions groups, ApiCallback _callback) throws ApiException
      Build call for adminSetUserQuotaGroups
      Parameters:
      username - username of the user to modify the quota groups from (required)
      groups - list of groups that the user should be a member of (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details
      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 -
      422 APIValidationError is error format response related to input validation -
    • adminSetUserQuotaGroups

      public void adminSetUserQuotaGroups(@Nonnull String username, @Nonnull SetUserQuotaGroupsOptions groups) throws ApiException
      Set the user's quota groups to a given list.
      Parameters:
      username - username of the user to modify the quota groups from (required)
      groups - list of groups that the user should be a member of (required)
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      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 -
      422 APIValidationError is error format response related to input validation -
    • adminSetUserQuotaGroupsWithHttpInfo

      public ApiResponse<Void> adminSetUserQuotaGroupsWithHttpInfo(@Nonnull String username, @Nonnull SetUserQuotaGroupsOptions groups) throws ApiException
      Set the user's quota groups to a given list.
      Parameters:
      username - username of the user to modify the quota groups from (required)
      groups - list of groups that the user should be a member of (required)
      Returns:
      ApiResponse<Void>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      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 -
      422 APIValidationError is error format response related to input validation -
    • adminSetUserQuotaGroupsAsync

      public okhttp3.Call adminSetUserQuotaGroupsAsync(@Nonnull String username, @Nonnull SetUserQuotaGroupsOptions groups, ApiCallback<Void> _callback) throws ApiException
      Set the user's quota groups to a given list. (asynchronously)
      Parameters:
      username - username of the user to modify the quota groups from (required)
      groups - list of groups that the user should be a member of (required)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details
      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 -
      422 APIValidationError is error format response related to input validation -
    • adminUnadoptedListCall

      public okhttp3.Call adminUnadoptedListCall(@Nullable Integer page, @Nullable Integer limit, @Nullable String pattern, ApiCallback _callback) throws ApiException
      Build call for adminUnadoptedList
      Parameters:
      page - page number of results to return (1-based) (optional)
      limit - page size of results (optional)
      pattern - pattern of repositories to search for (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 StringSlice -
      403 APIForbiddenError is a forbidden error response -
    • adminUnadoptedList

      public List<String> adminUnadoptedList(@Nullable Integer page, @Nullable Integer limit, @Nullable String pattern) throws ApiException
      List unadopted repositories
      Parameters:
      page - page number of results to return (1-based) (optional)
      limit - page size of results (optional)
      pattern - pattern of repositories to search for (optional)
      Returns:
      List<String>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 StringSlice -
      403 APIForbiddenError is a forbidden error response -
    • adminUnadoptedListWithHttpInfo

      public ApiResponse<List<String>> adminUnadoptedListWithHttpInfo(@Nullable Integer page, @Nullable Integer limit, @Nullable String pattern) throws ApiException
      List unadopted repositories
      Parameters:
      page - page number of results to return (1-based) (optional)
      limit - page size of results (optional)
      pattern - pattern of repositories to search for (optional)
      Returns:
      ApiResponse<List<String>>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 StringSlice -
      403 APIForbiddenError is a forbidden error response -
    • adminUnadoptedListAsync

      public okhttp3.Call adminUnadoptedListAsync(@Nullable Integer page, @Nullable Integer limit, @Nullable String pattern, ApiCallback<List<String>> _callback) throws ApiException
      List unadopted repositories (asynchronously)
      Parameters:
      page - page number of results to return (1-based) (optional)
      limit - page size of results (optional)
      pattern - pattern of repositories to search for (optional)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 StringSlice -
      403 APIForbiddenError is a forbidden error response -
    • deleteAdminRunnerCall

      public okhttp3.Call deleteAdminRunnerCall(@Nonnull String runnerId, ApiCallback _callback) throws ApiException
      Build call for deleteAdminRunner
      Parameters:
      runnerId - ID of the runner (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details
      Response Details
      Status Code Description Response Headers
      204 runner has been deleted -
      400 APIError is error format response -
      404 APINotFound is a not found error response -
    • deleteAdminRunner

      public void deleteAdminRunner(@Nonnull String runnerId) throws ApiException
      Delete a particular runner, no matter whether it is a global runner or scoped to an organization, user, or repository
      Parameters:
      runnerId - ID of the runner (required)
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      Response Details
      Status Code Description Response Headers
      204 runner has been deleted -
      400 APIError is error format response -
      404 APINotFound is a not found error response -
    • deleteAdminRunnerWithHttpInfo

      public ApiResponse<Void> deleteAdminRunnerWithHttpInfo(@Nonnull String runnerId) throws ApiException
      Delete a particular runner, no matter whether it is a global runner or scoped to an organization, user, or repository
      Parameters:
      runnerId - ID of the runner (required)
      Returns:
      ApiResponse<Void>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      Response Details
      Status Code Description Response Headers
      204 runner has been deleted -
      400 APIError is error format response -
      404 APINotFound is a not found error response -
    • deleteAdminRunnerAsync

      public okhttp3.Call deleteAdminRunnerAsync(@Nonnull String runnerId, ApiCallback<Void> _callback) throws ApiException
      Delete a particular runner, no matter whether it is a global runner or scoped to an organization, user, or repository (asynchronously)
      Parameters:
      runnerId - ID of the runner (required)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details
      Response Details
      Status Code Description Response Headers
      204 runner has been deleted -
      400 APIError is error format response -
      404 APINotFound is a not found error response -
    • getAdminRunnerCall

      public okhttp3.Call getAdminRunnerCall(@Nonnull String runnerId, ApiCallback _callback) throws ApiException
      Build call for getAdminRunner
      Parameters:
      runnerId - ID of the runner (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 ActionRunner represents a runner -
      400 APIError is error format response -
      404 APINotFound is a not found error response -
    • getAdminRunner

      public ActionRunner getAdminRunner(@Nonnull String runnerId) throws ApiException
      Get a particular runner, no matter whether it is a global runner or scoped to an organization, user, or repository
      Parameters:
      runnerId - ID of the runner (required)
      Returns:
      ActionRunner
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 ActionRunner represents a runner -
      400 APIError is error format response -
      404 APINotFound is a not found error response -
    • getAdminRunnerWithHttpInfo

      public ApiResponse<ActionRunner> getAdminRunnerWithHttpInfo(@Nonnull String runnerId) throws ApiException
      Get a particular runner, no matter whether it is a global runner or scoped to an organization, user, or repository
      Parameters:
      runnerId - ID of the runner (required)
      Returns:
      ApiResponse<ActionRunner>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 ActionRunner represents a runner -
      400 APIError is error format response -
      404 APINotFound is a not found error response -
    • getAdminRunnerAsync

      public okhttp3.Call getAdminRunnerAsync(@Nonnull String runnerId, ApiCallback<ActionRunner> _callback) throws ApiException
      Get a particular runner, no matter whether it is a global runner or scoped to an organization, user, or repository (asynchronously)
      Parameters:
      runnerId - ID of the runner (required)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 ActionRunner represents a runner -
      400 APIError is error format response -
      404 APINotFound is a not found error response -
    • getAdminRunnersCall

      public okhttp3.Call getAdminRunnersCall(@Nullable Boolean visible, @Nullable Integer page, @Nullable Integer limit, ApiCallback _callback) throws ApiException
      Build call for getAdminRunners
      Parameters:
      visible - whether to include all visible runners (true) or only those that are directly owned by the instance (false) (optional)
      page - page number of results to return (1-based) (optional)
      limit - page size of results (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 ActionRunnerList is a list of Forgejo Action runners * X-Total-Count - The total number of access tokens
      * Link - Links to other pages, if any
      400 APIError is error format response -
      404 APINotFound is a not found error response -
    • getAdminRunners

      public List<ActionRunner> getAdminRunners(@Nullable Boolean visible, @Nullable Integer page, @Nullable Integer limit) throws ApiException
      Get all runners, no matter whether they are global runners or scoped to an organization, user, or repository
      Parameters:
      visible - whether to include all visible runners (true) or only those that are directly owned by the instance (false) (optional)
      page - page number of results to return (1-based) (optional)
      limit - page size of results (optional)
      Returns:
      List<ActionRunner>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 ActionRunnerList is a list of Forgejo Action runners * X-Total-Count - The total number of access tokens
      * Link - Links to other pages, if any
      400 APIError is error format response -
      404 APINotFound is a not found error response -
    • getAdminRunnersWithHttpInfo

      public ApiResponse<List<ActionRunner>> getAdminRunnersWithHttpInfo(@Nullable Boolean visible, @Nullable Integer page, @Nullable Integer limit) throws ApiException
      Get all runners, no matter whether they are global runners or scoped to an organization, user, or repository
      Parameters:
      visible - whether to include all visible runners (true) or only those that are directly owned by the instance (false) (optional)
      page - page number of results to return (1-based) (optional)
      limit - page size of results (optional)
      Returns:
      ApiResponse<List<ActionRunner>>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 ActionRunnerList is a list of Forgejo Action runners * X-Total-Count - The total number of access tokens
      * Link - Links to other pages, if any
      400 APIError is error format response -
      404 APINotFound is a not found error response -
    • getAdminRunnersAsync

      public okhttp3.Call getAdminRunnersAsync(@Nullable Boolean visible, @Nullable Integer page, @Nullable Integer limit, ApiCallback<List<ActionRunner>> _callback) throws ApiException
      Get all runners, no matter whether they are global runners or scoped to an organization, user, or repository (asynchronously)
      Parameters:
      visible - whether to include all visible runners (true) or only those that are directly owned by the instance (false) (optional)
      page - page number of results to return (1-based) (optional)
      limit - page size of results (optional)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 ActionRunnerList is a list of Forgejo Action runners * X-Total-Count - The total number of access tokens
      * Link - Links to other pages, if any
      400 APIError is error format response -
      404 APINotFound is a not found error response -
    • registerAdminRunnerCall

      public okhttp3.Call registerAdminRunnerCall(@Nullable RegisterRunnerOptions body, ApiCallback _callback) throws ApiException
      Build call for registerAdminRunner
      Parameters:
      body - (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details
      Response Details
      Status Code Description Response Headers
      201 RegisterRunnerResponse contains the details of the just registered runner. -
      400 APIError is error format response -
      401 APIUnauthorizedError is a unauthorized error response -
      404 APINotFound is a not found error response -
    • registerAdminRunner

      public RegisterRunnerResponse registerAdminRunner(@Nullable RegisterRunnerOptions body) throws ApiException
      Register a new global runner
      Parameters:
      body - (optional)
      Returns:
      RegisterRunnerResponse
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      Response Details
      Status Code Description Response Headers
      201 RegisterRunnerResponse contains the details of the just registered runner. -
      400 APIError is error format response -
      401 APIUnauthorizedError is a unauthorized error response -
      404 APINotFound is a not found error response -
    • registerAdminRunnerWithHttpInfo

      public ApiResponse<RegisterRunnerResponse> registerAdminRunnerWithHttpInfo(@Nullable RegisterRunnerOptions body) throws ApiException
      Register a new global runner
      Parameters:
      body - (optional)
      Returns:
      ApiResponse<RegisterRunnerResponse>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      Response Details
      Status Code Description Response Headers
      201 RegisterRunnerResponse contains the details of the just registered runner. -
      400 APIError is error format response -
      401 APIUnauthorizedError is a unauthorized error response -
      404 APINotFound is a not found error response -
    • registerAdminRunnerAsync

      public okhttp3.Call registerAdminRunnerAsync(@Nullable RegisterRunnerOptions body, ApiCallback<RegisterRunnerResponse> _callback) throws ApiException
      Register a new global runner (asynchronously)
      Parameters:
      body - (optional)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details
      Response Details
      Status Code Description Response Headers
      201 RegisterRunnerResponse contains the details of the just registered runner. -
      400 APIError is error format response -
      401 APIUnauthorizedError is a unauthorized error response -
      404 APINotFound is a not found error response -