@emergentmethods/asknews-typescript-sdk
Version:
Typescript SDK for AskNews API
154 lines (153 loc) • 6.62 kB
TypeScript
/**
* AskNews API
* AskNews API
*
* The version of the OpenAPI document: 0.21.1
* 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, CreateDomainRequest, HitShareResponse, PaginatedResponseReadDomainResponse, ReadDomainResponse, TopNArticlesByHitsResponse, TopNArticlesForDomainResponse, TopNDomainsByHitsResponse, UpdateDomainRequest } from '../models/index';
export interface CreateDomainOperationRequest {
createDomainRequest: CreateDomainRequest;
}
export interface DomainHitShareRequest {
domainNames: Array<string>;
startDate?: number;
endDate?: number;
isPublisher?: boolean;
}
export interface FindDomainsRequest {
page?: number;
perPage?: number;
names?: Array<string>;
includeIds?: Array<string>;
excludeIds?: Array<string>;
isTollbit?: boolean;
}
export interface GetArticleHitsRequest {
domain: string;
startDate?: number;
endDate?: number;
}
export interface GetDomainRequest {
domainIdOrName: string;
}
export interface TopNArticlesByHitsRequest {
limit?: number;
startDate?: number;
endDate?: number;
}
export interface TopNArticlesForDomainRequest {
domain: string;
limit?: number;
startDate?: number;
endDate?: number;
}
export interface TopNDomainsByHitsRequest {
limit?: number;
startDate?: number;
endDate?: number;
}
export interface UpdateDomainOperationRequest {
domainId: string;
updateDomainRequest: UpdateDomainRequest;
}
/**
*
*/
export declare class DistributionApi extends runtime.BaseAPI {
/**
* Create a new domain.
* Create a new domain
*/
createDomainRaw(requestParameters: CreateDomainOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ReadDomainResponse> | runtime.StreamApiResponse>;
/**
* Create a new domain.
* Create a new domain
*/
createDomain(requestParameters: CreateDomainOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReadDomainResponse | ReadableStream<any>>;
/**
* 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 new domain.
* Get a domain by ID or name
*/
getDomainRaw(requestParameters: GetDomainRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ReadDomainResponse>>;
/**
* Get a new domain.
* Get a domain by ID or name
*/
getDomain(requestParameters: GetDomainRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReadDomainResponse>;
/**
* 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.
* Get the top N articles by hits for domain
*/
topNArticlesForDomainRaw(requestParameters: TopNArticlesForDomainRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TopNArticlesForDomainResponse>>;
/**
* Get the top N domain articles by hits.
* Get the top N articles by hits for domain
*/
topNArticlesForDomain(requestParameters: TopNArticlesForDomainRequest, 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>>;
}