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

Class MosaicRoutesApi

java.lang.Object

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

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2020-08-14T13:43:37.324Z[UTC]")
public class MosaicRoutesApi
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
MosaicRoutesApi()
MosaicRoutesApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
MosaicInfoDTO	getMosaic(java.lang.String mosaicId) Get mosaic information Gets the mosaic definition for a given mosaic identifier.
java.util.List<MosaicInfoDTO>	getMosaics(MosaicIds mosaicIds) Get mosaics information for an array of mosaics Gets an array of mosaic definition.
ApiResponse<java.util.List<MosaicInfoDTO>>	getMosaicsWithHttpInfo(MosaicIds mosaicIds) Get mosaics information for an array of mosaics Gets an array of mosaic definition.
ApiResponse<MosaicInfoDTO>	getMosaicWithHttpInfo(java.lang.String mosaicId) Get mosaic information Gets the mosaic definition for a given mosaic identifier.
MosaicPage	searchMosaics(java.lang.String ownerAddress, java.lang.Integer pageSize, java.lang.Integer pageNumber, java.lang.String offset, Order order) Search mosaics Gets an array of mosaics.
ApiResponse<MosaicPage>	searchMosaicsWithHttpInfo(java.lang.String ownerAddress, java.lang.Integer pageSize, java.lang.Integer pageNumber, java.lang.String offset, Order order) Search mosaics Gets an array of mosaics.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

MosaicRoutesApi

public MosaicRoutesApi()

MosaicRoutesApi

public MosaicRoutesApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getMosaic

public MosaicInfoDTO getMosaic(java.lang.String mosaicId)
                        throws ApiException

Get mosaic information Gets the mosaic definition for a given mosaic identifier.

Parameters:

mosaicId - Mosaic identifier. (required)

Returns:

MosaicInfoDTO

Throws:

ApiException - if fails to make API call

Http Response Details

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

getMosaicWithHttpInfo

public ApiResponse<MosaicInfoDTO> getMosaicWithHttpInfo(java.lang.String mosaicId)
                                                 throws ApiException

Get mosaic information Gets the mosaic definition for a given mosaic identifier.

Parameters:

mosaicId - Mosaic identifier. (required)

Returns:

ApiResponse<MosaicInfoDTO>

Throws:

ApiException - if fails to make API call

Http Response Details

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

getMosaics

public java.util.List<MosaicInfoDTO> getMosaics(MosaicIds mosaicIds)
                                         throws ApiException

Get mosaics information for an array of mosaics Gets an array of mosaic definition.

Parameters:

mosaicIds - (required)

Returns:

List<MosaicInfoDTO>

Throws:

ApiException - if fails to make API call

Http Response Details

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

getMosaicsWithHttpInfo

public ApiResponse<java.util.List<MosaicInfoDTO>> getMosaicsWithHttpInfo(MosaicIds mosaicIds)
                                                                  throws ApiException

Get mosaics information for an array of mosaics Gets an array of mosaic definition.

Parameters:

mosaicIds - (required)

Returns:

ApiResponse<List<MosaicInfoDTO>>

Throws:

ApiException - if fails to make API call

Http Response Details

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

searchMosaics

public MosaicPage searchMosaics(java.lang.String ownerAddress,
                                java.lang.Integer pageSize,
                                java.lang.Integer pageNumber,
                                java.lang.String offset,
                                Order order)
                         throws ApiException

Search mosaics Gets an array of mosaics.

Parameters:

ownerAddress - Filter by owner address. (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:

MosaicPage

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	success	-
409	InvalidArgument	-

searchMosaicsWithHttpInfo

public ApiResponse<MosaicPage> searchMosaicsWithHttpInfo(java.lang.String ownerAddress,
                                                         java.lang.Integer pageSize,
                                                         java.lang.Integer pageNumber,
                                                         java.lang.String offset,
                                                         Order order)
                                                  throws ApiException

Search mosaics Gets an array of mosaics.

Parameters:

ownerAddress - Filter by owner address. (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<MosaicPage>

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	success	-
409	InvalidArgument	-