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

Class RestrictionMosaicRoutesApi

java.lang.Object

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

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

Constructor Summary

Constructors

Constructor and Description
RestrictionMosaicRoutesApi()
RestrictionMosaicRoutesApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
java.lang.Object	getMosaicRestrictions(java.lang.String compositeHash) Get the mosaic restrictions Returns the mosaic restrictions for a composite hash.
MerkleStateInfoDTO	getMosaicRestrictionsMerkle(java.lang.String compositeHash) Get the mosaic restrictions merkle Returns the mosaic restrictions merkle for a given composite hash.
ApiResponse<MerkleStateInfoDTO>	getMosaicRestrictionsMerkleWithHttpInfo(java.lang.String compositeHash) Get the mosaic restrictions merkle Returns the mosaic restrictions merkle for a given composite hash.
ApiResponse<java.lang.Object>	getMosaicRestrictionsWithHttpInfo(java.lang.String compositeHash) Get the mosaic restrictions Returns the mosaic restrictions for a composite hash.
MosaicRestrictionsPage	searchMosaicRestrictions(java.lang.String mosaicId, MosaicRestrictionEntryTypeEnum entryType, java.lang.String targetAddress, java.lang.Integer pageSize, java.lang.Integer pageNumber, java.lang.String offset, Order order) Search mosaic restrictions Returns an array of mosaic restrictions.
ApiResponse<MosaicRestrictionsPage>	searchMosaicRestrictionsWithHttpInfo(java.lang.String mosaicId, MosaicRestrictionEntryTypeEnum entryType, java.lang.String targetAddress, java.lang.Integer pageSize, java.lang.Integer pageNumber, java.lang.String offset, Order order) Search mosaic restrictions Returns an array of mosaic restrictions.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

RestrictionMosaicRoutesApi

public RestrictionMosaicRoutesApi()

RestrictionMosaicRoutesApi

public RestrictionMosaicRoutesApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getMosaicRestrictions

public java.lang.Object getMosaicRestrictions(java.lang.String compositeHash)
                                       throws ApiException

Get the mosaic restrictions Returns the mosaic restrictions for a composite hash.

Parameters:

compositeHash - Filter by composite hash. (required)

Returns:

Object

Throws:

ApiException - if fails to make API call

Http Response Details

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

getMosaicRestrictionsWithHttpInfo

public ApiResponse<java.lang.Object> getMosaicRestrictionsWithHttpInfo(java.lang.String compositeHash)
                                                                throws ApiException

Get the mosaic restrictions Returns the mosaic restrictions for a composite hash.

Parameters:

compositeHash - Filter by composite hash. (required)

Returns:

ApiResponse<Object>

Throws:

ApiException - if fails to make API call

Http Response Details

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

getMosaicRestrictionsMerkle

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

Get the mosaic restrictions merkle Returns the mosaic restrictions 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	-
404	ResourceNotFound	-
409	InvalidArgument	-

getMosaicRestrictionsMerkleWithHttpInfo

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

Get the mosaic restrictions merkle Returns the mosaic restrictions 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	-
404	ResourceNotFound	-
409	InvalidArgument	-

searchMosaicRestrictions

public MosaicRestrictionsPage searchMosaicRestrictions(java.lang.String mosaicId,
                                                       MosaicRestrictionEntryTypeEnum entryType,
                                                       java.lang.String targetAddress,
                                                       java.lang.Integer pageSize,
                                                       java.lang.Integer pageNumber,
                                                       java.lang.String offset,
                                                       Order order)
                                                throws ApiException

Search mosaic restrictions Returns an array of mosaic restrictions.

Parameters:

mosaicId - Filter by mosaic identifier. (optional)

entryType - Filter by entry type. (optional)

targetAddress - Filter by target 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:

MosaicRestrictionsPage

Throws:

ApiException - if fails to make API call

Http Response Details

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

searchMosaicRestrictionsWithHttpInfo

public ApiResponse<MosaicRestrictionsPage> searchMosaicRestrictionsWithHttpInfo(java.lang.String mosaicId,
                                                                                MosaicRestrictionEntryTypeEnum entryType,
                                                                                java.lang.String targetAddress,
                                                                                java.lang.Integer pageSize,
                                                                                java.lang.Integer pageNumber,
                                                                                java.lang.String offset,
                                                                                Order order)
                                                                         throws ApiException

Search mosaic restrictions Returns an array of mosaic restrictions.

Parameters:

mosaicId - Filter by mosaic identifier. (optional)

entryType - Filter by entry type. (optional)

targetAddress - Filter by target 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<MosaicRestrictionsPage>

Throws:

ApiException - if fails to make API call

Http Response Details

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