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="2020-06-30T14:26:28.734Z[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(AccountIds accountIds) Get readable names for a set of accountIds Returns friendly names for accounts.
ApiResponse<AccountsNamesDTO>	getAccountsNamesWithHttpInfo(AccountIds accountIds) 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.
NamespacesInfoDTO	getNamespacesFromAccount(java.lang.String accountId, java.lang.Integer pageSize, java.lang.String id) Get namespaces created by an account Gets an array of namespaces for a given account address.
NamespacesInfoDTO	getNamespacesFromAccounts(AccountIds accountIds) Get namespaces for given array of addresses Gets namespaces for a given array of addresses.
ApiResponse<NamespacesInfoDTO>	getNamespacesFromAccountsWithHttpInfo(AccountIds accountIds) Get namespaces for given array of addresses Gets namespaces for a given array of addresses.
ApiResponse<NamespacesInfoDTO>	getNamespacesFromAccountWithHttpInfo(java.lang.String accountId, java.lang.Integer pageSize, java.lang.String id) Get namespaces created by an account Gets an array of namespaces for a given account address.
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.
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(AccountIds accountIds)
                                  throws ApiException

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

Parameters:

accountIds - (optional)

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(AccountIds accountIds)
                                                           throws ApiException

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

Parameters:

accountIds - (optional)

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	-

getNamespacesFromAccount

public NamespacesInfoDTO getNamespacesFromAccount(java.lang.String accountId,
                                                  java.lang.Integer pageSize,
                                                  java.lang.String id)
                                           throws ApiException

Get namespaces created by an account Gets an array of namespaces for a given account address.

Parameters:

accountId - Account public key or address enconded using a 32-character set. (required)

pageSize - Select the number of entries to return. (optional, default to 10)

id - 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)

Returns:

NamespacesInfoDTO

Throws:

ApiException - if fails to make API call

Http Response Details

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

getNamespacesFromAccountWithHttpInfo

public ApiResponse<NamespacesInfoDTO> getNamespacesFromAccountWithHttpInfo(java.lang.String accountId,
                                                                           java.lang.Integer pageSize,
                                                                           java.lang.String id)
                                                                    throws ApiException

Get namespaces created by an account Gets an array of namespaces for a given account address.

Parameters:

accountId - Account public key or address enconded using a 32-character set. (required)

pageSize - Select the number of entries to return. (optional, default to 10)

id - 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)

Returns:

ApiResponse<NamespacesInfoDTO>

Throws:

ApiException - if fails to make API call

Http Response Details

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

getNamespacesFromAccounts

public NamespacesInfoDTO getNamespacesFromAccounts(AccountIds accountIds)
                                            throws ApiException

Get namespaces for given array of addresses Gets namespaces for a given array of addresses.

Parameters:

accountIds - (optional)

Returns:

NamespacesInfoDTO

Throws:

ApiException - if fails to make API call

Http Response Details

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

getNamespacesFromAccountsWithHttpInfo

public ApiResponse<NamespacesInfoDTO> getNamespacesFromAccountsWithHttpInfo(AccountIds accountIds)
                                                                     throws ApiException

Get namespaces for given array of addresses Gets namespaces for a given array of addresses.

Parameters:

accountIds - (optional)

Returns:

ApiResponse<NamespacesInfoDTO>

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	success	-
400	InvalidContent	-
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	-