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

package/src/apis/ConfigSourceControlApi.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.176.0-01
+ * The version of the OpenAPI document: 1.177.0-01
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/src/apis/CycloneDXApi.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.176.0-01
+ * The version of the OpenAPI document: 1.177.0-01
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/src/apis/DataRetentionPoliciesApi.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.176.0-01
+ * The version of the OpenAPI document: 1.177.0-01
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -32,7 +32,7 @@ export interface GetParentDataRetentionPoliciesRequest {
 
 export interface SetDataRetentionPoliciesRequest {
     organizationId: string;
-    apiDataRetentionPoliciesDTO?: ApiDataRetentionPoliciesDTO;
+    apiDataRetentionPoliciesDTO: ApiDataRetentionPoliciesDTO;
 }
 
 /**
@@ -43,8 +43,8 @@ export interface SetDataRetentionPoliciesRequest {
  */
 export interface DataRetentionPoliciesApiInterface {
     /**
-     * 
-     * @param {string} organizationId 
+     * Data retention policies help to limit the disk space consumption by removing obsolete data. Use this method to inspect the retention policies that are in effect for an organization. Application reports created by continuous monitoring are not affected by the stage retention policy. They appear separately under the key continuous-monitoring in the response JSON<p>Permissions required: View IQ Elements
+     * @param {string} organizationId The organizationId assigned by IQ Server. Use the organization REST API to retrieve the organizationId.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof DataRetentionPoliciesApiInterface
@@ -52,12 +52,13 @@ export interface DataRetentionPoliciesApiInterface {
     getDataRetentionPoliciesRaw(requestParameters: GetDataRetentionPoliciesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiDataRetentionPoliciesDTO>>;
 
     /**
+     * Data retention policies help to limit the disk space consumption by removing obsolete data. Use this method to inspect the retention policies that are in effect for an organization. Application reports created by continuous monitoring are not affected by the stage retention policy. They appear separately under the key continuous-monitoring in the response JSON<p>Permissions required: View IQ Elements
      */
     getDataRetentionPolicies(requestParameters: GetDataRetentionPoliciesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiDataRetentionPoliciesDTO>;
 
     /**
-     * 
-     * @param {string} organizationId 
+     * Data retention policies help to limit the disk space consumption by removing obsolete data. Use this method to inspect the retention policies that are in effect for the parent organization of the given organization. Application reports created by continuous monitoring are not affected by the stage retention policy. They appear separately under the key continuous-monitoring.<p>Permissions required: View IQ Elements
+     * @param {string} organizationId The organizationId assigned by IQ Server. Use the organization REST API to retrieve the parent organizationId
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof DataRetentionPoliciesApiInterface
@@ -65,13 +66,14 @@ export interface DataRetentionPoliciesApiInterface {
     getParentDataRetentionPoliciesRaw(requestParameters: GetParentDataRetentionPoliciesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiDataRetentionPoliciesDTO>>;
 
     /**
+     * Data retention policies help to limit the disk space consumption by removing obsolete data. Use this method to inspect the retention policies that are in effect for the parent organization of the given organization. Application reports created by continuous monitoring are not affected by the stage retention policy. They appear separately under the key continuous-monitoring.<p>Permissions required: View IQ Elements
      */
     getParentDataRetentionPolicies(requestParameters: GetParentDataRetentionPoliciesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiDataRetentionPoliciesDTO>;
 
     /**
-     * 
-     * @param {string} organizationId 
-     * @param {ApiDataRetentionPoliciesDTO} [apiDataRetentionPoliciesDTO] 
+     * Data retention policies help to limit the disk space consumption by removing obsolete data. Use this method to set the retention policies for an organization. Application reports created by continuous monitoring are not affected by the stage retention policy. They appear separately under the key continuous-monitoring.<p>Permissions required: Edit IQ Elements
+     * @param {string} organizationId The organizationId for the organization you want to set the data retention policy. Use the organization REST API to retrieve the organizationId.
+     * @param {ApiDataRetentionPoliciesDTO} apiDataRetentionPoliciesDTO The request JSON should include the retention policy settings for both application reports and success metrics.  Policy settings for application reports can be specified for each stage of development represented in the example below by additionalProp1.  Example values for additionalProp1 are develop, build, stage-release, release, operate &amp; continuous monitoring. For application reports created during continuous monitoring use the key continuous-monitoring instead of the stage name. &lt;ul&gt;&lt;li&gt;inheritPolicy IS a boolean flag indicating whether the policy is inherited from a parent organization.&lt;/li&gt;&lt;li&gt;enablePurging IS a boolean flag indicating enabled or disabled status for automatic purging. &lt;/li&gt;&lt;li&gt;maxCount IS the maximum no. of reports to retain.&lt;/li&gt;&lt;li&gt;maxAge IS the maximum age that a report is allowed to reach before it is purged. Possible values are days, weeks, months, years.&lt;/li&gt;&lt;/ul&gt;
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof DataRetentionPoliciesApiInterface
@@ -79,6 +81,7 @@ export interface DataRetentionPoliciesApiInterface {
     setDataRetentionPoliciesRaw(requestParameters: SetDataRetentionPoliciesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
 
     /**
+     * Data retention policies help to limit the disk space consumption by removing obsolete data. Use this method to set the retention policies for an organization. Application reports created by continuous monitoring are not affected by the stage retention policy. They appear separately under the key continuous-monitoring.<p>Permissions required: Edit IQ Elements
      */
     setDataRetentionPolicies(requestParameters: SetDataRetentionPoliciesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
 
@@ -90,6 +93,7 @@ export interface DataRetentionPoliciesApiInterface {
 export class DataRetentionPoliciesApi extends runtime.BaseAPI implements DataRetentionPoliciesApiInterface {
 
     /**
+     * Data retention policies help to limit the disk space consumption by removing obsolete data. Use this method to inspect the retention policies that are in effect for an organization. Application reports created by continuous monitoring are not affected by the stage retention policy. They appear separately under the key continuous-monitoring in the response JSON<p>Permissions required: View IQ Elements
      */
     async getDataRetentionPoliciesRaw(requestParameters: GetDataRetentionPoliciesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiDataRetentionPoliciesDTO>> {
         if (requestParameters.organizationId === null || requestParameters.organizationId === undefined) {
@@ -114,6 +118,7 @@ export class DataRetentionPoliciesApi extends runtime.BaseAPI implements DataRet
     }
 
     /**
+     * Data retention policies help to limit the disk space consumption by removing obsolete data. Use this method to inspect the retention policies that are in effect for an organization. Application reports created by continuous monitoring are not affected by the stage retention policy. They appear separately under the key continuous-monitoring in the response JSON<p>Permissions required: View IQ Elements
      */
     async getDataRetentionPolicies(requestParameters: GetDataRetentionPoliciesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiDataRetentionPoliciesDTO> {
         const response = await this.getDataRetentionPoliciesRaw(requestParameters, initOverrides);
@@ -121,6 +126,7 @@ export class DataRetentionPoliciesApi extends runtime.BaseAPI implements DataRet
     }
 
     /**
+     * Data retention policies help to limit the disk space consumption by removing obsolete data. Use this method to inspect the retention policies that are in effect for the parent organization of the given organization. Application reports created by continuous monitoring are not affected by the stage retention policy. They appear separately under the key continuous-monitoring.<p>Permissions required: View IQ Elements
      */
     async getParentDataRetentionPoliciesRaw(requestParameters: GetParentDataRetentionPoliciesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiDataRetentionPoliciesDTO>> {
         if (requestParameters.organizationId === null || requestParameters.organizationId === undefined) {
@@ -145,6 +151,7 @@ export class DataRetentionPoliciesApi extends runtime.BaseAPI implements DataRet
     }
 
     /**
+     * Data retention policies help to limit the disk space consumption by removing obsolete data. Use this method to inspect the retention policies that are in effect for the parent organization of the given organization. Application reports created by continuous monitoring are not affected by the stage retention policy. They appear separately under the key continuous-monitoring.<p>Permissions required: View IQ Elements
      */
     async getParentDataRetentionPolicies(requestParameters: GetParentDataRetentionPoliciesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiDataRetentionPoliciesDTO> {
         const response = await this.getParentDataRetentionPoliciesRaw(requestParameters, initOverrides);
@@ -152,12 +159,17 @@ export class DataRetentionPoliciesApi extends runtime.BaseAPI implements DataRet
     }
 
     /**
+     * Data retention policies help to limit the disk space consumption by removing obsolete data. Use this method to set the retention policies for an organization. Application reports created by continuous monitoring are not affected by the stage retention policy. They appear separately under the key continuous-monitoring.<p>Permissions required: Edit IQ Elements
      */
     async setDataRetentionPoliciesRaw(requestParameters: SetDataRetentionPoliciesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
         if (requestParameters.organizationId === null || requestParameters.organizationId === undefined) {
             throw new runtime.RequiredError('organizationId','Required parameter requestParameters.organizationId was null or undefined when calling setDataRetentionPolicies.');
         }
 
+        if (requestParameters.apiDataRetentionPoliciesDTO === null || requestParameters.apiDataRetentionPoliciesDTO === undefined) {
+            throw new runtime.RequiredError('apiDataRetentionPoliciesDTO','Required parameter requestParameters.apiDataRetentionPoliciesDTO was null or undefined when calling setDataRetentionPolicies.');
+        }
+
         const queryParameters: any = {};
 
         const headerParameters: runtime.HTTPHeaders = {};
@@ -179,6 +191,7 @@ export class DataRetentionPoliciesApi extends runtime.BaseAPI implements DataRet
     }
 
     /**
+     * Data retention policies help to limit the disk space consumption by removing obsolete data. Use this method to set the retention policies for an organization. Application reports created by continuous monitoring are not affected by the stage retention policy. They appear separately under the key continuous-monitoring.<p>Permissions required: Edit IQ Elements
      */
     async setDataRetentionPolicies(requestParameters: SetDataRetentionPoliciesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
         await this.setDataRetentionPoliciesRaw(requestParameters, initOverrides);

package/src/apis/EndpointsApi.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.176.0-01
+ * The version of the OpenAPI document: 1.177.0-01
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/src/apis/FirewallApi.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.176.0-01
+ * The version of the OpenAPI document: 1.177.0-01
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/src/apis/LabelsApi.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.176.0-01
+ * The version of the OpenAPI document: 1.177.0-01
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/src/apis/LicenseLegalMetadataApi.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.176.0-01
+ * The version of the OpenAPI document: 1.177.0-01
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/src/apis/OrganizationsApi.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.176.0-01
+ * The version of the OpenAPI document: 1.177.0-01
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/src/apis/PoliciesApi.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.176.0-01
+ * The version of the OpenAPI document: 1.177.0-01
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/src/apis/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.176.0-01
+ * The version of the OpenAPI document: 1.177.0-01
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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