/* 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 { ApiAutoPolicyWaiverExclusionRequestDTO, ApiAutoPolicyWaiverExclusionResponseDTO, } from '../models/index'; import { ApiAutoPolicyWaiverExclusionRequestDTOFromJSON, ApiAutoPolicyWaiverExclusionRequestDTOToJSON, ApiAutoPolicyWaiverExclusionResponseDTOFromJSON, ApiAutoPolicyWaiverExclusionResponseDTOToJSON, } from '../models/index'; export interface AutoPolicyWaiverExclusionsApiAddAutoPolicyWaiveExclusionRequest { ownerType: AddAutoPolicyWaiveExclusionOwnerTypeEnum; ownerId: string; apiAutoPolicyWaiverExclusionRequestDTO: ApiAutoPolicyWaiverExclusionRequestDTO; } export interface AutoPolicyWaiverExclusionsApiDeleteAutoPolicyWaiverExclusionRequest { ownerType: DeleteAutoPolicyWaiverExclusionOwnerTypeEnum; ownerId: string; autoPolicyWaiverId: string; autoPolicyWaiverExclusionId: string; } export interface AutoPolicyWaiverExclusionsApiGetAutoPolicyWaiverExclusionsRequest { ownerType: GetAutoPolicyWaiverExclusionsOwnerTypeEnum; ownerId: string; autoPolicyWaiverId: string; page?: number; pageSize?: number; } /** * AutoPolicyWaiverExclusionsApi - interface * * @export * @interface AutoPolicyWaiverExclusionsApiInterface */ export interface AutoPolicyWaiverExclusionsApiInterface { /** * Use this method to create an auto policy waiver exclusion for a specified auto policy waiver. Permissions required: Waive Policy Violations * @param {'application' | 'organization'} ownerType Enter the ownerType to specify which resource type owns the auto waiver you want to apply a exclusion to. Possible values are application, organization. * @param {string} ownerId Enter the corresponding id for the ownerType specified above. * @param {ApiAutoPolicyWaiverExclusionRequestDTO} apiAutoPolicyWaiverExclusionRequestDTO The request JSON can include the fields<ol><li>applicationPublicId</li><li>ownerId - ID of the application or organization which will own the auto waiver exclusion</li><li>policyViolationId - ID of the policy violation which the exclusion will apply to</li><li>autoPolicyWaiverId - ID of the auto waiver you want to apply a exclusion to</li><li>scanId - ID of the scan which the violation being waived appeared in</li><li>matchStrategy (enumeration, required) can have values EXACT_COMPONENT, ALL_VERSIONS, POLICY_VIOLATION. </li></ol> * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AutoPolicyWaiverExclusionsApiInterface */ addAutoPolicyWaiveExclusionRaw(requestParameters: AutoPolicyWaiverExclusionsApiAddAutoPolicyWaiveExclusionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Use this method to create an auto policy waiver exclusion for a specified auto policy waiver. Permissions required: Waive Policy Violations */ addAutoPolicyWaiveExclusion(requestParameters: AutoPolicyWaiverExclusionsApiAddAutoPolicyWaiveExclusionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Use this method to delete an auto policy waiver exclusion, specified by the autoPolicyWaiverExclusionId. Permissions required: Waive Policy Violations * @param {'application' | 'organization'} ownerType Enter the ownerType to specify the scope. A waiver exclusion corresponding to the autoPolicyWaiverExclusionId provided and within the scope specified will be deleted. * @param {string} ownerId Enter the corresponding id for the ownerType specified above. * @param {string} autoPolicyWaiverId Enter the relevant Auto Policy Waiver ID. * @param {string} autoPolicyWaiverExclusionId Enter the autoPolicyWaiverId to be deleted * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AutoPolicyWaiverExclusionsApiInterface */ deleteAutoPolicyWaiverExclusionRaw(requestParameters: AutoPolicyWaiverExclusionsApiDeleteAutoPolicyWaiverExclusionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Use this method to delete an auto policy waiver exclusion, specified by the autoPolicyWaiverExclusionId. Permissions required: Waive Policy Violations */ deleteAutoPolicyWaiverExclusion(requestParameters: AutoPolicyWaiverExclusionsApiDeleteAutoPolicyWaiverExclusionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Use this method to retrieve auto policy waiver exclusions for the given owner and policy waiver. Permissions required: View IQ Elements * @param {'application' | 'organization'} ownerType Enter the owner type. * @param {string} ownerId Enter the owner id. * @param {string} autoPolicyWaiverId Enter the id of the automatic policy waiver. * @param {number} [page] Enter the page. * @param {number} [pageSize] Enter the page size. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AutoPolicyWaiverExclusionsApiInterface */ getAutoPolicyWaiverExclusionsRaw(requestParameters: AutoPolicyWaiverExclusionsApiGetAutoPolicyWaiverExclusionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>>; /** * Use this method to retrieve auto policy waiver exclusions for the given owner and policy waiver. Permissions required: View IQ Elements */ getAutoPolicyWaiverExclusions(requestParameters: AutoPolicyWaiverExclusionsApiGetAutoPolicyWaiverExclusionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; } /** * */ export class AutoPolicyWaiverExclusionsApi extends runtime.BaseAPI implements AutoPolicyWaiverExclusionsApiInterface { /** * Use this method to create an auto policy waiver exclusion for a specified auto policy waiver. Permissions required: Waive Policy Violations */ async addAutoPolicyWaiveExclusionRaw(requestParameters: AutoPolicyWaiverExclusionsApiAddAutoPolicyWaiveExclusionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise> { if (requestParameters['ownerType'] == null) { throw new runtime.RequiredError( 'ownerType', 'Required parameter "ownerType" was null or undefined when calling addAutoPolicyWaiveExclusion().' ); } if (requestParameters['ownerId'] == null) { throw new runtime.RequiredError( 'ownerId', 'Required parameter "ownerId" was null or undefined when calling addAutoPolicyWaiveExclusion().' ); } if (requestParameters['apiAutoPolicyWaiverExclusionRequestDTO'] == null) { throw new runtime.RequiredError( 'apiAutoPolicyWaiverExclusionRequestDTO', 'Required parameter "apiAutoPolicyWaiverExclusionRequestDTO" was null or undefined when calling addAutoPolicyWaiveExclusion().' ); } 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/autoPolicyWaiverExclusions/{ownerType}/{ownerId}`; urlPath = urlPath.replace(`{${"ownerType"}}`, encodeURIComponent(String(requestParameters['ownerType']))); urlPath = urlPath.replace(`{${"ownerId"}}`, encodeURIComponent(String(requestParameters['ownerId']))); const response = await this.request({ path: urlPath, method: 'POST', headers: headerParameters, query: queryParameters, body: ApiAutoPolicyWaiverExclusionRequestDTOToJSON(requestParameters['apiAutoPolicyWaiverExclusionRequestDTO']), }, initOverrides); return new runtime.JSONApiResponse(response, (jsonValue) => ApiAutoPolicyWaiverExclusionResponseDTOFromJSON(jsonValue)); } /** * Use this method to create an auto policy waiver exclusion for a specified auto policy waiver. Permissions required: Waive Policy Violations */ async addAutoPolicyWaiveExclusion(requestParameters: AutoPolicyWaiverExclusionsApiAddAutoPolicyWaiveExclusionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise { const response = await this.addAutoPolicyWaiveExclusionRaw(requestParameters, initOverrides); return await response.value(); } /** * Use this method to delete an auto policy waiver exclusion, specified by the autoPolicyWaiverExclusionId. Permissions required: Waive Policy Violations */ async deleteAutoPolicyWaiverExclusionRaw(requestParameters: AutoPolicyWaiverExclusionsApiDeleteAutoPolicyWaiverExclusionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise> { if (requestParameters['ownerType'] == null) { throw new runtime.RequiredError( 'ownerType', 'Required parameter "ownerType" was null or undefined when calling deleteAutoPolicyWaiverExclusion().' ); } if (requestParameters['ownerId'] == null) { throw new runtime.RequiredError( 'ownerId', 'Required parameter "ownerId" was null or undefined when calling deleteAutoPolicyWaiverExclusion().' ); } if (requestParameters['autoPolicyWaiverId'] == null) { throw new runtime.RequiredError( 'autoPolicyWaiverId', 'Required parameter "autoPolicyWaiverId" was null or undefined when calling deleteAutoPolicyWaiverExclusion().' ); } if (requestParameters['autoPolicyWaiverExclusionId'] == null) { throw new runtime.RequiredError( 'autoPolicyWaiverExclusionId', 'Required parameter "autoPolicyWaiverExclusionId" was null or undefined when calling deleteAutoPolicyWaiverExclusion().' ); } 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/autoPolicyWaiverExclusions/{ownerType}/{ownerId}/{autoPolicyWaiverId}/{autoPolicyWaiverExclusionId}`; urlPath = urlPath.replace(`{${"ownerType"}}`, encodeURIComponent(String(requestParameters['ownerType']))); urlPath = urlPath.replace(`{${"ownerId"}}`, encodeURIComponent(String(requestParameters['ownerId']))); urlPath = urlPath.replace(`{${"autoPolicyWaiverId"}}`, encodeURIComponent(String(requestParameters['autoPolicyWaiverId']))); urlPath = urlPath.replace(`{${"autoPolicyWaiverExclusionId"}}`, encodeURIComponent(String(requestParameters['autoPolicyWaiverExclusionId']))); 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 auto policy waiver exclusion, specified by the autoPolicyWaiverExclusionId. Permissions required: Waive Policy Violations */ async deleteAutoPolicyWaiverExclusion(requestParameters: AutoPolicyWaiverExclusionsApiDeleteAutoPolicyWaiverExclusionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise { await this.deleteAutoPolicyWaiverExclusionRaw(requestParameters, initOverrides); } /** * Use this method to retrieve auto policy waiver exclusions for the given owner and policy waiver. Permissions required: View IQ Elements */ async getAutoPolicyWaiverExclusionsRaw(requestParameters: AutoPolicyWaiverExclusionsApiGetAutoPolicyWaiverExclusionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>> { if (requestParameters['ownerType'] == null) { throw new runtime.RequiredError( 'ownerType', 'Required parameter "ownerType" was null or undefined when calling getAutoPolicyWaiverExclusions().' ); } if (requestParameters['ownerId'] == null) { throw new runtime.RequiredError( 'ownerId', 'Required parameter "ownerId" was null or undefined when calling getAutoPolicyWaiverExclusions().' ); } if (requestParameters['autoPolicyWaiverId'] == null) { throw new runtime.RequiredError( 'autoPolicyWaiverId', 'Required parameter "autoPolicyWaiverId" was null or undefined when calling getAutoPolicyWaiverExclusions().' ); } const queryParameters: any = {}; if (requestParameters['page'] != null) { queryParameters['page'] = requestParameters['page']; } if (requestParameters['pageSize'] != null) { queryParameters['pageSize'] = requestParameters['pageSize']; } 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/autoPolicyWaiverExclusions/{ownerType}/{ownerId}/{autoPolicyWaiverId}`; urlPath = urlPath.replace(`{${"ownerType"}}`, encodeURIComponent(String(requestParameters['ownerType']))); urlPath = urlPath.replace(`{${"ownerId"}}`, encodeURIComponent(String(requestParameters['ownerId']))); urlPath = urlPath.replace(`{${"autoPolicyWaiverId"}}`, encodeURIComponent(String(requestParameters['autoPolicyWaiverId']))); const response = await this.request({ path: urlPath, method: 'GET', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(ApiAutoPolicyWaiverExclusionResponseDTOFromJSON)); } /** * Use this method to retrieve auto policy waiver exclusions for the given owner and policy waiver. Permissions required: View IQ Elements */ async getAutoPolicyWaiverExclusions(requestParameters: AutoPolicyWaiverExclusionsApiGetAutoPolicyWaiverExclusionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise> { const response = await this.getAutoPolicyWaiverExclusionsRaw(requestParameters, initOverrides); return await response.value(); } } /** * @export */ export const AddAutoPolicyWaiveExclusionOwnerTypeEnum = { Application: 'application', Organization: 'organization' } as const; export type AddAutoPolicyWaiveExclusionOwnerTypeEnum = typeof AddAutoPolicyWaiveExclusionOwnerTypeEnum[keyof typeof AddAutoPolicyWaiveExclusionOwnerTypeEnum]; /** * @export */ export const DeleteAutoPolicyWaiverExclusionOwnerTypeEnum = { Application: 'application', Organization: 'organization' } as const; export type DeleteAutoPolicyWaiverExclusionOwnerTypeEnum = typeof DeleteAutoPolicyWaiverExclusionOwnerTypeEnum[keyof typeof DeleteAutoPolicyWaiverExclusionOwnerTypeEnum]; /** * @export */ export const GetAutoPolicyWaiverExclusionsOwnerTypeEnum = { Application: 'application', Organization: 'organization' } as const; export type GetAutoPolicyWaiverExclusionsOwnerTypeEnum = typeof GetAutoPolicyWaiverExclusionsOwnerTypeEnum[keyof typeof GetAutoPolicyWaiverExclusionsOwnerTypeEnum];