/* 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 { DevelopmentPrioritizationResults, } from '../models/index'; import { DevelopmentPrioritizationResultsFromJSON, DevelopmentPrioritizationResultsToJSON, } from '../models/index'; export interface DeveloperPrioritiesApiGetPrioritiesRequest { applicationId: string; scanId: string; includeRemediation?: boolean; page?: number; pageSize?: number; componentNameFilter?: string; filterOnPolicyActions?: boolean; } export interface DeveloperPrioritiesApiGetPrioritiesExportRequest { applicationId: string; scanId: string; } /** * DeveloperPrioritiesApi - interface * * @export * @interface DeveloperPrioritiesApiInterface */ export interface DeveloperPrioritiesApiInterface { /** * Use this method to retrieve all priorities by providing the application ID and scan ID. Permissions required: View IQ Elements * @param {string} applicationId Enter the applicationId. * @param {string} scanId Enter the scanId. * @param {boolean} [includeRemediation] Whether to include remediation type and version for the component or not * @param {number} [page] Current page number. * @param {number} [pageSize] Enter the no. of results that should be visible per page. * @param {string} [componentNameFilter] Component name to filter by * @param {boolean} [filterOnPolicyActions] Whether to enable Fail/Warn policy action filter or not * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DeveloperPrioritiesApiInterface */ getPrioritiesRaw(requestParameters: DeveloperPrioritiesApiGetPrioritiesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Use this method to retrieve all priorities by providing the application ID and scan ID. Permissions required: View IQ Elements */ getPriorities(requestParameters: DeveloperPrioritiesApiGetPrioritiesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Use this method to retrieve the priorities, by providing the applicationId and scanId. Permissions required: View IQ Elements * @param {string} applicationId Enter the applicationId. * @param {string} scanId Enter the scanId. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DeveloperPrioritiesApiInterface */ getPrioritiesExportRaw(requestParameters: DeveloperPrioritiesApiGetPrioritiesExportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Use this method to retrieve the priorities, by providing the applicationId and scanId. Permissions required: View IQ Elements */ getPrioritiesExport(requestParameters: DeveloperPrioritiesApiGetPrioritiesExportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; } /** * */ export class DeveloperPrioritiesApi extends runtime.BaseAPI implements DeveloperPrioritiesApiInterface { /** * Use this method to retrieve all priorities by providing the application ID and scan ID. Permissions required: View IQ Elements */ async getPrioritiesRaw(requestParameters: DeveloperPrioritiesApiGetPrioritiesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise> { if (requestParameters['applicationId'] == null) { throw new runtime.RequiredError( 'applicationId', 'Required parameter "applicationId" was null or undefined when calling getPriorities().' ); } if (requestParameters['scanId'] == null) { throw new runtime.RequiredError( 'scanId', 'Required parameter "scanId" was null or undefined when calling getPriorities().' ); } const queryParameters: any = {}; if (requestParameters['includeRemediation'] != null) { queryParameters['includeRemediation'] = requestParameters['includeRemediation']; } if (requestParameters['page'] != null) { queryParameters['page'] = requestParameters['page']; } if (requestParameters['pageSize'] != null) { queryParameters['pageSize'] = requestParameters['pageSize']; } if (requestParameters['componentNameFilter'] != null) { queryParameters['componentNameFilter'] = requestParameters['componentNameFilter']; } if (requestParameters['filterOnPolicyActions'] != null) { queryParameters['filterOnPolicyActions'] = requestParameters['filterOnPolicyActions']; } 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/developer/priorities/{applicationId}/{scanId}`; urlPath = urlPath.replace(`{${"applicationId"}}`, encodeURIComponent(String(requestParameters['applicationId']))); urlPath = urlPath.replace(`{${"scanId"}}`, encodeURIComponent(String(requestParameters['scanId']))); const response = await this.request({ path: urlPath, method: 'GET', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.JSONApiResponse(response, (jsonValue) => DevelopmentPrioritizationResultsFromJSON(jsonValue)); } /** * Use this method to retrieve all priorities by providing the application ID and scan ID. Permissions required: View IQ Elements */ async getPriorities(requestParameters: DeveloperPrioritiesApiGetPrioritiesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise { const response = await this.getPrioritiesRaw(requestParameters, initOverrides); return await response.value(); } /** * Use this method to retrieve the priorities, by providing the applicationId and scanId. Permissions required: View IQ Elements */ async getPrioritiesExportRaw(requestParameters: DeveloperPrioritiesApiGetPrioritiesExportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise> { if (requestParameters['applicationId'] == null) { throw new runtime.RequiredError( 'applicationId', 'Required parameter "applicationId" was null or undefined when calling getPrioritiesExport().' ); } if (requestParameters['scanId'] == null) { throw new runtime.RequiredError( 'scanId', 'Required parameter "scanId" was null or undefined when calling getPrioritiesExport().' ); } 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/developer/priorities/{applicationId}/{scanId}/export`; urlPath = urlPath.replace(`{${"applicationId"}}`, encodeURIComponent(String(requestParameters['applicationId']))); urlPath = urlPath.replace(`{${"scanId"}}`, encodeURIComponent(String(requestParameters['scanId']))); const response = await this.request({ path: urlPath, method: 'GET', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.VoidApiResponse(response); } /** * Use this method to retrieve the priorities, by providing the applicationId and scanId. Permissions required: View IQ Elements */ async getPrioritiesExport(requestParameters: DeveloperPrioritiesApiGetPrioritiesExportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise { await this.getPrioritiesExportRaw(requestParameters, initOverrides); } }