@sonatype/nexus-iq-api-client 0.174.0 → 0.176.0

package/src/apis/{EvaluationApi.ts → PolicyEvaluationApi.ts}

@@ -4,7 +4,7 @@
  * 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.174.0-01
+ * The version of the OpenAPI document: 1.176.0-01
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -40,7 +40,7 @@ import {
     ApiSourceControlEvaluationRequestDTOToJSON,
 } from '../models/index';
 
-export interface EvaluateComponents1Request {
+export interface EvaluateComponentsRequest {
     applicationId: string;
     apiComponentEvaluationRequestDTOV2?: ApiComponentEvaluationRequestDTOV2;
 }
@@ -66,79 +66,84 @@ export interface PromoteScanRequest {
 }
 
 /**
- * EvaluationApi - interface
+ * PolicyEvaluationApi - interface
  * 
  * @export
- * @interface EvaluationApiInterface
+ * @interface PolicyEvaluationApiInterface
  */
-export interface EvaluationApiInterface {
+export interface PolicyEvaluationApiInterface {
     /**
-     * 
-     * @param {string} applicationId 
-     * @param {ApiComponentEvaluationRequestDTOV2} [apiComponentEvaluationRequestDTOV2] 
+     * Use this method to request a component evaluation. This is step 1 of the 2 step policy evaluation for components process.  Permissions Required: Evaluate Components
+     * @param {string} applicationId Enter the internal applicationId. Use the Applications REST API to retrieve the internal applicationId.
+     * @param {ApiComponentEvaluationRequestDTOV2} [apiComponentEvaluationRequestDTOV2] The request JSON should contain component coordinates or the hash (SHA1) for each component. You can provide the packageURL instead of component information or hash.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof EvaluationApiInterface
+     * @memberof PolicyEvaluationApiInterface
      */
-    evaluateComponents1Raw(requestParameters: EvaluateComponents1Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiComponentEvaluationTicketDTOV2>>;
+    evaluateComponentsRaw(requestParameters: EvaluateComponentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiComponentEvaluationTicketDTOV2>>;
 
     /**
+     * Use this method to request a component evaluation. This is step 1 of the 2 step policy evaluation for components process.  Permissions Required: Evaluate Components
      */
-    evaluateComponents1(requestParameters: EvaluateComponents1Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiComponentEvaluationTicketDTOV2>;
+    evaluateComponents(requestParameters: EvaluateComponentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiComponentEvaluationTicketDTOV2>;
 
     /**
-     * 
-     * @param {string} applicationId 
-     * @param {ApiSourceControlEvaluationRequestDTO} [apiSourceControlEvaluationRequestDTO] 
+     * Use this method to request a source control evaluation for a specific application. This is step 1 of the 2 step source control evaluation process.   Permissions Required: Evaluate Applications
+     * @param {string} applicationId Enter the internal applicationId. Use the Applications REST API to retrieve the internal applicationId.
+     * @param {ApiSourceControlEvaluationRequestDTO} [apiSourceControlEvaluationRequestDTO] The request JSON should include the 1. branch name (name of the target branch in the source control repository, 2. stageId (recommended values are \&#39;develop\&#39; for feature branches, and \&#39;source\&#39; for default branches. Other stageIds that can be used are \&#39;build\&#39;, \&#39;stage-release\&#39;, \&#39;release\&#39;, \&#39;operate\&#39; but are not recommended), 3. scanTargets (optional, specify one or more paths inside the repository. If not specified, the entire repository will be evaluated by default). Ensure that the repository paths are not relative and do not contain \&#39;../\&#39; or \&#39;..\\\&#39;.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof EvaluationApiInterface
+     * @memberof PolicyEvaluationApiInterface
      */
     evaluateSourceControlRaw(requestParameters: EvaluateSourceControlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiApplicationEvaluationStatusDTOV2>>;
 
     /**
+     * Use this method to request a source control evaluation for a specific application. This is step 1 of the 2 step source control evaluation process.   Permissions Required: Evaluate Applications
      */
     evaluateSourceControl(requestParameters: EvaluateSourceControlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiApplicationEvaluationStatusDTOV2>;
 
     /**
-     * 
-     * @param {string} applicationId 
-     * @param {string} statusId 
+     * This is step 2 of the policy evaluation process. Use the statusUrl obtained from the POST response for the corresponding applicationId.   Permissions Required: Evaluate Applications
+     * @param {string} applicationId Enter the applicationId, for the which policy evaluation was requested.
+     * @param {string} statusId Enter the statusId value obtained as response of the POST call in step 1.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof EvaluationApiInterface
+     * @memberof PolicyEvaluationApiInterface
      */
     getApplicationEvaluationStatusRaw(requestParameters: GetApplicationEvaluationStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiApplicationEvaluationResultDTOV2>>;
 
     /**
+     * This is step 2 of the policy evaluation process. Use the statusUrl obtained from the POST response for the corresponding applicationId.   Permissions Required: Evaluate Applications
      */
     getApplicationEvaluationStatus(requestParameters: GetApplicationEvaluationStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiApplicationEvaluationResultDTOV2>;
 
     /**
-     * 
-     * @param {string} applicationId 
-     * @param {string} resultId 
+     * This is step 2 of the policy evaluation process for components. Use the resultId obtained from the POST response for the corresponding applicationId.   Permissions Required: Evaluate Components 
+     * @param {string} applicationId Enter the internal applicationId (same as that sent in the POST request (step 1))
+     * @param {string} resultId Enter the resultId obtained from the POST response (step 1) used for component evaluation.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof EvaluationApiInterface
+     * @memberof PolicyEvaluationApiInterface
      */
     getComponentEvaluationRaw(requestParameters: GetComponentEvaluationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiComponentEvaluationResultDTOV2>>;
 
     /**
+     * This is step 2 of the policy evaluation process for components. Use the resultId obtained from the POST response for the corresponding applicationId.   Permissions Required: Evaluate Components 
      */
     getComponentEvaluation(requestParameters: GetComponentEvaluationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiComponentEvaluationResultDTOV2>;
 
     /**
-     * 
-     * @param {string} applicationId 
-     * @param {ApiPromoteScanRequestDTOV2} [apiPromoteScanRequestDTOV2] 
+     * Use this method to rescan older scans. This is done when the binaries of a previous build are now moving to a new stage in the production pipeline. Using this method, you can avoid rebuilding the application and reuse the scan metadata at the newer stage. This new evaluation will evaluate the most recent security and license data against your current policies.   Permissions Required: Evaluate Applications
+     * @param {string} applicationId Enter the internal applicationId. Use the Applications REST API to retrieve the internal applicationId.
+     * @param {ApiPromoteScanRequestDTOV2} [apiPromoteScanRequestDTOV2] You can provide either the scanId (reportId) of the previous scan OR the source stageId (possible values are \&#39;build\&#39;, \&#39;stage-release\&#39;, \&#39;release\&#39; or \&#39;operate\&#39;). When using the stageId, the latest scanId for the application will be used. Enter the targetStageId for the new stage you want your scan to be promoted to (possible values are \&#39;build\&#39;, \&#39;stage-release\&#39;, \&#39;release\&#39; or \&#39;operate\&#39;). Using the same value for source and target stage will resubmit the latest scan report.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof EvaluationApiInterface
+     * @memberof PolicyEvaluationApiInterface
      */
     promoteScanRaw(requestParameters: PromoteScanRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiApplicationEvaluationStatusDTOV2>>;
 
     /**
+     * Use this method to rescan older scans. This is done when the binaries of a previous build are now moving to a new stage in the production pipeline. Using this method, you can avoid rebuilding the application and reuse the scan metadata at the newer stage. This new evaluation will evaluate the most recent security and license data against your current policies.   Permissions Required: Evaluate Applications
      */
     promoteScan(requestParameters: PromoteScanRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiApplicationEvaluationStatusDTOV2>;
 
@@ -147,13 +152,14 @@ export interface EvaluationApiInterface {
 /**
  * 
  */
-export class EvaluationApi extends runtime.BaseAPI implements EvaluationApiInterface {
+export class PolicyEvaluationApi extends runtime.BaseAPI implements PolicyEvaluationApiInterface {
 
     /**
+     * Use this method to request a component evaluation. This is step 1 of the 2 step policy evaluation for components process.  Permissions Required: Evaluate Components
      */
-    async evaluateComponents1Raw(requestParameters: EvaluateComponents1Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiComponentEvaluationTicketDTOV2>> {
+    async evaluateComponentsRaw(requestParameters: EvaluateComponentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiComponentEvaluationTicketDTOV2>> {
         if (requestParameters.applicationId === null || requestParameters.applicationId === undefined) {
-            throw new runtime.RequiredError('applicationId','Required parameter requestParameters.applicationId was null or undefined when calling evaluateComponents1.');
+            throw new runtime.RequiredError('applicationId','Required parameter requestParameters.applicationId was null or undefined when calling evaluateComponents.');
         }
 
         const queryParameters: any = {};
@@ -177,13 +183,15 @@ export class EvaluationApi extends runtime.BaseAPI implements EvaluationApiInter
     }
 
     /**
+     * Use this method to request a component evaluation. This is step 1 of the 2 step policy evaluation for components process.  Permissions Required: Evaluate Components
      */
-    async evaluateComponents1(requestParameters: EvaluateComponents1Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiComponentEvaluationTicketDTOV2> {
-        const response = await this.evaluateComponents1Raw(requestParameters, initOverrides);
+    async evaluateComponents(requestParameters: EvaluateComponentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiComponentEvaluationTicketDTOV2> {
+        const response = await this.evaluateComponentsRaw(requestParameters, initOverrides);
         return await response.value();
     }
 
     /**
+     * Use this method to request a source control evaluation for a specific application. This is step 1 of the 2 step source control evaluation process.   Permissions Required: Evaluate Applications
      */
     async evaluateSourceControlRaw(requestParameters: EvaluateSourceControlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiApplicationEvaluationStatusDTOV2>> {
         if (requestParameters.applicationId === null || requestParameters.applicationId === undefined) {
@@ -211,6 +219,7 @@ export class EvaluationApi extends runtime.BaseAPI implements EvaluationApiInter
     }
 
     /**
+     * Use this method to request a source control evaluation for a specific application. This is step 1 of the 2 step source control evaluation process.   Permissions Required: Evaluate Applications
      */
     async evaluateSourceControl(requestParameters: EvaluateSourceControlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiApplicationEvaluationStatusDTOV2> {
         const response = await this.evaluateSourceControlRaw(requestParameters, initOverrides);
@@ -218,6 +227,7 @@ export class EvaluationApi extends runtime.BaseAPI implements EvaluationApiInter
     }
 
     /**
+     * This is step 2 of the policy evaluation process. Use the statusUrl obtained from the POST response for the corresponding applicationId.   Permissions Required: Evaluate Applications
      */
     async getApplicationEvaluationStatusRaw(requestParameters: GetApplicationEvaluationStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiApplicationEvaluationResultDTOV2>> {
         if (requestParameters.applicationId === null || requestParameters.applicationId === undefined) {
@@ -246,6 +256,7 @@ export class EvaluationApi extends runtime.BaseAPI implements EvaluationApiInter
     }
 
     /**
+     * This is step 2 of the policy evaluation process. Use the statusUrl obtained from the POST response for the corresponding applicationId.   Permissions Required: Evaluate Applications
      */
     async getApplicationEvaluationStatus(requestParameters: GetApplicationEvaluationStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiApplicationEvaluationResultDTOV2> {
         const response = await this.getApplicationEvaluationStatusRaw(requestParameters, initOverrides);
@@ -253,6 +264,7 @@ export class EvaluationApi extends runtime.BaseAPI implements EvaluationApiInter
     }
 
     /**
+     * This is step 2 of the policy evaluation process for components. Use the resultId obtained from the POST response for the corresponding applicationId.   Permissions Required: Evaluate Components 
      */
     async getComponentEvaluationRaw(requestParameters: GetComponentEvaluationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiComponentEvaluationResultDTOV2>> {
         if (requestParameters.applicationId === null || requestParameters.applicationId === undefined) {
@@ -281,6 +293,7 @@ export class EvaluationApi extends runtime.BaseAPI implements EvaluationApiInter
     }
 
     /**
+     * This is step 2 of the policy evaluation process for components. Use the resultId obtained from the POST response for the corresponding applicationId.   Permissions Required: Evaluate Components 
      */
     async getComponentEvaluation(requestParameters: GetComponentEvaluationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiComponentEvaluationResultDTOV2> {
         const response = await this.getComponentEvaluationRaw(requestParameters, initOverrides);
@@ -288,6 +301,7 @@ export class EvaluationApi extends runtime.BaseAPI implements EvaluationApiInter
     }
 
     /**
+     * Use this method to rescan older scans. This is done when the binaries of a previous build are now moving to a new stage in the production pipeline. Using this method, you can avoid rebuilding the application and reuse the scan metadata at the newer stage. This new evaluation will evaluate the most recent security and license data against your current policies.   Permissions Required: Evaluate Applications
      */
     async promoteScanRaw(requestParameters: PromoteScanRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiApplicationEvaluationStatusDTOV2>> {
         if (requestParameters.applicationId === null || requestParameters.applicationId === undefined) {
@@ -315,6 +329,7 @@ export class EvaluationApi extends runtime.BaseAPI implements EvaluationApiInter
     }
 
     /**
+     * Use this method to rescan older scans. This is done when the binaries of a previous build are now moving to a new stage in the production pipeline. Using this method, you can avoid rebuilding the application and reuse the scan metadata at the newer stage. This new evaluation will evaluate the most recent security and license data against your current policies.   Permissions Required: Evaluate Applications
      */
     async promoteScan(requestParameters: PromoteScanRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiApplicationEvaluationStatusDTOV2> {
         const response = await this.promoteScanRaw(requestParameters, initOverrides);

package/src/apis/PolicyViolationsApi.ts

@@ -4,7 +4,7 @@
  * 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.174.0-01
+ * The version of the OpenAPI document: 1.176.0-01
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/src/apis/PolicyWaiverApi.ts

@@ -4,7 +4,7 @@
  * 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.174.0-01
+ * The version of the OpenAPI document: 1.176.0-01
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/src/apis/PolicyWaiversApi.ts

@@ -4,7 +4,7 @@
  * 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.174.0-01
+ * The version of the OpenAPI document: 1.176.0-01
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/src/apis/ReportsApi.ts

@@ -4,7 +4,7 @@
  * 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.174.0-01
+ * The version of the OpenAPI document: 1.176.0-01
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/src/apis/RepositoriesApi.ts

@@ -4,7 +4,7 @@
  * 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.174.0-01
+ * The version of the OpenAPI document: 1.176.0-01
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/src/apis/RoleMembershipsApi.ts

@@ -4,7 +4,7 @@
  * 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.174.0-01
+ * The version of the OpenAPI document: 1.176.0-01
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/src/apis/RolesApi.ts

@@ -4,7 +4,7 @@
  * 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.174.0-01
+ * The version of the OpenAPI document: 1.176.0-01
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).