/* 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 { ApiRoleDTO, ApiRoleListDTO, } from '../models/index'; import { ApiRoleDTOFromJSON, ApiRoleDTOToJSON, ApiRoleListDTOFromJSON, ApiRoleListDTOToJSON, } from '../models/index'; export interface RolesApiAddRoleRequest { apiRoleDTO?: ApiRoleDTO; } export interface RolesApiDeleteRoleRequest { roleId: string; } export interface RolesApiGetRoleByIdRequest { roleId: string; } export interface RolesApiUpdateRoleRequest { roleId: string; apiRoleDTO?: ApiRoleDTO; } /** * RolesApi - interface * * @export * @interface RolesApiInterface */ export interface RolesApiInterface { /** * Use this method to create a new custom role with specified permissions. Permissions required: Edit Roles * @param {ApiRoleDTO} [apiRoleDTO] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof RolesApiInterface */ addRoleRaw(requestParameters: RolesApiAddRoleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Use this method to create a new custom role with specified permissions. Permissions required: Edit Roles */ addRole(requestParameters: RolesApiAddRoleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Use this method to delete a custom role. Permissions required: Edit Roles * @param {string} roleId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof RolesApiInterface */ deleteRoleRaw(requestParameters: RolesApiDeleteRoleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Use this method to delete a custom role. Permissions required: Edit Roles */ deleteRole(requestParameters: RolesApiDeleteRoleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Use this method to retrieve details for a specific role, including its permissions. Permissions required: View All Roles * @param {string} roleId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof RolesApiInterface */ getRoleByIdRaw(requestParameters: RolesApiGetRoleByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Use this method to retrieve details for a specific role, including its permissions. Permissions required: View All Roles */ getRoleById(requestParameters: RolesApiGetRoleByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Use this method to view the role IDs, role names and descriptions. Permissions required: View All Roles * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof RolesApiInterface */ getRolesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Use this method to view the role IDs, role names and descriptions. Permissions required: View All Roles */ getRoles(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Use this method to retrieve a template for creating a new custom role, including all available permissions that can be assigned. Permissions required: Edit Roles * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof RolesApiInterface */ getTemplateForNewRoleRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Use this method to retrieve a template for creating a new custom role, including all available permissions that can be assigned. Permissions required: Edit Roles */ getTemplateForNewRole(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Use this method to update an existing custom role and its permissions. Permissions required: Edit Roles * @param {string} roleId * @param {ApiRoleDTO} [apiRoleDTO] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof RolesApiInterface */ updateRoleRaw(requestParameters: RolesApiUpdateRoleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Use this method to update an existing custom role and its permissions. Permissions required: Edit Roles */ updateRole(requestParameters: RolesApiUpdateRoleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; } /** * */ export class RolesApi extends runtime.BaseAPI implements RolesApiInterface { /** * Use this method to create a new custom role with specified permissions. Permissions required: Edit Roles */ async addRoleRaw(requestParameters: RolesApiAddRoleRequest, 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/roles`; const response = await this.request({ path: urlPath, method: 'POST', headers: headerParameters, query: queryParameters, body: ApiRoleDTOToJSON(requestParameters['apiRoleDTO']), }, initOverrides); return new runtime.JSONApiResponse(response, (jsonValue) => ApiRoleDTOFromJSON(jsonValue)); } /** * Use this method to create a new custom role with specified permissions. Permissions required: Edit Roles */ async addRole(requestParameters: RolesApiAddRoleRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise { const response = await this.addRoleRaw(requestParameters, initOverrides); return await response.value(); } /** * Use this method to delete a custom role. Permissions required: Edit Roles */ async deleteRoleRaw(requestParameters: RolesApiDeleteRoleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise> { if (requestParameters['roleId'] == null) { throw new runtime.RequiredError( 'roleId', 'Required parameter "roleId" was null or undefined when calling deleteRole().' ); } const queryParameters: any = {}; 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/roles/{roleId}`; urlPath = urlPath.replace(`{${"roleId"}}`, encodeURIComponent(String(requestParameters['roleId']))); const response = await this.request({ path: urlPath, method: 'DELETE', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.VoidApiResponse(response); } /** * Use this method to delete a custom role. Permissions required: Edit Roles */ async deleteRole(requestParameters: RolesApiDeleteRoleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise { await this.deleteRoleRaw(requestParameters, initOverrides); } /** * Use this method to retrieve details for a specific role, including its permissions. Permissions required: View All Roles */ async getRoleByIdRaw(requestParameters: RolesApiGetRoleByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise> { if (requestParameters['roleId'] == null) { throw new runtime.RequiredError( 'roleId', 'Required parameter "roleId" was null or undefined when calling getRoleById().' ); } const queryParameters: any = {}; 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/roles/{roleId}`; urlPath = urlPath.replace(`{${"roleId"}}`, encodeURIComponent(String(requestParameters['roleId']))); const response = await this.request({ path: urlPath, method: 'GET', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.JSONApiResponse(response, (jsonValue) => ApiRoleDTOFromJSON(jsonValue)); } /** * Use this method to retrieve details for a specific role, including its permissions. Permissions required: View All Roles */ async getRoleById(requestParameters: RolesApiGetRoleByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise { const response = await this.getRoleByIdRaw(requestParameters, initOverrides); return await response.value(); } /** * Use this method to view the role IDs, role names and descriptions. Permissions required: View All Roles */ async getRolesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise> { const queryParameters: any = {}; 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/roles`; const response = await this.request({ path: urlPath, method: 'GET', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.JSONApiResponse(response, (jsonValue) => ApiRoleListDTOFromJSON(jsonValue)); } /** * Use this method to view the role IDs, role names and descriptions. Permissions required: View All Roles */ async getRoles(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise { const response = await this.getRolesRaw(initOverrides); return await response.value(); } /** * Use this method to retrieve a template for creating a new custom role, including all available permissions that can be assigned. Permissions required: Edit Roles */ async getTemplateForNewRoleRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise> { const queryParameters: any = {}; 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/roles/new`; const response = await this.request({ path: urlPath, method: 'GET', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.JSONApiResponse(response, (jsonValue) => ApiRoleDTOFromJSON(jsonValue)); } /** * Use this method to retrieve a template for creating a new custom role, including all available permissions that can be assigned. Permissions required: Edit Roles */ async getTemplateForNewRole(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise { const response = await this.getTemplateForNewRoleRaw(initOverrides); return await response.value(); } /** * Use this method to update an existing custom role and its permissions. Permissions required: Edit Roles */ async updateRoleRaw(requestParameters: RolesApiUpdateRoleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise> { if (requestParameters['roleId'] == null) { throw new runtime.RequiredError( 'roleId', 'Required parameter "roleId" was null or undefined when calling updateRole().' ); } 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/roles/{roleId}`; urlPath = urlPath.replace(`{${"roleId"}}`, encodeURIComponent(String(requestParameters['roleId']))); const response = await this.request({ path: urlPath, method: 'PUT', headers: headerParameters, query: queryParameters, body: ApiRoleDTOToJSON(requestParameters['apiRoleDTO']), }, initOverrides); return new runtime.JSONApiResponse(response, (jsonValue) => ApiRoleDTOFromJSON(jsonValue)); } /** * Use this method to update an existing custom role and its permissions. Permissions required: Edit Roles */ async updateRole(requestParameters: RolesApiUpdateRoleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise { const response = await this.updateRoleRaw(requestParameters, initOverrides); return await response.value(); } }