@sonatype/nexus-iq-api-client 0.177.1 → 0.183.0

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.177.0-01
+ * The version of the OpenAPI document: 1.182.0-01
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -63,7 +63,7 @@ export interface GetReportHistoryForApplicationRequest {
  */
 export interface ReportsApiInterface {
     /**
-     * 
+     * Use this method to view all application reports for applications to which  you have access.   Permissions required: View IQ Elements 
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof ReportsApiInterface
@@ -71,12 +71,13 @@ export interface ReportsApiInterface {
     getAll1Raw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<ApiApplicationReportDTOV2>>>;
 
     /**
+     * Use this method to view all application reports for applications to which  you have access.   Permissions required: View IQ Elements 
      */
     getAll1(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<ApiApplicationReportDTOV2>>;
 
     /**
-     * 
-     * @param {string} applicationId 
+     * Use this method to retrieve the application reports for the specified application Id. You can view application reports only for applications to which you have access.   Permissions required: View IQ Elements 
+     * @param {string} applicationId Enter the internal application Id. You can use the Applications REST API to get the internal application Id. 
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof ReportsApiInterface
@@ -84,11 +85,12 @@ export interface ReportsApiInterface {
     getByApplicationIdRaw(requestParameters: GetByApplicationIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<ApiApplicationReportDTOV2>>>;
 
     /**
+     * Use this method to retrieve the application reports for the specified application Id. You can view application reports only for applications to which you have access.   Permissions required: View IQ Elements 
      */
     getByApplicationId(requestParameters: GetByApplicationIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<ApiApplicationReportDTOV2>>;
 
     /**
-     * 
+     * Use this method to retrieve all repository components that are quarantined. The response contains violation details and the quarantine Id of the component. Use the quarantine Id,  to release the component from quarantine, using the Release from Quarantine REST API.   Permissions required: View IQ Elements and access to the specific repository.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof ReportsApiInterface
@@ -96,12 +98,13 @@ export interface ReportsApiInterface {
     getComponentsInQuarantineRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiComponentsInQuarantineDTO>>;
 
     /**
+     * Use this method to retrieve all repository components that are quarantined. The response contains violation details and the quarantine Id of the component. Use the quarantine Id,  to release the component from quarantine, using the Release from Quarantine REST API.   Permissions required: View IQ Elements and access to the specific repository.
      */
     getComponentsInQuarantine(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiComponentsInQuarantineDTO>;
 
     /**
-     * 
-     * @param {string} [format] 
+     * Use this method to retrieve existing policy waivers by components. For an up-to-date response, ensure that all application and repository reports are current and contain the most recent re-evaluation data.<p>You can specify the format/ecosystem of the component for a filtered result. <p>Permissions required: View IQ Elements and access to the specific applications and repositories 
+     * @param {string} [format] Enter the format/ecosystem of the component
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof ReportsApiInterface
@@ -109,11 +112,12 @@ export interface ReportsApiInterface {
     getComponentsWithWaiversRaw(requestParameters: GetComponentsWithWaiversRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiComponentWaiversDTO>>;
 
     /**
+     * Use this method to retrieve existing policy waivers by components. For an up-to-date response, ensure that all application and repository reports are current and contain the most recent re-evaluation data.<p>You can specify the format/ecosystem of the component for a filtered result. <p>Permissions required: View IQ Elements and access to the specific applications and repositories 
      */
     getComponentsWithWaivers(requestParameters: GetComponentsWithWaiversRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiComponentWaiversDTO>;
 
     /**
-     * 
+     * Use this method to retrieve metrics data such as policy evaluation metrics, violation and remediation metrics aggregated monthly or weekly.  Permissions required: View IQ Elements
      * @param {ApiMetricsReportingQueryDTOV2} [apiMetricsReportingQueryDTOV2] 
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -122,14 +126,15 @@ export interface ReportsApiInterface {
     getMetricsRaw(requestParameters: GetMetricsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
 
     /**
+     * Use this method to retrieve metrics data such as policy evaluation metrics, violation and remediation metrics aggregated monthly or weekly.  Permissions required: View IQ Elements
      */
     getMetrics(requestParameters: GetMetricsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
 
     /**
-     * 
-     * @param {string} applicationId 
-     * @param {string} [stage] 
-     * @param {number} [limit] 
+     * Use this method to retrieve previous application scan reports (100 max.) for the specified application. You can view application reports only for applications to which you have access.    Permissions required: View IQ Elements 
+     * @param {string} applicationId Enter the internal application Id. You can use the Applications REST API to get the internal application Id. 
+     * @param {string} [stage] Enter the specific stage, for which you want retrieve the scan history, e.g. \&#39;build\&#39; 
+     * @param {number} [limit] Enter the exact no. of most recent reports to retrieve.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof ReportsApiInterface
@@ -137,11 +142,12 @@ export interface ReportsApiInterface {
     getReportHistoryForApplicationRaw(requestParameters: GetReportHistoryForApplicationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiReportHistoryDTO>>;
 
     /**
+     * Use this method to retrieve previous application scan reports (100 max.) for the specified application. You can view application reports only for applications to which you have access.    Permissions required: View IQ Elements 
      */
     getReportHistoryForApplication(requestParameters: GetReportHistoryForApplicationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiReportHistoryDTO>;
 
     /**
-     * 
+     * Stale waivers pose a risk because they could be applied unintentionally. Use this method to retrieve stale waivers to eliminate this risk for future application evaluations.   Permissions required: View IQ Elements. You can view stale waivers only for applications/repositories  to which you have access. 
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof ReportsApiInterface
@@ -149,6 +155,7 @@ export interface ReportsApiInterface {
     getStaleWaiversRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiStaleWaiversResponseDTO>>;
 
     /**
+     * Stale waivers pose a risk because they could be applied unintentionally. Use this method to retrieve stale waivers to eliminate this risk for future application evaluations.   Permissions required: View IQ Elements. You can view stale waivers only for applications/repositories  to which you have access. 
      */
     getStaleWaivers(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiStaleWaiversResponseDTO>;
 
@@ -160,6 +167,7 @@ export interface ReportsApiInterface {
 export class ReportsApi extends runtime.BaseAPI implements ReportsApiInterface {
 
     /**
+     * Use this method to view all application reports for applications to which  you have access.   Permissions required: View IQ Elements 
      */
     async getAll1Raw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<ApiApplicationReportDTOV2>>> {
         const queryParameters: any = {};
@@ -180,6 +188,7 @@ export class ReportsApi extends runtime.BaseAPI implements ReportsApiInterface {
     }
 
     /**
+     * Use this method to view all application reports for applications to which  you have access.   Permissions required: View IQ Elements 
      */
     async getAll1(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<ApiApplicationReportDTOV2>> {
         const response = await this.getAll1Raw(initOverrides);
@@ -187,10 +196,14 @@ export class ReportsApi extends runtime.BaseAPI implements ReportsApiInterface {
     }
 
     /**
+     * Use this method to retrieve the application reports for the specified application Id. You can view application reports only for applications to which you have access.   Permissions required: View IQ Elements 
      */
     async getByApplicationIdRaw(requestParameters: GetByApplicationIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<ApiApplicationReportDTOV2>>> {
-        if (requestParameters.applicationId === null || requestParameters.applicationId === undefined) {
-            throw new runtime.RequiredError('applicationId','Required parameter requestParameters.applicationId was null or undefined when calling getByApplicationId.');
+        if (requestParameters['applicationId'] == null) {
+            throw new runtime.RequiredError(
+                'applicationId',
+                'Required parameter "applicationId" was null or undefined when calling getByApplicationId().'
+            );
         }
 
         const queryParameters: any = {};
@@ -201,7 +214,7 @@ export class ReportsApi extends runtime.BaseAPI implements ReportsApiInterface {
             headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password);
         }
         const response = await this.request({
-            path: `/api/v2/reports/applications/{applicationId}`.replace(`{${"applicationId"}}`, encodeURIComponent(String(requestParameters.applicationId))),
+            path: `/api/v2/reports/applications/{applicationId}`.replace(`{${"applicationId"}}`, encodeURIComponent(String(requestParameters['applicationId']))),
             method: 'GET',
             headers: headerParameters,
             query: queryParameters,
@@ -211,6 +224,7 @@ export class ReportsApi extends runtime.BaseAPI implements ReportsApiInterface {
     }
 
     /**
+     * Use this method to retrieve the application reports for the specified application Id. You can view application reports only for applications to which you have access.   Permissions required: View IQ Elements 
      */
     async getByApplicationId(requestParameters: GetByApplicationIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<ApiApplicationReportDTOV2>> {
         const response = await this.getByApplicationIdRaw(requestParameters, initOverrides);
@@ -218,6 +232,7 @@ export class ReportsApi extends runtime.BaseAPI implements ReportsApiInterface {
     }
 
     /**
+     * Use this method to retrieve all repository components that are quarantined. The response contains violation details and the quarantine Id of the component. Use the quarantine Id,  to release the component from quarantine, using the Release from Quarantine REST API.   Permissions required: View IQ Elements and access to the specific repository.
      */
     async getComponentsInQuarantineRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiComponentsInQuarantineDTO>> {
         const queryParameters: any = {};
@@ -238,6 +253,7 @@ export class ReportsApi extends runtime.BaseAPI implements ReportsApiInterface {
     }
 
     /**
+     * Use this method to retrieve all repository components that are quarantined. The response contains violation details and the quarantine Id of the component. Use the quarantine Id,  to release the component from quarantine, using the Release from Quarantine REST API.   Permissions required: View IQ Elements and access to the specific repository.
      */
     async getComponentsInQuarantine(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiComponentsInQuarantineDTO> {
         const response = await this.getComponentsInQuarantineRaw(initOverrides);
@@ -245,12 +261,13 @@ export class ReportsApi extends runtime.BaseAPI implements ReportsApiInterface {
     }
 
     /**
+     * Use this method to retrieve existing policy waivers by components. For an up-to-date response, ensure that all application and repository reports are current and contain the most recent re-evaluation data.<p>You can specify the format/ecosystem of the component for a filtered result. <p>Permissions required: View IQ Elements and access to the specific applications and repositories 
      */
     async getComponentsWithWaiversRaw(requestParameters: GetComponentsWithWaiversRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiComponentWaiversDTO>> {
         const queryParameters: any = {};
 
-        if (requestParameters.format !== undefined) {
-            queryParameters['format'] = requestParameters.format;
+        if (requestParameters['format'] != null) {
+            queryParameters['format'] = requestParameters['format'];
         }
 
         const headerParameters: runtime.HTTPHeaders = {};
@@ -269,6 +286,7 @@ export class ReportsApi extends runtime.BaseAPI implements ReportsApiInterface {
     }
 
     /**
+     * Use this method to retrieve existing policy waivers by components. For an up-to-date response, ensure that all application and repository reports are current and contain the most recent re-evaluation data.<p>You can specify the format/ecosystem of the component for a filtered result. <p>Permissions required: View IQ Elements and access to the specific applications and repositories 
      */
     async getComponentsWithWaivers(requestParameters: GetComponentsWithWaiversRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiComponentWaiversDTO> {
         const response = await this.getComponentsWithWaiversRaw(requestParameters, initOverrides);
@@ -276,6 +294,7 @@ export class ReportsApi extends runtime.BaseAPI implements ReportsApiInterface {
     }
 
     /**
+     * Use this method to retrieve metrics data such as policy evaluation metrics, violation and remediation metrics aggregated monthly or weekly.  Permissions required: View IQ Elements
      */
     async getMetricsRaw(requestParameters: GetMetricsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
         const queryParameters: any = {};
@@ -292,33 +311,38 @@ export class ReportsApi extends runtime.BaseAPI implements ReportsApiInterface {
             method: 'POST',
             headers: headerParameters,
             query: queryParameters,
-            body: ApiMetricsReportingQueryDTOV2ToJSON(requestParameters.apiMetricsReportingQueryDTOV2),
+            body: ApiMetricsReportingQueryDTOV2ToJSON(requestParameters['apiMetricsReportingQueryDTOV2']),
         }, initOverrides);
 
         return new runtime.VoidApiResponse(response);
     }
 
     /**
+     * Use this method to retrieve metrics data such as policy evaluation metrics, violation and remediation metrics aggregated monthly or weekly.  Permissions required: View IQ Elements
      */
     async getMetrics(requestParameters: GetMetricsRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
         await this.getMetricsRaw(requestParameters, initOverrides);
     }
 
     /**
+     * Use this method to retrieve previous application scan reports (100 max.) for the specified application. You can view application reports only for applications to which you have access.    Permissions required: View IQ Elements 
      */
     async getReportHistoryForApplicationRaw(requestParameters: GetReportHistoryForApplicationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiReportHistoryDTO>> {
-        if (requestParameters.applicationId === null || requestParameters.applicationId === undefined) {
-            throw new runtime.RequiredError('applicationId','Required parameter requestParameters.applicationId was null or undefined when calling getReportHistoryForApplication.');
+        if (requestParameters['applicationId'] == null) {
+            throw new runtime.RequiredError(
+                'applicationId',
+                'Required parameter "applicationId" was null or undefined when calling getReportHistoryForApplication().'
+            );
         }
 
         const queryParameters: any = {};
 
-        if (requestParameters.stage !== undefined) {
-            queryParameters['stage'] = requestParameters.stage;
+        if (requestParameters['stage'] != null) {
+            queryParameters['stage'] = requestParameters['stage'];
         }
 
-        if (requestParameters.limit !== undefined) {
-            queryParameters['limit'] = requestParameters.limit;
+        if (requestParameters['limit'] != null) {
+            queryParameters['limit'] = requestParameters['limit'];
         }
 
         const headerParameters: runtime.HTTPHeaders = {};
@@ -327,7 +351,7 @@ export class ReportsApi extends runtime.BaseAPI implements ReportsApiInterface {
             headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password);
         }
         const response = await this.request({
-            path: `/api/v2/reports/applications/{applicationId}/history`.replace(`{${"applicationId"}}`, encodeURIComponent(String(requestParameters.applicationId))),
+            path: `/api/v2/reports/applications/{applicationId}/history`.replace(`{${"applicationId"}}`, encodeURIComponent(String(requestParameters['applicationId']))),
             method: 'GET',
             headers: headerParameters,
             query: queryParameters,
@@ -337,6 +361,7 @@ export class ReportsApi extends runtime.BaseAPI implements ReportsApiInterface {
     }
 
     /**
+     * Use this method to retrieve previous application scan reports (100 max.) for the specified application. You can view application reports only for applications to which you have access.    Permissions required: View IQ Elements 
      */
     async getReportHistoryForApplication(requestParameters: GetReportHistoryForApplicationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiReportHistoryDTO> {
         const response = await this.getReportHistoryForApplicationRaw(requestParameters, initOverrides);
@@ -344,6 +369,7 @@ export class ReportsApi extends runtime.BaseAPI implements ReportsApiInterface {
     }
 
     /**
+     * Stale waivers pose a risk because they could be applied unintentionally. Use this method to retrieve stale waivers to eliminate this risk for future application evaluations.   Permissions required: View IQ Elements. You can view stale waivers only for applications/repositories  to which you have access. 
      */
     async getStaleWaiversRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiStaleWaiversResponseDTO>> {
         const queryParameters: any = {};
@@ -364,6 +390,7 @@ export class ReportsApi extends runtime.BaseAPI implements ReportsApiInterface {
     }
 
     /**
+     * Stale waivers pose a risk because they could be applied unintentionally. Use this method to retrieve stale waivers to eliminate this risk for future application evaluations.   Permissions required: View IQ Elements. You can view stale waivers only for applications/repositories  to which you have access. 
      */
     async getStaleWaivers(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiStaleWaiversResponseDTO> {
         const response = await this.getStaleWaiversRaw(initOverrides);

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.177.0-01
+ * The version of the OpenAPI document: 1.182.0-01
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -82,12 +82,18 @@ export class RepositoriesApi extends runtime.BaseAPI implements RepositoriesApiI
     /**
      */
     async getQuarantinedByPathRaw(requestParameters: GetQuarantinedByPathRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiRepositoryPathResponseDTO>> {
-        if (requestParameters.repositoryManagerInstanceId === null || requestParameters.repositoryManagerInstanceId === undefined) {
-            throw new runtime.RequiredError('repositoryManagerInstanceId','Required parameter requestParameters.repositoryManagerInstanceId was null or undefined when calling getQuarantinedByPath.');
+        if (requestParameters['repositoryManagerInstanceId'] == null) {
+            throw new runtime.RequiredError(
+                'repositoryManagerInstanceId',
+                'Required parameter "repositoryManagerInstanceId" was null or undefined when calling getQuarantinedByPath().'
+            );
         }
 
-        if (requestParameters.repositoryPublicId === null || requestParameters.repositoryPublicId === undefined) {
-            throw new runtime.RequiredError('repositoryPublicId','Required parameter requestParameters.repositoryPublicId was null or undefined when calling getQuarantinedByPath.');
+        if (requestParameters['repositoryPublicId'] == null) {
+            throw new runtime.RequiredError(
+                'repositoryPublicId',
+                'Required parameter "repositoryPublicId" was null or undefined when calling getQuarantinedByPath().'
+            );
         }
 
         const queryParameters: any = {};
@@ -100,11 +106,11 @@ export class RepositoriesApi extends runtime.BaseAPI implements RepositoriesApiI
             headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password);
         }
         const response = await this.request({
-            path: `/api/v2/repositories/{repositoryManagerInstanceId}/{repositoryPublicId}/components/quarantined/pathnames`.replace(`{${"repositoryManagerInstanceId"}}`, encodeURIComponent(String(requestParameters.repositoryManagerInstanceId))).replace(`{${"repositoryPublicId"}}`, encodeURIComponent(String(requestParameters.repositoryPublicId))),
+            path: `/api/v2/repositories/{repositoryManagerInstanceId}/{repositoryPublicId}/components/quarantined/pathnames`.replace(`{${"repositoryManagerInstanceId"}}`, encodeURIComponent(String(requestParameters['repositoryManagerInstanceId']))).replace(`{${"repositoryPublicId"}}`, encodeURIComponent(String(requestParameters['repositoryPublicId']))),
             method: 'POST',
             headers: headerParameters,
             query: queryParameters,
-            body: requestParameters.requestBody,
+            body: requestParameters['requestBody'],
         }, initOverrides);
 
         return new runtime.JSONApiResponse(response, (jsonValue) => ApiRepositoryPathResponseDTOFromJSON(jsonValue));
@@ -120,8 +126,11 @@ export class RepositoriesApi extends runtime.BaseAPI implements RepositoriesApiI
     /**
      */
     async releaseQuarantineWithoutReEvalRaw(requestParameters: ReleaseQuarantineWithoutReEvalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiComponentReleasedFromQuarantineDTO>> {
-        if (requestParameters.quarantineId === null || requestParameters.quarantineId === undefined) {
-            throw new runtime.RequiredError('quarantineId','Required parameter requestParameters.quarantineId was null or undefined when calling releaseQuarantineWithoutReEval.');
+        if (requestParameters['quarantineId'] == null) {
+            throw new runtime.RequiredError(
+                'quarantineId',
+                'Required parameter "quarantineId" was null or undefined when calling releaseQuarantineWithoutReEval().'
+            );
         }
 
         const queryParameters: any = {};
@@ -134,11 +143,11 @@ export class RepositoriesApi extends runtime.BaseAPI implements RepositoriesApiI
             headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password);
         }
         const response = await this.request({
-            path: `/api/v2/repositories/quarantine/{quarantineId}/release`.replace(`{${"quarantineId"}}`, encodeURIComponent(String(requestParameters.quarantineId))),
+            path: `/api/v2/repositories/quarantine/{quarantineId}/release`.replace(`{${"quarantineId"}}`, encodeURIComponent(String(requestParameters['quarantineId']))),
             method: 'POST',
             headers: headerParameters,
             query: queryParameters,
-            body: requestParameters.body as any,
+            body: requestParameters['body'] as any,
         }, initOverrides);
 
         return new runtime.JSONApiResponse(response, (jsonValue) => ApiComponentReleasedFromQuarantineDTOFromJSON(jsonValue));