cwmsjs/src/apis/LocksApi.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,
    DeleteMethod,
    DeleteMethodFromJSON,
    DeleteMethodToJSON,
    Lock,
    LockFromJSON,
    LockToJSON,
} from '../models';

export interface DeleteProjectsLocksWithNameRequest {
    name: string;
    office: string;
    method?: DeleteMethod;
}

export interface GetProjectsLocksRequest {
    office: string;
    projectId: string;
}

export interface GetProjectsLocksWithNameRequest {
    name: string;
    office: string;
    unit?: string;
}

export interface PatchProjectsLocksWithNameRequest {
    name: string;
    name2: string;
    office: string;
}

export interface PostProjectsLocksRequest {
    lock: Lock;
    failIfExists?: boolean;
}

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

    /**
     * Delete CWMS Lock
     * Delete projects locks with name
     */
    async deleteProjectsLocksWithNameRaw(requestParameters: DeleteProjectsLocksWithNameRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<void>> {
        if (requestParameters.name === null || requestParameters.name === undefined) {
            throw new runtime.RequiredError('name','Required parameter requestParameters.name was null or undefined when calling deleteProjectsLocksWithName.');
        }

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

        const queryParameters: any = {};

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

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

        const headerParameters: runtime.HTTPHeaders = {};

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

        const response = await this.request({
            path: `/projects/locks/{name}`.replace(`{${"name"}}`, encodeURIComponent(String(requestParameters.name))),
            method: 'DELETE',
            headers: headerParameters,
            query: queryParameters,
        }, initOverrides);

        return new runtime.VoidApiResponse(response);
    }

    /**
     * Delete CWMS Lock
     * Delete projects locks with name
     */
    async deleteProjectsLocksWithName(requestParameters: DeleteProjectsLocksWithNameRequest, initOverrides?: RequestInit): Promise<void> {
        await this.deleteProjectsLocksWithNameRaw(requestParameters, initOverrides);
    }

    /**
     * Returns matching CWMS Lock Data for a Reservoir Project.
     * Get projects locks
     */
    async getProjectsLocksRaw(requestParameters: GetProjectsLocksRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<Array<Lock>>> {
        if (requestParameters.office === null || requestParameters.office === undefined) {
            throw new runtime.RequiredError('office','Required parameter requestParameters.office was null or undefined when calling getProjectsLocks.');
        }

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

        const queryParameters: any = {};

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

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

        const headerParameters: runtime.HTTPHeaders = {};

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

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

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

    /**
     * Returns matching CWMS Lock Data for a Reservoir Project.
     * Get projects locks
     */
    async getProjectsLocks(requestParameters: GetProjectsLocksRequest, initOverrides?: RequestInit): Promise<Array<Lock>> {
        const response = await this.getProjectsLocksRaw(requestParameters, initOverrides);
        return await response.value();
    }

    /**
     * Returns CWMS Lock Data
     * Get projects locks with name
     */
    async getProjectsLocksWithNameRaw(requestParameters: GetProjectsLocksWithNameRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<Array<Lock>>> {
        if (requestParameters.name === null || requestParameters.name === undefined) {
            throw new runtime.RequiredError('name','Required parameter requestParameters.name was null or undefined when calling getProjectsLocksWithName.');
        }

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

        const queryParameters: any = {};

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

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

        const headerParameters: runtime.HTTPHeaders = {};

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

        const response = await this.request({
            path: `/projects/locks/{name}`.replace(`{${"name"}}`, encodeURIComponent(String(requestParameters.name))),
            method: 'GET',
            headers: headerParameters,
            query: queryParameters,
        }, initOverrides);

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

    /**
     * Returns CWMS Lock Data
     * Get projects locks with name
     */
    async getProjectsLocksWithName(requestParameters: GetProjectsLocksWithNameRequest, initOverrides?: RequestInit): Promise<Array<Lock>> {
        const response = await this.getProjectsLocksWithNameRaw(requestParameters, initOverrides);
        return await response.value();
    }

    /**
     * Rename CWMS Lock
     * Patch projects locks with name
     */
    async patchProjectsLocksWithNameRaw(requestParameters: PatchProjectsLocksWithNameRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<void>> {
        if (requestParameters.name === null || requestParameters.name === undefined) {
            throw new runtime.RequiredError('name','Required parameter requestParameters.name was null or undefined when calling patchProjectsLocksWithName.');
        }

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

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

        const queryParameters: any = {};

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

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

        const headerParameters: runtime.HTTPHeaders = {};

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

        const response = await this.request({
            path: `/projects/locks/{name}`.replace(`{${"name"}}`, encodeURIComponent(String(requestParameters.name))),
            method: 'PATCH',
            headers: headerParameters,
            query: queryParameters,
        }, initOverrides);

        return new runtime.VoidApiResponse(response);
    }

    /**
     * Rename CWMS Lock
     * Patch projects locks with name
     */
    async patchProjectsLocksWithName(requestParameters: PatchProjectsLocksWithNameRequest, initOverrides?: RequestInit): Promise<void> {
        await this.patchProjectsLocksWithNameRaw(requestParameters, initOverrides);
    }

    /**
     * Create CWMS Lock
     * Post projects locks
     */
    async postProjectsLocksRaw(requestParameters: PostProjectsLocksRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<void>> {
        if (requestParameters.lock === null || requestParameters.lock === undefined) {
            throw new runtime.RequiredError('lock','Required parameter requestParameters.lock was null or undefined when calling postProjectsLocks.');
        }

        const queryParameters: any = {};

        if (requestParameters.failIfExists !== undefined) {
            queryParameters['fail-if-exists'] = requestParameters.failIfExists;
        }

        const headerParameters: runtime.HTTPHeaders = {};

        headerParameters['Content-Type'] = 'application/json;version=1';

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

        const response = await this.request({
            path: `/projects/locks`,
            method: 'POST',
            headers: headerParameters,
            query: queryParameters,
            body: LockToJSON(requestParameters.lock),
        }, initOverrides);

        return new runtime.VoidApiResponse(response);
    }

    /**
     * Create CWMS Lock
     * Post projects locks
     */
    async postProjectsLocks(requestParameters: PostProjectsLocksRequest, initOverrides?: RequestInit): Promise<void> {
        await this.postProjectsLocksRaw(requestParameters, initOverrides);
    }

}