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

Class ReceiptRoutesApi

java.lang.Object

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

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2020-08-14T13:43:37.324Z[UTC]")
public class ReceiptRoutesApi
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
ReceiptRoutesApi()
ReceiptRoutesApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
ResolutionStatementPage	searchAddressResolutionStatements(java.math.BigInteger height, java.lang.Integer pageSize, java.lang.Integer pageNumber, java.lang.String offset, Order order) Get receipts address resolution statements Gets an array of address resolution statements.
ApiResponse<ResolutionStatementPage>	searchAddressResolutionStatementsWithHttpInfo(java.math.BigInteger height, java.lang.Integer pageSize, java.lang.Integer pageNumber, java.lang.String offset, Order order) Get receipts address resolution statements Gets an array of address resolution statements.
ResolutionStatementPage	searchMosaicResolutionStatements(java.math.BigInteger height, java.lang.Integer pageSize, java.lang.Integer pageNumber, java.lang.String offset, Order order) Get receipts mosaic resolution statements Gets an array of mosaic resolution statements.
ApiResponse<ResolutionStatementPage>	searchMosaicResolutionStatementsWithHttpInfo(java.math.BigInteger height, java.lang.Integer pageSize, java.lang.Integer pageNumber, java.lang.String offset, Order order) Get receipts mosaic resolution statements Gets an array of mosaic resolution statements.
TransactionStatementPage	searchReceipts(java.math.BigInteger height, java.util.List<ReceiptTypeEnum> receiptType, java.lang.String recipientAddress, java.lang.String senderAddress, java.lang.String targetAddress, java.lang.String artifactId, java.lang.Integer pageSize, java.lang.Integer pageNumber, java.lang.String offset, Order order) Search transaction statements Gets an array of transaction statements.
ApiResponse<TransactionStatementPage>	searchReceiptsWithHttpInfo(java.math.BigInteger height, java.util.List<ReceiptTypeEnum> receiptType, java.lang.String recipientAddress, java.lang.String senderAddress, java.lang.String targetAddress, java.lang.String artifactId, java.lang.Integer pageSize, java.lang.Integer pageNumber, java.lang.String offset, Order order) Search transaction statements Gets an array of transaction statements.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

ReceiptRoutesApi

public ReceiptRoutesApi()

ReceiptRoutesApi

public ReceiptRoutesApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

searchAddressResolutionStatements

public ResolutionStatementPage searchAddressResolutionStatements(java.math.BigInteger height,
                                                                 java.lang.Integer pageSize,
                                                                 java.lang.Integer pageNumber,
                                                                 java.lang.String offset,
                                                                 Order order)
                                                          throws ApiException

Get receipts address resolution statements Gets an array of address resolution statements.

Parameters:

height - Filter by block height. (optional, default to null)

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:

ResolutionStatementPage

Throws:

ApiException - if fails to make API call

Http Response Details

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

searchAddressResolutionStatementsWithHttpInfo

public ApiResponse<ResolutionStatementPage> searchAddressResolutionStatementsWithHttpInfo(java.math.BigInteger height,
                                                                                          java.lang.Integer pageSize,
                                                                                          java.lang.Integer pageNumber,
                                                                                          java.lang.String offset,
                                                                                          Order order)
                                                                                   throws ApiException

Get receipts address resolution statements Gets an array of address resolution statements.

Parameters:

height - Filter by block height. (optional, default to null)

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<ResolutionStatementPage>

Throws:

ApiException - if fails to make API call

Http Response Details

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

searchMosaicResolutionStatements

public ResolutionStatementPage searchMosaicResolutionStatements(java.math.BigInteger height,
                                                                java.lang.Integer pageSize,
                                                                java.lang.Integer pageNumber,
                                                                java.lang.String offset,
                                                                Order order)
                                                         throws ApiException

Get receipts mosaic resolution statements Gets an array of mosaic resolution statements.

Parameters:

height - Filter by block height. (optional, default to null)

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:

ResolutionStatementPage

Throws:

ApiException - if fails to make API call

Http Response Details

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

searchMosaicResolutionStatementsWithHttpInfo

public ApiResponse<ResolutionStatementPage> searchMosaicResolutionStatementsWithHttpInfo(java.math.BigInteger height,
                                                                                         java.lang.Integer pageSize,
                                                                                         java.lang.Integer pageNumber,
                                                                                         java.lang.String offset,
                                                                                         Order order)
                                                                                  throws ApiException

Get receipts mosaic resolution statements Gets an array of mosaic resolution statements.

Parameters:

height - Filter by block height. (optional, default to null)

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<ResolutionStatementPage>

Throws:

ApiException - if fails to make API call

Http Response Details

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

searchReceipts

public TransactionStatementPage searchReceipts(java.math.BigInteger height,
                                               java.util.List<ReceiptTypeEnum> receiptType,
                                               java.lang.String recipientAddress,
                                               java.lang.String senderAddress,
                                               java.lang.String targetAddress,
                                               java.lang.String artifactId,
                                               java.lang.Integer pageSize,
                                               java.lang.Integer pageNumber,
                                               java.lang.String offset,
                                               Order order)
                                        throws ApiException

Search transaction statements Gets an array of transaction statements.

Parameters:

height - Filter by block height. (optional, default to null)

receiptType - Filter by receipt type. To filter by multiple receipt types, add more filter query params like: ``receiptType=8515&receiptType=20803``. (optional, default to new ArrayList<>())

recipientAddress - Filter by address of the account receiving the transaction. (optional)

senderAddress - Filter by address sending mosaics. (optional)

targetAddress - Filter by target address. (optional)

artifactId - Mosaic or namespace identifier (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:

TransactionStatementPage

Throws:

ApiException - if fails to make API call

Http Response Details

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

searchReceiptsWithHttpInfo

public ApiResponse<TransactionStatementPage> searchReceiptsWithHttpInfo(java.math.BigInteger height,
                                                                        java.util.List<ReceiptTypeEnum> receiptType,
                                                                        java.lang.String recipientAddress,
                                                                        java.lang.String senderAddress,
                                                                        java.lang.String targetAddress,
                                                                        java.lang.String artifactId,
                                                                        java.lang.Integer pageSize,
                                                                        java.lang.Integer pageNumber,
                                                                        java.lang.String offset,
                                                                        Order order)
                                                                 throws ApiException

Search transaction statements Gets an array of transaction statements.

Parameters:

height - Filter by block height. (optional, default to null)

receiptType - Filter by receipt type. To filter by multiple receipt types, add more filter query params like: ``receiptType=8515&receiptType=20803``. (optional, default to new ArrayList<>())

recipientAddress - Filter by address of the account receiving the transaction. (optional)

senderAddress - Filter by address sending mosaics. (optional)

targetAddress - Filter by target address. (optional)

artifactId - Mosaic or namespace identifier (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<TransactionStatementPage>

Throws:

ApiException - if fails to make API call

Http Response Details

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