Package com.boldsign.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)

      • cancelInvitationCall

        public okhttp3.Call cancelInvitationCall​(String userId,
                                         ApiCallback _callback)
                                  throws ApiException
        Build call for cancelInvitation
        Parameters:
        userId - (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 OK -
        401 Unauthorized -
        403 Forbidden -

      • cancelInvitation

        public void cancelInvitation​(String userId)
                      throws ApiException
        Cancel the users invitation.
        Parameters:
        userId - (required)
        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 OK -
        401 Unauthorized -
        403 Forbidden -

      • cancelInvitationWithHttpInfo

        public ApiResponse<Void> cancelInvitationWithHttpInfo​(String userId)
                                               throws ApiException
        Cancel the users invitation.
        Parameters:
        userId - (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:
        Status Code Description Response Headers
        200 OK -
        401 Unauthorized -
        403 Forbidden -

      • cancelInvitationAsync

        public okhttp3.Call cancelInvitationAsync​(String userId,
                                          ApiCallback<Void> _callback)
                                   throws ApiException
        Cancel the users invitation. (asynchronously)
        Parameters:
        userId - (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 OK -
        401 Unauthorized -
        403 Forbidden -

      • changeTeamCall

        public okhttp3.Call changeTeamCall​(String userId,
                                   ChangeTeamRequest changeTeamRequest,
                                   ApiCallback _callback)
                            throws ApiException
        Build call for changeTeam
        Parameters:
        userId - user Id. (required)
        changeTeamRequest - Change team request. (optional)
        _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 OK -
        401 Unauthorized -
        403 Forbidden -

      • changeTeam

        public void changeTeam​(String userId,
                       ChangeTeamRequest changeTeamRequest)
                throws ApiException
        Change users to other team.
        Parameters:
        userId - user Id. (required)
        changeTeamRequest - Change team request. (optional)
        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 OK -
        401 Unauthorized -
        403 Forbidden -

      • changeTeamWithHttpInfo

        public ApiResponse<Void> changeTeamWithHttpInfo​(String userId,
                                                ChangeTeamRequest changeTeamRequest)
                                         throws ApiException
        Change users to other team.
        Parameters:
        userId - user Id. (required)
        changeTeamRequest - Change team request. (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:
        Status Code Description Response Headers
        200 OK -
        401 Unauthorized -
        403 Forbidden -

      • changeTeamAsync

        public okhttp3.Call changeTeamAsync​(String userId,
                                    ChangeTeamRequest changeTeamRequest,
                                    ApiCallback<Void> _callback)
                             throws ApiException
        Change users to other team. (asynchronously)
        Parameters:
        userId - user Id. (required)
        changeTeamRequest - Change team request. (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:
        Status Code Description Response Headers
        200 OK -
        401 Unauthorized -
        403 Forbidden -

      • createUserCall

        public okhttp3.Call createUserCall​(List<CreateUser> createUser,
                                   ApiCallback _callback)
                            throws ApiException
        Build call for createUser
        Parameters:
        createUser - The create user. (optional)
        _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
        204 No Content -
        401 Unauthorized -
        403 Forbidden -

      • createUser

        public void createUser​(List<CreateUser> createUser)
                throws ApiException
        Create the user.
        Parameters:
        createUser - The create user. (optional)
        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
        204 No Content -
        401 Unauthorized -
        403 Forbidden -

      • createUserWithHttpInfo

        public ApiResponse<Void> createUserWithHttpInfo​(List<CreateUser> createUser)
                                         throws ApiException
        Create the user.
        Parameters:
        createUser - The create user. (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:
        Status Code Description Response Headers
        204 No Content -
        401 Unauthorized -
        403 Forbidden -

      • createUserAsync

        public okhttp3.Call createUserAsync​(List<CreateUser> createUser,
                                    ApiCallback<Void> _callback)
                             throws ApiException
        Create the user. (asynchronously)
        Parameters:
        createUser - The create user. (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:
        Status Code Description Response Headers
        204 No Content -
        401 Unauthorized -
        403 Forbidden -

      • getUserCall

        public okhttp3.Call getUserCall​(String userId,
                                ApiCallback _callback)
                         throws ApiException
        Build call for getUser
        Parameters:
        userId - User Id. (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 OK -
        401 Unauthorized -
        403 Forbidden -

      • getUser

        public UserProperties getUser​(String userId)
                       throws ApiException
        Get summary of the user.
        Parameters:
        userId - User Id. (required)
        Returns:
        UserProperties
        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 OK -
        401 Unauthorized -
        403 Forbidden -

      • getUserWithHttpInfo

        public ApiResponse<UserProperties> getUserWithHttpInfo​(String userId)
                                                throws ApiException
        Get summary of the user.
        Parameters:
        userId - User Id. (required)
        Returns:
        ApiResponse<UserProperties>
        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 OK -
        401 Unauthorized -
        403 Forbidden -

      • getUserAsync

        public okhttp3.Call getUserAsync​(String userId,
                                 ApiCallback<UserProperties> _callback)
                          throws ApiException
        Get summary of the user. (asynchronously)
        Parameters:
        userId - User Id. (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 OK -
        401 Unauthorized -
        403 Forbidden -

      • listUsersCall

        public okhttp3.Call listUsersCall​(Integer page,
                                  Integer pageSize,
                                  String search,
                                  List<String> userId,
                                  ApiCallback _callback)
                           throws ApiException
        Build call for listUsers
        Parameters:
        page - Page index specified in get user list request. (required)
        pageSize - Page size specified in get user list request. (optional, default to 10)
        search - Users can be listed by the search based on the user ID (optional)
        userId - Users can be listed by the search based on the user IDs (optional)
        _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 OK -
        401 Unauthorized -

      • listUsers

        public UserRecords listUsers​(Integer page,
                             Integer pageSize,
                             String search,
                             List<String> userId)
                      throws ApiException
        List user documents.
        Parameters:
        page - Page index specified in get user list request. (required)
        pageSize - Page size specified in get user list request. (optional, default to 10)
        search - Users can be listed by the search based on the user ID (optional)
        userId - Users can be listed by the search based on the user IDs (optional)
        Returns:
        UserRecords
        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 OK -
        401 Unauthorized -

      • listUsersWithHttpInfo

        public ApiResponse<UserRecords> listUsersWithHttpInfo​(Integer page,
                                                      Integer pageSize,
                                                      String search,
                                                      List<String> userId)
                                               throws ApiException
        List user documents.
        Parameters:
        page - Page index specified in get user list request. (required)
        pageSize - Page size specified in get user list request. (optional, default to 10)
        search - Users can be listed by the search based on the user ID (optional)
        userId - Users can be listed by the search based on the user IDs (optional)
        Returns:
        ApiResponse<UserRecords>
        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 OK -
        401 Unauthorized -

      • listUsersAsync

        public okhttp3.Call listUsersAsync​(Integer page,
                                   Integer pageSize,
                                   String search,
                                   List<String> userId,
                                   ApiCallback<UserRecords> _callback)
                            throws ApiException
        List user documents. (asynchronously)
        Parameters:
        page - Page index specified in get user list request. (required)
        pageSize - Page size specified in get user list request. (optional, default to 10)
        search - Users can be listed by the search based on the user ID (optional)
        userId - Users can be listed by the search based on the user IDs (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:
        Status Code Description Response Headers
        200 OK -
        401 Unauthorized -

      • resendInvitationCall

        public okhttp3.Call resendInvitationCall​(String userId,
                                         ApiCallback _callback)
                                  throws ApiException
        Build call for resendInvitation
        Parameters:
        userId - (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 OK -
        401 Unauthorized -
        403 Forbidden -

      • resendInvitation

        public void resendInvitation​(String userId)
                      throws ApiException
        Resend the users invitation.
        Parameters:
        userId - (required)
        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 OK -
        401 Unauthorized -
        403 Forbidden -

      • resendInvitationWithHttpInfo

        public ApiResponse<Void> resendInvitationWithHttpInfo​(String userId)
                                               throws ApiException
        Resend the users invitation.
        Parameters:
        userId - (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:
        Status Code Description Response Headers
        200 OK -
        401 Unauthorized -
        403 Forbidden -

      • resendInvitationAsync

        public okhttp3.Call resendInvitationAsync​(String userId,
                                          ApiCallback<Void> _callback)
                                   throws ApiException
        Resend the users invitation. (asynchronously)
        Parameters:
        userId - (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 OK -
        401 Unauthorized -
        403 Forbidden -

      • updateMetaDataCall

        public okhttp3.Call updateMetaDataCall​(UpdateUserMetaData updateUserMetaData,
                                       ApiCallback _callback)
                                throws ApiException
        Build call for updateMetaData
        Parameters:
        updateUserMetaData - update query. (optional)
        _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 OK -
        401 Unauthorized -
        403 Forbidden -

      • updateMetaData

        public void updateMetaData​(UpdateUserMetaData updateUserMetaData)
                    throws ApiException
        Update new User meta data details.
        Parameters:
        updateUserMetaData - update query. (optional)
        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 OK -
        401 Unauthorized -
        403 Forbidden -

      • updateMetaDataWithHttpInfo

        public ApiResponse<Void> updateMetaDataWithHttpInfo​(UpdateUserMetaData updateUserMetaData)
                                             throws ApiException
        Update new User meta data details.
        Parameters:
        updateUserMetaData - update query. (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:
        Status Code Description Response Headers
        200 OK -
        401 Unauthorized -
        403 Forbidden -

      • updateMetaDataAsync

        public okhttp3.Call updateMetaDataAsync​(UpdateUserMetaData updateUserMetaData,
                                        ApiCallback<Void> _callback)
                                 throws ApiException
        Update new User meta data details. (asynchronously)
        Parameters:
        updateUserMetaData - update query. (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:
        Status Code Description Response Headers
        200 OK -
        401 Unauthorized -
        403 Forbidden -

      • updateUserCall

        public okhttp3.Call updateUserCall​(UpdateUser updateUser,
                                   ApiCallback _callback)
                            throws ApiException
        Build call for updateUser
        Parameters:
        updateUser - update query. (optional)
        _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 OK -
        401 Unauthorized -
        403 Forbidden -

      • updateUser

        public void updateUser​(UpdateUser updateUser)
                throws ApiException
        Update new User role.
        Parameters:
        updateUser - update query. (optional)
        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 OK -
        401 Unauthorized -
        403 Forbidden -

      • updateUserWithHttpInfo

        public ApiResponse<Void> updateUserWithHttpInfo​(UpdateUser updateUser)
                                         throws ApiException
        Update new User role.
        Parameters:
        updateUser - update query. (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:
        Status Code Description Response Headers
        200 OK -
        401 Unauthorized -
        403 Forbidden -

      • updateUserAsync

        public okhttp3.Call updateUserAsync​(UpdateUser updateUser,
                                    ApiCallback<Void> _callback)
                             throws ApiException
        Update new User role. (asynchronously)
        Parameters:
        updateUser - update query. (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:
        Status Code Description Response Headers
        200 OK -
        401 Unauthorized -
        403 Forbidden -