@emergentmethods/asknews-typescript-sdk/dist/models/CreateNewsletterRequest.d.ts

Typescript SDK for AskNews API

/**
 * 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.
 */
/**
 *
 * @export
 * @interface CreateNewsletterRequest
 */
export interface CreateNewsletterRequest {
    /**
     * The name of the newsletter.
     * @type {string}
     * @memberof CreateNewsletterRequest
     */
    name: string;
    /**
     * The natural language query to run for the newsletter.
     * @type {string}
     * @memberof CreateNewsletterRequest
     */
    query: string;
    /**
     * The cron schedule for the newsletter. For example daily at 00:00 UTC is '0 0 * * *'. See https://crontab.run/ for more examples
     * @type {string}
     * @memberof CreateNewsletterRequest
     */
    cron: string;
    /**
     * The model to use for the newsletter.
     * @type {string}
     * @memberof CreateNewsletterRequest
     */
    model: CreateNewsletterRequestModelEnum;
    /**
     *
     * @type {string}
     * @memberof CreateNewsletterRequest
     */
    subject?: string | null;
    /**
     * The sender of the newsletter.
     * @type {string}
     * @memberof CreateNewsletterRequest
     */
    sender: string;
    /**
     *
     * @type {string}
     * @memberof CreateNewsletterRequest
     */
    logoUrl?: string | null;
    /**
     *
     * @type {string}
     * @memberof CreateNewsletterRequest
     */
    replyTo?: string | null;
    /**
     *
     * @type {string}
     * @memberof CreateNewsletterRequest
     */
    audienceId?: string | null;
    /**
     *
     * @type {string}
     * @memberof CreateNewsletterRequest
     */
    resendApiKey?: string | null;
    /**
     * Whether the newsletter is public or not. If not provided, the newsletter will be public. If you make the newsletter public only title and query will be shown.
     * @type {boolean}
     * @memberof CreateNewsletterRequest
     */
    _public?: boolean;
    /**
     * Whether the newsletter is active or not. If not provided, the newsletter will be active. If you make the newsletter inactive, it will not be sent.
     * @type {boolean}
     * @memberof CreateNewsletterRequest
     */
    active?: boolean;
    /**
     *
     * @type {Date}
     * @memberof CreateNewsletterRequest
     */
    expiresAt?: Date | null;
}
/**
 * @export
 */
export declare const CreateNewsletterRequestModelEnum: {
    readonly Gpt4o: "gpt-4o";
    readonly Gpt4oMini: "gpt-4o-mini";
    readonly Claude35SonnetLatest: "claude-3-5-sonnet-latest";
    readonly MetaLlamaMetaLlama31405BInstruct: "meta-llama/Meta-Llama-3.1-405B-Instruct";
    readonly MetaLlamaMetaLlama3370BInstruct: "meta-llama/Meta-Llama-3.3-70B-Instruct";
};
export type CreateNewsletterRequestModelEnum = typeof CreateNewsletterRequestModelEnum[keyof typeof CreateNewsletterRequestModelEnum];
/**
 * Check if a given object implements the CreateNewsletterRequest interface.
 */
export declare function instanceOfCreateNewsletterRequest(value: object): value is CreateNewsletterRequest;
export declare function CreateNewsletterRequestFromJSON(json: any): CreateNewsletterRequest;
export declare function CreateNewsletterRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateNewsletterRequest;
export declare function CreateNewsletterRequestToJSON(json: any): CreateNewsletterRequest;
export declare function CreateNewsletterRequestToJSONTyped(value?: CreateNewsletterRequest | null, ignoreDiscriminator?: boolean): any;