import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios'; import { Configuration } from '../configuration'; import { RequestArgs, BaseAPI } from '../base'; import { From } from '../models'; import { MoreLikeThisRequest } from '../models'; import { RankedOnly } from '../models'; import { SearchSimilarGetResponse } from '../models'; import { SearchSimilarPostResponse } from '../models'; import { To } from '../models'; /** * SearchSimilarApi - axios parameter creator * @export */ export declare const SearchSimilarApiAxiosParamCreator: (configuration?: Configuration) => { /** * This endpoint returns a list of articles that are similar to the query provided. You also have the option to get similar articles for the results of a search. * @summary [Get] Search For Similar Articles Request * @param {string} q * @param {string} [searchIn] * @param {boolean} [includeSimilarDocuments] * @param {number} [similarDocumentsNumber] * @param {string} [similarDocumentsFields] * @param {any} [predefinedSources] * @param {any} [sources] * @param {any} [notSources] * @param {any} [lang] * @param {any} [notLang] * @param {any} [countries] * @param {any} [notCountries] * @param {From} [from] * @param {To} [to] * @param {boolean} [byParseDate] * @param {string} [publishedDatePrecision] * @param {string} [sortBy] * @param {RankedOnly} [rankedOnly] * @param {number} [fromRank] * @param {number} [toRank] * @param {boolean} [isHeadline] * @param {boolean} [isOpinion] * @param {boolean} [isPaidContent] * @param {any} [parentUrl] * @param {any} [allLinks] * @param {any} [allDomainLinks] * @param {number} [wordCountMin] * @param {number} [wordCountMax] * @param {number} [page] * @param {number} [pageSize] * @param {boolean} [includeNlpData] * @param {boolean} [hasNlp] * @param {string} [theme] * @param {string} [notTheme] * @param {number} [titleSentimentMin] * @param {number} [titleSentimentMax] * @param {number} [contentSentimentMin] * @param {number} [contentSentimentMax] * @param {any} [iptcTags] * @param {any} [notIptcTags] * @param {*} [options] Override http request option. * @throws {RequiredError} */ get: (q: string, searchIn?: string, includeSimilarDocuments?: boolean, similarDocumentsNumber?: number, similarDocumentsFields?: string, predefinedSources?: any, sources?: any, notSources?: any, lang?: any, notLang?: any, countries?: any, notCountries?: any, from?: From, to?: To, byParseDate?: boolean, publishedDatePrecision?: string, sortBy?: string, rankedOnly?: RankedOnly, fromRank?: number, toRank?: number, isHeadline?: boolean, isOpinion?: boolean, isPaidContent?: boolean, parentUrl?: any, allLinks?: any, allDomainLinks?: any, wordCountMin?: number, wordCountMax?: number, page?: number, pageSize?: number, includeNlpData?: boolean, hasNlp?: boolean, theme?: string, notTheme?: string, titleSentimentMin?: number, titleSentimentMax?: number, contentSentimentMin?: number, contentSentimentMax?: number, iptcTags?: any, notIptcTags?: any, options?: AxiosRequestConfig) => Promise; /** * This endpoint returns a list of articles that are similar to the query provided. You also have the option to get similar articles for the results of a search. * @summary [Post] Search For Similar Articles Request * @param {MoreLikeThisRequest} moreLikeThisRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ post: (moreLikeThisRequest: MoreLikeThisRequest, options?: AxiosRequestConfig) => Promise; }; /** * SearchSimilarApi - functional programming interface * @export */ export declare const SearchSimilarApiFp: (configuration?: Configuration) => { /** * This endpoint returns a list of articles that are similar to the query provided. You also have the option to get similar articles for the results of a search. * @summary [Get] Search For Similar Articles Request * @param {SearchSimilarApiGetRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ get(requestParameters: SearchSimilarApiGetRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This endpoint returns a list of articles that are similar to the query provided. You also have the option to get similar articles for the results of a search. * @summary [Post] Search For Similar Articles Request * @param {SearchSimilarApiPostRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ post(requestParameters: SearchSimilarApiPostRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * SearchSimilarApi - factory interface * @export */ export declare const SearchSimilarApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * This endpoint returns a list of articles that are similar to the query provided. You also have the option to get similar articles for the results of a search. * @summary [Get] Search For Similar Articles Request * @param {SearchSimilarApiGetRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ get(requestParameters: SearchSimilarApiGetRequest, options?: AxiosRequestConfig): AxiosPromise; /** * This endpoint returns a list of articles that are similar to the query provided. You also have the option to get similar articles for the results of a search. * @summary [Post] Search For Similar Articles Request * @param {SearchSimilarApiPostRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ post(requestParameters: SearchSimilarApiPostRequest, options?: AxiosRequestConfig): AxiosPromise; }; /** * Request parameters for get operation in SearchSimilarApi. * @export * @interface SearchSimilarApiGetRequest */ export type SearchSimilarApiGetRequest = { /** * * @type {string} * @memberof SearchSimilarApiGet */ readonly q: string; /** * * @type {string} * @memberof SearchSimilarApiGet */ readonly searchIn?: string; /** * * @type {boolean} * @memberof SearchSimilarApiGet */ readonly includeSimilarDocuments?: boolean; /** * * @type {number} * @memberof SearchSimilarApiGet */ readonly similarDocumentsNumber?: number; /** * * @type {string} * @memberof SearchSimilarApiGet */ readonly similarDocumentsFields?: string; /** * * @type {any} * @memberof SearchSimilarApiGet */ readonly predefinedSources?: any; /** * * @type {any} * @memberof SearchSimilarApiGet */ readonly sources?: any; /** * * @type {any} * @memberof SearchSimilarApiGet */ readonly notSources?: any; /** * * @type {any} * @memberof SearchSimilarApiGet */ readonly lang?: any; /** * * @type {any} * @memberof SearchSimilarApiGet */ readonly notLang?: any; /** * * @type {any} * @memberof SearchSimilarApiGet */ readonly countries?: any; /** * * @type {any} * @memberof SearchSimilarApiGet */ readonly notCountries?: any; /** * * @type {From} * @memberof SearchSimilarApiGet */ readonly from?: From; /** * * @type {To} * @memberof SearchSimilarApiGet */ readonly to?: To; /** * * @type {boolean} * @memberof SearchSimilarApiGet */ readonly byParseDate?: boolean; /** * * @type {string} * @memberof SearchSimilarApiGet */ readonly publishedDatePrecision?: string; /** * * @type {string} * @memberof SearchSimilarApiGet */ readonly sortBy?: string; /** * * @type {RankedOnly} * @memberof SearchSimilarApiGet */ readonly rankedOnly?: RankedOnly; /** * * @type {number} * @memberof SearchSimilarApiGet */ readonly fromRank?: number; /** * * @type {number} * @memberof SearchSimilarApiGet */ readonly toRank?: number; /** * * @type {boolean} * @memberof SearchSimilarApiGet */ readonly isHeadline?: boolean; /** * * @type {boolean} * @memberof SearchSimilarApiGet */ readonly isOpinion?: boolean; /** * * @type {boolean} * @memberof SearchSimilarApiGet */ readonly isPaidContent?: boolean; /** * * @type {any} * @memberof SearchSimilarApiGet */ readonly parentUrl?: any; /** * * @type {any} * @memberof SearchSimilarApiGet */ readonly allLinks?: any; /** * * @type {any} * @memberof SearchSimilarApiGet */ readonly allDomainLinks?: any; /** * * @type {number} * @memberof SearchSimilarApiGet */ readonly wordCountMin?: number; /** * * @type {number} * @memberof SearchSimilarApiGet */ readonly wordCountMax?: number; /** * * @type {number} * @memberof SearchSimilarApiGet */ readonly page?: number; /** * * @type {number} * @memberof SearchSimilarApiGet */ readonly pageSize?: number; /** * * @type {boolean} * @memberof SearchSimilarApiGet */ readonly includeNlpData?: boolean; /** * * @type {boolean} * @memberof SearchSimilarApiGet */ readonly hasNlp?: boolean; /** * * @type {string} * @memberof SearchSimilarApiGet */ readonly theme?: string; /** * * @type {string} * @memberof SearchSimilarApiGet */ readonly notTheme?: string; /** * * @type {number} * @memberof SearchSimilarApiGet */ readonly titleSentimentMin?: number; /** * * @type {number} * @memberof SearchSimilarApiGet */ readonly titleSentimentMax?: number; /** * * @type {number} * @memberof SearchSimilarApiGet */ readonly contentSentimentMin?: number; /** * * @type {number} * @memberof SearchSimilarApiGet */ readonly contentSentimentMax?: number; /** * * @type {any} * @memberof SearchSimilarApiGet */ readonly iptcTags?: any; /** * * @type {any} * @memberof SearchSimilarApiGet */ readonly notIptcTags?: any; }; /** * Request parameters for post operation in SearchSimilarApi. * @export * @interface SearchSimilarApiPostRequest */ export type SearchSimilarApiPostRequest = {} & MoreLikeThisRequest; /** * SearchSimilarApiGenerated - object-oriented interface * @export * @class SearchSimilarApiGenerated * @extends {BaseAPI} */ export declare class SearchSimilarApiGenerated extends BaseAPI { /** * This endpoint returns a list of articles that are similar to the query provided. You also have the option to get similar articles for the results of a search. * @summary [Get] Search For Similar Articles Request * @param {SearchSimilarApiGetRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SearchSimilarApiGenerated */ get(requestParameters: SearchSimilarApiGetRequest, options?: AxiosRequestConfig): Promise>; /** * This endpoint returns a list of articles that are similar to the query provided. You also have the option to get similar articles for the results of a search. * @summary [Post] Search For Similar Articles Request * @param {SearchSimilarApiPostRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SearchSimilarApiGenerated */ post(requestParameters: SearchSimilarApiPostRequest, options?: AxiosRequestConfig): Promise>; }