io.nem.sdk.openapi.okhttp_gson.api

Class BlockRoutesApi

java.lang.Object

io.nem.sdk.openapi.okhttp_gson.api.BlockRoutesApi

public class BlockRoutesApi
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
BlockRoutesApi()
BlockRoutesApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
BlockInfoDTO	getBlockByHeight(java.lang.Long height) Get block information Gets a block from the chain that has the given height.
okhttp3.Call	getBlockByHeightAsync(java.lang.Long height, ApiCallback<BlockInfoDTO> _callback) Get block information (asynchronously) Gets a block from the chain that has the given height.
okhttp3.Call	getBlockByHeightCall(java.lang.Long height, ApiCallback _callback) Build call for getBlockByHeight
ApiResponse<BlockInfoDTO>	getBlockByHeightWithHttpInfo(java.lang.Long height) Get block information Gets a block from the chain that has the given height.
StatementsDTO	getBlockReceipts(java.lang.Long height) Get receipts from a block Returns the receipts linked to a block.
okhttp3.Call	getBlockReceiptsAsync(java.lang.Long height, ApiCallback<StatementsDTO> _callback) Get receipts from a block (asynchronously) Returns the receipts linked to a block.
okhttp3.Call	getBlockReceiptsCall(java.lang.Long height, ApiCallback _callback) Build call for getBlockReceipts
ApiResponse<StatementsDTO>	getBlockReceiptsWithHttpInfo(java.lang.Long height) Get receipts from a block Returns the receipts linked to a block.
java.util.List<BlockInfoDTO>	getBlocksByHeightWithLimit(java.lang.Long height, java.lang.Integer limit) Get blocks information Gets up to limit number of blocks after given block height.
okhttp3.Call	getBlocksByHeightWithLimitAsync(java.lang.Long height, java.lang.Integer limit, ApiCallback<java.util.List<BlockInfoDTO>> _callback) Get blocks information (asynchronously) Gets up to limit number of blocks after given block height.
okhttp3.Call	getBlocksByHeightWithLimitCall(java.lang.Long height, java.lang.Integer limit, ApiCallback _callback) Build call for getBlocksByHeightWithLimit
ApiResponse<java.util.List<BlockInfoDTO>>	getBlocksByHeightWithLimitWithHttpInfo(java.lang.Long height, java.lang.Integer limit) Get blocks information Gets up to limit number of blocks after given block height.
java.util.List<TransactionInfoDTO>	getBlockTransactions(java.lang.Long height, java.lang.Integer pageSize, java.lang.String id, java.lang.String ordering) Get transactions from a block Returns an array of transactions included in a block for a given block height.
okhttp3.Call	getBlockTransactionsAsync(java.lang.Long height, java.lang.Integer pageSize, java.lang.String id, java.lang.String ordering, ApiCallback<java.util.List<TransactionInfoDTO>> _callback) Get transactions from a block (asynchronously) Returns an array of transactions included in a block for a given block height.
okhttp3.Call	getBlockTransactionsCall(java.lang.Long height, java.lang.Integer pageSize, java.lang.String id, java.lang.String ordering, ApiCallback _callback) Build call for getBlockTransactions
ApiResponse<java.util.List<TransactionInfoDTO>>	getBlockTransactionsWithHttpInfo(java.lang.Long height, java.lang.Integer pageSize, java.lang.String id, java.lang.String ordering) Get transactions from a block Returns an array of transactions included in a block for a given block height.
MerkleProofInfoDTO	getMerkleReceipts(java.lang.Long height, java.lang.String hash) Get the merkle path for a given a receipt statement hash and block Returns the merkle path for a receipt statement or resolution linked to a block.
okhttp3.Call	getMerkleReceiptsAsync(java.lang.Long height, java.lang.String hash, ApiCallback<MerkleProofInfoDTO> _callback) Get the merkle path for a given a receipt statement hash and block (asynchronously) Returns the merkle path for a receipt statement or resolution linked to a block.
okhttp3.Call	getMerkleReceiptsCall(java.lang.Long height, java.lang.String hash, ApiCallback _callback) Build call for getMerkleReceipts
ApiResponse<MerkleProofInfoDTO>	getMerkleReceiptsWithHttpInfo(java.lang.Long height, java.lang.String hash) Get the merkle path for a given a receipt statement hash and block Returns the merkle path for a receipt statement or resolution linked to a block.
MerkleProofInfoDTO	getMerkleTransaction(java.lang.Long height, java.lang.String hash) Get the merkle path for a given a transaction and block Returns the merkle path for a transaction included in a block.
okhttp3.Call	getMerkleTransactionAsync(java.lang.Long height, java.lang.String hash, ApiCallback<MerkleProofInfoDTO> _callback) Get the merkle path for a given a transaction and block (asynchronously) Returns the merkle path for a transaction included in a block.
okhttp3.Call	getMerkleTransactionCall(java.lang.Long height, java.lang.String hash, ApiCallback _callback) Build call for getMerkleTransaction
ApiResponse<MerkleProofInfoDTO>	getMerkleTransactionWithHttpInfo(java.lang.Long height, java.lang.String hash) Get the merkle path for a given a transaction and block Returns the merkle path for a transaction included in a block.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

BlockRoutesApi

public BlockRoutesApi()

BlockRoutesApi

public BlockRoutesApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getBlockByHeightCall

public okhttp3.Call getBlockByHeightCall(java.lang.Long height,
                                         ApiCallback _callback)
                                  throws ApiException

Build call for getBlockByHeight

Parameters:

height - Block height. If height -1 is not a multiple of the limit provided, the inferior closest multiple + 1 is used instead. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

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

getBlockByHeight

public BlockInfoDTO getBlockByHeight(java.lang.Long height)
                              throws ApiException

Get block information Gets a block from the chain that has the given height.

Parameters:

height - Block height. If height -1 is not a multiple of the limit provided, the inferior closest multiple + 1 is used instead. (required)

Returns:

BlockInfoDTO

Throws:

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

Http Response Details

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

getBlockByHeightWithHttpInfo

public ApiResponse<BlockInfoDTO> getBlockByHeightWithHttpInfo(java.lang.Long height)
                                                       throws ApiException

Get block information Gets a block from the chain that has the given height.

Parameters:

height - Block height. If height -1 is not a multiple of the limit provided, the inferior closest multiple + 1 is used instead. (required)

Returns:

ApiResponse<BlockInfoDTO>

Throws:

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

Http Response Details

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

getBlockByHeightAsync

public okhttp3.Call getBlockByHeightAsync(java.lang.Long height,
                                          ApiCallback<BlockInfoDTO> _callback)
                                   throws ApiException

Get block information (asynchronously) Gets a block from the chain that has the given height.

Parameters:

height - Block height. If height -1 is not a multiple of the limit provided, the inferior closest multiple + 1 is used instead. (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

Http Response Details

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

getBlockReceiptsCall

public okhttp3.Call getBlockReceiptsCall(java.lang.Long height,
                                         ApiCallback _callback)
                                  throws ApiException

Build call for getBlockReceipts

Parameters:

height - Block height. If height -1 is not a multiple of the limit provided, the inferior closest multiple + 1 is used instead. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

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

getBlockReceipts

public StatementsDTO getBlockReceipts(java.lang.Long height)
                               throws ApiException

Get receipts from a block Returns the receipts linked to a block.

Parameters:

height - Block height. If height -1 is not a multiple of the limit provided, the inferior closest multiple + 1 is used instead. (required)

Returns:

StatementsDTO

Throws:

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

Http Response Details

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

getBlockReceiptsWithHttpInfo

public ApiResponse<StatementsDTO> getBlockReceiptsWithHttpInfo(java.lang.Long height)
                                                        throws ApiException

Get receipts from a block Returns the receipts linked to a block.

Parameters:

height - Block height. If height -1 is not a multiple of the limit provided, the inferior closest multiple + 1 is used instead. (required)

Returns:

ApiResponse<StatementsDTO>

Throws:

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

Http Response Details

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

getBlockReceiptsAsync

public okhttp3.Call getBlockReceiptsAsync(java.lang.Long height,
                                          ApiCallback<StatementsDTO> _callback)
                                   throws ApiException

Get receipts from a block (asynchronously) Returns the receipts linked to a block.

Parameters:

height - Block height. If height -1 is not a multiple of the limit provided, the inferior closest multiple + 1 is used instead. (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

Http Response Details

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

getBlockTransactionsCall

public okhttp3.Call getBlockTransactionsCall(java.lang.Long height,
                                             java.lang.Integer pageSize,
                                             java.lang.String id,
                                             java.lang.String ordering,
                                             ApiCallback _callback)
                                      throws ApiException

Build call for getBlockTransactions

Parameters:

height - Block height. If height -1 is not a multiple of the limit provided, the inferior closest multiple + 1 is used instead. (required)

pageSize - Number of transactions to return for each request. (optional, default to 10)

id - Transaction identifier up to which transactions are returned. (optional)

ordering - Ordering criteria: * -id - Descending order by id. * id - Ascending order by id. (optional, default to "-id")

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

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

getBlockTransactions

public java.util.List<TransactionInfoDTO> getBlockTransactions(java.lang.Long height,
                                                               java.lang.Integer pageSize,
                                                               java.lang.String id,
                                                               java.lang.String ordering)
                                                        throws ApiException

Get transactions from a block Returns an array of transactions included in a block for a given block height.

Parameters:

height - Block height. If height -1 is not a multiple of the limit provided, the inferior closest multiple + 1 is used instead. (required)

pageSize - Number of transactions to return for each request. (optional, default to 10)

id - Transaction identifier up to which transactions are returned. (optional)

ordering - Ordering criteria: * -id - Descending order by id. * id - Ascending order by id. (optional, default to "-id")

Returns:

List<TransactionInfoDTO>

Throws:

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

Http Response Details

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

getBlockTransactionsWithHttpInfo

public ApiResponse<java.util.List<TransactionInfoDTO>> getBlockTransactionsWithHttpInfo(java.lang.Long height,
                                                                                        java.lang.Integer pageSize,
                                                                                        java.lang.String id,
                                                                                        java.lang.String ordering)
                                                                                 throws ApiException

Get transactions from a block Returns an array of transactions included in a block for a given block height.

Parameters:

height - Block height. If height -1 is not a multiple of the limit provided, the inferior closest multiple + 1 is used instead. (required)

pageSize - Number of transactions to return for each request. (optional, default to 10)

id - Transaction identifier up to which transactions are returned. (optional)

ordering - Ordering criteria: * -id - Descending order by id. * id - Ascending order by id. (optional, default to "-id")

Returns:

ApiResponse<List<TransactionInfoDTO>>

Throws:

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

Http Response Details

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

getBlockTransactionsAsync

public okhttp3.Call getBlockTransactionsAsync(java.lang.Long height,
                                              java.lang.Integer pageSize,
                                              java.lang.String id,
                                              java.lang.String ordering,
                                              ApiCallback<java.util.List<TransactionInfoDTO>> _callback)
                                       throws ApiException

Get transactions from a block (asynchronously) Returns an array of transactions included in a block for a given block height.

Parameters:

height - Block height. If height -1 is not a multiple of the limit provided, the inferior closest multiple + 1 is used instead. (required)

pageSize - Number of transactions to return for each request. (optional, default to 10)

id - Transaction identifier up to which transactions are returned. (optional)

ordering - Ordering criteria: * -id - Descending order by id. * id - Ascending order by id. (optional, default to "-id")

_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

Http Response Details

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

getBlocksByHeightWithLimitCall

public okhttp3.Call getBlocksByHeightWithLimitCall(java.lang.Long height,
                                                   java.lang.Integer limit,
                                                   ApiCallback _callback)
                                            throws ApiException

Build call for getBlocksByHeightWithLimit

Parameters:

height - Block height. If height -1 is not a multiple of the limit provided, the inferior closest multiple + 1 is used instead. (required)

limit - Number of elements to be returned. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Status Code	Description	Response Headers
200	success	-
409	InvalidArgument	-

getBlocksByHeightWithLimit

public java.util.List<BlockInfoDTO> getBlocksByHeightWithLimit(java.lang.Long height,
                                                               java.lang.Integer limit)
                                                        throws ApiException

Get blocks information Gets up to limit number of blocks after given block height.

Parameters:

height - Block height. If height -1 is not a multiple of the limit provided, the inferior closest multiple + 1 is used instead. (required)

limit - Number of elements to be returned. (required)

Returns:

List<BlockInfoDTO>

Throws:

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

Http Response Details

Status Code	Description	Response Headers
200	success	-
409	InvalidArgument	-

getBlocksByHeightWithLimitWithHttpInfo

public ApiResponse<java.util.List<BlockInfoDTO>> getBlocksByHeightWithLimitWithHttpInfo(java.lang.Long height,
                                                                                        java.lang.Integer limit)
                                                                                 throws ApiException

Get blocks information Gets up to limit number of blocks after given block height.

Parameters:

height - Block height. If height -1 is not a multiple of the limit provided, the inferior closest multiple + 1 is used instead. (required)

limit - Number of elements to be returned. (required)

Returns:

ApiResponse<List<BlockInfoDTO>>

Throws:

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

Http Response Details

Status Code	Description	Response Headers
200	success	-
409	InvalidArgument	-

getBlocksByHeightWithLimitAsync

public okhttp3.Call getBlocksByHeightWithLimitAsync(java.lang.Long height,
                                                    java.lang.Integer limit,
                                                    ApiCallback<java.util.List<BlockInfoDTO>> _callback)
                                             throws ApiException

Get blocks information (asynchronously) Gets up to limit number of blocks after given block height.

Parameters:

height - Block height. If height -1 is not a multiple of the limit provided, the inferior closest multiple + 1 is used instead. (required)

limit - Number of elements to be returned. (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

Http Response Details

Status Code	Description	Response Headers
200	success	-
409	InvalidArgument	-

getMerkleReceiptsCall

public okhttp3.Call getMerkleReceiptsCall(java.lang.Long height,
                                          java.lang.String hash,
                                          ApiCallback _callback)
                                   throws ApiException

Build call for getMerkleReceipts

Parameters:

height - Block height. If height -1 is not a multiple of the limit provided, the inferior closest multiple + 1 is used instead. (required)

hash - Receipt hash. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

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

getMerkleReceipts

public MerkleProofInfoDTO getMerkleReceipts(java.lang.Long height,
                                            java.lang.String hash)
                                     throws ApiException

Get the merkle path for a given a receipt statement hash and block Returns the merkle path for a receipt statement or resolution linked to a block. The path is the complementary data needed to calculate the merkle root. A client can compare if the calculated root equals the one recorded in the block header, verifying that the receipt was linked with the block.

Parameters:

height - Block height. If height -1 is not a multiple of the limit provided, the inferior closest multiple + 1 is used instead. (required)

hash - Receipt hash. (required)

Returns:

MerkleProofInfoDTO

Throws:

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

Http Response Details

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

getMerkleReceiptsWithHttpInfo

public ApiResponse<MerkleProofInfoDTO> getMerkleReceiptsWithHttpInfo(java.lang.Long height,
                                                                     java.lang.String hash)
                                                              throws ApiException

Get the merkle path for a given a receipt statement hash and block Returns the merkle path for a receipt statement or resolution linked to a block. The path is the complementary data needed to calculate the merkle root. A client can compare if the calculated root equals the one recorded in the block header, verifying that the receipt was linked with the block.

Parameters:

height - Block height. If height -1 is not a multiple of the limit provided, the inferior closest multiple + 1 is used instead. (required)

hash - Receipt hash. (required)

Returns:

ApiResponse<MerkleProofInfoDTO>

Throws:

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

Http Response Details

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

getMerkleReceiptsAsync

public okhttp3.Call getMerkleReceiptsAsync(java.lang.Long height,
                                           java.lang.String hash,
                                           ApiCallback<MerkleProofInfoDTO> _callback)
                                    throws ApiException

Get the merkle path for a given a receipt statement hash and block (asynchronously) Returns the merkle path for a receipt statement or resolution linked to a block. The path is the complementary data needed to calculate the merkle root. A client can compare if the calculated root equals the one recorded in the block header, verifying that the receipt was linked with the block.

Parameters:

height - Block height. If height -1 is not a multiple of the limit provided, the inferior closest multiple + 1 is used instead. (required)

hash - Receipt hash. (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

Http Response Details

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

getMerkleTransactionCall

public okhttp3.Call getMerkleTransactionCall(java.lang.Long height,
                                             java.lang.String hash,
                                             ApiCallback _callback)
                                      throws ApiException

Build call for getMerkleTransaction

Parameters:

height - Block height. If height -1 is not a multiple of the limit provided, the inferior closest multiple + 1 is used instead. (required)

hash - Transaction hash. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

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

getMerkleTransaction

public MerkleProofInfoDTO getMerkleTransaction(java.lang.Long height,
                                               java.lang.String hash)
                                        throws ApiException

Get the merkle path for a given a transaction and block Returns the merkle path for a transaction included in a block. The path is the complementary data needed to calculate the merkle root. A client can compare if the calculated root equals the one recorded in the block header, verifying that the transaction was included in the block.

Parameters:

height - Block height. If height -1 is not a multiple of the limit provided, the inferior closest multiple + 1 is used instead. (required)

hash - Transaction hash. (required)

Returns:

MerkleProofInfoDTO

Throws:

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

Http Response Details

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

getMerkleTransactionWithHttpInfo

public ApiResponse<MerkleProofInfoDTO> getMerkleTransactionWithHttpInfo(java.lang.Long height,
                                                                        java.lang.String hash)
                                                                 throws ApiException

Get the merkle path for a given a transaction and block Returns the merkle path for a transaction included in a block. The path is the complementary data needed to calculate the merkle root. A client can compare if the calculated root equals the one recorded in the block header, verifying that the transaction was included in the block.

Parameters:

height - Block height. If height -1 is not a multiple of the limit provided, the inferior closest multiple + 1 is used instead. (required)

hash - Transaction hash. (required)

Returns:

ApiResponse<MerkleProofInfoDTO>

Throws:

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

Http Response Details

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

getMerkleTransactionAsync

public okhttp3.Call getMerkleTransactionAsync(java.lang.Long height,
                                              java.lang.String hash,
                                              ApiCallback<MerkleProofInfoDTO> _callback)
                                       throws ApiException

Get the merkle path for a given a transaction and block (asynchronously) Returns the merkle path for a transaction included in a block. The path is the complementary data needed to calculate the merkle root. A client can compare if the calculated root equals the one recorded in the block header, verifying that the transaction was included in the block.

Parameters:

height - Block height. If height -1 is not a multiple of the limit provided, the inferior closest multiple + 1 is used instead. (required)

hash - Transaction hash. (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

Http Response Details

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