io.swagger.client.api

Class MandatorAdministrationApi

java.lang.Object

io.swagger.client.api.MandatorAdministrationApi

public class MandatorAdministrationApi
extends Object

Constructor Summary

Constructors

Constructor and Description
MandatorAdministrationApi()
MandatorAdministrationApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
void	changeClientCredentials(ChangeClientCredentialsParams body) Change client credentials Change the client_secret for any of your clients, including the mandator admin client.
com.squareup.okhttp.Call	changeClientCredentialsAsync(ChangeClientCredentialsParams body, ApiCallback<Void> callback) Change client credentials (asynchronously) Change the client_secret for any of your clients, including the mandator admin client.
com.squareup.okhttp.Call	changeClientCredentialsCall(ChangeClientCredentialsParams body, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for changeClientCredentials
ApiResponse<Void>	changeClientCredentialsWithHttpInfo(ChangeClientCredentialsParams body) Change client credentials Change the client_secret for any of your clients, including the mandator admin client.
UserIdentifiersList	deleteUsers(UserIdentifiersParams body) Delete users Delete one or several users, which are specified by a given list of identifiers.
com.squareup.okhttp.Call	deleteUsersAsync(UserIdentifiersParams body, ApiCallback<UserIdentifiersList> callback) Delete users (asynchronously) Delete one or several users, which are specified by a given list of identifiers.
com.squareup.okhttp.Call	deleteUsersCall(UserIdentifiersParams body, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for deleteUsers
ApiResponse<UserIdentifiersList>	deleteUsersWithHttpInfo(UserIdentifiersParams body) Delete users Delete one or several users, which are specified by a given list of identifiers.
ApiClient	getApiClient()
PageableUserInfoList	getUserList(String minRegistrationDate, String maxRegistrationDate, String minDeletionDate, String maxDeletionDate, String minLastActiveDate, String maxLastActiveDate, Boolean includeMonthlyStats, String monthlyStatsStartDate, String monthlyStatsEndDate, Boolean isDeleted, Integer page, Integer perPage, List<String> order) Get user list <p>Get a list of the users of the mandator that is authorized by the access_token.
com.squareup.okhttp.Call	getUserListAsync(String minRegistrationDate, String maxRegistrationDate, String minDeletionDate, String maxDeletionDate, String minLastActiveDate, String maxLastActiveDate, Boolean includeMonthlyStats, String monthlyStatsStartDate, String monthlyStatsEndDate, Boolean isDeleted, Integer page, Integer perPage, List<String> order, ApiCallback<PageableUserInfoList> callback) Get user list (asynchronously) <p>Get a list of the users of the mandator that is authorized by the access_token.
com.squareup.okhttp.Call	getUserListCall(String minRegistrationDate, String maxRegistrationDate, String minDeletionDate, String maxDeletionDate, String minLastActiveDate, String maxLastActiveDate, Boolean includeMonthlyStats, String monthlyStatsStartDate, String monthlyStatsEndDate, Boolean isDeleted, Integer page, Integer perPage, List<String> order, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getUserList
ApiResponse<PageableUserInfoList>	getUserListWithHttpInfo(String minRegistrationDate, String maxRegistrationDate, String minDeletionDate, String maxDeletionDate, String minLastActiveDate, String maxLastActiveDate, Boolean includeMonthlyStats, String monthlyStatsStartDate, String monthlyStatsEndDate, Boolean isDeleted, Integer page, Integer perPage, List<String> order) Get user list <p>Get a list of the users of the mandator that is authorized by the access_token.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

MandatorAdministrationApi

public MandatorAdministrationApi()

MandatorAdministrationApi

public MandatorAdministrationApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

changeClientCredentialsCall

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

Build call for changeClientCredentials

Parameters:

body - Parameters for changing client credentials (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

changeClientCredentials

public void changeClientCredentials(ChangeClientCredentialsParams body)
                             throws ApiException

Change client credentials Change the client_secret for any of your clients, including the mandator admin client. Must pass the <a href='https://finapi.zendesk.com/hc/en-us/articles/115003661827-Difference-between-app-clients-and-mandator-admin-client'>mandator admin client</a>'s access_token. <br/><br/>NOTES:<br/>&bull; When you change a client's secret, then all of its existing access tokens will be revoked. User access tokens are not affected.<br/>&bull; finAPI is storing client secrets with a one-way encryption. A lost client secret can NOT be recovered.

Parameters:

body - Parameters for changing client credentials (required)

Throws:

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

changeClientCredentialsWithHttpInfo

public ApiResponse<Void> changeClientCredentialsWithHttpInfo(ChangeClientCredentialsParams body)
                                                      throws ApiException

Change client credentials Change the client_secret for any of your clients, including the mandator admin client. Must pass the <a href='https://finapi.zendesk.com/hc/en-us/articles/115003661827-Difference-between-app-clients-and-mandator-admin-client'>mandator admin client</a>'s access_token. <br/><br/>NOTES:<br/>&bull; When you change a client's secret, then all of its existing access tokens will be revoked. User access tokens are not affected.<br/>&bull; finAPI is storing client secrets with a one-way encryption. A lost client secret can NOT be recovered.

Parameters:

body - Parameters for changing client credentials (required)

Returns:

ApiResponse<Void>

Throws:

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

changeClientCredentialsAsync

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

Change client credentials (asynchronously) Change the client_secret for any of your clients, including the mandator admin client. Must pass the <a href='https://finapi.zendesk.com/hc/en-us/articles/115003661827-Difference-between-app-clients-and-mandator-admin-client'>mandator admin client</a>'s access_token. <br/><br/>NOTES:<br/>&bull; When you change a client's secret, then all of its existing access tokens will be revoked. User access tokens are not affected.<br/>&bull; finAPI is storing client secrets with a one-way encryption. A lost client secret can NOT be recovered.

Parameters:

body - Parameters for changing client credentials (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

deleteUsersCall

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

Build call for deleteUsers

Parameters:

body - List of user identifiers (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

deleteUsers

public UserIdentifiersList deleteUsers(UserIdentifiersParams body)
                                throws ApiException

Delete users Delete one or several users, which are specified by a given list of identifiers. Must pass the <a href='https://finapi.zendesk.com/hc/en-us/articles/115003661827-Difference-between-app-clients-and-mandator-admin-client'>mandator admin client</a>'s access_token. <br/><br/><b>NOTE</b>: finAPI may fail to delete one (or several, or all) of the specified users. A user cannot get deleted when his data is currently locked by an internal process (for instance, update of a bank connection or transactions categorization). The response contains the identifiers of all users that could not get deleted, and all users that could get deleted, separated in two lists. The mandator admin client can retry the request at a later time for the users who could not get deleted.

Parameters:

body - List of user identifiers (required)

Returns:

UserIdentifiersList

Throws:

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

deleteUsersWithHttpInfo

public ApiResponse<UserIdentifiersList> deleteUsersWithHttpInfo(UserIdentifiersParams body)
                                                         throws ApiException

Delete users Delete one or several users, which are specified by a given list of identifiers. Must pass the <a href='https://finapi.zendesk.com/hc/en-us/articles/115003661827-Difference-between-app-clients-and-mandator-admin-client'>mandator admin client</a>'s access_token. <br/><br/><b>NOTE</b>: finAPI may fail to delete one (or several, or all) of the specified users. A user cannot get deleted when his data is currently locked by an internal process (for instance, update of a bank connection or transactions categorization). The response contains the identifiers of all users that could not get deleted, and all users that could get deleted, separated in two lists. The mandator admin client can retry the request at a later time for the users who could not get deleted.

Parameters:

body - List of user identifiers (required)

Returns:

ApiResponse<UserIdentifiersList>

Throws:

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

deleteUsersAsync

public com.squareup.okhttp.Call deleteUsersAsync(UserIdentifiersParams body,
                                                 ApiCallback<UserIdentifiersList> callback)
                                          throws ApiException

Delete users (asynchronously) Delete one or several users, which are specified by a given list of identifiers. Must pass the <a href='https://finapi.zendesk.com/hc/en-us/articles/115003661827-Difference-between-app-clients-and-mandator-admin-client'>mandator admin client</a>'s access_token. <br/><br/><b>NOTE</b>: finAPI may fail to delete one (or several, or all) of the specified users. A user cannot get deleted when his data is currently locked by an internal process (for instance, update of a bank connection or transactions categorization). The response contains the identifiers of all users that could not get deleted, and all users that could get deleted, separated in two lists. The mandator admin client can retry the request at a later time for the users who could not get deleted.

Parameters:

body - List of user identifiers (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

getUserListCall

public com.squareup.okhttp.Call getUserListCall(String minRegistrationDate,
                                                String maxRegistrationDate,
                                                String minDeletionDate,
                                                String maxDeletionDate,
                                                String minLastActiveDate,
                                                String maxLastActiveDate,
                                                Boolean includeMonthlyStats,
                                                String monthlyStatsStartDate,
                                                String monthlyStatsEndDate,
                                                Boolean isDeleted,
                                                Integer page,
                                                Integer perPage,
                                                List<String> order,
                                                ProgressResponseBody.ProgressListener progressListener,
                                                ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                         throws ApiException

Build call for getUserList

Parameters:

minRegistrationDate - Lower bound for a user's registration date, in the format 'YYYY-MM-DD' (e.g. '2016-01-01'). If specified, then only users whose 'registrationDate' is equal to or later than the given date will be regarded. (optional)

maxRegistrationDate - Upper bound for a user's registration date, in the format 'YYYY-MM-DD' (e.g. '2016-01-01'). If specified, then only users whose 'registrationDate' is equal to or earlier than the given date will be regarded. (optional)

minDeletionDate - Lower bound for a user's deletion date, in the format 'YYYY-MM-DD' (e.g. '2016-01-01'). If specified, then only users whose 'deletionDate' is not null, and is equal to or later than the given date will be regarded. (optional)

maxDeletionDate - Upper bound for a user's deletion date, in the format 'YYYY-MM-DD' (e.g. '2016-01-01'). If specified, then only users whose 'deletionDate' is null, or is equal to or earlier than the given date will be regarded. (optional)

minLastActiveDate - Lower bound for a user's last active date, in the format 'YYYY-MM-DD' (e.g. '2016-01-01'). If specified, then only users whose 'lastActiveDate' is not null, and is equal to or later than the given date will be regarded. (optional)

maxLastActiveDate - Upper bound for a user's last active date, in the format 'YYYY-MM-DD' (e.g. '2016-01-01'). If specified, then only users whose 'lastActiveDate' is null, or is equal to or earlier than the given date will be regarded. (optional)

includeMonthlyStats - Whether to include the 'monthlyStats' for the returned users. If not specified, then the field defaults to 'false'. (optional)

monthlyStatsStartDate - Minimum bound for the monthly stats (=oldest month that should be included). Must be passed in the format 'YYYY-MM'. If not specified, then the monthly stats will go back up to the first month in which the user existed (date of the user's registration). Note that this field is only regarded if 'includeMonthlyStats' = true. (optional)

monthlyStatsEndDate - Maximum bound for the monthly stats (=latest month that should be included). Must be passed in the format 'YYYY-MM'. If not specified, then the monthly stats will go up to either the current month (for active users), or up to the month of deletion (for deleted users). Note that this field is only regarded if 'includeMonthlyStats' = true. (optional)

isDeleted - If NOT specified, then the service will regard both active and deleted users in the search. If set to 'true', then ONLY deleted users will be regarded. If set to 'false', then ONLY active users will be regarded. (optional)

page - Result page that you want to retrieve (optional, default to 1)

perPage - Maximum number of records per page. Can be at most 500. NOTE: Due to its validation and visualization, the swagger frontend might show very low performance, or even crashes, when a service responds with a lot of data. It is recommended to use a HTTP client like Postman or DHC instead of our swagger frontend for service calls with large page sizes. (optional, default to 20)

order - Determines the order of the results. You can order the results by 'userId'. The default order for this service is 'userId,asc'. The general format is: 'property[,asc|desc]', with 'asc' being the default value. (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getUserList

public PageableUserInfoList getUserList(String minRegistrationDate,
                                        String maxRegistrationDate,
                                        String minDeletionDate,
                                        String maxDeletionDate,
                                        String minLastActiveDate,
                                        String maxLastActiveDate,
                                        Boolean includeMonthlyStats,
                                        String monthlyStatsStartDate,
                                        String monthlyStatsEndDate,
                                        Boolean isDeleted,
                                        Integer page,
                                        Integer perPage,
                                        List<String> order)
                                 throws ApiException

Get user list <p>Get a list of the users of the mandator that is authorized by the access_token. Must pass the <a href='https://finapi.zendesk.com/hc/en-us/articles/115003661827-Difference-between-app-clients-and-mandator-admin-client'>mandator admin client</a>'s access_token. You can set optional search criteria to get only those users that you are interested in. If you do not specify any search criteria, then this service functions as a 'get all' service.</p><p>Note that the original user id is longer available in finAPI once a user has been deleted. Because of this, the userId of deleted users will be a distorted version of the original userId. For example, if the deleted user's id was originally 'user', then this service will return 'uXXr' as the userId.</p>

Parameters:

minRegistrationDate - Lower bound for a user's registration date, in the format 'YYYY-MM-DD' (e.g. '2016-01-01'). If specified, then only users whose 'registrationDate' is equal to or later than the given date will be regarded. (optional)

maxRegistrationDate - Upper bound for a user's registration date, in the format 'YYYY-MM-DD' (e.g. '2016-01-01'). If specified, then only users whose 'registrationDate' is equal to or earlier than the given date will be regarded. (optional)

minDeletionDate - Lower bound for a user's deletion date, in the format 'YYYY-MM-DD' (e.g. '2016-01-01'). If specified, then only users whose 'deletionDate' is not null, and is equal to or later than the given date will be regarded. (optional)

maxDeletionDate - Upper bound for a user's deletion date, in the format 'YYYY-MM-DD' (e.g. '2016-01-01'). If specified, then only users whose 'deletionDate' is null, or is equal to or earlier than the given date will be regarded. (optional)

minLastActiveDate - Lower bound for a user's last active date, in the format 'YYYY-MM-DD' (e.g. '2016-01-01'). If specified, then only users whose 'lastActiveDate' is not null, and is equal to or later than the given date will be regarded. (optional)

maxLastActiveDate - Upper bound for a user's last active date, in the format 'YYYY-MM-DD' (e.g. '2016-01-01'). If specified, then only users whose 'lastActiveDate' is null, or is equal to or earlier than the given date will be regarded. (optional)

includeMonthlyStats - Whether to include the 'monthlyStats' for the returned users. If not specified, then the field defaults to 'false'. (optional)

monthlyStatsStartDate - Minimum bound for the monthly stats (=oldest month that should be included). Must be passed in the format 'YYYY-MM'. If not specified, then the monthly stats will go back up to the first month in which the user existed (date of the user's registration). Note that this field is only regarded if 'includeMonthlyStats' = true. (optional)

monthlyStatsEndDate - Maximum bound for the monthly stats (=latest month that should be included). Must be passed in the format 'YYYY-MM'. If not specified, then the monthly stats will go up to either the current month (for active users), or up to the month of deletion (for deleted users). Note that this field is only regarded if 'includeMonthlyStats' = true. (optional)

isDeleted - If NOT specified, then the service will regard both active and deleted users in the search. If set to 'true', then ONLY deleted users will be regarded. If set to 'false', then ONLY active users will be regarded. (optional)

page - Result page that you want to retrieve (optional, default to 1)

perPage - Maximum number of records per page. Can be at most 500. NOTE: Due to its validation and visualization, the swagger frontend might show very low performance, or even crashes, when a service responds with a lot of data. It is recommended to use a HTTP client like Postman or DHC instead of our swagger frontend for service calls with large page sizes. (optional, default to 20)

order - Determines the order of the results. You can order the results by 'userId'. The default order for this service is 'userId,asc'. The general format is: 'property[,asc|desc]', with 'asc' being the default value. (optional)

Returns:

PageableUserInfoList

Throws:

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

getUserListWithHttpInfo

public ApiResponse<PageableUserInfoList> getUserListWithHttpInfo(String minRegistrationDate,
                                                                 String maxRegistrationDate,
                                                                 String minDeletionDate,
                                                                 String maxDeletionDate,
                                                                 String minLastActiveDate,
                                                                 String maxLastActiveDate,
                                                                 Boolean includeMonthlyStats,
                                                                 String monthlyStatsStartDate,
                                                                 String monthlyStatsEndDate,
                                                                 Boolean isDeleted,
                                                                 Integer page,
                                                                 Integer perPage,
                                                                 List<String> order)
                                                          throws ApiException

Get user list <p>Get a list of the users of the mandator that is authorized by the access_token. Must pass the <a href='https://finapi.zendesk.com/hc/en-us/articles/115003661827-Difference-between-app-clients-and-mandator-admin-client'>mandator admin client</a>'s access_token. You can set optional search criteria to get only those users that you are interested in. If you do not specify any search criteria, then this service functions as a 'get all' service.</p><p>Note that the original user id is longer available in finAPI once a user has been deleted. Because of this, the userId of deleted users will be a distorted version of the original userId. For example, if the deleted user's id was originally 'user', then this service will return 'uXXr' as the userId.</p>

Parameters:

minRegistrationDate - Lower bound for a user's registration date, in the format 'YYYY-MM-DD' (e.g. '2016-01-01'). If specified, then only users whose 'registrationDate' is equal to or later than the given date will be regarded. (optional)

maxRegistrationDate - Upper bound for a user's registration date, in the format 'YYYY-MM-DD' (e.g. '2016-01-01'). If specified, then only users whose 'registrationDate' is equal to or earlier than the given date will be regarded. (optional)

minDeletionDate - Lower bound for a user's deletion date, in the format 'YYYY-MM-DD' (e.g. '2016-01-01'). If specified, then only users whose 'deletionDate' is not null, and is equal to or later than the given date will be regarded. (optional)

maxDeletionDate - Upper bound for a user's deletion date, in the format 'YYYY-MM-DD' (e.g. '2016-01-01'). If specified, then only users whose 'deletionDate' is null, or is equal to or earlier than the given date will be regarded. (optional)

minLastActiveDate - Lower bound for a user's last active date, in the format 'YYYY-MM-DD' (e.g. '2016-01-01'). If specified, then only users whose 'lastActiveDate' is not null, and is equal to or later than the given date will be regarded. (optional)

maxLastActiveDate - Upper bound for a user's last active date, in the format 'YYYY-MM-DD' (e.g. '2016-01-01'). If specified, then only users whose 'lastActiveDate' is null, or is equal to or earlier than the given date will be regarded. (optional)

includeMonthlyStats - Whether to include the 'monthlyStats' for the returned users. If not specified, then the field defaults to 'false'. (optional)

monthlyStatsStartDate - Minimum bound for the monthly stats (=oldest month that should be included). Must be passed in the format 'YYYY-MM'. If not specified, then the monthly stats will go back up to the first month in which the user existed (date of the user's registration). Note that this field is only regarded if 'includeMonthlyStats' = true. (optional)

monthlyStatsEndDate - Maximum bound for the monthly stats (=latest month that should be included). Must be passed in the format 'YYYY-MM'. If not specified, then the monthly stats will go up to either the current month (for active users), or up to the month of deletion (for deleted users). Note that this field is only regarded if 'includeMonthlyStats' = true. (optional)

isDeleted - If NOT specified, then the service will regard both active and deleted users in the search. If set to 'true', then ONLY deleted users will be regarded. If set to 'false', then ONLY active users will be regarded. (optional)

page - Result page that you want to retrieve (optional, default to 1)

perPage - Maximum number of records per page. Can be at most 500. NOTE: Due to its validation and visualization, the swagger frontend might show very low performance, or even crashes, when a service responds with a lot of data. It is recommended to use a HTTP client like Postman or DHC instead of our swagger frontend for service calls with large page sizes. (optional, default to 20)

order - Determines the order of the results. You can order the results by 'userId'. The default order for this service is 'userId,asc'. The general format is: 'property[,asc|desc]', with 'asc' being the default value. (optional)

Returns:

ApiResponse<PageableUserInfoList>

Throws:

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

getUserListAsync

public com.squareup.okhttp.Call getUserListAsync(String minRegistrationDate,
                                                 String maxRegistrationDate,
                                                 String minDeletionDate,
                                                 String maxDeletionDate,
                                                 String minLastActiveDate,
                                                 String maxLastActiveDate,
                                                 Boolean includeMonthlyStats,
                                                 String monthlyStatsStartDate,
                                                 String monthlyStatsEndDate,
                                                 Boolean isDeleted,
                                                 Integer page,
                                                 Integer perPage,
                                                 List<String> order,
                                                 ApiCallback<PageableUserInfoList> callback)
                                          throws ApiException

Get user list (asynchronously) <p>Get a list of the users of the mandator that is authorized by the access_token. Must pass the <a href='https://finapi.zendesk.com/hc/en-us/articles/115003661827-Difference-between-app-clients-and-mandator-admin-client'>mandator admin client</a>'s access_token. You can set optional search criteria to get only those users that you are interested in. If you do not specify any search criteria, then this service functions as a 'get all' service.</p><p>Note that the original user id is longer available in finAPI once a user has been deleted. Because of this, the userId of deleted users will be a distorted version of the original userId. For example, if the deleted user's id was originally 'user', then this service will return 'uXXr' as the userId.</p>

Parameters:

minRegistrationDate - Lower bound for a user's registration date, in the format 'YYYY-MM-DD' (e.g. '2016-01-01'). If specified, then only users whose 'registrationDate' is equal to or later than the given date will be regarded. (optional)

maxRegistrationDate - Upper bound for a user's registration date, in the format 'YYYY-MM-DD' (e.g. '2016-01-01'). If specified, then only users whose 'registrationDate' is equal to or earlier than the given date will be regarded. (optional)

minDeletionDate - Lower bound for a user's deletion date, in the format 'YYYY-MM-DD' (e.g. '2016-01-01'). If specified, then only users whose 'deletionDate' is not null, and is equal to or later than the given date will be regarded. (optional)

maxDeletionDate - Upper bound for a user's deletion date, in the format 'YYYY-MM-DD' (e.g. '2016-01-01'). If specified, then only users whose 'deletionDate' is null, or is equal to or earlier than the given date will be regarded. (optional)

minLastActiveDate - Lower bound for a user's last active date, in the format 'YYYY-MM-DD' (e.g. '2016-01-01'). If specified, then only users whose 'lastActiveDate' is not null, and is equal to or later than the given date will be regarded. (optional)

maxLastActiveDate - Upper bound for a user's last active date, in the format 'YYYY-MM-DD' (e.g. '2016-01-01'). If specified, then only users whose 'lastActiveDate' is null, or is equal to or earlier than the given date will be regarded. (optional)

includeMonthlyStats - Whether to include the 'monthlyStats' for the returned users. If not specified, then the field defaults to 'false'. (optional)

monthlyStatsStartDate - Minimum bound for the monthly stats (=oldest month that should be included). Must be passed in the format 'YYYY-MM'. If not specified, then the monthly stats will go back up to the first month in which the user existed (date of the user's registration). Note that this field is only regarded if 'includeMonthlyStats' = true. (optional)

monthlyStatsEndDate - Maximum bound for the monthly stats (=latest month that should be included). Must be passed in the format 'YYYY-MM'. If not specified, then the monthly stats will go up to either the current month (for active users), or up to the month of deletion (for deleted users). Note that this field is only regarded if 'includeMonthlyStats' = true. (optional)

isDeleted - If NOT specified, then the service will regard both active and deleted users in the search. If set to 'true', then ONLY deleted users will be regarded. If set to 'false', then ONLY active users will be regarded. (optional)

page - Result page that you want to retrieve (optional, default to 1)

perPage - Maximum number of records per page. Can be at most 500. NOTE: Due to its validation and visualization, the swagger frontend might show very low performance, or even crashes, when a service responds with a lot of data. It is recommended to use a HTTP client like Postman or DHC instead of our swagger frontend for service calls with large page sizes. (optional, default to 20)

order - Determines the order of the results. You can order the results by 'userId'. The default order for this service is 'userId,asc'. The general format is: 'property[,asc|desc]', with 'asc' being the default value. (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