cwmsjs
Version:
CWMS Data API Library for JavaScript/TypeScript created with OpenAPI generator for use with browser webapps
94 lines (93 loc) • 3.68 kB
TypeScript
/**
* 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 { Clob, Clobs } from '../models';
export interface DeleteClobsWithClobIdRequest {
clobId: string;
clobId2: string;
office: string;
}
export interface GetClobsRequest {
office?: string;
page?: string;
pageSize?: number;
includeValues?: boolean;
like?: string;
}
export interface GetClobsWithClobIdRequest {
clobId: string;
office?: string;
clobId2?: string;
}
export interface PatchClobsWithClobIdRequest {
clobId: string;
clobId2: string;
clob: Clob;
ignoreNulls?: boolean;
}
export interface PostClobsRequest {
clob: Clob;
failIfExists?: boolean;
}
/**
*
*/
export declare class ClobApi extends runtime.BaseAPI {
/**
* Delete clob
* Delete clobs with clobId
*/
deleteClobsWithClobIdRaw(requestParameters: DeleteClobsWithClobIdRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<void>>;
/**
* Delete clob
* Delete clobs with clobId
*/
deleteClobsWithClobId(requestParameters: DeleteClobsWithClobIdRequest, initOverrides?: RequestInit): Promise<void>;
/**
* Get clobs
*/
getClobsRaw(requestParameters: GetClobsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<Clobs>>;
/**
* Get clobs
*/
getClobs(requestParameters?: GetClobsRequest, initOverrides?: RequestInit): Promise<Clobs>;
/**
* Get a single clob. If the accept header is set to text/plain, the raw value is returned as the response body. Responses to text/plain requests are streamed and support the Range header. When the accept header is set to application/json;version=2 the clob will be returned as a serialized Clob object with fields for office-id, id, description and value. For more information about accept header usage, <a href=\"legacy-format/\">see this page.</a>
* Get clobs with clobId
*/
getClobsWithClobIdRaw(requestParameters: GetClobsWithClobIdRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<Clob>>;
/**
* Get a single clob. If the accept header is set to text/plain, the raw value is returned as the response body. Responses to text/plain requests are streamed and support the Range header. When the accept header is set to application/json;version=2 the clob will be returned as a serialized Clob object with fields for office-id, id, description and value. For more information about accept header usage, <a href=\"legacy-format/\">see this page.</a>
* Get clobs with clobId
*/
getClobsWithClobId(requestParameters: GetClobsWithClobIdRequest, initOverrides?: RequestInit): Promise<Clob>;
/**
* Update clob
* Patch clobs with clobId
*/
patchClobsWithClobIdRaw(requestParameters: PatchClobsWithClobIdRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<void>>;
/**
* Update clob
* Patch clobs with clobId
*/
patchClobsWithClobId(requestParameters: PatchClobsWithClobIdRequest, initOverrides?: RequestInit): Promise<void>;
/**
* Create new Clob
* Post clobs
*/
postClobsRaw(requestParameters: PostClobsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<void>>;
/**
* Create new Clob
* Post clobs
*/
postClobs(requestParameters: PostClobsRequest, initOverrides?: RequestInit): Promise<void>;
}