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)

      • availableOperationsCall

        public okhttp3.Call availableOperationsCall​(ApiCallback _callback)
                                     throws ApiException
        Build call for availableOperations
        Parameters:
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • availableOperations

        public ResourceOptionsDto availableOperations()
                                       throws ApiException
        Options The `/user` resource supports two custom `OPTIONS` requests, one for the resource as such and one for individual user instances. The `OPTIONS` request allows checking for the set of available operations that the currently authenticated user can perform on the /user resource. If the user can perform an operation or not may depend on various things, including the user's authorizations to interact with this resource and the internal configuration of the process engine. `OPTIONS /user` returns available interactions on the resource.
        Returns:
        ResourceOptionsDto
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • availableOperationsWithHttpInfo

        public ApiResponse<ResourceOptionsDto> availableOperationsWithHttpInfo()
                                                                throws ApiException
        Options The `/user` resource supports two custom `OPTIONS` requests, one for the resource as such and one for individual user instances. The `OPTIONS` request allows checking for the set of available operations that the currently authenticated user can perform on the /user resource. If the user can perform an operation or not may depend on various things, including the user's authorizations to interact with this resource and the internal configuration of the process engine. `OPTIONS /user` returns available interactions on the resource.
        Returns:
        ApiResponse<ResourceOptionsDto>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • availableOperationsAsync

        public okhttp3.Call availableOperationsAsync​(ApiCallback<ResourceOptionsDto> _callback)
                                      throws ApiException
        Options (asynchronously) The `/user` resource supports two custom `OPTIONS` requests, one for the resource as such and one for individual user instances. The `OPTIONS` request allows checking for the set of available operations that the currently authenticated user can perform on the /user resource. If the user can perform an operation or not may depend on various things, including the user's authorizations to interact with this resource and the internal configuration of the process engine. `OPTIONS /user` returns available interactions on the resource.
        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

      • availableUserOperationsCall

        public okhttp3.Call availableUserOperationsCall​(String id,
                                                ApiCallback _callback)
                                         throws ApiException
        Build call for availableUserOperations
        Parameters:
        id - The id of the user to be deleted. (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • availableUserOperations

        public ResourceOptionsDto availableUserOperations​(String id)
                                           throws ApiException
        Options The `/user` resource supports two custom `OPTIONS` requests, one for the resource as such and one for individual user instances. The `OPTIONS` request allows checking for the set of available operations that the currently authenticated user can perform on the /user resource. If the user can perform an operation or not may depend on various things, including the user's authorizations to interact with this resource and the internal configuration of the process engine. `OPTIONS /user/{id}` returns available interactions on a resource instance.
        Parameters:
        id - The id of the user to be deleted. (required)
        Returns:
        ResourceOptionsDto
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • availableUserOperationsWithHttpInfo

        public ApiResponse<ResourceOptionsDto> availableUserOperationsWithHttpInfo​(String id)
                                                                    throws ApiException
        Options The `/user` resource supports two custom `OPTIONS` requests, one for the resource as such and one for individual user instances. The `OPTIONS` request allows checking for the set of available operations that the currently authenticated user can perform on the /user resource. If the user can perform an operation or not may depend on various things, including the user's authorizations to interact with this resource and the internal configuration of the process engine. `OPTIONS /user/{id}` returns available interactions on a resource instance.
        Parameters:
        id - The id of the user to be deleted. (required)
        Returns:
        ApiResponse<ResourceOptionsDto>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • availableUserOperationsAsync

        public okhttp3.Call availableUserOperationsAsync​(String id,
                                                 ApiCallback<ResourceOptionsDto> _callback)
                                          throws ApiException
        Options (asynchronously) The `/user` resource supports two custom `OPTIONS` requests, one for the resource as such and one for individual user instances. The `OPTIONS` request allows checking for the set of available operations that the currently authenticated user can perform on the /user resource. If the user can perform an operation or not may depend on various things, including the user's authorizations to interact with this resource and the internal configuration of the process engine. `OPTIONS /user/{id}` returns available interactions on a resource instance.
        Parameters:
        id - The id of the user to be deleted. (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

      • createUserCall

        public okhttp3.Call createUserCall​(UserDto userDto,
                                   ApiCallback _callback)
                            throws ApiException
        Build call for createUser
        Parameters:
        userDto - (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • createUser

        public void createUser​(UserDto userDto)
                throws ApiException
        Create Create a new user.
        Parameters:
        userDto - (optional)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • createUserWithHttpInfo

        public ApiResponse<Void> createUserWithHttpInfo​(UserDto userDto)
                                         throws ApiException
        Create Create a new user.
        Parameters:
        userDto - (optional)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • createUserAsync

        public okhttp3.Call createUserAsync​(UserDto userDto,
                                    ApiCallback<Void> _callback)
                             throws ApiException
        Create (asynchronously) Create a new user.
        Parameters:
        userDto - (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

      • deleteUserCall

        public okhttp3.Call deleteUserCall​(String id,
                                   ApiCallback _callback)
                            throws ApiException
        Build call for deleteUser
        Parameters:
        id - The id of the user to be deleted. (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • deleteUser

        public void deleteUser​(String id)
                throws ApiException
        Delete Deletes a user by id.
        Parameters:
        id - The id of the user to be deleted. (required)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • deleteUserWithHttpInfo

        public ApiResponse<Void> deleteUserWithHttpInfo​(String id)
                                         throws ApiException
        Delete Deletes a user by id.
        Parameters:
        id - The id of the user to be deleted. (required)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • deleteUserAsync

        public okhttp3.Call deleteUserAsync​(String id,
                                    ApiCallback<Void> _callback)
                             throws ApiException
        Delete (asynchronously) Deletes a user by id.
        Parameters:
        id - The id of the user to be deleted. (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

      • getUserCountCall

        public okhttp3.Call getUserCountCall​(String id,
                                     String idIn,
                                     String firstName,
                                     String firstNameLike,
                                     String lastName,
                                     String lastNameLike,
                                     String email,
                                     String emailLike,
                                     String memberOfGroup,
                                     String memberOfTenant,
                                     String potentialStarter,
                                     ApiCallback _callback)
                              throws ApiException
        Build call for getUserCount
        Parameters:
        id - Filter by user id (optional)
        idIn - Filter by a comma-separated list of user ids. (optional)
        firstName - Filter by the first name of the user. Exact match. (optional)
        firstNameLike - Filter by the first name that the parameter is a substring of. (optional)
        lastName - Filter by the last name of the user. Exact match. (optional)
        lastNameLike - Filter by the last name that the parameter is a substring of. (optional)
        email - Filter by the email of the user. Exact match. (optional)
        emailLike - Filter by the email that the parameter is a substring of. (optional)
        memberOfGroup - Filter for users which are members of the given group. (optional)
        memberOfTenant - Filter for users which are members of the given tenant. (optional)
        potentialStarter - Only select Users that are potential starter for the given process definition. (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • getUserCount

        public CountResultDto getUserCount​(String id,
                                   String idIn,
                                   String firstName,
                                   String firstNameLike,
                                   String lastName,
                                   String lastNameLike,
                                   String email,
                                   String emailLike,
                                   String memberOfGroup,
                                   String memberOfTenant,
                                   String potentialStarter)
                            throws ApiException
        Get List Count Queries for the number of deployments that fulfill given parameters. Takes the same parameters as the [Get Users](https://docs.camunda.org/manual/7.18/reference/rest/user/get-query/) method.
        Parameters:
        id - Filter by user id (optional)
        idIn - Filter by a comma-separated list of user ids. (optional)
        firstName - Filter by the first name of the user. Exact match. (optional)
        firstNameLike - Filter by the first name that the parameter is a substring of. (optional)
        lastName - Filter by the last name of the user. Exact match. (optional)
        lastNameLike - Filter by the last name that the parameter is a substring of. (optional)
        email - Filter by the email of the user. Exact match. (optional)
        emailLike - Filter by the email that the parameter is a substring of. (optional)
        memberOfGroup - Filter for users which are members of the given group. (optional)
        memberOfTenant - Filter for users which are members of the given tenant. (optional)
        potentialStarter - Only select Users that are potential starter for the given process definition. (optional)
        Returns:
        CountResultDto
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getUserCountWithHttpInfo

        public ApiResponse<CountResultDto> getUserCountWithHttpInfo​(String id,
                                                            String idIn,
                                                            String firstName,
                                                            String firstNameLike,
                                                            String lastName,
                                                            String lastNameLike,
                                                            String email,
                                                            String emailLike,
                                                            String memberOfGroup,
                                                            String memberOfTenant,
                                                            String potentialStarter)
                                                     throws ApiException
        Get List Count Queries for the number of deployments that fulfill given parameters. Takes the same parameters as the [Get Users](https://docs.camunda.org/manual/7.18/reference/rest/user/get-query/) method.
        Parameters:
        id - Filter by user id (optional)
        idIn - Filter by a comma-separated list of user ids. (optional)
        firstName - Filter by the first name of the user. Exact match. (optional)
        firstNameLike - Filter by the first name that the parameter is a substring of. (optional)
        lastName - Filter by the last name of the user. Exact match. (optional)
        lastNameLike - Filter by the last name that the parameter is a substring of. (optional)
        email - Filter by the email of the user. Exact match. (optional)
        emailLike - Filter by the email that the parameter is a substring of. (optional)
        memberOfGroup - Filter for users which are members of the given group. (optional)
        memberOfTenant - Filter for users which are members of the given tenant. (optional)
        potentialStarter - Only select Users that are potential starter for the given process definition. (optional)
        Returns:
        ApiResponse<CountResultDto>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getUserCountAsync

        public okhttp3.Call getUserCountAsync​(String id,
                                      String idIn,
                                      String firstName,
                                      String firstNameLike,
                                      String lastName,
                                      String lastNameLike,
                                      String email,
                                      String emailLike,
                                      String memberOfGroup,
                                      String memberOfTenant,
                                      String potentialStarter,
                                      ApiCallback<CountResultDto> _callback)
                               throws ApiException
        Get List Count (asynchronously) Queries for the number of deployments that fulfill given parameters. Takes the same parameters as the [Get Users](https://docs.camunda.org/manual/7.18/reference/rest/user/get-query/) method.
        Parameters:
        id - Filter by user id (optional)
        idIn - Filter by a comma-separated list of user ids. (optional)
        firstName - Filter by the first name of the user. Exact match. (optional)
        firstNameLike - Filter by the first name that the parameter is a substring of. (optional)
        lastName - Filter by the last name of the user. Exact match. (optional)
        lastNameLike - Filter by the last name that the parameter is a substring of. (optional)
        email - Filter by the email of the user. Exact match. (optional)
        emailLike - Filter by the email that the parameter is a substring of. (optional)
        memberOfGroup - Filter for users which are members of the given group. (optional)
        memberOfTenant - Filter for users which are members of the given tenant. (optional)
        potentialStarter - Only select Users that are potential starter for the given process definition. (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

      • getUserProfileCall

        public okhttp3.Call getUserProfileCall​(String id,
                                       ApiCallback _callback)
                                throws ApiException
        Build call for getUserProfile
        Parameters:
        id - The id of the user to retrieve. (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • getUserProfile

        public UserProfileDto getUserProfile​(String id)
                              throws ApiException
        Get Profile Retrieves a user's profile.
        Parameters:
        id - The id of the user to retrieve. (required)
        Returns:
        UserProfileDto
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getUserProfileWithHttpInfo

        public ApiResponse<UserProfileDto> getUserProfileWithHttpInfo​(String id)
                                                       throws ApiException
        Get Profile Retrieves a user's profile.
        Parameters:
        id - The id of the user to retrieve. (required)
        Returns:
        ApiResponse<UserProfileDto>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getUserProfileAsync

        public okhttp3.Call getUserProfileAsync​(String id,
                                        ApiCallback<UserProfileDto> _callback)
                                 throws ApiException
        Get Profile (asynchronously) Retrieves a user's profile.
        Parameters:
        id - The id of the user to retrieve. (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

      • getUsersCall

        public okhttp3.Call getUsersCall​(String id,
                                 String idIn,
                                 String firstName,
                                 String firstNameLike,
                                 String lastName,
                                 String lastNameLike,
                                 String email,
                                 String emailLike,
                                 String memberOfGroup,
                                 String memberOfTenant,
                                 String potentialStarter,
                                 String sortBy,
                                 String sortOrder,
                                 Integer firstResult,
                                 Integer maxResults,
                                 ApiCallback _callback)
                          throws ApiException
        Build call for getUsers
        Parameters:
        id - Filter by user id (optional)
        idIn - Filter by a comma-separated list of user ids. (optional)
        firstName - Filter by the first name of the user. Exact match. (optional)
        firstNameLike - Filter by the first name that the parameter is a substring of. (optional)
        lastName - Filter by the last name of the user. Exact match. (optional)
        lastNameLike - Filter by the last name that the parameter is a substring of. (optional)
        email - Filter by the email of the user. Exact match. (optional)
        emailLike - Filter by the email that the parameter is a substring of. (optional)
        memberOfGroup - Filter for users which are members of the given group. (optional)
        memberOfTenant - Filter for users which are members of the given tenant. (optional)
        potentialStarter - Only select Users that are potential starter for the given process definition. (optional)
        sortBy - Sort the results lexicographically by a given criterion. Must be used in conjunction with the sortOrder parameter. (optional)
        sortOrder - Sort the results in a given order. Values may be asc for ascending order or desc for descending order. Must be used in conjunction with the sortBy parameter. (optional)
        firstResult - Pagination of results. Specifies the index of the first result to return. (optional)
        maxResults - Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left. (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • getUsers

        public List<UserProfileDto> getUsers​(String id,
                                     String idIn,
                                     String firstName,
                                     String firstNameLike,
                                     String lastName,
                                     String lastNameLike,
                                     String email,
                                     String emailLike,
                                     String memberOfGroup,
                                     String memberOfTenant,
                                     String potentialStarter,
                                     String sortBy,
                                     String sortOrder,
                                     Integer firstResult,
                                     Integer maxResults)
                              throws ApiException
        Get List Query for a list of users using a list of parameters. The size of the result set can be retrieved by using the Get User Count method. [Get User Count](https://docs.camunda.org/manual/7.18/reference/rest/user/get-query-count/) method.
        Parameters:
        id - Filter by user id (optional)
        idIn - Filter by a comma-separated list of user ids. (optional)
        firstName - Filter by the first name of the user. Exact match. (optional)
        firstNameLike - Filter by the first name that the parameter is a substring of. (optional)
        lastName - Filter by the last name of the user. Exact match. (optional)
        lastNameLike - Filter by the last name that the parameter is a substring of. (optional)
        email - Filter by the email of the user. Exact match. (optional)
        emailLike - Filter by the email that the parameter is a substring of. (optional)
        memberOfGroup - Filter for users which are members of the given group. (optional)
        memberOfTenant - Filter for users which are members of the given tenant. (optional)
        potentialStarter - Only select Users that are potential starter for the given process definition. (optional)
        sortBy - Sort the results lexicographically by a given criterion. Must be used in conjunction with the sortOrder parameter. (optional)
        sortOrder - Sort the results in a given order. Values may be asc for ascending order or desc for descending order. Must be used in conjunction with the sortBy parameter. (optional)
        firstResult - Pagination of results. Specifies the index of the first result to return. (optional)
        maxResults - Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left. (optional)
        Returns:
        List<UserProfileDto>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getUsersWithHttpInfo

        public ApiResponse<List<UserProfileDto>> getUsersWithHttpInfo​(String id,
                                                              String idIn,
                                                              String firstName,
                                                              String firstNameLike,
                                                              String lastName,
                                                              String lastNameLike,
                                                              String email,
                                                              String emailLike,
                                                              String memberOfGroup,
                                                              String memberOfTenant,
                                                              String potentialStarter,
                                                              String sortBy,
                                                              String sortOrder,
                                                              Integer firstResult,
                                                              Integer maxResults)
                                                       throws ApiException
        Get List Query for a list of users using a list of parameters. The size of the result set can be retrieved by using the Get User Count method. [Get User Count](https://docs.camunda.org/manual/7.18/reference/rest/user/get-query-count/) method.
        Parameters:
        id - Filter by user id (optional)
        idIn - Filter by a comma-separated list of user ids. (optional)
        firstName - Filter by the first name of the user. Exact match. (optional)
        firstNameLike - Filter by the first name that the parameter is a substring of. (optional)
        lastName - Filter by the last name of the user. Exact match. (optional)
        lastNameLike - Filter by the last name that the parameter is a substring of. (optional)
        email - Filter by the email of the user. Exact match. (optional)
        emailLike - Filter by the email that the parameter is a substring of. (optional)
        memberOfGroup - Filter for users which are members of the given group. (optional)
        memberOfTenant - Filter for users which are members of the given tenant. (optional)
        potentialStarter - Only select Users that are potential starter for the given process definition. (optional)
        sortBy - Sort the results lexicographically by a given criterion. Must be used in conjunction with the sortOrder parameter. (optional)
        sortOrder - Sort the results in a given order. Values may be asc for ascending order or desc for descending order. Must be used in conjunction with the sortBy parameter. (optional)
        firstResult - Pagination of results. Specifies the index of the first result to return. (optional)
        maxResults - Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left. (optional)
        Returns:
        ApiResponse<List<UserProfileDto>>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getUsersAsync

        public okhttp3.Call getUsersAsync​(String id,
                                  String idIn,
                                  String firstName,
                                  String firstNameLike,
                                  String lastName,
                                  String lastNameLike,
                                  String email,
                                  String emailLike,
                                  String memberOfGroup,
                                  String memberOfTenant,
                                  String potentialStarter,
                                  String sortBy,
                                  String sortOrder,
                                  Integer firstResult,
                                  Integer maxResults,
                                  ApiCallback<List<UserProfileDto>> _callback)
                           throws ApiException
        Get List (asynchronously) Query for a list of users using a list of parameters. The size of the result set can be retrieved by using the Get User Count method. [Get User Count](https://docs.camunda.org/manual/7.18/reference/rest/user/get-query-count/) method.
        Parameters:
        id - Filter by user id (optional)
        idIn - Filter by a comma-separated list of user ids. (optional)
        firstName - Filter by the first name of the user. Exact match. (optional)
        firstNameLike - Filter by the first name that the parameter is a substring of. (optional)
        lastName - Filter by the last name of the user. Exact match. (optional)
        lastNameLike - Filter by the last name that the parameter is a substring of. (optional)
        email - Filter by the email of the user. Exact match. (optional)
        emailLike - Filter by the email that the parameter is a substring of. (optional)
        memberOfGroup - Filter for users which are members of the given group. (optional)
        memberOfTenant - Filter for users which are members of the given tenant. (optional)
        potentialStarter - Only select Users that are potential starter for the given process definition. (optional)
        sortBy - Sort the results lexicographically by a given criterion. Must be used in conjunction with the sortOrder parameter. (optional)
        sortOrder - Sort the results in a given order. Values may be asc for ascending order or desc for descending order. Must be used in conjunction with the sortBy parameter. (optional)
        firstResult - Pagination of results. Specifies the index of the first result to return. (optional)
        maxResults - Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left. (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

      • unlockUserCall

        public okhttp3.Call unlockUserCall​(String id,
                                   ApiCallback _callback)
                            throws ApiException
        Build call for unlockUser
        Parameters:
        id - The id of the user to be unlocked. (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • unlockUser

        public void unlockUser​(String id)
                throws ApiException
        Unlock User Unlocks a user by id.
        Parameters:
        id - The id of the user to be unlocked. (required)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • unlockUserWithHttpInfo

        public ApiResponse<Void> unlockUserWithHttpInfo​(String id)
                                         throws ApiException
        Unlock User Unlocks a user by id.
        Parameters:
        id - The id of the user to be unlocked. (required)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • unlockUserAsync

        public okhttp3.Call unlockUserAsync​(String id,
                                    ApiCallback<Void> _callback)
                             throws ApiException
        Unlock User (asynchronously) Unlocks a user by id.
        Parameters:
        id - The id of the user to be unlocked. (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

      • updateCredentialsCall

        public okhttp3.Call updateCredentialsCall​(String id,
                                          UserCredentialsDto userCredentialsDto,
                                          ApiCallback _callback)
                                   throws ApiException
        Build call for updateCredentials
        Parameters:
        id - The id of the user to be updated. (required)
        userCredentialsDto - (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • updateCredentials

        public void updateCredentials​(String id,
                              UserCredentialsDto userCredentialsDto)
                       throws ApiException
        Update Credentials Updates a user's credentials (password)
        Parameters:
        id - The id of the user to be updated. (required)
        userCredentialsDto - (optional)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • updateCredentialsWithHttpInfo

        public ApiResponse<Void> updateCredentialsWithHttpInfo​(String id,
                                                       UserCredentialsDto userCredentialsDto)
                                                throws ApiException
        Update Credentials Updates a user's credentials (password)
        Parameters:
        id - The id of the user to be updated. (required)
        userCredentialsDto - (optional)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • updateCredentialsAsync

        public okhttp3.Call updateCredentialsAsync​(String id,
                                           UserCredentialsDto userCredentialsDto,
                                           ApiCallback<Void> _callback)
                                    throws ApiException
        Update Credentials (asynchronously) Updates a user's credentials (password)
        Parameters:
        id - The id of the user to be updated. (required)
        userCredentialsDto - (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

      • updateProfileCall

        public okhttp3.Call updateProfileCall​(String id,
                                      UserProfileDto userProfileDto,
                                      ApiCallback _callback)
                               throws ApiException
        Build call for updateProfile
        Parameters:
        id - The id of the user. (required)
        userProfileDto - (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • updateProfile

        public void updateProfile​(String id,
                          UserProfileDto userProfileDto)
                   throws ApiException
        Update User Profile Updates the profile information of an already existing user.
        Parameters:
        id - The id of the user. (required)
        userProfileDto - (optional)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • updateProfileWithHttpInfo

        public ApiResponse<Void> updateProfileWithHttpInfo​(String id,
                                                   UserProfileDto userProfileDto)
                                            throws ApiException
        Update User Profile Updates the profile information of an already existing user.
        Parameters:
        id - The id of the user. (required)
        userProfileDto - (optional)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • updateProfileAsync

        public okhttp3.Call updateProfileAsync​(String id,
                                       UserProfileDto userProfileDto,
                                       ApiCallback<Void> _callback)
                                throws ApiException
        Update User Profile (asynchronously) Updates the profile information of an already existing user.
        Parameters:
        id - The id of the user. (required)
        userProfileDto - (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