/**
* @module API
* @submodule API Search
* @namespace api.search
*/

namespace internal.api.search {
    /**
     * Search api response facet specification
     * @class SearchResultFacet
     */
    export class SearchResultFacet {
        /**
         * The name of the field for the facet
         * @property {string} field
         */
        public field: string;

        /**
         * The collection of facet values
         * @property {string} values
         */
        public values: Array<SearchResultFacetValue>;
    }

    export class SearchResultFacetValue {
        /**
         * The name of the facet
         * @property {string} name
         */
        public name: string;

        /**
         * The value of the facet
         * @property {string} value
         */
        public value: string;

        /**
         * The type of the facet
         * @property {string} facetType
         */
        public facetType: string;

        /**
         * The number of search results in this facet
         * @property {string} count
         */
        public count: number;

        /**
         * The start of this facet range, if any
         * @property {string} from
         */
        public from: string;

        /**
         * The end of this facet range, if any
         * @property {string} to
         */
        public to: string;
    }
}