@emergentmethods/asknews-typescript-sdk/src/models/Article.ts

Typescript SDK for AskNews API

/* tslint:disable */
/* eslint-disable */
/**
 * AskNews API
 * AskNews API
 *
 * The version of the OpenAPI document: 0.19.10
 * 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 { mapValues } from '../runtime';
import type { Assets } from './Assets';
import {
    AssetsFromJSON,
    AssetsFromJSONTyped,
    AssetsToJSON,
    AssetsToJSONTyped,
} from './Assets';
import type { Classification } from './Classification';
import {
    ClassificationFromJSON,
    ClassificationFromJSONTyped,
    ClassificationToJSON,
    ClassificationToJSONTyped,
} from './Classification';
import type { AsknewsApiSchemaV1CommonGraphRelationships } from './AsknewsApiSchemaV1CommonGraphRelationships';
import {
    AsknewsApiSchemaV1CommonGraphRelationshipsFromJSON,
    AsknewsApiSchemaV1CommonGraphRelationshipsFromJSONTyped,
    AsknewsApiSchemaV1CommonGraphRelationshipsToJSON,
    AsknewsApiSchemaV1CommonGraphRelationshipsToJSONTyped,
} from './AsknewsApiSchemaV1CommonGraphRelationships';
import type { GeoCoordinate } from './GeoCoordinate';
import {
    GeoCoordinateFromJSON,
    GeoCoordinateFromJSONTyped,
    GeoCoordinateToJSON,
    GeoCoordinateToJSONTyped,
} from './GeoCoordinate';
import type { ReportingVoice1 } from './ReportingVoice1';
import {
    ReportingVoice1FromJSON,
    ReportingVoice1FromJSONTyped,
    ReportingVoice1ToJSON,
    ReportingVoice1ToJSONTyped,
} from './ReportingVoice1';
import type { Entities } from './Entities';
import {
    EntitiesFromJSON,
    EntitiesFromJSONTyped,
    EntitiesToJSON,
    EntitiesToJSONTyped,
} from './Entities';

/**
 * 
 * @export
 * @interface Article
 */
export interface Article {
    /**
     * 
     * @type {string}
     * @memberof Article
     */
    articleUrl: string;
    /**
     * 
     * @type {string}
     * @memberof Article
     */
    articleId: string;
    /**
     * 
     * @type {Classification}
     * @memberof Article
     */
    classification: Classification;
    /**
     * 
     * @type {string}
     * @memberof Article
     */
    country: string;
    /**
     * 
     * @type {string}
     * @memberof Article
     */
    sourceId: string;
    /**
     * 
     * @type {number}
     * @memberof Article
     */
    pageRank: number;
    /**
     * 
     * @type {string}
     * @memberof Article
     */
    domainUrl: string;
    /**
     * 
     * @type {string}
     * @memberof Article
     */
    engTitle: string;
    /**
     * 
     * @type {Entities}
     * @memberof Article
     */
    entities: Entities;
    /**
     * 
     * @type {string}
     * @memberof Article
     */
    imageUrl?: string | null;
    /**
     * 
     * @type {Array<string>}
     * @memberof Article
     */
    keywords: Array<string>;
    /**
     * 
     * @type {string}
     * @memberof Article
     */
    language: string;
    /**
     * 
     * @type {Date}
     * @memberof Article
     */
    pubDate: Date;
    /**
     * 
     * @type {string}
     * @memberof Article
     */
    summary: string;
    /**
     * 
     * @type {Array<string>}
     * @memberof Article
     */
    keyPoints?: Array<string> | null;
    /**
     * 
     * @type {string}
     * @memberof Article
     */
    title: string;
    /**
     * 
     * @type {number}
     * @memberof Article
     */
    sentiment: number;
    /**
     * 
     * @type {number}
     * @memberof Article
     */
    centroidDistance: number;
    /**
     * 
     * @type {number}
     * @memberof Article
     */
    clusterProbability: number;
    /**
     * 
     * @type {string}
     * @memberof Article
     */
    markdownCitation?: string;
    /**
     * 
     * @type {string}
     * @memberof Article
     */
    provocative?: ArticleProvocativeEnum;
    /**
     * 
     * @type {ReportingVoice1}
     * @memberof Article
     */
    reportingVoice?: ReportingVoice1;
    /**
     * 
     * @type {AsknewsApiSchemaV1CommonGraphRelationships}
     * @memberof Article
     */
    entityRelationGraph?: AsknewsApiSchemaV1CommonGraphRelationships | null;
    /**
     * 
     * @type {{ [key: string]: GeoCoordinate; }}
     * @memberof Article
     */
    geoCoordinates?: { [key: string]: GeoCoordinate; } | null;
    /**
     * 
     * @type {string}
     * @memberof Article
     */
    continent?: ArticleContinentEnum | null;
    /**
     * 
     * @type {Assets}
     * @memberof Article
     */
    assets?: Assets | null;
    /**
     * 
     * @type {Array<string>}
     * @memberof Article
     */
    socialEmbeds?: Array<string> | null;
}


/**
 * @export
 */
export const ArticleProvocativeEnum = {
    Unknown: 'unknown',
    Low: 'low',
    Medium: 'medium',
    High: 'high'
} as const;
export type ArticleProvocativeEnum = typeof ArticleProvocativeEnum[keyof typeof ArticleProvocativeEnum];

/**
 * @export
 */
export const ArticleContinentEnum = {
    Africa: 'Africa',
    Asia: 'Asia',
    Europe: 'Europe',
    MiddleEast: 'Middle East',
    NorthAmerica: 'North America',
    SouthAmerica: 'South America',
    Oceania: 'Oceania'
} as const;
export type ArticleContinentEnum = typeof ArticleContinentEnum[keyof typeof ArticleContinentEnum];


/**
 * Check if a given object implements the Article interface.
 */
export function instanceOfArticle(value: object): value is Article {
    if (!('articleUrl' in value) || value['articleUrl'] === undefined) return false;
    if (!('articleId' in value) || value['articleId'] === undefined) return false;
    if (!('classification' in value) || value['classification'] === undefined) return false;
    if (!('country' in value) || value['country'] === undefined) return false;
    if (!('sourceId' in value) || value['sourceId'] === undefined) return false;
    if (!('pageRank' in value) || value['pageRank'] === undefined) return false;
    if (!('domainUrl' in value) || value['domainUrl'] === undefined) return false;
    if (!('engTitle' in value) || value['engTitle'] === undefined) return false;
    if (!('entities' in value) || value['entities'] === undefined) return false;
    if (!('keywords' in value) || value['keywords'] === undefined) return false;
    if (!('language' in value) || value['language'] === undefined) return false;
    if (!('pubDate' in value) || value['pubDate'] === undefined) return false;
    if (!('summary' in value) || value['summary'] === undefined) return false;
    if (!('title' in value) || value['title'] === undefined) return false;
    if (!('sentiment' in value) || value['sentiment'] === undefined) return false;
    if (!('centroidDistance' in value) || value['centroidDistance'] === undefined) return false;
    if (!('clusterProbability' in value) || value['clusterProbability'] === undefined) return false;
    return true;
}

export function ArticleFromJSON(json: any): Article {
    return ArticleFromJSONTyped(json, false);
}

export function ArticleFromJSONTyped(json: any, ignoreDiscriminator: boolean): Article {
    if (json == null) {
        return json;
    }
    return {
        
        'articleUrl': json['article_url'],
        'articleId': json['article_id'],
        'classification': ClassificationFromJSON(json['classification']),
        'country': json['country'],
        'sourceId': json['source_id'],
        'pageRank': json['page_rank'],
        'domainUrl': json['domain_url'],
        'engTitle': json['eng_title'],
        'entities': EntitiesFromJSON(json['entities']),
        'imageUrl': json['image_url'] == null ? undefined : json['image_url'],
        'keywords': json['keywords'],
        'language': json['language'],
        'pubDate': (new Date(json['pub_date'])),
        'summary': json['summary'],
        'keyPoints': json['key_points'] == null ? undefined : json['key_points'],
        'title': json['title'],
        'sentiment': json['sentiment'],
        'centroidDistance': json['centroid_distance'],
        'clusterProbability': json['cluster_probability'],
        'markdownCitation': json['markdown_citation'] == null ? undefined : json['markdown_citation'],
        'provocative': json['provocative'] == null ? undefined : json['provocative'],
        'reportingVoice': json['reporting_voice'] == null ? undefined : ReportingVoice1FromJSON(json['reporting_voice']),
        'entityRelationGraph': json['entity_relation_graph'] == null ? undefined : AsknewsApiSchemaV1CommonGraphRelationshipsFromJSON(json['entity_relation_graph']),
        'geoCoordinates': json['geo_coordinates'] == null ? undefined : (mapValues(json['geo_coordinates'], GeoCoordinateFromJSON)),
        'continent': json['continent'] == null ? undefined : json['continent'],
        'assets': json['assets'] == null ? undefined : AssetsFromJSON(json['assets']),
        'socialEmbeds': json['social_embeds'] == null ? undefined : json['social_embeds'],
    };
}

export function ArticleToJSON(json: any): Article {
    return ArticleToJSONTyped(json, false);
}

export function ArticleToJSONTyped(value?: Article | null, ignoreDiscriminator: boolean = false): any {
    if (value == null) {
        return value;
    }

    return {
        
        'article_url': value['articleUrl'],
        'article_id': value['articleId'],
        'classification': ClassificationToJSON(value['classification']),
        'country': value['country'],
        'source_id': value['sourceId'],
        'page_rank': value['pageRank'],
        'domain_url': value['domainUrl'],
        'eng_title': value['engTitle'],
        'entities': EntitiesToJSON(value['entities']),
        'image_url': value['imageUrl'],
        'keywords': value['keywords'],
        'language': value['language'],
        'pub_date': ((value['pubDate']).toISOString()),
        'summary': value['summary'],
        'key_points': value['keyPoints'],
        'title': value['title'],
        'sentiment': value['sentiment'],
        'centroid_distance': value['centroidDistance'],
        'cluster_probability': value['clusterProbability'],
        'markdown_citation': value['markdownCitation'],
        'provocative': value['provocative'],
        'reporting_voice': ReportingVoice1ToJSON(value['reportingVoice']),
        'entity_relation_graph': AsknewsApiSchemaV1CommonGraphRelationshipsToJSON(value['entityRelationGraph']),
        'geo_coordinates': value['geoCoordinates'] == null ? undefined : (mapValues(value['geoCoordinates'], GeoCoordinateToJSON)),
        'continent': value['continent'],
        'assets': AssetsToJSON(value['assets']),
        'social_embeds': value['socialEmbeds'],
    };
}