Package org.openapitools.client.api

Class UserApi

  • public class UserApi
extends Object

    • Constructor Detail

      • UserApi

        public UserApi()

      • UserApi

        public UserApi​(ApiClient apiClient)

    • Method Detail

      • 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)

      • deleteUserApiKeyCall

        public okhttp3.Call deleteUserApiKeyCall​(DeleteUserApiKeyRequest deleteUserApiKeyRequest,
                                         ApiCallback _callback)
                                  throws ApiException
        Build call for deleteUserApiKey
        Parameters:
        deleteUserApiKeyRequest - JSON request payload to delete a user api key (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        Http Response Details:
        Status Code Description Response Headers
        200 JSON body representing the api_key for the user -
        400 Service error relating to creating api_key for the user -

      • deleteUserApiKey

        public List<ApiKeyDTO> deleteUserApiKey​(DeleteUserApiKeyRequest deleteUserApiKeyRequest)
                                 throws ApiException
        Delete User Api Key Delete User Api Key Delete an api key for the auth'ed user.
        Parameters:
        deleteUserApiKeyRequest - JSON request payload to delete a user api key (required)
        Returns:
        List<ApiKeyDTO>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 JSON body representing the api_key for the user -
        400 Service error relating to creating api_key for the user -

      • deleteUserApiKeyWithHttpInfo

        public ApiResponse<List<ApiKeyDTO>> deleteUserApiKeyWithHttpInfo​(@NotNull
                                                                 @NotNull DeleteUserApiKeyRequest deleteUserApiKeyRequest)
                                                          throws ApiException
        Delete User Api Key Delete User Api Key Delete an api key for the auth'ed user.
        Parameters:
        deleteUserApiKeyRequest - JSON request payload to delete a user api key (required)
        Returns:
        ApiResponse<List<ApiKeyDTO>>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 JSON body representing the api_key for the user -
        400 Service error relating to creating api_key for the user -

      • deleteUserApiKeyAsync

        public okhttp3.Call deleteUserApiKeyAsync​(DeleteUserApiKeyRequest deleteUserApiKeyRequest,
                                          ApiCallback<List<ApiKeyDTO>> _callback)
                                   throws ApiException
        Delete User Api Key (asynchronously) Delete User Api Key Delete an api key for the auth'ed user.
        Parameters:
        deleteUserApiKeyRequest - JSON request payload to delete a user api key (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:
        Status Code Description Response Headers
        200 JSON body representing the api_key for the user -
        400 Service error relating to creating api_key for the user -

      • setUserApiKeyCall

        public okhttp3.Call setUserApiKeyCall​(SetUserApiKeyRequest setUserApiKeyRequest,
                                      ApiCallback _callback)
                               throws ApiException
        Build call for setUserApiKey
        Parameters:
        setUserApiKeyRequest - JSON request payload to create a new user api key (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        Http Response Details:
        Status Code Description Response Headers
        200 JSON body representing the api_key for the user -
        400 Service error relating to creating api_key for the user -

      • setUserApiKey

        public SetUserApiKeyResponse setUserApiKey​(SetUserApiKeyRequest setUserApiKeyRequest)
                                    throws ApiException
        Set User Api Key Set User Api Key Create a new api key for the auth'ed user. Successful response will contain the newly created api key. If a write role is assigned the api key will have permission level of the auth'ed user who calls this endpoint.
        Parameters:
        setUserApiKeyRequest - JSON request payload to create a new user api key (required)
        Returns:
        SetUserApiKeyResponse
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 JSON body representing the api_key for the user -
        400 Service error relating to creating api_key for the user -

      • setUserApiKeyWithHttpInfo

        public ApiResponse<SetUserApiKeyResponse> setUserApiKeyWithHttpInfo​(@NotNull
                                                                    @NotNull SetUserApiKeyRequest setUserApiKeyRequest)
                                                             throws ApiException
        Set User Api Key Set User Api Key Create a new api key for the auth'ed user. Successful response will contain the newly created api key. If a write role is assigned the api key will have permission level of the auth'ed user who calls this endpoint.
        Parameters:
        setUserApiKeyRequest - JSON request payload to create a new user api key (required)
        Returns:
        ApiResponse<SetUserApiKeyResponse>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 JSON body representing the api_key for the user -
        400 Service error relating to creating api_key for the user -

      • setUserApiKeyAsync

        public okhttp3.Call setUserApiKeyAsync​(SetUserApiKeyRequest setUserApiKeyRequest,
                                       ApiCallback<SetUserApiKeyResponse> _callback)
                                throws ApiException
        Set User Api Key (asynchronously) Set User Api Key Create a new api key for the auth'ed user. Successful response will contain the newly created api key. If a write role is assigned the api key will have permission level of the auth'ed user who calls this endpoint.
        Parameters:
        setUserApiKeyRequest - JSON request payload to create a new user api key (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:
        Status Code Description Response Headers
        200 JSON body representing the api_key for the user -
        400 Service error relating to creating api_key for the user -

      • updateUserCall

        public okhttp3.Call updateUserCall​(UpdateUserData updateUserData,
                                   ApiCallback _callback)
                            throws ApiException
        Build call for updateUser
        Parameters:
        updateUserData - JSON request payload to update user information for the auth'ed user (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        Http Response Details:
        Status Code Description Response Headers
        200 JSON body representing the updated user information -
        400 Service error relating to updating the user -

      • updateUser

        public SlimUser updateUser​(UpdateUserData updateUserData)
                    throws ApiException
        Update User Update User Update a user's information. If the user_id is not provided, the auth'ed user will be updated. If the user_id is provided, the auth'ed user must be an admin (1) or owner (2) of the organization.
        Parameters:
        updateUserData - JSON request payload to update user information for the auth'ed user (required)
        Returns:
        SlimUser
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 JSON body representing the updated user information -
        400 Service error relating to updating the user -

      • updateUserWithHttpInfo

        public ApiResponse<SlimUser> updateUserWithHttpInfo​(@NotNull
                                                    @NotNull UpdateUserData updateUserData)
                                             throws ApiException
        Update User Update User Update a user's information. If the user_id is not provided, the auth'ed user will be updated. If the user_id is provided, the auth'ed user must be an admin (1) or owner (2) of the organization.
        Parameters:
        updateUserData - JSON request payload to update user information for the auth'ed user (required)
        Returns:
        ApiResponse<SlimUser>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 JSON body representing the updated user information -
        400 Service error relating to updating the user -

      • updateUserAsync

        public okhttp3.Call updateUserAsync​(UpdateUserData updateUserData,
                                    ApiCallback<SlimUser> _callback)
                             throws ApiException
        Update User (asynchronously) Update User Update a user's information. If the user_id is not provided, the auth'ed user will be updated. If the user_id is provided, the auth'ed user must be an admin (1) or owner (2) of the organization.
        Parameters:
        updateUserData - JSON request payload to update user information for the auth'ed user (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:
        Status Code Description Response Headers
        200 JSON body representing the updated user information -
        400 Service error relating to updating the user -