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

Class RestrictionAccountRoutesApi

java.lang.Object

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

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2021-11-12T11:58:50.284Z[UTC]")
public class RestrictionAccountRoutesApi
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
RestrictionAccountRoutesApi()
RestrictionAccountRoutesApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
AccountRestrictionsInfoDTO	getAccountRestrictions(java.lang.String address) Get the account restrictions Returns the account restrictions for a given address.
MerkleStateInfoDTO	getAccountRestrictionsMerkle(java.lang.String address) Get the account restrictions merkle Returns the account restrictions merkle for a given address.
ApiResponse<MerkleStateInfoDTO>	getAccountRestrictionsMerkleWithHttpInfo(java.lang.String address) Get the account restrictions merkle Returns the account restrictions merkle for a given address.
ApiResponse<AccountRestrictionsInfoDTO>	getAccountRestrictionsWithHttpInfo(java.lang.String address) Get the account restrictions Returns the account restrictions for a given address.
ApiClient	getApiClient()
AccountRestrictionsPage	searchAccountRestrictions(java.lang.String address, java.lang.Integer pageSize, java.lang.Integer pageNumber, java.lang.String offset, Order order) Search account restrictions Returns an array of account restrictions.
ApiResponse<AccountRestrictionsPage>	searchAccountRestrictionsWithHttpInfo(java.lang.String address, java.lang.Integer pageSize, java.lang.Integer pageNumber, java.lang.String offset, Order order) Search account restrictions Returns an array of account restrictions.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

RestrictionAccountRoutesApi

public RestrictionAccountRoutesApi()

RestrictionAccountRoutesApi

public RestrictionAccountRoutesApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getAccountRestrictions

public AccountRestrictionsInfoDTO getAccountRestrictions(java.lang.String address)
                                                  throws ApiException

Get the account restrictions Returns the account restrictions for a given address.

Parameters:

address - Account address. (required)

Returns:

AccountRestrictionsInfoDTO

Throws:

ApiException - if fails to make API call

Http Response Details

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

getAccountRestrictionsWithHttpInfo

public ApiResponse<AccountRestrictionsInfoDTO> getAccountRestrictionsWithHttpInfo(java.lang.String address)
                                                                           throws ApiException

Get the account restrictions Returns the account restrictions for a given address.

Parameters:

address - Account address. (required)

Returns:

ApiResponse<AccountRestrictionsInfoDTO>

Throws:

ApiException - if fails to make API call

Http Response Details

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

getAccountRestrictionsMerkle

public MerkleStateInfoDTO getAccountRestrictionsMerkle(java.lang.String address)
                                                throws ApiException

Get the account restrictions merkle Returns the account restrictions merkle for a given address.

Parameters:

address - Account address. (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	-

getAccountRestrictionsMerkleWithHttpInfo

public ApiResponse<MerkleStateInfoDTO> getAccountRestrictionsMerkleWithHttpInfo(java.lang.String address)
                                                                         throws ApiException

Get the account restrictions merkle Returns the account restrictions merkle for a given address.

Parameters:

address - Account address. (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	-

searchAccountRestrictions

public AccountRestrictionsPage searchAccountRestrictions(java.lang.String address,
                                                         java.lang.Integer pageSize,
                                                         java.lang.Integer pageNumber,
                                                         java.lang.String offset,
                                                         Order order)
                                                  throws ApiException

Search account restrictions Returns an array of account restrictions.

Parameters:

address - Filter by address involved in the transaction. An account's address is considered to be involved in the transaction when the account is the sender, recipient, or it is required to cosign the transaction. This filter cannot be combined with ``recipientAddress`` and ``signerPublicKey`` query params. (optional)

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)

Returns:

AccountRestrictionsPage

Throws:

ApiException - if fails to make API call

Http Response Details

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

searchAccountRestrictionsWithHttpInfo

public ApiResponse<AccountRestrictionsPage> searchAccountRestrictionsWithHttpInfo(java.lang.String address,
                                                                                  java.lang.Integer pageSize,
                                                                                  java.lang.Integer pageNumber,
                                                                                  java.lang.String offset,
                                                                                  Order order)
                                                                           throws ApiException

Search account restrictions Returns an array of account restrictions.

Parameters:

address - Filter by address involved in the transaction. An account's address is considered to be involved in the transaction when the account is the sender, recipient, or it is required to cosign the transaction. This filter cannot be combined with ``recipientAddress`` and ``signerPublicKey`` query params. (optional)

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)

Returns:

ApiResponse<AccountRestrictionsPage>

Throws:

ApiException - if fails to make API call

Http Response Details

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