com.indix.client.MetadataApi Maven / Gradle / Ivy

Go to download
package com.indix.client;

import com.indix.exception.IndixApiException;
import com.indix.models.metadataResult.BrandsResult;
import com.indix.models.metadataResult.CategoriesResult;
import com.indix.models.metadataResult.StoresResult;
import com.indix.query.MetadataQuery;
import com.indix.query.Query;

import java.io.IOException;
import java.net.URISyntaxException;

public interface MetadataApi {

    /**
     * Search Stores - Lists all stores along with their IDs
     * @param query Instance of {@link MetadataQuery} with appropriate parameters
     * @return {@link StoresResult}
     * @throws {@link IndixApiException}
     */
    StoresResult getStores(Query query)
            throws IndixApiException, IOException, URISyntaxException;

    /**
     * Search Brands - Lists all brands along with their IDs
     * @param query Instance of {@link MetadataQuery} with appropriate parameters
     * @return {@link BrandsResult}
     * @throws {@link IndixApiException}
     */
    BrandsResult getBrands(Query query)
            throws IndixApiException, IOException, URISyntaxException;

    /**
     * Export Categories - Lists all categories along with their IDs and path
     * @param query Instance of {@link MetadataQuery} with appropriate parameters
     * @return {@link CategoriesResult}
     * @throws {@link IndixApiException}
     */
    CategoriesResult getCategories(Query query)
            throws IndixApiException, IOException, URISyntaxException;
}