/* tslint:disable */ /* eslint-disable */ /** * Sonatype Lifecycle Public REST API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 1.207.0-01 * * * 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 type { ApiUserDTO, ApiUserListDTO, } from '../models/index'; import { ApiUserDTOFromJSON, ApiUserDTOToJSON, ApiUserListDTOFromJSON, ApiUserListDTOToJSON, } from '../models/index'; export interface UsersApiAddRequest { apiUserDTO?: ApiUserDTO; } export interface UsersApiDelete1Request { username: string; realm?: string; } export interface UsersApiGet1Request { username: string; realm?: string; } export interface UsersApiGetAll2Request { realm?: string; } export interface UsersApiUpdateRequest { username: string; apiUserDTO?: ApiUserDTO; } /** * UsersApi - interface * * @export * @interface UsersApiInterface */ export interface UsersApiInterface { /** * Use this method to create a new user. Permissions required: Edit System Configuration and Users * @param {ApiUserDTO} [apiUserDTO] Specify the user details for the new user to be created. All fields except `realm` are required. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersApiInterface */ addRaw(requestParameters: UsersApiAddRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Use this method to create a new user. Permissions required: Edit System Configuration and Users */ add(requestParameters: UsersApiAddRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Use this method to delete an existing user. Permissions required: Edit System Configuration and Users * @param {string} username Enter the username to be deleted. * @param {string} [realm] Enter the `realm`. Allowed values are `Internal`,`OAUTH2`, and `SAML`. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersApiInterface */ delete1Raw(requestParameters: UsersApiDelete1Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Use this method to delete an existing user. Permissions required: Edit System Configuration and Users */ delete1(requestParameters: UsersApiDelete1Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Use this method to retrieve user details for the specified user. Permissions required: Edit System Configuration and Users * @param {string} username Enter the username. * @param {string} [realm] Enter the `realm`. Allowed values are `Internal`,`OAUTH2`, and `SAML`. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersApiInterface */ get1Raw(requestParameters: UsersApiGet1Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Use this method to retrieve user details for the specified user. Permissions required: Edit System Configuration and Users */ get1(requestParameters: UsersApiGet1Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Use this method to retrieve user details for all users. Permissions required: Edit System Configuration and Users * @param {string} [realm] Enter the `realm`. Allowed values are `Internal`,`OAUTH2`, and `SAML`. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersApiInterface */ getAll2Raw(requestParameters: UsersApiGetAll2Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Use this method to retrieve user details for all users. Permissions required: Edit System Configuration and Users */ getAll2(requestParameters: UsersApiGetAll2Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Use this method to update user details for an existing internal user, by specifying the username. Permissions required: Edit System Configuration and Users * @param {string} username Enter the username. * @param {ApiUserDTO} [apiUserDTO] Specify the user details to be updated. Any unspecified field will remain unchanged. Username, password, and realm cannot be updated. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersApiInterface */ updateRaw(requestParameters: UsersApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Use this method to update user details for an existing internal user, by specifying the username. Permissions required: Edit System Configuration and Users */ update(requestParameters: UsersApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; } /** * */ export class UsersApi extends runtime.BaseAPI implements UsersApiInterface { /** * Use this method to create a new user. Permissions required: Edit System Configuration and Users */ async addRaw(requestParameters: UsersApiAddRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise> { const queryParameters: any = {}; const headerParameters: runtime.HTTPHeaders = {}; headerParameters['Content-Type'] = 'application/json'; if (this.configuration && (this.configuration.username !== undefined || this.configuration.password !== undefined)) { headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password); } if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = await token("BearerAuth", []); if (tokenString) { headerParameters["Authorization"] = `Bearer ${tokenString}`; } } let urlPath = `/api/v2/users`; const response = await this.request({ path: urlPath, method: 'POST', headers: headerParameters, query: queryParameters, body: ApiUserDTOToJSON(requestParameters['apiUserDTO']), }, initOverrides); return new runtime.VoidApiResponse(response); } /** * Use this method to create a new user. Permissions required: Edit System Configuration and Users */ async add(requestParameters: UsersApiAddRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise { await this.addRaw(requestParameters, initOverrides); } /** * Use this method to delete an existing user. Permissions required: Edit System Configuration and Users */ async delete1Raw(requestParameters: UsersApiDelete1Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise> { if (requestParameters['username'] == null) { throw new runtime.RequiredError( 'username', 'Required parameter "username" was null or undefined when calling delete1().' ); } const queryParameters: any = {}; if (requestParameters['realm'] != null) { queryParameters['realm'] = requestParameters['realm']; } const headerParameters: runtime.HTTPHeaders = {}; if (this.configuration && (this.configuration.username !== undefined || this.configuration.password !== undefined)) { headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password); } if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = await token("BearerAuth", []); if (tokenString) { headerParameters["Authorization"] = `Bearer ${tokenString}`; } } let urlPath = `/api/v2/users/{username}`; urlPath = urlPath.replace(`{${"username"}}`, encodeURIComponent(String(requestParameters['username']))); const response = await this.request({ path: urlPath, method: 'DELETE', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.VoidApiResponse(response); } /** * Use this method to delete an existing user. Permissions required: Edit System Configuration and Users */ async delete1(requestParameters: UsersApiDelete1Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise { await this.delete1Raw(requestParameters, initOverrides); } /** * Use this method to retrieve user details for the specified user. Permissions required: Edit System Configuration and Users */ async get1Raw(requestParameters: UsersApiGet1Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise> { if (requestParameters['username'] == null) { throw new runtime.RequiredError( 'username', 'Required parameter "username" was null or undefined when calling get1().' ); } const queryParameters: any = {}; if (requestParameters['realm'] != null) { queryParameters['realm'] = requestParameters['realm']; } const headerParameters: runtime.HTTPHeaders = {}; if (this.configuration && (this.configuration.username !== undefined || this.configuration.password !== undefined)) { headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password); } if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = await token("BearerAuth", []); if (tokenString) { headerParameters["Authorization"] = `Bearer ${tokenString}`; } } let urlPath = `/api/v2/users/{username}`; urlPath = urlPath.replace(`{${"username"}}`, encodeURIComponent(String(requestParameters['username']))); const response = await this.request({ path: urlPath, method: 'GET', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.JSONApiResponse(response, (jsonValue) => ApiUserDTOFromJSON(jsonValue)); } /** * Use this method to retrieve user details for the specified user. Permissions required: Edit System Configuration and Users */ async get1(requestParameters: UsersApiGet1Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise { const response = await this.get1Raw(requestParameters, initOverrides); return await response.value(); } /** * Use this method to retrieve user details for all users. Permissions required: Edit System Configuration and Users */ async getAll2Raw(requestParameters: UsersApiGetAll2Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise> { const queryParameters: any = {}; if (requestParameters['realm'] != null) { queryParameters['realm'] = requestParameters['realm']; } const headerParameters: runtime.HTTPHeaders = {}; if (this.configuration && (this.configuration.username !== undefined || this.configuration.password !== undefined)) { headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password); } if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = await token("BearerAuth", []); if (tokenString) { headerParameters["Authorization"] = `Bearer ${tokenString}`; } } let urlPath = `/api/v2/users`; const response = await this.request({ path: urlPath, method: 'GET', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.JSONApiResponse(response, (jsonValue) => ApiUserListDTOFromJSON(jsonValue)); } /** * Use this method to retrieve user details for all users. Permissions required: Edit System Configuration and Users */ async getAll2(requestParameters: UsersApiGetAll2Request = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise { const response = await this.getAll2Raw(requestParameters, initOverrides); return await response.value(); } /** * Use this method to update user details for an existing internal user, by specifying the username. Permissions required: Edit System Configuration and Users */ async updateRaw(requestParameters: UsersApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise> { if (requestParameters['username'] == null) { throw new runtime.RequiredError( 'username', 'Required parameter "username" was null or undefined when calling update().' ); } const queryParameters: any = {}; const headerParameters: runtime.HTTPHeaders = {}; headerParameters['Content-Type'] = 'application/json'; if (this.configuration && (this.configuration.username !== undefined || this.configuration.password !== undefined)) { headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password); } if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = await token("BearerAuth", []); if (tokenString) { headerParameters["Authorization"] = `Bearer ${tokenString}`; } } let urlPath = `/api/v2/users/{username}`; urlPath = urlPath.replace(`{${"username"}}`, encodeURIComponent(String(requestParameters['username']))); const response = await this.request({ path: urlPath, method: 'PUT', headers: headerParameters, query: queryParameters, body: ApiUserDTOToJSON(requestParameters['apiUserDTO']), }, initOverrides); return new runtime.JSONApiResponse(response, (jsonValue) => ApiUserDTOFromJSON(jsonValue)); } /** * Use this method to update user details for an existing internal user, by specifying the username. Permissions required: Edit System Configuration and Users */ async update(requestParameters: UsersApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise { const response = await this.updateRaw(requestParameters, initOverrides); return await response.value(); } }