@emergentmethods/asknews-typescript-sdk
Version:
Typescript SDK for AskNews API
519 lines (518 loc) • 24.1 kB
JavaScript
"use strict";
/* tslint:disable */
/* eslint-disable */
/**
* AskNews API
* AskNews API [](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.
*/
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.DistributionApi = void 0;
const runtime = require("../runtime");
const index_1 = require("../models/index");
/**
*
*/
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, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
if (requestParameters['domainNames'] == null) {
throw new runtime.RequiredError('domainNames', 'Required parameter "domainNames" was null or undefined when calling domainHitShare().');
}
const queryParameters = {};
if (requestParameters['domainNames'] != null) {
queryParameters['domain_names'] = requestParameters['domainNames'];
}
if (requestParameters['startDate'] != null) {
queryParameters['start_date'] = requestParameters['startDate'];
}
if (requestParameters['endDate'] != null) {
queryParameters['end_date'] = requestParameters['endDate'];
}
if (requestParameters['isPublisher'] != null) {
queryParameters['is_publisher'] = requestParameters['isPublisher'];
}
const headerParameters = {};
const response = yield this.request({
path: `/v1/distribution/stats/hit_share`,
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.HitShareResponseFromJSON)(jsonValue));
});
}
/**
* 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, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
const response = yield this.domainHitShareRaw(requestParameters, initOverrides);
return yield response.value();
});
}
/**
* Find domains with optional filters.
* Find domains
*/
findDomainsRaw(requestParameters, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
const queryParameters = {};
if (requestParameters['page'] != null) {
queryParameters['page'] = requestParameters['page'];
}
if (requestParameters['perPage'] != null) {
queryParameters['per_page'] = requestParameters['perPage'];
}
if (requestParameters['names'] != null) {
queryParameters['names'] = requestParameters['names'];
}
if (requestParameters['isTollbit'] != null) {
queryParameters['is_tollbit'] = requestParameters['isTollbit'];
}
if (requestParameters['publisher'] != null) {
queryParameters['publisher'] = requestParameters['publisher'];
}
const headerParameters = {};
const response = yield this.request({
path: `/v1/distribution/domains`,
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.PaginatedResponseReadDomainResponseFromJSON)(jsonValue));
});
}
/**
* Find domains with optional filters.
* Find domains
*/
findDomains(requestParameters = {}, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
const response = yield this.findDomainsRaw(requestParameters, initOverrides);
return yield response.value();
});
}
/**
* Get the number of hits for articles in a specific domain.
* Get article hits
*/
getArticleHitsRaw(requestParameters, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
if (requestParameters['domainName'] == null) {
throw new runtime.RequiredError('domainName', 'Required parameter "domainName" was null or undefined when calling getArticleHits().');
}
const queryParameters = {};
if (requestParameters['domainName'] != null) {
queryParameters['domain_name'] = requestParameters['domainName'];
}
if (requestParameters['startDate'] != null) {
queryParameters['start_date'] = requestParameters['startDate'];
}
if (requestParameters['endDate'] != null) {
queryParameters['end_date'] = requestParameters['endDate'];
}
const headerParameters = {};
const response = yield this.request({
path: `/v1/distribution/stats/count`,
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.CountResponseFromJSON)(jsonValue));
});
}
/**
* Get the number of hits for articles in a specific domain.
* Get article hits
*/
getArticleHits(requestParameters, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
const response = yield this.getArticleHitsRaw(requestParameters, initOverrides);
return yield response.value();
});
}
/**
* Get a domain.
* Get a domain by name
*/
getDomainRaw(requestParameters, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
if (requestParameters['name'] == null) {
throw new runtime.RequiredError('name', 'Required parameter "name" was null or undefined when calling getDomain().');
}
const queryParameters = {};
const headerParameters = {};
const response = yield this.request({
path: `/v1/distribution/domains/{name}`.replace(`{${"name"}}`, encodeURIComponent(String(requestParameters['name']))),
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.ReadDomainResponseFromJSON)(jsonValue));
});
}
/**
* Get a domain.
* Get a domain by name
*/
getDomain(requestParameters, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
const response = yield this.getDomainRaw(requestParameters, initOverrides);
return yield response.value();
});
}
/**
* Get total hits and surfaced articles for domains.
* Get total hits and surfaced articles for domains
*/
getDomainHitsSurfaceRaw(requestParameters, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
if (requestParameters['domainNames'] == null) {
throw new runtime.RequiredError('domainNames', 'Required parameter "domainNames" was null or undefined when calling getDomainHitsSurface().');
}
if (requestParameters['year'] == null) {
throw new runtime.RequiredError('year', 'Required parameter "year" was null or undefined when calling getDomainHitsSurface().');
}
if (requestParameters['month'] == null) {
throw new runtime.RequiredError('month', 'Required parameter "month" was null or undefined when calling getDomainHitsSurface().');
}
const queryParameters = {};
if (requestParameters['domainNames'] != null) {
queryParameters['domain_names'] = requestParameters['domainNames'];
}
if (requestParameters['year'] != null) {
queryParameters['year'] = requestParameters['year'];
}
if (requestParameters['month'] != null) {
queryParameters['month'] = requestParameters['month'];
}
const headerParameters = {};
const response = yield this.request({
path: `/v1/distribution/articles/domain_hits_surface`,
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.DomainHitsSurfaceResponseFromJSON)(jsonValue));
});
}
/**
* Get total hits and surfaced articles for domains.
* Get total hits and surfaced articles for domains
*/
getDomainHitsSurface(requestParameters, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
const response = yield this.getDomainHitsSurfaceRaw(requestParameters, initOverrides);
return yield response.value();
});
}
/**
* Get hits and surfaced articles per day for domains.
* Get hits and surfaced articles per day for domains
*/
getDomainHitsSurfaceTimewindowRaw(requestParameters, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
if (requestParameters['domainNames'] == null) {
throw new runtime.RequiredError('domainNames', 'Required parameter "domainNames" was null or undefined when calling getDomainHitsSurfaceTimewindow().');
}
if (requestParameters['year'] == null) {
throw new runtime.RequiredError('year', 'Required parameter "year" was null or undefined when calling getDomainHitsSurfaceTimewindow().');
}
if (requestParameters['month'] == null) {
throw new runtime.RequiredError('month', 'Required parameter "month" was null or undefined when calling getDomainHitsSurfaceTimewindow().');
}
const queryParameters = {};
if (requestParameters['domainNames'] != null) {
queryParameters['domain_names'] = requestParameters['domainNames'];
}
if (requestParameters['year'] != null) {
queryParameters['year'] = requestParameters['year'];
}
if (requestParameters['month'] != null) {
queryParameters['month'] = requestParameters['month'];
}
const headerParameters = {};
const response = yield this.request({
path: `/v1/distribution/articles/domain_hits_surface_timewindow`,
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.DomainHitsSurfaceTimeWindowResponseFromJSON)(jsonValue));
});
}
/**
* Get hits and surfaced articles per day for domains.
* Get hits and surfaced articles per day for domains
*/
getDomainHitsSurfaceTimewindow(requestParameters, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
const response = yield this.getDomainHitsSurfaceTimewindowRaw(requestParameters, initOverrides);
return yield response.value();
});
}
/**
* Get article hits.
* Get queries that surfaced domain articles
*/
getDomainQueriesRaw(requestParameters, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
if (requestParameters['domainNames'] == null) {
throw new runtime.RequiredError('domainNames', 'Required parameter "domainNames" was null or undefined when calling getDomainQueries().');
}
const queryParameters = {};
if (requestParameters['domainNames'] != null) {
queryParameters['domain_names'] = requestParameters['domainNames'];
}
if (requestParameters['limit'] != null) {
queryParameters['limit'] = requestParameters['limit'];
}
if (requestParameters['startDate'] != null) {
queryParameters['start_date'] = requestParameters['startDate'];
}
if (requestParameters['endDate'] != null) {
queryParameters['end_date'] = requestParameters['endDate'];
}
const headerParameters = {};
const response = yield this.request({
path: `/v1/distribution/articles/domain_queries`,
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.DomainQueriesResponseFromJSON)(jsonValue));
});
}
/**
* Get article hits.
* Get queries that surfaced domain articles
*/
getDomainQueries(requestParameters, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
const response = yield this.getDomainQueriesRaw(requestParameters, initOverrides);
return yield response.value();
});
}
/**
* Get the top N articles by hits.
* Get the top N articles by hits
*/
topNArticlesByHitsRaw(requestParameters, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
const queryParameters = {};
if (requestParameters['limit'] != null) {
queryParameters['limit'] = requestParameters['limit'];
}
if (requestParameters['startDate'] != null) {
queryParameters['start_date'] = requestParameters['startDate'];
}
if (requestParameters['endDate'] != null) {
queryParameters['end_date'] = requestParameters['endDate'];
}
if (requestParameters['domainNames'] != null) {
queryParameters['domain_names'] = requestParameters['domainNames'];
}
const headerParameters = {};
const response = yield this.request({
path: `/v1/distribution/articles/top_n`,
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.TopNArticlesByHitsResponseFromJSON)(jsonValue));
});
}
/**
* Get the top N articles by hits.
* Get the top N articles by hits
*/
topNArticlesByHits(requestParameters = {}, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
const response = yield this.topNArticlesByHitsRaw(requestParameters, initOverrides);
return yield response.value();
});
}
/**
* 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, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
if (requestParameters['domainName'] == null) {
throw new runtime.RequiredError('domainName', 'Required parameter "domainName" was null or undefined when calling topNArticlesForDomainTimeseries().');
}
const queryParameters = {};
if (requestParameters['domainName'] != null) {
queryParameters['domain_name'] = requestParameters['domainName'];
}
if (requestParameters['limit'] != null) {
queryParameters['limit'] = requestParameters['limit'];
}
if (requestParameters['startDate'] != null) {
queryParameters['start_date'] = requestParameters['startDate'];
}
if (requestParameters['endDate'] != null) {
queryParameters['end_date'] = requestParameters['endDate'];
}
const headerParameters = {};
const response = yield this.request({
path: `/v1/distribution/articles/top_n_for_domain_timeseries`,
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.TopNArticlesTimeseriesResponseFromJSON)(jsonValue));
});
}
/**
* 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, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
const response = yield this.topNArticlesForDomainTimeseriesRaw(requestParameters, initOverrides);
return yield response.value();
});
}
/**
* Get the top N domain articles by hits.
* Get the top N articles by hits for domains
*/
topNArticlesForDomainsRaw(requestParameters, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
if (requestParameters['domainNames'] == null) {
throw new runtime.RequiredError('domainNames', 'Required parameter "domainNames" was null or undefined when calling topNArticlesForDomains().');
}
const queryParameters = {};
if (requestParameters['domainNames'] != null) {
queryParameters['domain_names'] = requestParameters['domainNames'];
}
if (requestParameters['limit'] != null) {
queryParameters['limit'] = requestParameters['limit'];
}
if (requestParameters['startDate'] != null) {
queryParameters['start_date'] = requestParameters['startDate'];
}
if (requestParameters['endDate'] != null) {
queryParameters['end_date'] = requestParameters['endDate'];
}
const headerParameters = {};
const response = yield this.request({
path: `/v1/distribution/articles/top_n_for_domains`,
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.TopNArticlesForDomainResponseFromJSON)(jsonValue));
});
}
/**
* Get the top N domain articles by hits.
* Get the top N articles by hits for domains
*/
topNArticlesForDomains(requestParameters, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
const response = yield this.topNArticlesForDomainsRaw(requestParameters, initOverrides);
return yield response.value();
});
}
/**
* Get the top N domains by hits.
* Get the top N domains by hits
*/
topNDomainsByHitsRaw(requestParameters, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
const queryParameters = {};
if (requestParameters['limit'] != null) {
queryParameters['limit'] = requestParameters['limit'];
}
if (requestParameters['startDate'] != null) {
queryParameters['start_date'] = requestParameters['startDate'];
}
if (requestParameters['endDate'] != null) {
queryParameters['end_date'] = requestParameters['endDate'];
}
if (requestParameters['names'] != null) {
queryParameters['names'] = requestParameters['names'];
}
const headerParameters = {};
const response = yield this.request({
path: `/v1/distribution/domains/top_n`,
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.TopNDomainsByHitsResponseFromJSON)(jsonValue));
});
}
/**
* Get the top N domains by hits.
* Get the top N domains by hits
*/
topNDomainsByHits(requestParameters = {}, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
const response = yield this.topNDomainsByHitsRaw(requestParameters, initOverrides);
return yield response.value();
});
}
/**
* Update an existing domain.
* Update an existing domain
*/
updateDomainRaw(requestParameters, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
if (requestParameters['name'] == null) {
throw new runtime.RequiredError('name', 'Required parameter "name" was null or undefined when calling updateDomain().');
}
if (requestParameters['updateDomainRequest'] == null) {
throw new runtime.RequiredError('updateDomainRequest', 'Required parameter "updateDomainRequest" was null or undefined when calling updateDomain().');
}
const queryParameters = {};
const headerParameters = {};
headerParameters['Content-Type'] = 'application/json';
const response = yield this.request({
path: `/v1/distribution/domains/{name}`.replace(`{${"name"}}`, encodeURIComponent(String(requestParameters['name']))),
method: 'PUT',
headers: headerParameters,
query: queryParameters,
body: (0, index_1.UpdateDomainRequestToJSON)(requestParameters['updateDomainRequest']),
}, initOverrides);
if ('updateDomainRequest' in requestParameters && requestParameters['updateDomainRequest'] != null && 'stream' in requestParameters['updateDomainRequest'] && requestParameters['updateDomainRequest']['stream'] === true) {
return new runtime.StreamApiResponse(response);
}
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.ReadDomainResponseFromJSON)(jsonValue));
});
}
/**
* Update an existing domain.
* Update an existing domain
*/
updateDomain(requestParameters, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
const response = yield this.updateDomainRaw(requestParameters, initOverrides);
return yield response.value();
});
}
}
exports.DistributionApi = DistributionApi;