cwmsjs/src/apis/EntityApi.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,
    Entity,
    EntityFromJSON,
    EntityToJSON,
} from '../models';

export interface DeleteEntityWithEntityIdRequest {
    entityId: string;
    office: string;
    cascadeDelete: boolean;
}

export interface GetEntityRequest {
    office?: string;
    entityId?: string;
    parentEntityId?: string;
    categoryId?: string;
    longName?: string;
    matchNullParents?: boolean;
}

export interface GetEntityWithEntityIdRequest {
    entityId: string;
    office: string;
}

export interface PatchEntityWithEntityIdRequest {
    entityId: string;
    entity: Entity;
}

export interface PostEntityRequest {
    entity: Entity;
}

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

    /**
     * Delete CWMS Entity.
     * Delete entity with entityId
     */
    async deleteEntityWithEntityIdRaw(requestParameters: DeleteEntityWithEntityIdRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<void>> {
        if (requestParameters.entityId === null || requestParameters.entityId === undefined) {
            throw new runtime.RequiredError('entityId','Required parameter requestParameters.entityId was null or undefined when calling deleteEntityWithEntityId.');
        }

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

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

        const queryParameters: any = {};

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

        if (requestParameters.cascadeDelete !== undefined) {
            queryParameters['cascade-delete'] = requestParameters.cascadeDelete;
        }

        const headerParameters: runtime.HTTPHeaders = {};

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

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

        return new runtime.VoidApiResponse(response);
    }

    /**
     * Delete CWMS Entity.
     * Delete entity with entityId
     */
    async deleteEntityWithEntityId(requestParameters: DeleteEntityWithEntityIdRequest, initOverrides?: RequestInit): Promise<void> {
        await this.deleteEntityWithEntityIdRaw(requestParameters, initOverrides);
    }

    /**
     * Returns all CWMS Entity Data filtered by optional masks.
     * Get entity
     */
    async getEntityRaw(requestParameters: GetEntityRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<Array<Entity>>> {
        const queryParameters: any = {};

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

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

        if (requestParameters.parentEntityId !== undefined) {
            queryParameters['parent-entity-id'] = requestParameters.parentEntityId;
        }

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

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

        if (requestParameters.matchNullParents !== undefined) {
            queryParameters['match-null-parents'] = requestParameters.matchNullParents;
        }

        const headerParameters: runtime.HTTPHeaders = {};

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

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

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

    /**
     * Returns all CWMS Entity Data filtered by optional masks.
     * Get entity
     */
    async getEntity(requestParameters: GetEntityRequest = {}, initOverrides?: RequestInit): Promise<Array<Entity>> {
        const response = await this.getEntityRaw(requestParameters, initOverrides);
        return await response.value();
    }

    /**
     * Returns CWMS Entity data by entity id and office id.
     * Get entity with entityId
     */
    async getEntityWithEntityIdRaw(requestParameters: GetEntityWithEntityIdRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<Entity>> {
        if (requestParameters.entityId === null || requestParameters.entityId === undefined) {
            throw new runtime.RequiredError('entityId','Required parameter requestParameters.entityId was null or undefined when calling getEntityWithEntityId.');
        }

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

        const queryParameters: any = {};

        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: `/entity/{entity-id}`.replace(`{${"entity-id"}}`, encodeURIComponent(String(requestParameters.entityId))),
            method: 'GET',
            headers: headerParameters,
            query: queryParameters,
        }, initOverrides);

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

    /**
     * Returns CWMS Entity data by entity id and office id.
     * Get entity with entityId
     */
    async getEntityWithEntityId(requestParameters: GetEntityWithEntityIdRequest, initOverrides?: RequestInit): Promise<Entity> {
        const response = await this.getEntityWithEntityIdRaw(requestParameters, initOverrides);
        return await response.value();
    }

    /**
     * Update an existing Entity.
     * Patch entity with entityId
     */
    async patchEntityWithEntityIdRaw(requestParameters: PatchEntityWithEntityIdRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<void>> {
        if (requestParameters.entityId === null || requestParameters.entityId === undefined) {
            throw new runtime.RequiredError('entityId','Required parameter requestParameters.entityId was null or undefined when calling patchEntityWithEntityId.');
        }

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

        const queryParameters: any = {};

        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: `/entity/{entity-id}`.replace(`{${"entity-id"}}`, encodeURIComponent(String(requestParameters.entityId))),
            method: 'PATCH',
            headers: headerParameters,
            query: queryParameters,
            body: EntityToJSON(requestParameters.entity),
        }, initOverrides);

        return new runtime.VoidApiResponse(response);
    }

    /**
     * Update an existing Entity.
     * Patch entity with entityId
     */
    async patchEntityWithEntityId(requestParameters: PatchEntityWithEntityIdRequest, initOverrides?: RequestInit): Promise<void> {
        await this.patchEntityWithEntityIdRaw(requestParameters, initOverrides);
    }

    /**
     * Create CWMS Entity
     * Post entity
     */
    async postEntityRaw(requestParameters: PostEntityRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<void>> {
        if (requestParameters.entity === null || requestParameters.entity === undefined) {
            throw new runtime.RequiredError('entity','Required parameter requestParameters.entity was null or undefined when calling postEntity.');
        }

        const queryParameters: any = {};

        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: `/entity`,
            method: 'POST',
            headers: headerParameters,
            query: queryParameters,
            body: EntityToJSON(requestParameters.entity),
        }, initOverrides);

        return new runtime.VoidApiResponse(response);
    }

    /**
     * Create CWMS Entity
     * Post entity
     */
    async postEntity(requestParameters: PostEntityRequest, initOverrides?: RequestInit): Promise<void> {
        await this.postEntityRaw(requestParameters, initOverrides);
    }

}