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

Class HashLockRoutesApi

java.lang.Object

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

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

Constructor Summary

Constructors

Constructor and Description
HashLockRoutesApi()
HashLockRoutesApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
HashLockInfoDTO	getHashLock(java.lang.String hash) Get hash lock information Gets the hash lock for a given hash.
MerkleStateInfoDTO	getHashLockMerkle(java.lang.String hash) Get hash lock merkle information Gets the hash lock merkle for a given hash.
ApiResponse<MerkleStateInfoDTO>	getHashLockMerkleWithHttpInfo(java.lang.String hash) Get hash lock merkle information Gets the hash lock merkle for a given hash.
ApiResponse<HashLockInfoDTO>	getHashLockWithHttpInfo(java.lang.String hash) Get hash lock information Gets the hash lock for a given hash.
HashLockPage	searchHashLock(java.lang.String address, java.lang.Integer pageSize, java.lang.Integer pageNumber, java.lang.String offset, Order order) Search hash lock entries Returns an array of hash locks.
ApiResponse<HashLockPage>	searchHashLockWithHttpInfo(java.lang.String address, java.lang.Integer pageSize, java.lang.Integer pageNumber, java.lang.String offset, Order order) Search hash lock entries Returns an array of hash locks.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

HashLockRoutesApi

public HashLockRoutesApi()

HashLockRoutesApi

public HashLockRoutesApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getHashLock

public HashLockInfoDTO getHashLock(java.lang.String hash)
                            throws ApiException

Get hash lock information Gets the hash lock for a given hash.

Parameters:

hash - Filter by hash. (required)

Returns:

HashLockInfoDTO

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	success	-
409	InvalidArgument	-

getHashLockWithHttpInfo

public ApiResponse<HashLockInfoDTO> getHashLockWithHttpInfo(java.lang.String hash)
                                                     throws ApiException

Get hash lock information Gets the hash lock for a given hash.

Parameters:

hash - Filter by hash. (required)

Returns:

ApiResponse<HashLockInfoDTO>

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	success	-
409	InvalidArgument	-

getHashLockMerkle

public MerkleStateInfoDTO getHashLockMerkle(java.lang.String hash)
                                     throws ApiException

Get hash lock merkle information Gets the hash lock merkle for a given hash.

Parameters:

hash - Filter by hash. (required)

Returns:

MerkleStateInfoDTO

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	success	-
409	InvalidArgument	-

getHashLockMerkleWithHttpInfo

public ApiResponse<MerkleStateInfoDTO> getHashLockMerkleWithHttpInfo(java.lang.String hash)
                                                              throws ApiException

Get hash lock merkle information Gets the hash lock merkle for a given hash.

Parameters:

hash - Filter by hash. (required)

Returns:

ApiResponse<MerkleStateInfoDTO>

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	success	-
409	InvalidArgument	-

searchHashLock

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

Search hash lock entries Returns an array of hash locks.

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:

HashLockPage

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	success	-
409	InvalidArgument	-

searchHashLockWithHttpInfo

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

Search hash lock entries Returns an array of hash locks.

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

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	success	-
409	InvalidArgument	-