io.nem.sdk.openapi.jersey2.api

Class BlockRoutesApi

java.lang.Object

io.nem.sdk.openapi.jersey2.api.BlockRoutesApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2019-10-15T22:22:43.352+02:00[Europe/Madrid]")
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.
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.
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.
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.
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.
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.
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)

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 fails to make API call

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 fails to make API call

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 fails to make API call

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 fails to make API call

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 fails to make API call

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 fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	success	-
404	ResourceNotFound	-
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 fails to make API call

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 fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	success	-
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 fails to make API call

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 fails to make API call

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 fails to make API call

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 fails to make API call

Http Response Details

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