cwmsjs/src/apis/PoolsApi.ts

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

/* tslint:disable */
/* eslint-disable */
/**
 * 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 {
    CdaError,
    CdaErrorFromJSON,
    CdaErrorToJSON,
    Pool,
    PoolFromJSON,
    PoolToJSON,
    Pools,
    PoolsFromJSON,
    PoolsToJSON,
} from '../models';

export interface GetPoolsRequest {
    office?: string;
    idMask?: string;
    nameMask?: string;
    bottomMask?: string;
    topMask?: string;
    includeExplicit?: string;
    includeImplicit?: string;
    page?: string;
    pageSize?: number;
}

export interface GetPoolsWithPoolIdRequest {
    poolId: string;
    office: string;
    projectId: string;
    bottomMask?: string;
    topMask?: string;
    includeExplicit?: string;
    includeImplicit?: string;
}

/**
 * 
 */
export class PoolsApi extends runtime.BaseAPI {

    /**
     * Returns Pools Data
     * Get pools
     */
    async getPoolsRaw(requestParameters: GetPoolsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<Pools>> {
        const queryParameters: any = {};

        if (requestParameters.office !== undefined) {
            queryParameters['office'] = requestParameters.office;
        }

        if (requestParameters.idMask !== undefined) {
            queryParameters['id-mask'] = requestParameters.idMask;
        }

        if (requestParameters.nameMask !== undefined) {
            queryParameters['name-mask'] = requestParameters.nameMask;
        }

        if (requestParameters.bottomMask !== undefined) {
            queryParameters['bottom-mask'] = requestParameters.bottomMask;
        }

        if (requestParameters.topMask !== undefined) {
            queryParameters['top-mask'] = requestParameters.topMask;
        }

        if (requestParameters.includeExplicit !== undefined) {
            queryParameters['include-explicit'] = requestParameters.includeExplicit;
        }

        if (requestParameters.includeImplicit !== undefined) {
            queryParameters['include-implicit'] = requestParameters.includeImplicit;
        }

        if (requestParameters.page !== undefined) {
            queryParameters['page'] = requestParameters.page;
        }

        if (requestParameters.pageSize !== undefined) {
            queryParameters['page-size'] = requestParameters.pageSize;
        }

        const headerParameters: runtime.HTTPHeaders = {};

        if (this.configuration && this.configuration.apiKey) {
            headerParameters["Authorization"] = this.configuration.apiKey("Authorization"); // ApiKey authentication
        }

        const response = await this.request({
            path: `/pools`,
            method: 'GET',
            headers: headerParameters,
            query: queryParameters,
        }, initOverrides);

        return new runtime.JSONApiResponse(response, (jsonValue) => PoolsFromJSON(jsonValue));
    }

    /**
     * Returns Pools Data
     * Get pools
     */
    async getPools(requestParameters: GetPoolsRequest = {}, initOverrides?: RequestInit): Promise<Pools> {
        const response = await this.getPoolsRaw(requestParameters, initOverrides);
        return await response.value();
    }

    /**
     * Retrieves requested Pool
     * Get pools with poolId
     */
    async getPoolsWithPoolIdRaw(requestParameters: GetPoolsWithPoolIdRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<Pool>> {
        if (requestParameters.poolId === null || requestParameters.poolId === undefined) {
            throw new runtime.RequiredError('poolId','Required parameter requestParameters.poolId was null or undefined when calling getPoolsWithPoolId.');
        }

        if (requestParameters.office === null || requestParameters.office === undefined) {
            throw new runtime.RequiredError('office','Required parameter requestParameters.office was null or undefined when calling getPoolsWithPoolId.');
        }

        if (requestParameters.projectId === null || requestParameters.projectId === undefined) {
            throw new runtime.RequiredError('projectId','Required parameter requestParameters.projectId was null or undefined when calling getPoolsWithPoolId.');
        }

        const queryParameters: any = {};

        if (requestParameters.office !== undefined) {
            queryParameters['office'] = requestParameters.office;
        }

        if (requestParameters.projectId !== undefined) {
            queryParameters['project-id'] = requestParameters.projectId;
        }

        if (requestParameters.bottomMask !== undefined) {
            queryParameters['bottom-mask'] = requestParameters.bottomMask;
        }

        if (requestParameters.topMask !== undefined) {
            queryParameters['top-mask'] = requestParameters.topMask;
        }

        if (requestParameters.includeExplicit !== undefined) {
            queryParameters['include-explicit'] = requestParameters.includeExplicit;
        }

        if (requestParameters.includeImplicit !== undefined) {
            queryParameters['include-implicit'] = requestParameters.includeImplicit;
        }

        const headerParameters: runtime.HTTPHeaders = {};

        if (this.configuration && this.configuration.apiKey) {
            headerParameters["Authorization"] = this.configuration.apiKey("Authorization"); // ApiKey authentication
        }

        const response = await this.request({
            path: `/pools/{pool-id}`.replace(`{${"pool-id"}}`, encodeURIComponent(String(requestParameters.poolId))),
            method: 'GET',
            headers: headerParameters,
            query: queryParameters,
        }, initOverrides);

        return new runtime.JSONApiResponse(response, (jsonValue) => PoolFromJSON(jsonValue));
    }

    /**
     * Retrieves requested Pool
     * Get pools with poolId
     */
    async getPoolsWithPoolId(requestParameters: GetPoolsWithPoolIdRequest, initOverrides?: RequestInit): Promise<Pool> {
        const response = await this.getPoolsWithPoolIdRaw(requestParameters, initOverrides);
        return await response.value();
    }

}