@emergentmethods/asknews-typescript-sdk/dist/apis/AlertsApi.d.ts

Typescript SDK for AskNews API

/**
 * 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 * as runtime from '../runtime';
import type { AlertResponse, CreateAlertRequest, PaginatedResponseAlertLog, PaginatedResponseAlertResponse, UpdateAlertRequest } from '../models/index';
export interface CreateAlertOperationRequest {
    createAlertRequest: CreateAlertRequest;
}
export interface DeleteAlertRequest {
    alertId: string;
}
export interface GetAlertRequest {
    alertId: string;
    userId?: string;
}
export interface GetAlertLogsRequest {
    alertId: string;
    userId?: string;
    page?: number;
    perPage?: number;
    all?: boolean;
    startTimestamp?: number;
    endTimestamp?: number;
}
export interface GetAlertsRequest {
    page?: number;
    perPage?: number;
    all?: boolean;
}
export interface GetAllAlertLogsRequest {
    alertId?: string;
    userId?: string;
    page?: number;
    perPage?: number;
    all?: boolean;
    startTimestamp?: number;
    endTimestamp?: number;
}
export interface PutAlertRequest {
    alertId: string;
    updateAlertRequest: UpdateAlertRequest;
}
/**
 *
 */
export declare class AlertsApi extends runtime.BaseAPI {
    /**
     * Create an alert.
     * Create an alert
     */
    createAlertRaw(requestParameters: CreateAlertOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AlertResponse> | runtime.StreamApiResponse>;
    /**
     * Create an alert.
     * Create an alert
     */
    createAlert(requestParameters: CreateAlertOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AlertResponse | ReadableStream<any>>;
    /**
     * Delete an alert.
     * Delete an alert
     */
    deleteAlertRaw(requestParameters: DeleteAlertRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    /**
     * Delete an alert.
     * Delete an alert
     */
    deleteAlert(requestParameters: DeleteAlertRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    /**
     * Get an alert.
     * Get an alert
     */
    getAlertRaw(requestParameters: GetAlertRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AlertResponse>>;
    /**
     * Get an alert.
     * Get an alert
     */
    getAlert(requestParameters: GetAlertRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AlertResponse>;
    /**
     * Get alert logs.
     * Get alert logs
     */
    getAlertLogsRaw(requestParameters: GetAlertLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseAlertLog>>;
    /**
     * Get alert logs.
     * Get alert logs
     */
    getAlertLogs(requestParameters: GetAlertLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseAlertLog>;
    /**
     * Get all created alerts.
     * Get all created alerts
     */
    getAlertsRaw(requestParameters: GetAlertsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseAlertResponse>>;
    /**
     * Get all created alerts.
     * Get all created alerts
     */
    getAlerts(requestParameters?: GetAlertsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseAlertResponse>;
    /**
     * Get all alert logs.
     * Get all alert logs
     */
    getAllAlertLogsRaw(requestParameters: GetAllAlertLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseAlertLog>>;
    /**
     * Get all alert logs.
     * Get all alert logs
     */
    getAllAlertLogs(requestParameters?: GetAllAlertLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseAlertLog>;
    /**
     * Update an alert.
     * Update an alert
     */
    putAlertRaw(requestParameters: PutAlertRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AlertResponse> | runtime.StreamApiResponse>;
    /**
     * Update an alert.
     * Update an alert
     */
    putAlert(requestParameters: PutAlertRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AlertResponse | ReadableStream<any>>;
}