cwmsjs/dist/apis/RatingsApi.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.3.2-2025.03.19
 *
 *
 * 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 { DatabaseLoadMethod, DeleteMethod, RatingMetadataList, RatingSpec, RatingSpecs, RatingTemplate, RatingTemplates } from '../models/index';
export interface DeleteRatingsSpecWithRatingIdRequest {
    ratingId: string;
    office: string;
    method: DeleteMethod;
}
export interface DeleteRatingsTemplateWithTemplateIdRequest {
    templateId: string;
    office: string;
    method: DeleteMethod;
}
export interface DeleteRatingsWithRatingIdRequest {
    ratingId: string;
    office: string;
    begin: string;
    end: string;
    timezone?: string;
}
export interface GetRatingsRequest {
    name?: string;
    office?: string;
    unit?: string;
    datum?: string;
    at?: string;
    end?: string;
    timezone?: string;
    format?: string;
}
export interface GetRatingsMetadataRequest {
    office?: string;
    ratingIdMask?: string;
    start?: string;
    end?: string;
    timezone?: string;
    page?: string;
    pageSize?: number;
}
export interface GetRatingsSpecRequest {
    office?: string;
    ratingIdMask?: string;
    page?: string;
    pageSize?: number;
}
export interface GetRatingsSpecWithRatingIdRequest {
    ratingId: string;
    office: string;
}
export interface GetRatingsTemplateRequest {
    office?: string;
    templateIdMask?: string;
    page?: string;
    pageSize?: number;
}
export interface GetRatingsTemplateWithTemplateIdRequest {
    templateId: string;
    office: string;
}
export interface GetRatingsWithRatingIdRequest {
    ratingId: string;
    office: string;
    begin?: string;
    end?: string;
    timezone?: string;
    method?: DatabaseLoadMethod;
}
export interface PatchRatingsWithRatingIdRequest {
    ratingId: string;
    body: object;
    storeTemplate?: boolean;
}
export interface PostRatingsRequest {
    body: object;
    storeTemplate?: boolean;
}
export interface PostRatingsSpecRequest {
    ratingSpec: RatingSpec;
    failIfExists?: boolean;
}
export interface PostRatingsTemplateRequest {
    ratingTemplate: RatingTemplate;
    failIfExists?: boolean;
}
/**
 *
 */
export declare class RatingsApi extends runtime.BaseAPI {
    /**
     * Deletes requested rating specification
     * Delete cwmsData ratings spec with ratingId
     */
    deleteRatingsSpecWithRatingIdRaw(requestParameters: DeleteRatingsSpecWithRatingIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    /**
     * Deletes requested rating specification
     * Delete cwmsData ratings spec with ratingId
     */
    deleteRatingsSpecWithRatingId(requestParameters: DeleteRatingsSpecWithRatingIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    /**
     * Deletes requested rating specification
     * Delete cwmsData ratings template with templateId
     */
    deleteRatingsTemplateWithTemplateIdRaw(requestParameters: DeleteRatingsTemplateWithTemplateIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    /**
     * Deletes requested rating specification
     * Delete cwmsData ratings template with templateId
     */
    deleteRatingsTemplateWithTemplateId(requestParameters: DeleteRatingsTemplateWithTemplateIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    /**
     * Delete cwmsData ratings with ratingId
     */
    deleteRatingsWithRatingIdRaw(requestParameters: DeleteRatingsWithRatingIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    /**
     * Delete cwmsData ratings with ratingId
     */
    deleteRatingsWithRatingId(requestParameters: DeleteRatingsWithRatingIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    /**
     * Get cwmsData ratings
     */
    getRatingsRaw(requestParameters: GetRatingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
    /**
     * Get cwmsData ratings
     */
    getRatings(requestParameters?: GetRatingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
    /**
     * Get cwmsData ratings metadata
     */
    getRatingsMetadataRaw(requestParameters: GetRatingsMetadataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RatingMetadataList>>;
    /**
     * Get cwmsData ratings metadata
     */
    getRatingsMetadata(requestParameters?: GetRatingsMetadataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RatingMetadataList>;
    /**
     * Get cwmsData ratings spec
     */
    getRatingsSpecRaw(requestParameters: GetRatingsSpecRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RatingSpecs>>;
    /**
     * Get cwmsData ratings spec
     */
    getRatingsSpec(requestParameters?: GetRatingsSpecRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RatingSpecs>;
    /**
     * Get cwmsData ratings spec with ratingId
     */
    getRatingsSpecWithRatingIdRaw(requestParameters: GetRatingsSpecWithRatingIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RatingSpec>>;
    /**
     * Get cwmsData ratings spec with ratingId
     */
    getRatingsSpecWithRatingId(requestParameters: GetRatingsSpecWithRatingIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RatingSpec>;
    /**
     * Get cwmsData ratings template
     */
    getRatingsTemplateRaw(requestParameters: GetRatingsTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RatingTemplates>>;
    /**
     * Get cwmsData ratings template
     */
    getRatingsTemplate(requestParameters?: GetRatingsTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RatingTemplates>;
    /**
     * Get cwmsData ratings template with templateId
     */
    getRatingsTemplateWithTemplateIdRaw(requestParameters: GetRatingsTemplateWithTemplateIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<RatingTemplate>>>;
    /**
     * Get cwmsData ratings template with templateId
     */
    getRatingsTemplateWithTemplateId(requestParameters: GetRatingsTemplateWithTemplateIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<RatingTemplate>>;
    /**
     * Returns CWMS Rating Data
     * Get cwmsData ratings with ratingId
     */
    getRatingsWithRatingIdRaw(requestParameters: GetRatingsWithRatingIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
    /**
     * Returns CWMS Rating Data
     * Get cwmsData ratings with ratingId
     */
    getRatingsWithRatingId(requestParameters: GetRatingsWithRatingIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
    /**
     * Update a RatingSet
     * Patch cwmsData ratings with ratingId
     */
    patchRatingsWithRatingIdRaw(requestParameters: PatchRatingsWithRatingIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    /**
     * Update a RatingSet
     * Patch cwmsData ratings with ratingId
     */
    patchRatingsWithRatingId(requestParameters: PatchRatingsWithRatingIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    /**
     * Create new RatingSet
     * Post cwmsData ratings
     */
    postRatingsRaw(requestParameters: PostRatingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    /**
     * Create new RatingSet
     * Post cwmsData ratings
     */
    postRatings(requestParameters: PostRatingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    /**
     * Create new Rating Specification
     * Post cwmsData ratings spec
     */
    postRatingsSpecRaw(requestParameters: PostRatingsSpecRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    /**
     * Create new Rating Specification
     * Post cwmsData ratings spec
     */
    postRatingsSpec(requestParameters: PostRatingsSpecRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    /**
     * Create new Rating Template
     * Post cwmsData ratings template
     */
    postRatingsTemplateRaw(requestParameters: PostRatingsTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    /**
     * Create new Rating Template
     * Post cwmsData ratings template
     */
    postRatingsTemplate(requestParameters: PostRatingsTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
}