cwmsjs/dist/apis/TextTimeSeriesApi.d.ts

CWMS Data API Library for JavaScript/TypeScript created with OpenAPI generator for use with browser webapps

/**
 * CWMS Data API
 * CWMS REST API for Data Retrieval
 *
 * The version of the OpenAPI document: 2.4.0-2026.3.16
 *
 *
 * 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 { TextTimeSeries } from '../models';
export interface DeleteTimeSeriesTextWithNameRequest {
    name: string;
    office: string;
    textMask: string;
    begin: string;
    end: string;
    timezone?: string;
    versionDate?: string;
}
export interface GetTimeSeriesTextRequest {
    office: string;
    name: string;
    begin: string;
    end: string;
    timezone?: string;
}
export interface GetTimeSeriesTextWithNameValueRequest {
    name: string;
    office: string;
    date: string;
    timezone?: string;
    versionDate?: string;
    clobId?: string;
}
export interface PatchTimeSeriesTextWithNameRequest {
    name: string;
    textTimeSeries: TextTimeSeries;
    replaceAll?: boolean;
}
export interface PostTimeSeriesTextRequest {
    textTimeSeries: TextTimeSeries;
    replaceAll?: boolean;
}
/**
 *
 */
export declare class TextTimeSeriesApi extends runtime.BaseAPI {
    /**
     * Deletes requested text timeseries id
     * Delete timeseries text with name
     */
    deleteTimeSeriesTextWithNameRaw(requestParameters: DeleteTimeSeriesTextWithNameRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<void>>;
    /**
     * Deletes requested text timeseries id
     * Delete timeseries text with name
     */
    deleteTimeSeriesTextWithName(requestParameters: DeleteTimeSeriesTextWithNameRequest, initOverrides?: RequestInit): Promise<void>;
    /**
     * Retrieve text time series values for a provided time window and date version.If individual values exceed 64 kilobytes, a URL to a separate download is provided instead of being included in the returned payload from this request.
     */
    getTimeSeriesTextRaw(requestParameters: GetTimeSeriesTextRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<TextTimeSeries>>;
    /**
     * Retrieve text time series values for a provided time window and date version.If individual values exceed 64 kilobytes, a URL to a separate download is provided instead of being included in the returned payload from this request.
     */
    getTimeSeriesText(requestParameters: GetTimeSeriesTextRequest, initOverrides?: RequestInit): Promise<TextTimeSeries>;
    /**
     * Get timeseries text with name value
     */
    getTimeSeriesTextWithNameValueRaw(requestParameters: GetTimeSeriesTextWithNameValueRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<string>>;
    /**
     * Get timeseries text with name value
     */
    getTimeSeriesTextWithNameValue(requestParameters: GetTimeSeriesTextWithNameValueRequest, initOverrides?: RequestInit): Promise<string>;
    /**
     * Updates a text timeseries
     * Patch timeseries text with name
     */
    patchTimeSeriesTextWithNameRaw(requestParameters: PatchTimeSeriesTextWithNameRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<void>>;
    /**
     * Updates a text timeseries
     * Patch timeseries text with name
     */
    patchTimeSeriesTextWithName(requestParameters: PatchTimeSeriesTextWithNameRequest, initOverrides?: RequestInit): Promise<void>;
    /**
     * Create new TextTimeSeries
     * Post timeseries text
     */
    postTimeSeriesTextRaw(requestParameters: PostTimeSeriesTextRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<void>>;
    /**
     * Create new TextTimeSeries
     * Post timeseries text
     */
    postTimeSeriesText(requestParameters: PostTimeSeriesTextRequest, initOverrides?: RequestInit): Promise<void>;
}