io.swagger.client.api

Class UsersApi

java.lang.Object

io.swagger.client.api.UsersApi

public class UsersApi
extends Object

Constructor Summary

Constructors

Constructor and Description
UsersApi()
UsersApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
User	createUser(UserCreateParamsImpl body) Create a new user <p>Create a new user.
com.squareup.okhttp.Call	createUserAsync(UserCreateParamsImpl body, ApiCallback<User> callback) Create a new user (asynchronously) <p>Create a new user.
com.squareup.okhttp.Call	createUserCall(UserCreateParamsImpl body, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for createUser
ApiResponse<User>	createUserWithHttpInfo(UserCreateParamsImpl body) Create a new user <p>Create a new user.
void	deleteAuthorizedUser() Delete the authorized user Delete the authorized user.
com.squareup.okhttp.Call	deleteAuthorizedUserAsync(ApiCallback<Void> callback) Delete the authorized user (asynchronously) Delete the authorized user.
com.squareup.okhttp.Call	deleteAuthorizedUserCall(ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for deleteAuthorizedUser
ApiResponse<Void>	deleteAuthorizedUserWithHttpInfo() Delete the authorized user Delete the authorized user.
void	deleteUnverifiedUser(String userId) Delete an unverified user Delete an unverified user.
com.squareup.okhttp.Call	deleteUnverifiedUserAsync(String userId, ApiCallback<Void> callback) Delete an unverified user (asynchronously) Delete an unverified user.
com.squareup.okhttp.Call	deleteUnverifiedUserCall(String userId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for deleteUnverifiedUser
ApiResponse<Void>	deleteUnverifiedUserWithHttpInfo(String userId) Delete an unverified user Delete an unverified user.
User	editAuthorizedUser(UserUpdateParamsImpl body) Edit the authorized user Edit the authorized user's data and settings.
com.squareup.okhttp.Call	editAuthorizedUserAsync(UserUpdateParamsImpl body, ApiCallback<User> callback) Edit the authorized user (asynchronously) Edit the authorized user's data and settings.
com.squareup.okhttp.Call	editAuthorizedUserCall(UserUpdateParamsImpl body, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for editAuthorizedUser
ApiResponse<User>	editAuthorizedUserWithHttpInfo(UserUpdateParamsImpl body) Edit the authorized user Edit the authorized user's data and settings.
void	executePasswordChange(ExecutePasswordChangeParams body) Execute password change Change the password of a user.
com.squareup.okhttp.Call	executePasswordChangeAsync(ExecutePasswordChangeParams body, ApiCallback<Void> callback) Execute password change (asynchronously) Change the password of a user.
com.squareup.okhttp.Call	executePasswordChangeCall(ExecutePasswordChangeParams body, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for executePasswordChange
ApiResponse<Void>	executePasswordChangeWithHttpInfo(ExecutePasswordChangeParams body) Execute password change Change the password of a user.
ApiClient	getApiClient()
User	getAuthorizedUser() Get the authorized user Get the authorized user's data.
com.squareup.okhttp.Call	getAuthorizedUserAsync(ApiCallback<User> callback) Get the authorized user (asynchronously) Get the authorized user's data.
com.squareup.okhttp.Call	getAuthorizedUserCall(ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getAuthorizedUser
ApiResponse<User>	getAuthorizedUserWithHttpInfo() Get the authorized user Get the authorized user's data.
VerificationStatusResource	getVerificationStatus(String userId) Get a user's verification status Get the verification status of the requested user.
com.squareup.okhttp.Call	getVerificationStatusAsync(String userId, ApiCallback<VerificationStatusResource> callback) Get a user's verification status (asynchronously) Get the verification status of the requested user.
com.squareup.okhttp.Call	getVerificationStatusCall(String userId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getVerificationStatus
ApiResponse<VerificationStatusResource>	getVerificationStatusWithHttpInfo(String userId) Get a user's verification status Get the verification status of the requested user.
PasswordChangingResource	requestPasswordChange(RequestPasswordChangeParameters body) Request password change Request password change for a user.
com.squareup.okhttp.Call	requestPasswordChangeAsync(RequestPasswordChangeParameters body, ApiCallback<PasswordChangingResource> callback) Request password change (asynchronously) Request password change for a user.
com.squareup.okhttp.Call	requestPasswordChangeCall(RequestPasswordChangeParameters body, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for requestPasswordChange
ApiResponse<PasswordChangingResource>	requestPasswordChangeWithHttpInfo(RequestPasswordChangeParameters body) Request password change Request password change for a user.
void	setApiClient(ApiClient apiClient)
void	verifyUser(String userId) Verify a user Verify a user.
com.squareup.okhttp.Call	verifyUserAsync(String userId, ApiCallback<Void> callback) Verify a user (asynchronously) Verify a user.
com.squareup.okhttp.Call	verifyUserCall(String userId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for verifyUser
ApiResponse<Void>	verifyUserWithHttpInfo(String userId) Verify a user Verify a user.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UsersApi

public UsersApi()

UsersApi

public UsersApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

createUserCall

public com.squareup.okhttp.Call createUserCall(UserCreateParamsImpl body,
                                               ProgressResponseBody.ProgressListener progressListener,
                                               ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                        throws ApiException

Build call for createUser

Parameters:

body - User's details (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

createUser

public User createUser(UserCreateParamsImpl body)
                throws ApiException

Create a new user <p>Create a new user. Must pass your global (i.e. client) access_token. </p><p>This service returns the user's password as plain text. </p><p>The automatic update of the user's bank connections is disabled by default for any new user. User identifiers are regarded case-insensitive by finAPI.</p><p>Please note that finAPI generally has a restricted set of allowed characters for input fields. You can find the allowed characters <a href = \"https://finapi.zendesk.com/hc/en-us/articles/222013148-What-symbols-are-allowed-in-finAPI-\">here</a>. If a field does not explicitly specify a set of allowed characters, then these are the characters that are allowed for the field. Some fields may specify a different set of characters, in which case this will be documented for the field (like for the 'id' field in this service).</p>

Parameters:

body - User's details (required)

Returns:

User

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

createUserWithHttpInfo

public ApiResponse<User> createUserWithHttpInfo(UserCreateParamsImpl body)
                                         throws ApiException

Create a new user <p>Create a new user. Must pass your global (i.e. client) access_token. </p><p>This service returns the user's password as plain text. </p><p>The automatic update of the user's bank connections is disabled by default for any new user. User identifiers are regarded case-insensitive by finAPI.</p><p>Please note that finAPI generally has a restricted set of allowed characters for input fields. You can find the allowed characters <a href = \"https://finapi.zendesk.com/hc/en-us/articles/222013148-What-symbols-are-allowed-in-finAPI-\">here</a>. If a field does not explicitly specify a set of allowed characters, then these are the characters that are allowed for the field. Some fields may specify a different set of characters, in which case this will be documented for the field (like for the 'id' field in this service).</p>

Parameters:

body - User's details (required)

Returns:

ApiResponse<User>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

createUserAsync

public com.squareup.okhttp.Call createUserAsync(UserCreateParamsImpl body,
                                                ApiCallback<User> callback)
                                         throws ApiException

Create a new user (asynchronously) <p>Create a new user. Must pass your global (i.e. client) access_token. </p><p>This service returns the user's password as plain text. </p><p>The automatic update of the user's bank connections is disabled by default for any new user. User identifiers are regarded case-insensitive by finAPI.</p><p>Please note that finAPI generally has a restricted set of allowed characters for input fields. You can find the allowed characters <a href = \"https://finapi.zendesk.com/hc/en-us/articles/222013148-What-symbols-are-allowed-in-finAPI-\">here</a>. If a field does not explicitly specify a set of allowed characters, then these are the characters that are allowed for the field. Some fields may specify a different set of characters, in which case this will be documented for the field (like for the 'id' field in this service).</p>

Parameters:

body - User's details (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

deleteAuthorizedUserCall

public com.squareup.okhttp.Call deleteAuthorizedUserCall(ProgressResponseBody.ProgressListener progressListener,
                                                         ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                  throws ApiException

Build call for deleteAuthorizedUser

Parameters:

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

deleteAuthorizedUser

public void deleteAuthorizedUser()
                          throws ApiException

Delete the authorized user Delete the authorized user. Must pass the user's access_token. ATTENTION: This deletes the user including all of his bank connections, accounts, balance data and transactions! THIS PROCESS CANNOT BE UNDONE! Note that a user cannot get deleted while any of his bank connections are currently busy (in the process of import, update, or transactions categorization). <p>Note: finAPI will send a notification about the deletion of the user to each of your clients that has a user synchronization callback URL set in its configuration. This also includes the client that is performing this request.</p>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

deleteAuthorizedUserWithHttpInfo

public ApiResponse<Void> deleteAuthorizedUserWithHttpInfo()
                                                   throws ApiException

Delete the authorized user Delete the authorized user. Must pass the user's access_token. ATTENTION: This deletes the user including all of his bank connections, accounts, balance data and transactions! THIS PROCESS CANNOT BE UNDONE! Note that a user cannot get deleted while any of his bank connections are currently busy (in the process of import, update, or transactions categorization). <p>Note: finAPI will send a notification about the deletion of the user to each of your clients that has a user synchronization callback URL set in its configuration. This also includes the client that is performing this request.</p>

Returns:

ApiResponse<Void>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

deleteAuthorizedUserAsync

public com.squareup.okhttp.Call deleteAuthorizedUserAsync(ApiCallback<Void> callback)
                                                   throws ApiException

Delete the authorized user (asynchronously) Delete the authorized user. Must pass the user's access_token. ATTENTION: This deletes the user including all of his bank connections, accounts, balance data and transactions! THIS PROCESS CANNOT BE UNDONE! Note that a user cannot get deleted while any of his bank connections are currently busy (in the process of import, update, or transactions categorization). <p>Note: finAPI will send a notification about the deletion of the user to each of your clients that has a user synchronization callback URL set in its configuration. This also includes the client that is performing this request.</p>

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

deleteUnverifiedUserCall

public com.squareup.okhttp.Call deleteUnverifiedUserCall(String userId,
                                                         ProgressResponseBody.ProgressListener progressListener,
                                                         ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                  throws ApiException

Build call for deleteUnverifiedUser

Parameters:

userId - (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

deleteUnverifiedUser

public void deleteUnverifiedUser(String userId)
                          throws ApiException

Delete an unverified user Delete an unverified user. Must pass your global (i.e. client) access_token.<br/><br/>Notes:<br/>&bull; Unverified users can only exist if the field 'isUserAutoVerificationEnabled' (see Client Configuration Resource) is set to 'false' (or had been false at some point in the past).<br/>&bull; finAPI will send a notification about the deletion of the user to each of your clients that has a user synchronization callback URL set in its configuration. This also includes the client that is performing this request.<br/>&bull; finAPI regards user identifiers case-insensitive.

Parameters:

userId - (required)

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

deleteUnverifiedUserWithHttpInfo

public ApiResponse<Void> deleteUnverifiedUserWithHttpInfo(String userId)
                                                   throws ApiException

Delete an unverified user Delete an unverified user. Must pass your global (i.e. client) access_token.<br/><br/>Notes:<br/>&bull; Unverified users can only exist if the field 'isUserAutoVerificationEnabled' (see Client Configuration Resource) is set to 'false' (or had been false at some point in the past).<br/>&bull; finAPI will send a notification about the deletion of the user to each of your clients that has a user synchronization callback URL set in its configuration. This also includes the client that is performing this request.<br/>&bull; finAPI regards user identifiers case-insensitive.

Parameters:

userId - (required)

Returns:

ApiResponse<Void>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

deleteUnverifiedUserAsync

public com.squareup.okhttp.Call deleteUnverifiedUserAsync(String userId,
                                                          ApiCallback<Void> callback)
                                                   throws ApiException

Delete an unverified user (asynchronously) Delete an unverified user. Must pass your global (i.e. client) access_token.<br/><br/>Notes:<br/>&bull; Unverified users can only exist if the field 'isUserAutoVerificationEnabled' (see Client Configuration Resource) is set to 'false' (or had been false at some point in the past).<br/>&bull; finAPI will send a notification about the deletion of the user to each of your clients that has a user synchronization callback URL set in its configuration. This also includes the client that is performing this request.<br/>&bull; finAPI regards user identifiers case-insensitive.

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

editAuthorizedUserCall

public com.squareup.okhttp.Call editAuthorizedUserCall(UserUpdateParamsImpl body,
                                                       ProgressResponseBody.ProgressListener progressListener,
                                                       ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                throws ApiException

Build call for editAuthorizedUser

Parameters:

body - User's details (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

editAuthorizedUser

public User editAuthorizedUser(UserUpdateParamsImpl body)
                        throws ApiException

Edit the authorized user Edit the authorized user's data and settings. Must pass the user's access_token. Pass an empty string (but not null) to unset either the email or phone number. At least one field must have a non-null value in the request body. This service returns the user's password as 'XXXXX'.

Parameters:

body - User's details (required)

Returns:

User

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

editAuthorizedUserWithHttpInfo

public ApiResponse<User> editAuthorizedUserWithHttpInfo(UserUpdateParamsImpl body)
                                                 throws ApiException

Edit the authorized user Edit the authorized user's data and settings. Must pass the user's access_token. Pass an empty string (but not null) to unset either the email or phone number. At least one field must have a non-null value in the request body. This service returns the user's password as 'XXXXX'.

Parameters:

body - User's details (required)

Returns:

ApiResponse<User>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

editAuthorizedUserAsync

public com.squareup.okhttp.Call editAuthorizedUserAsync(UserUpdateParamsImpl body,
                                                        ApiCallback<User> callback)
                                                 throws ApiException

Edit the authorized user (asynchronously) Edit the authorized user's data and settings. Must pass the user's access_token. Pass an empty string (but not null) to unset either the email or phone number. At least one field must have a non-null value in the request body. This service returns the user's password as 'XXXXX'.

Parameters:

body - User's details (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

executePasswordChangeCall

public com.squareup.okhttp.Call executePasswordChangeCall(ExecutePasswordChangeParams body,
                                                          ProgressResponseBody.ProgressListener progressListener,
                                                          ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                   throws ApiException

Build call for executePasswordChange

Parameters:

body - (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

executePasswordChange

public void executePasswordChange(ExecutePasswordChangeParams body)
                           throws ApiException

Execute password change Change the password of a user. Must pass your global (i.e. client) access_token.<br/><br/>Note: When changing the password of a user, all tokens that have been handed out for that user (for whatever client) will be revoked! Also note that finAPI regards user identifiers case-insensitive.

Parameters:

body - (optional)

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

executePasswordChangeWithHttpInfo

public ApiResponse<Void> executePasswordChangeWithHttpInfo(ExecutePasswordChangeParams body)
                                                    throws ApiException

Execute password change Change the password of a user. Must pass your global (i.e. client) access_token.<br/><br/>Note: When changing the password of a user, all tokens that have been handed out for that user (for whatever client) will be revoked! Also note that finAPI regards user identifiers case-insensitive.

Parameters:

body - (optional)

Returns:

ApiResponse<Void>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

executePasswordChangeAsync

public com.squareup.okhttp.Call executePasswordChangeAsync(ExecutePasswordChangeParams body,
                                                           ApiCallback<Void> callback)
                                                    throws ApiException

Execute password change (asynchronously) Change the password of a user. Must pass your global (i.e. client) access_token.<br/><br/>Note: When changing the password of a user, all tokens that have been handed out for that user (for whatever client) will be revoked! Also note that finAPI regards user identifiers case-insensitive.

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

getAuthorizedUserCall

public com.squareup.okhttp.Call getAuthorizedUserCall(ProgressResponseBody.ProgressListener progressListener,
                                                      ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                               throws ApiException

Build call for getAuthorizedUser

Parameters:

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getAuthorizedUser

public User getAuthorizedUser()
                       throws ApiException

Get the authorized user Get the authorized user's data. Must pass the user's access_token. Only the authorized user can get his data, i.e. his access_token must be used. This service returns the user's password as 'XXXXX'.

Returns:

User

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getAuthorizedUserWithHttpInfo

public ApiResponse<User> getAuthorizedUserWithHttpInfo()
                                                throws ApiException

Get the authorized user Get the authorized user's data. Must pass the user's access_token. Only the authorized user can get his data, i.e. his access_token must be used. This service returns the user's password as 'XXXXX'.

Returns:

ApiResponse<User>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getAuthorizedUserAsync

public com.squareup.okhttp.Call getAuthorizedUserAsync(ApiCallback<User> callback)
                                                throws ApiException

Get the authorized user (asynchronously) Get the authorized user's data. Must pass the user's access_token. Only the authorized user can get his data, i.e. his access_token must be used. This service returns the user's password as 'XXXXX'.

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

getVerificationStatusCall

public com.squareup.okhttp.Call getVerificationStatusCall(String userId,
                                                          ProgressResponseBody.ProgressListener progressListener,
                                                          ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                   throws ApiException

Build call for getVerificationStatus

Parameters:

userId - User's identifier (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getVerificationStatus

public VerificationStatusResource getVerificationStatus(String userId)
                                                 throws ApiException

Get a user's verification status Get the verification status of the requested user. Must pass your global (i.e. client) access_token. Note that finAPI regards user identifiers case-insensitive.

Parameters:

userId - User's identifier (required)

Returns:

VerificationStatusResource

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getVerificationStatusWithHttpInfo

public ApiResponse<VerificationStatusResource> getVerificationStatusWithHttpInfo(String userId)
                                                                          throws ApiException

Get a user's verification status Get the verification status of the requested user. Must pass your global (i.e. client) access_token. Note that finAPI regards user identifiers case-insensitive.

Parameters:

userId - User's identifier (required)

Returns:

ApiResponse<VerificationStatusResource>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getVerificationStatusAsync

public com.squareup.okhttp.Call getVerificationStatusAsync(String userId,
                                                           ApiCallback<VerificationStatusResource> callback)
                                                    throws ApiException

Get a user's verification status (asynchronously) Get the verification status of the requested user. Must pass your global (i.e. client) access_token. Note that finAPI regards user identifiers case-insensitive.

Parameters:

userId - User's identifier (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

requestPasswordChangeCall

public com.squareup.okhttp.Call requestPasswordChangeCall(RequestPasswordChangeParameters body,
                                                          ProgressResponseBody.ProgressListener progressListener,
                                                          ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                   throws ApiException

Build call for requestPasswordChange

Parameters:

body - (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

requestPasswordChange

public PasswordChangingResource requestPasswordChange(RequestPasswordChangeParameters body)
                                               throws ApiException

Request password change Request password change for a user. Must pass your global (i.e. client) access_token. Note that finAPI regards user identifiers case-insensitive.

Parameters:

body - (optional)

Returns:

PasswordChangingResource

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

requestPasswordChangeWithHttpInfo

public ApiResponse<PasswordChangingResource> requestPasswordChangeWithHttpInfo(RequestPasswordChangeParameters body)
                                                                        throws ApiException

Request password change Request password change for a user. Must pass your global (i.e. client) access_token. Note that finAPI regards user identifiers case-insensitive.

Parameters:

body - (optional)

Returns:

ApiResponse<PasswordChangingResource>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

requestPasswordChangeAsync

public com.squareup.okhttp.Call requestPasswordChangeAsync(RequestPasswordChangeParameters body,
                                                           ApiCallback<PasswordChangingResource> callback)
                                                    throws ApiException

Request password change (asynchronously) Request password change for a user. Must pass your global (i.e. client) access_token. Note that finAPI regards user identifiers case-insensitive.

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

verifyUserCall

public com.squareup.okhttp.Call verifyUserCall(String userId,
                                               ProgressResponseBody.ProgressListener progressListener,
                                               ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                        throws ApiException

Build call for verifyUser

Parameters:

userId - User's identifier (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

verifyUser

public void verifyUser(String userId)
                throws ApiException

Verify a user Verify a user. User verification is only required when your client does not have auto-verification enabled (see field 'isUserAutoVerificationEnabled' in Client Configuration Resource). Must pass your global (i.e. client) access_token. Note that finAPI regards user identifiers case-insensitive.

Parameters:

userId - User's identifier (required)

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

verifyUserWithHttpInfo

public ApiResponse<Void> verifyUserWithHttpInfo(String userId)
                                         throws ApiException

Verify a user Verify a user. User verification is only required when your client does not have auto-verification enabled (see field 'isUserAutoVerificationEnabled' in Client Configuration Resource). Must pass your global (i.e. client) access_token. Note that finAPI regards user identifiers case-insensitive.

Parameters:

userId - User's identifier (required)

Returns:

ApiResponse<Void>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

verifyUserAsync

public com.squareup.okhttp.Call verifyUserAsync(String userId,
                                                ApiCallback<Void> callback)
                                         throws ApiException

Verify a user (asynchronously) Verify a user. User verification is only required when your client does not have auto-verification enabled (see field 'isUserAutoVerificationEnabled' in Client Configuration Resource). Must pass your global (i.e. client) access_token. Note that finAPI regards user identifiers case-insensitive.

Parameters:

userId - User's identifier (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