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

Typescript SDK for AskNews API

/* tslint:disable */
/* eslint-disable */
/**
 * 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.66
 * 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 { DeepNewsReportParams } from './DeepNewsReportParams';
import {
    DeepNewsReportParamsFromJSON,
    DeepNewsReportParamsFromJSONTyped,
    DeepNewsReportParamsToJSON,
    DeepNewsReportParamsToJSONTyped,
} from './DeepNewsReportParams';
import type { DeepNewsReportRequest } from './DeepNewsReportRequest';
import {
    DeepNewsReportRequestFromJSON,
    DeepNewsReportRequestFromJSONTyped,
    DeepNewsReportRequestToJSON,
    DeepNewsReportRequestToJSONTyped,
} from './DeepNewsReportRequest';
import type { LegacyReportRequest } from './LegacyReportRequest';
import {
    LegacyReportRequestFromJSON,
    LegacyReportRequestFromJSONTyped,
    LegacyReportRequestToJSON,
    LegacyReportRequestToJSONTyped,
} from './LegacyReportRequest';
import type { Report2AnyOfInner } from './Report2AnyOfInner';
import {
    Report2AnyOfInnerFromJSON,
    Report2AnyOfInnerFromJSONTyped,
    Report2AnyOfInnerToJSON,
    Report2AnyOfInnerToJSONTyped,
} from './Report2AnyOfInner';

/**
 * Configuration for generating a written report when the alert triggers. If report is a list, the individual reports will be concatenated into one report in the order they are defined. If not specified, no report is generated. Use ReportRequest(identifier='deepnews', ...) for DeepNews reports.Use ReportRequest(...) or ReportRequest(identifier='legacy', ...) for legacy reports (DEPRECATED). Requests without identifier default to 'deepnews'. Only DeepNews reports can be used in list.
 * @export
 * @interface Report2
 */
export interface Report2 {
    /**
     * 
     * @type {string}
     * @memberof Report2
     */
    logoUrl?: string;
    /**
     * 
     * @type {boolean}
     * @memberof Report2
     */
    includeAppendix?: boolean;
    /**
     * Append 'Generated by AskNews AI' watermark
     * @type {boolean}
     * @memberof Report2
     */
    asknewsWatermark?: boolean;
    /**
     * 
     * @type {string}
     * @memberof Report2
     */
    identifier?: Report2IdentifierEnum;
    /**
     * The model to use for the report. Defaults to claude-sonnet-4-6.
     * @type {string}
     * @memberof Report2
     */
    model?: Report2ModelEnum;
    /**
     * 
     * @type {DeepNewsReportParams}
     * @memberof Report2
     */
    params?: DeepNewsReportParams;
    /**
     * The prompt to use for report generation instructions. This is similar to the alert query but can contain additional instructions on how to format the report.
     * @type {string}
     * @memberof Report2
     */
    prompt: string;
}


/**
 * @export
 */
export const Report2IdentifierEnum = {
    Deepnews: 'deepnews'
} as const;
export type Report2IdentifierEnum = typeof Report2IdentifierEnum[keyof typeof Report2IdentifierEnum];

/**
 * @export
 */
export const Report2ModelEnum = {
    Gpt5: 'gpt-5',
    Gpt4o: 'gpt-4o',
    Gpt4120250414: 'gpt-4.1-2025-04-14',
    Gpt41Mini20250414: 'gpt-4.1-mini-2025-04-14',
    Gpt4oMini: 'gpt-4o-mini',
    O3Mini: 'o3-mini',
    Claude35SonnetLatest: 'claude-3-5-sonnet-latest',
    ClaudeSonnet420250514: 'claude-sonnet-4-20250514',
    ClaudeSonnet4520250929: 'claude-sonnet-4-5-20250929',
    ClaudeOpus4520251101: 'claude-opus-4-5-20251101',
    ClaudeOpus46: 'claude-opus-4-6',
    ClaudeSonnet46: 'claude-sonnet-4-6',
    MetaLlamaMetaLlama31405BInstruct: 'meta-llama/Meta-Llama-3.1-405B-Instruct',
    MetaLlamaMetaLlama3370BInstruct: 'meta-llama/Meta-Llama-3.3-70B-Instruct'
} as const;
export type Report2ModelEnum = typeof Report2ModelEnum[keyof typeof Report2ModelEnum];


/**
 * Check if a given object implements the Report2 interface.
 */
export function instanceOfReport2(value: object): value is Report2 {
    if (!('prompt' in value) || value['prompt'] === undefined) return false;
    return true;
}

export function Report2FromJSON(json: any): Report2 {
    return Report2FromJSONTyped(json, false);
}

export function Report2FromJSONTyped(json: any, ignoreDiscriminator: boolean): Report2 {
    if (json == null) {
        return json;
    }
    return {
        
        'logoUrl': json['logo_url'] == null ? undefined : json['logo_url'],
        'includeAppendix': json['include_appendix'] == null ? undefined : json['include_appendix'],
        'asknewsWatermark': json['asknews_watermark'] == null ? undefined : json['asknews_watermark'],
        'identifier': json['identifier'] == null ? undefined : json['identifier'],
        'model': json['model'] == null ? undefined : json['model'],
        'params': json['params'] == null ? undefined : DeepNewsReportParamsFromJSON(json['params']),
        'prompt': json['prompt'],
    };
}

export function Report2ToJSON(json: any): Report2 {
    return Report2ToJSONTyped(json, false);
}

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

    return {
        
        'logo_url': value['logoUrl'],
        'include_appendix': value['includeAppendix'],
        'asknews_watermark': value['asknewsWatermark'],
        'identifier': value['identifier'],
        'model': value['model'],
        'params': DeepNewsReportParamsToJSON(value['params']),
        'prompt': value['prompt'],
    };
}