@emergentmethods/asknews-typescript-sdk/dist/apis/DistributionApi.d.ts

Typescript SDK for AskNews API

/**
 * AskNews API
 * AskNews API [![status](https://status.asknews.app/api/badge/2/status?style=for-the-badge)](https://status.asknews.app/status/prod)
 *
 * The version of the OpenAPI document: 0.24.22
 * Contact: contact@emergentmethods.ai
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */
import * as runtime from '../runtime';
import type { CountResponse, DomainHitsSurfaceResponse, DomainHitsSurfaceTimeWindowResponse, DomainQueriesResponse, HitShareResponse, PaginatedResponseReadDomainResponse, ReadDomainResponse, TopNArticlesByHitsResponse, TopNArticlesForDomainResponse, TopNArticlesTimeseriesResponse, TopNDomainsByHitsResponse, UpdateDomainRequest } from '../models/index';
export interface DomainHitShareRequest {
    domainNames: Array<string>;
    startDate?: number;
    endDate?: number;
    isPublisher?: boolean;
}
export interface FindDomainsRequest {
    page?: number;
    perPage?: number;
    names?: Array<string>;
    isTollbit?: boolean;
    publisher?: boolean;
}
export interface GetArticleHitsRequest {
    domainName: string;
    startDate?: number;
    endDate?: number;
}
export interface GetDomainRequest {
    name: string;
}
export interface GetDomainHitsSurfaceRequest {
    domainNames: Array<string>;
    year: number;
    month: number;
}
export interface GetDomainHitsSurfaceTimewindowRequest {
    domainNames: Array<string>;
    year: number;
    month: number;
}
export interface GetDomainQueriesRequest {
    domainNames: Array<string>;
    limit?: number;
    startDate?: number;
    endDate?: number;
}
export interface TopNArticlesByHitsRequest {
    limit?: number;
    startDate?: number;
    endDate?: number;
    domainNames?: Array<string>;
}
export interface TopNArticlesForDomainTimeseriesRequest {
    domainName: string;
    limit?: number;
    startDate?: number;
    endDate?: number;
}
export interface TopNArticlesForDomainsRequest {
    domainNames: Array<string>;
    limit?: number;
    startDate?: number;
    endDate?: number;
}
export interface TopNDomainsByHitsRequest {
    limit?: number;
    startDate?: number;
    endDate?: number;
    names?: Array<string>;
}
export interface UpdateDomainOperationRequest {
    name: string;
    updateDomainRequest: UpdateDomainRequest;
}
/**
 *
 */
export declare class DistributionApi extends runtime.BaseAPI {
    /**
     * Get the hit share for a list of domains in a time period.
     * Get the hit share for a list of domains in a time period
     */
    domainHitShareRaw(requestParameters: DomainHitShareRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<HitShareResponse>>;
    /**
     * Get the hit share for a list of domains in a time period.
     * Get the hit share for a list of domains in a time period
     */
    domainHitShare(requestParameters: DomainHitShareRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<HitShareResponse>;
    /**
     * Find domains with optional filters.
     * Find domains
     */
    findDomainsRaw(requestParameters: FindDomainsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseReadDomainResponse>>;
    /**
     * Find domains with optional filters.
     * Find domains
     */
    findDomains(requestParameters?: FindDomainsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseReadDomainResponse>;
    /**
     * Get the number of hits for articles in a specific domain.
     * Get article hits
     */
    getArticleHitsRaw(requestParameters: GetArticleHitsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CountResponse>>;
    /**
     * Get the number of hits for articles in a specific domain.
     * Get article hits
     */
    getArticleHits(requestParameters: GetArticleHitsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CountResponse>;
    /**
     * Get a domain.
     * Get a domain by name
     */
    getDomainRaw(requestParameters: GetDomainRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ReadDomainResponse>>;
    /**
     * Get a domain.
     * Get a domain by name
     */
    getDomain(requestParameters: GetDomainRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReadDomainResponse>;
    /**
     * Get total hits and surfaced articles for domains.
     * Get total hits and surfaced articles for domains
     */
    getDomainHitsSurfaceRaw(requestParameters: GetDomainHitsSurfaceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DomainHitsSurfaceResponse>>;
    /**
     * Get total hits and surfaced articles for domains.
     * Get total hits and surfaced articles for domains
     */
    getDomainHitsSurface(requestParameters: GetDomainHitsSurfaceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DomainHitsSurfaceResponse>;
    /**
     * Get hits and surfaced articles per day for domains.
     * Get hits and surfaced articles per day for domains
     */
    getDomainHitsSurfaceTimewindowRaw(requestParameters: GetDomainHitsSurfaceTimewindowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DomainHitsSurfaceTimeWindowResponse>>;
    /**
     * Get hits and surfaced articles per day for domains.
     * Get hits and surfaced articles per day for domains
     */
    getDomainHitsSurfaceTimewindow(requestParameters: GetDomainHitsSurfaceTimewindowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DomainHitsSurfaceTimeWindowResponse>;
    /**
     * Get article hits.
     * Get queries that surfaced domain articles
     */
    getDomainQueriesRaw(requestParameters: GetDomainQueriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DomainQueriesResponse>>;
    /**
     * Get article hits.
     * Get queries that surfaced domain articles
     */
    getDomainQueries(requestParameters: GetDomainQueriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DomainQueriesResponse>;
    /**
     * Get the top N articles by hits.
     * Get the top N articles by hits
     */
    topNArticlesByHitsRaw(requestParameters: TopNArticlesByHitsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TopNArticlesByHitsResponse>>;
    /**
     * Get the top N articles by hits.
     * Get the top N articles by hits
     */
    topNArticlesByHits(requestParameters?: TopNArticlesByHitsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TopNArticlesByHitsResponse>;
    /**
     * Get the top N domain articles by hits with daily breakdown.
     * Get the top N articles by hits for domain with daily breakdown
     */
    topNArticlesForDomainTimeseriesRaw(requestParameters: TopNArticlesForDomainTimeseriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TopNArticlesTimeseriesResponse>>;
    /**
     * Get the top N domain articles by hits with daily breakdown.
     * Get the top N articles by hits for domain with daily breakdown
     */
    topNArticlesForDomainTimeseries(requestParameters: TopNArticlesForDomainTimeseriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TopNArticlesTimeseriesResponse>;
    /**
     * Get the top N domain articles by hits.
     * Get the top N articles by hits for domains
     */
    topNArticlesForDomainsRaw(requestParameters: TopNArticlesForDomainsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TopNArticlesForDomainResponse>>;
    /**
     * Get the top N domain articles by hits.
     * Get the top N articles by hits for domains
     */
    topNArticlesForDomains(requestParameters: TopNArticlesForDomainsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TopNArticlesForDomainResponse>;
    /**
     * Get the top N domains by hits.
     * Get the top N domains by hits
     */
    topNDomainsByHitsRaw(requestParameters: TopNDomainsByHitsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TopNDomainsByHitsResponse>>;
    /**
     * Get the top N domains by hits.
     * Get the top N domains by hits
     */
    topNDomainsByHits(requestParameters?: TopNDomainsByHitsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TopNDomainsByHitsResponse>;
    /**
     * Update an existing domain.
     * Update an existing domain
     */
    updateDomainRaw(requestParameters: UpdateDomainOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ReadDomainResponse> | runtime.StreamApiResponse>;
    /**
     * Update an existing domain.
     * Update an existing domain
     */
    updateDomain(requestParameters: UpdateDomainOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReadDomainResponse | ReadableStream<any>>;
}