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

Class SecretLockRoutesApi

java.lang.Object

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

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2021-01-14T22:22:10.865Z[UTC]")
public class SecretLockRoutesApi
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
SecretLockRoutesApi()
SecretLockRoutesApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
SecretLockInfoDTO	getSecretLock(java.lang.String compositeHash) Get secret lock information Gets the hash lock for a given composite hash.
MerkleStateInfoDTO	getSecretLockMerkle(java.lang.String compositeHash) Get secret lock merkle information Gets the hash lock merkle for a given composite hash.
ApiResponse<MerkleStateInfoDTO>	getSecretLockMerkleWithHttpInfo(java.lang.String compositeHash) Get secret lock merkle information Gets the hash lock merkle for a given composite hash.
ApiResponse<SecretLockInfoDTO>	getSecretLockWithHttpInfo(java.lang.String compositeHash) Get secret lock information Gets the hash lock for a given composite hash.
SecretLockPage	searchSecretLock(java.lang.String address, java.lang.String secret, java.lang.Integer pageSize, java.lang.Integer pageNumber, java.lang.String offset, Order order) Search secret lock entries Returns an array of secret locks.
ApiResponse<SecretLockPage>	searchSecretLockWithHttpInfo(java.lang.String address, java.lang.String secret, java.lang.Integer pageSize, java.lang.Integer pageNumber, java.lang.String offset, Order order) Search secret lock entries Returns an array of secret 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

SecretLockRoutesApi

public SecretLockRoutesApi()

SecretLockRoutesApi

public SecretLockRoutesApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getSecretLock

public SecretLockInfoDTO getSecretLock(java.lang.String compositeHash)
                                throws ApiException

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

Parameters:

compositeHash - Filter by composite hash. (required)

Returns:

SecretLockInfoDTO

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	success	-
409	InvalidArgument	-

getSecretLockWithHttpInfo

public ApiResponse<SecretLockInfoDTO> getSecretLockWithHttpInfo(java.lang.String compositeHash)
                                                         throws ApiException

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

Parameters:

compositeHash - Filter by composite hash. (required)

Returns:

ApiResponse<SecretLockInfoDTO>

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	success	-
409	InvalidArgument	-

getSecretLockMerkle

public MerkleStateInfoDTO getSecretLockMerkle(java.lang.String compositeHash)
                                       throws ApiException

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

Parameters:

compositeHash - Filter by composite hash. (required)

Returns:

MerkleStateInfoDTO

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	success	-
409	InvalidArgument	-

getSecretLockMerkleWithHttpInfo

public ApiResponse<MerkleStateInfoDTO> getSecretLockMerkleWithHttpInfo(java.lang.String compositeHash)
                                                                throws ApiException

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

Parameters:

compositeHash - Filter by composite 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	-

searchSecretLock

public SecretLockPage searchSecretLock(java.lang.String address,
                                       java.lang.String secret,
                                       java.lang.Integer pageSize,
                                       java.lang.Integer pageNumber,
                                       java.lang.String offset,
                                       Order order)
                                throws ApiException

Search secret lock entries Returns an array of secret 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)

secret - Filter by secret. (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:

SecretLockPage

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	success	-
409	InvalidArgument	-

searchSecretLockWithHttpInfo

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

Search secret lock entries Returns an array of secret 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)

secret - Filter by secret. (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<SecretLockPage>

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	success	-
409	InvalidArgument	-