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

Class NamespaceRoutesApi

java.lang.Object

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

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

Constructor Summary

Constructors

Constructor and Description
NamespaceRoutesApi()
NamespaceRoutesApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
AccountsNamesDTO	getAccountsNames(Addresses addresses) Get readable names for a set of accountIds Returns friendly names for accounts.
ApiResponse<AccountsNamesDTO>	getAccountsNamesWithHttpInfo(Addresses addresses) Get readable names for a set of accountIds Returns friendly names for accounts.
ApiClient	getApiClient()
MosaicsNamesDTO	getMosaicsNames(MosaicIds mosaicIds) Get readable names for a set of mosaics Returns friendly names for mosaics.
ApiResponse<MosaicsNamesDTO>	getMosaicsNamesWithHttpInfo(MosaicIds mosaicIds) Get readable names for a set of mosaics Returns friendly names for mosaics.
NamespaceInfoDTO	getNamespace(java.lang.String namespaceId) Get namespace information Gets the namespace for a given namespace identifier.
MerkleStateInfoDTO	getNamespaceMerkle(java.lang.String namespaceId) Get namespace merkle information Gets the namespace merkle for a given namespace identifier.
ApiResponse<MerkleStateInfoDTO>	getNamespaceMerkleWithHttpInfo(java.lang.String namespaceId) Get namespace merkle information Gets the namespace merkle for a given namespace identifier.
java.util.List<NamespaceNameDTO>	getNamespacesNames(NamespaceIds namespaceIds) Get readable names for a set of namespaces Returns friendly names for namespaces.
ApiResponse<java.util.List<NamespaceNameDTO>>	getNamespacesNamesWithHttpInfo(NamespaceIds namespaceIds) Get readable names for a set of namespaces Returns friendly names for namespaces.
ApiResponse<NamespaceInfoDTO>	getNamespaceWithHttpInfo(java.lang.String namespaceId) Get namespace information Gets the namespace for a given namespace identifier.
NamespacePage	searchNamespaces(java.lang.String ownerAddress, NamespaceRegistrationTypeEnum registrationType, java.lang.String level0, AliasTypeEnum aliasType, java.lang.Integer pageSize, java.lang.Integer pageNumber, java.lang.String offset, Order order) Search namespaces Gets an array of namespaces.
ApiResponse<NamespacePage>	searchNamespacesWithHttpInfo(java.lang.String ownerAddress, NamespaceRegistrationTypeEnum registrationType, java.lang.String level0, AliasTypeEnum aliasType, java.lang.Integer pageSize, java.lang.Integer pageNumber, java.lang.String offset, Order order) Search namespaces Gets an array of namespaces.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

NamespaceRoutesApi

public NamespaceRoutesApi()

NamespaceRoutesApi

public NamespaceRoutesApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getAccountsNames

public AccountsNamesDTO getAccountsNames(Addresses addresses)
                                  throws ApiException

Get readable names for a set of accountIds Returns friendly names for accounts.

Parameters:

addresses - (required)

Returns:

AccountsNamesDTO

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	success	-
400	InvalidContent	-
409	InvalidArgument	-

getAccountsNamesWithHttpInfo

public ApiResponse<AccountsNamesDTO> getAccountsNamesWithHttpInfo(Addresses addresses)
                                                           throws ApiException

Get readable names for a set of accountIds Returns friendly names for accounts.

Parameters:

addresses - (required)

Returns:

ApiResponse<AccountsNamesDTO>

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	success	-
400	InvalidContent	-
409	InvalidArgument	-

getMosaicsNames

public MosaicsNamesDTO getMosaicsNames(MosaicIds mosaicIds)
                                throws ApiException

Get readable names for a set of mosaics Returns friendly names for mosaics.

Parameters:

mosaicIds - (required)

Returns:

MosaicsNamesDTO

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	success	-
400	InvalidContent	-
409	InvalidArgument	-

getMosaicsNamesWithHttpInfo

public ApiResponse<MosaicsNamesDTO> getMosaicsNamesWithHttpInfo(MosaicIds mosaicIds)
                                                         throws ApiException

Get readable names for a set of mosaics Returns friendly names for mosaics.

Parameters:

mosaicIds - (required)

Returns:

ApiResponse<MosaicsNamesDTO>

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	success	-
400	InvalidContent	-
409	InvalidArgument	-

getNamespace

public NamespaceInfoDTO getNamespace(java.lang.String namespaceId)
                              throws ApiException

Get namespace information Gets the namespace for a given namespace identifier.

Parameters:

namespaceId - Namespace identifier. (required)

Returns:

NamespaceInfoDTO

Throws:

ApiException - if fails to make API call

Http Response Details

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

getNamespaceWithHttpInfo

public ApiResponse<NamespaceInfoDTO> getNamespaceWithHttpInfo(java.lang.String namespaceId)
                                                       throws ApiException

Get namespace information Gets the namespace for a given namespace identifier.

Parameters:

namespaceId - Namespace identifier. (required)

Returns:

ApiResponse<NamespaceInfoDTO>

Throws:

ApiException - if fails to make API call

Http Response Details

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

getNamespaceMerkle

public MerkleStateInfoDTO getNamespaceMerkle(java.lang.String namespaceId)
                                      throws ApiException

Get namespace merkle information Gets the namespace merkle for a given namespace identifier.

Parameters:

namespaceId - Namespace identifier. (required)

Returns:

MerkleStateInfoDTO

Throws:

ApiException - if fails to make API call

Http Response Details

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

getNamespaceMerkleWithHttpInfo

public ApiResponse<MerkleStateInfoDTO> getNamespaceMerkleWithHttpInfo(java.lang.String namespaceId)
                                                               throws ApiException

Get namespace merkle information Gets the namespace merkle for a given namespace identifier.

Parameters:

namespaceId - Namespace identifier. (required)

Returns:

ApiResponse<MerkleStateInfoDTO>

Throws:

ApiException - if fails to make API call

Http Response Details

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

getNamespacesNames

public java.util.List<NamespaceNameDTO> getNamespacesNames(NamespaceIds namespaceIds)
                                                    throws ApiException

Get readable names for a set of namespaces Returns friendly names for namespaces.

Parameters:

namespaceIds - (required)

Returns:

List<NamespaceNameDTO>

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	success	-
400	InvalidContent	-
409	InvalidArgument	-

getNamespacesNamesWithHttpInfo

public ApiResponse<java.util.List<NamespaceNameDTO>> getNamespacesNamesWithHttpInfo(NamespaceIds namespaceIds)
                                                                             throws ApiException

Get readable names for a set of namespaces Returns friendly names for namespaces.

Parameters:

namespaceIds - (required)

Returns:

ApiResponse<List<NamespaceNameDTO>>

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	success	-
400	InvalidContent	-
409	InvalidArgument	-

searchNamespaces

public NamespacePage searchNamespaces(java.lang.String ownerAddress,
                                      NamespaceRegistrationTypeEnum registrationType,
                                      java.lang.String level0,
                                      AliasTypeEnum aliasType,
                                      java.lang.Integer pageSize,
                                      java.lang.Integer pageNumber,
                                      java.lang.String offset,
                                      Order order)
                               throws ApiException

Search namespaces Gets an array of namespaces.

Parameters:

ownerAddress - Filter by owner address. (optional)

registrationType - Filter by registration type. (optional)

level0 - Filter by root namespace. (optional)

aliasType - Filter by alias type. (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:

NamespacePage

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	success	-
409	InvalidArgument	-

searchNamespacesWithHttpInfo

public ApiResponse<NamespacePage> searchNamespacesWithHttpInfo(java.lang.String ownerAddress,
                                                               NamespaceRegistrationTypeEnum registrationType,
                                                               java.lang.String level0,
                                                               AliasTypeEnum aliasType,
                                                               java.lang.Integer pageSize,
                                                               java.lang.Integer pageNumber,
                                                               java.lang.String offset,
                                                               Order order)
                                                        throws ApiException

Search namespaces Gets an array of namespaces.

Parameters:

ownerAddress - Filter by owner address. (optional)

registrationType - Filter by registration type. (optional)

level0 - Filter by root namespace. (optional)

aliasType - Filter by alias type. (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<NamespacePage>

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	success	-
409	InvalidArgument	-