io.nem.symbol.sdk.openapi.jersey2.api

Class AccountRoutesApi

java.lang.Object

io.nem.symbol.sdk.openapi.jersey2.api.AccountRoutesApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2021-01-14T22:22:10.865Z[UTC]")
public class AccountRoutesApi
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
AccountRoutesApi()
AccountRoutesApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
AccountInfoDTO	getAccountInfo(java.lang.String accountId) Get account information Returns the account information.
MerkleStateInfoDTO	getAccountInfoMerkle(java.lang.String accountId) Get account merkle information Returns the account merkle information.
ApiResponse<MerkleStateInfoDTO>	getAccountInfoMerkleWithHttpInfo(java.lang.String accountId) Get account merkle information Returns the account merkle information.
ApiResponse<AccountInfoDTO>	getAccountInfoWithHttpInfo(java.lang.String accountId) Get account information Returns the account information.
java.util.List<AccountInfoDTO>	getAccountsInfo(AccountIds accountIds) Get accounts information Returns the account information for an array of accounts.
ApiResponse<java.util.List<AccountInfoDTO>>	getAccountsInfoWithHttpInfo(AccountIds accountIds) Get accounts information Returns the account information for an array of accounts.
ApiClient	getApiClient()
AccountPage	searchAccounts(java.lang.Integer pageSize, java.lang.Integer pageNumber, java.lang.String offset, Order order, AccountOrderByEnum orderBy, java.lang.String mosaicId) Search accounts Gets an array of accounts.
ApiResponse<AccountPage>	searchAccountsWithHttpInfo(java.lang.Integer pageSize, java.lang.Integer pageNumber, java.lang.String offset, Order order, AccountOrderByEnum orderBy, java.lang.String mosaicId) Search accounts Gets an array of accounts.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

AccountRoutesApi

public AccountRoutesApi()

AccountRoutesApi

public AccountRoutesApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getAccountInfo

public AccountInfoDTO getAccountInfo(java.lang.String accountId)
                              throws ApiException

Get account information Returns the account information.

Parameters:

accountId - Account public key or address encoded using a 32-character set. (required)

Returns:

AccountInfoDTO

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	success	-
404	ResourceNotFound	-
409	InvalidArgument	-

getAccountInfoWithHttpInfo

public ApiResponse<AccountInfoDTO> getAccountInfoWithHttpInfo(java.lang.String accountId)
                                                       throws ApiException

Get account information Returns the account information.

Parameters:

accountId - Account public key or address encoded using a 32-character set. (required)

Returns:

ApiResponse<AccountInfoDTO>

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	success	-
404	ResourceNotFound	-
409	InvalidArgument	-

getAccountInfoMerkle

public MerkleStateInfoDTO getAccountInfoMerkle(java.lang.String accountId)
                                        throws ApiException

Get account merkle information Returns the account merkle information.

Parameters:

accountId - Account public key or address encoded using a 32-character set. (required)

Returns:

MerkleStateInfoDTO

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	success	-
404	ResourceNotFound	-
409	InvalidArgument	-

getAccountInfoMerkleWithHttpInfo

public ApiResponse<MerkleStateInfoDTO> getAccountInfoMerkleWithHttpInfo(java.lang.String accountId)
                                                                 throws ApiException

Get account merkle information Returns the account merkle information.

Parameters:

accountId - Account public key or address encoded using a 32-character set. (required)

Returns:

ApiResponse<MerkleStateInfoDTO>

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	success	-
404	ResourceNotFound	-
409	InvalidArgument	-

getAccountsInfo

public java.util.List<AccountInfoDTO> getAccountsInfo(AccountIds accountIds)
                                               throws ApiException

Get accounts information Returns the account information for an array of accounts.

Parameters:

accountIds - (optional)

Returns:

List<AccountInfoDTO>

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	success	-
400	InvalidContent	-
409	InvalidArgument	-

getAccountsInfoWithHttpInfo

public ApiResponse<java.util.List<AccountInfoDTO>> getAccountsInfoWithHttpInfo(AccountIds accountIds)
                                                                        throws ApiException

Get accounts information Returns the account information for an array of accounts.

Parameters:

accountIds - (optional)

Returns:

ApiResponse<List<AccountInfoDTO>>

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	success	-
400	InvalidContent	-
409	InvalidArgument	-

searchAccounts

public AccountPage searchAccounts(java.lang.Integer pageSize,
                                  java.lang.Integer pageNumber,
                                  java.lang.String offset,
                                  Order order,
                                  AccountOrderByEnum orderBy,
                                  java.lang.String mosaicId)
                           throws ApiException

Search accounts Gets an array of accounts.

Parameters:

pageSize - Select the number of entries to return. (optional, default to 10)

pageNumber - Filter by page number. (optional, default to 1)

offset - Entry id at which to start pagination. If the ordering parameter is set to -id, the elements returned precede the identifier. Otherwise, newer elements with respect to the id are returned. (optional)

order - Sort responses in ascending or descending order based on the collection property set on the param ``orderBy``. If the request does not specify ``orderBy``, REST returns the collection ordered by id. (optional, default to desc)

orderBy - Sort responses by the property set. If ``balance`` option is selected, the request must define the ``mosaicId`` filter. (optional)

mosaicId - Filter by mosaic identifier. (optional)

Returns:

AccountPage

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	success	-
409	InvalidArgument	-

searchAccountsWithHttpInfo

public ApiResponse<AccountPage> searchAccountsWithHttpInfo(java.lang.Integer pageSize,
                                                           java.lang.Integer pageNumber,
                                                           java.lang.String offset,
                                                           Order order,
                                                           AccountOrderByEnum orderBy,
                                                           java.lang.String mosaicId)
                                                    throws ApiException

Search accounts Gets an array of accounts.

Parameters:

pageSize - Select the number of entries to return. (optional, default to 10)

pageNumber - Filter by page number. (optional, default to 1)

offset - Entry id at which to start pagination. If the ordering parameter is set to -id, the elements returned precede the identifier. Otherwise, newer elements with respect to the id are returned. (optional)

order - Sort responses in ascending or descending order based on the collection property set on the param ``orderBy``. If the request does not specify ``orderBy``, REST returns the collection ordered by id. (optional, default to desc)

orderBy - Sort responses by the property set. If ``balance`` option is selected, the request must define the ``mosaicId`` filter. (optional)

mosaicId - Filter by mosaic identifier. (optional)

Returns:

ApiResponse<AccountPage>

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	success	-
409	InvalidArgument	-