cwmsjs/src/apis/UserManagementApi.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,
    User,
    UserFromJSON,
    UserToJSON,
    Users,
    UsersFromJSON,
    UsersToJSON,
} from '../models';

export interface DeleteUserWithUserNameRolesWithOfficeIdRequest {
    userName: string;
    officeId: string;
    requestBody?: Array<string>;
}

export interface GetUsersRequest {
    office?: string;
    page?: string;
    pageSize?: number;
}

export interface GetUsersWithUserNameRequest {
    userName: string;
}

export interface PostUserWithUserNameRolesWithOfficeIdRequest {
    userName: string;
    officeId: string;
    requestBody?: Array<string>;
}

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

    /**
     * Remove roles from user
     * Delete user with userName roles with officeId
     */
    async deleteUserWithUserNameRolesWithOfficeIdRaw(requestParameters: DeleteUserWithUserNameRolesWithOfficeIdRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<void>> {
        if (requestParameters.userName === null || requestParameters.userName === undefined) {
            throw new runtime.RequiredError('userName','Required parameter requestParameters.userName was null or undefined when calling deleteUserWithUserNameRolesWithOfficeId.');
        }

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

        const queryParameters: any = {};

        const headerParameters: runtime.HTTPHeaders = {};

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

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

        const response = await this.request({
            path: `/user/{user-name}/roles/{office-id}`.replace(`{${"user-name"}}`, encodeURIComponent(String(requestParameters.userName))).replace(`{${"office-id"}}`, encodeURIComponent(String(requestParameters.officeId))),
            method: 'DELETE',
            headers: headerParameters,
            query: queryParameters,
            body: requestParameters.requestBody,
        }, initOverrides);

        return new runtime.VoidApiResponse(response);
    }

    /**
     * Remove roles from user
     * Delete user with userName roles with officeId
     */
    async deleteUserWithUserNameRolesWithOfficeId(requestParameters: DeleteUserWithUserNameRolesWithOfficeIdRequest, initOverrides?: RequestInit): Promise<void> {
        await this.deleteUserWithUserNameRolesWithOfficeIdRaw(requestParameters, initOverrides);
    }

    /**
     * View all roles
     * Get roles
     */
    async getRolesRaw(initOverrides?: RequestInit): Promise<runtime.ApiResponse<Array<string>>> {
        const queryParameters: any = {};

        const headerParameters: runtime.HTTPHeaders = {};

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

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

        return new runtime.JSONApiResponse<any>(response);
    }

    /**
     * View all roles
     * Get roles
     */
    async getRoles(initOverrides?: RequestInit): Promise<Array<string>> {
        const response = await this.getRolesRaw(initOverrides);
        return await response.value();
    }

    /**
     * View users\' own information
     * Get user profile
     */
    async getUserProfileRaw(initOverrides?: RequestInit): Promise<runtime.ApiResponse<User>> {
        const queryParameters: any = {};

        const headerParameters: runtime.HTTPHeaders = {};

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

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

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

    /**
     * View users\' own information
     * Get user profile
     */
    async getUserProfile(initOverrides?: RequestInit): Promise<User> {
        const response = await this.getUserProfileRaw(initOverrides);
        return await response.value();
    }

    /**
     * View all users
     * Get users
     */
    async getUsersRaw(requestParameters: GetUsersRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<Users>> {
        const queryParameters: any = {};

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

        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: `/users`,
            method: 'GET',
            headers: headerParameters,
            query: queryParameters,
        }, initOverrides);

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

    /**
     * View all users
     * Get users
     */
    async getUsers(requestParameters: GetUsersRequest = {}, initOverrides?: RequestInit): Promise<Users> {
        const response = await this.getUsersRaw(requestParameters, initOverrides);
        return await response.value();
    }

    /**
     * View specific user
     * Get users with userName
     */
    async getUsersWithUserNameRaw(requestParameters: GetUsersWithUserNameRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<User>> {
        if (requestParameters.userName === null || requestParameters.userName === undefined) {
            throw new runtime.RequiredError('userName','Required parameter requestParameters.userName was null or undefined when calling getUsersWithUserName.');
        }

        const queryParameters: any = {};

        const headerParameters: runtime.HTTPHeaders = {};

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

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

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

    /**
     * View specific user
     * Get users with userName
     */
    async getUsersWithUserName(requestParameters: GetUsersWithUserNameRequest, initOverrides?: RequestInit): Promise<User> {
        const response = await this.getUsersWithUserNameRaw(requestParameters, initOverrides);
        return await response.value();
    }

    /**
     * Add roles to user
     * Post user with userName roles with officeId
     */
    async postUserWithUserNameRolesWithOfficeIdRaw(requestParameters: PostUserWithUserNameRolesWithOfficeIdRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<void>> {
        if (requestParameters.userName === null || requestParameters.userName === undefined) {
            throw new runtime.RequiredError('userName','Required parameter requestParameters.userName was null or undefined when calling postUserWithUserNameRolesWithOfficeId.');
        }

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

        const queryParameters: any = {};

        const headerParameters: runtime.HTTPHeaders = {};

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

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

        const response = await this.request({
            path: `/user/{user-name}/roles/{office-id}`.replace(`{${"user-name"}}`, encodeURIComponent(String(requestParameters.userName))).replace(`{${"office-id"}}`, encodeURIComponent(String(requestParameters.officeId))),
            method: 'POST',
            headers: headerParameters,
            query: queryParameters,
            body: requestParameters.requestBody,
        }, initOverrides);

        return new runtime.VoidApiResponse(response);
    }

    /**
     * Add roles to user
     * Post user with userName roles with officeId
     */
    async postUserWithUserNameRolesWithOfficeId(requestParameters: PostUserWithUserNameRolesWithOfficeIdRequest, initOverrides?: RequestInit): Promise<void> {
        await this.postUserWithUserNameRolesWithOfficeIdRaw(requestParameters, initOverrides);
    }

}