io.blockfrost.sdk.api.MetadataService Maven / Gradle / Ivy

Go to download
package io.blockfrost.sdk.api;

import io.blockfrost.sdk.api.exception.APIException;
import io.blockfrost.sdk.api.model.TransactionMetadataLabel;
import io.blockfrost.sdk.api.model.TransactionMetadataLabelCbor;
import io.blockfrost.sdk.api.model.TransactionMetadataLabelJson;
import io.blockfrost.sdk.api.util.OrderEnum;

import java.util.List;

public interface MetadataService {

    /**
     * Transaction metadata labels
     * List of all used transaction metadata labels.
     *
     * @param count The number of results displayed on one page.
     * @param page  The page number for listing the results.
     * @param order The ordering of items from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last.  (optional, default to asc)
     * @return List<TransactionMetadataLabel>
     */
    List getTransactionMetadataLabels(int count, int page, OrderEnum order) throws APIException;

    /**
     * Transaction metadata labels
     * List of all used transaction metadata labels ordered from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last.
     *
     * @param count The numbers of pools per page (<=100).
     * @param page  The page number for listing the results.
     * @return List<TransactionMetadataLabel>
     */
    List getTransactionMetadataLabels(int count, int page) throws APIException;


    /**
     * Transaction metadata labels
     * List of all used transaction metadata labels.
     *
     * @param order The ordering of items from the point of view of the blockchain.
     * @return List<TransactionMetadataLabel>
     */
    List getAllTransactionMetadataLabels(OrderEnum order) throws APIException;

    /**
     * Transaction metadata labels
     * List of all used transaction metadata labels in ascending order from the point of view of the blockchain. We return oldest first, newest last
     *
     * @return List<TransactionMetadataLabel>
     */
    List getAllTransactionMetadataLabels() throws APIException;

    /**
     * Transaction metadata content in CBOR
     * Transaction metadata per label.
     *
     * @param label Metadata label (required)
     * @param count The number of results displayed on one page.
     * @param page  The page number for listing the results.
     * @param order The ordering of items from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last.  (optional, default to asc)
     * @return List<TransactionMetadataLabelCbor>
     */
    List getTransactionMetadataCborForLabel(String label, int count, int page, OrderEnum order) throws APIException;

    /**
     * Transaction metadata content in CBOR
     * Transaction metadata per label ordered from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last.
     *
     * @param label Metadata label (required)
     * @param count The numbers of pools per page (<=100).
     * @param page  The page number for listing the results.
     * @return List<TransactionMetadataLabelCbor>
     */
    List getTransactionMetadataCborForLabel(String label, int count, int page) throws APIException;


    /**
     * Transaction metadata content in CBOR
     * Transaction metadata per label.
     *
     * @param label Metadata label (required)
     * @param order The ordering of items from the point of view of the blockchain.
     * @return List<TransactionMetadataLabelCbor>
     */
    List getAllTransactionMetadataCborForLabel(String label, OrderEnum order) throws APIException;

    /**
     * Transaction metadata content in CBOR
     * Transaction metadata per label in ascending order from the point of view of the blockchain. We return oldest first, newest last
     *
     * @param label Metadata label (required)
     * @return List<TransactionMetadataLabelCbor>
     */
    List getAllTransactionMetadataCborForLabel(String label) throws APIException;

    /**
     * Transaction metadata content in JSON
     * Transaction metadata per label.
     *
     * @param label Metadata label (required)
     * @param count The number of results displayed on one page.
     * @param page  The page number for listing the results.
     * @param order The ordering of items from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last.  (optional, default to asc)
     * @return List<TransactionMetadataLabelJson>
     */
    List getTransactionMetadataJsonForLabel(String label, int count, int page, OrderEnum order) throws APIException;

    /**
     * Transaction metadata content in JSON
     * Transaction metadata per label ordered from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last.
     *
     * @param label Metadata label (required)
     * @param count The numbers of pools per page (<=100).
     * @param page  The page number for listing the results.
     * @return List<TransactionMetadataLabelJson>
     */
    List getTransactionMetadataJsonForLabel(String label, int count, int page) throws APIException;


    /**
     * Transaction metadata content in JSON
     * Transaction metadata per label.
     *
     * @param label Metadata label (required)
     * @param order The ordering of items from the point of view of the blockchain.
     * @return List<TransactionMetadataLabelJson>
     */
    List getAllTransactionMetadataJsonForLabel(String label, OrderEnum order) throws APIException;

    /**
     * Transaction metadata content in JSON
     * Transaction metadata per label in ascending order from the point of view of the blockchain. We return oldest first, newest last
     *
     * @param label Metadata label (required)
     * @return List<TransactionMetadataLabelJson>
     */
    List getAllTransactionMetadataJsonForLabel(String label) throws APIException;
}