@sonatype/nexus-iq-api-client 0.184.3 → 0.192.0

package/src/apis/ConfigCrowdApi.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.184.0-01
+ * The version of the OpenAPI document: 1.192.0-01
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -41,7 +41,7 @@ export interface TestCrowdConfigurationRequest {
  */
 export interface ConfigCrowdApiInterface {
     /**
-     * 
+     * Use this method to remove an existing Atlassian Crowd Configuration.  Permissions required: Edit System Configuration and Users
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof ConfigCrowdApiInterface
@@ -49,11 +49,12 @@ export interface ConfigCrowdApiInterface {
     deleteCrowdConfigurationRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
 
     /**
+     * Use this method to remove an existing Atlassian Crowd Configuration.  Permissions required: Edit System Configuration and Users
      */
     deleteCrowdConfiguration(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
 
     /**
-     * 
+     * Use this method to retrieve the configuration details for the Atlassian Crowd Server.  Permissions required: Edit System Configuration and Users
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof ConfigCrowdApiInterface
@@ -61,12 +62,13 @@ export interface ConfigCrowdApiInterface {
     getCrowdConfigurationRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiCrowdConfigurationDTO>>;
 
     /**
+     * Use this method to retrieve the configuration details for the Atlassian Crowd Server.  Permissions required: Edit System Configuration and Users
      */
     getCrowdConfiguration(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiCrowdConfigurationDTO>;
 
     /**
-     * 
-     * @param {ApiCrowdConfigurationDTO} [apiCrowdConfigurationDTO] 
+     * Use this method to create a new or update an existing Atlassian Crowd Server configuration.  Permissions required: Edit System Configuration and Users
+     * @param {ApiCrowdConfigurationDTO} [apiCrowdConfigurationDTO] The request JSON should include the &#x60;serverUrl&#x60;, &#x60;applicationName&#x60;, and the &#x60;applicationPassword&#x60; which will be used for authentication against the Atlassian Crowd Server.  If updating the &#x60;serverUrl&#x60;, the &#x60;applicationPassword&#x60; field is required.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof ConfigCrowdApiInterface
@@ -74,12 +76,13 @@ export interface ConfigCrowdApiInterface {
     insertOrUpdateCrowdConfigurationRaw(requestParameters: InsertOrUpdateCrowdConfigurationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
 
     /**
+     * Use this method to create a new or update an existing Atlassian Crowd Server configuration.  Permissions required: Edit System Configuration and Users
      */
     insertOrUpdateCrowdConfiguration(requestParameters: InsertOrUpdateCrowdConfigurationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
 
     /**
-     * 
-     * @param {ApiCrowdConfigurationDTO} [apiCrowdConfigurationDTO] 
+     * Use this method to test a new or an existing Atlassian Crowd Server configuration.
+     * @param {ApiCrowdConfigurationDTO} [apiCrowdConfigurationDTO] To test an existing configuration, the request body is not required.  To test a new configuration, provide the &#x60;serverURl&#x60;, &#x60;applicationName&#x60;, and &#x60;applicationPassword&#x60; for the configuration.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof ConfigCrowdApiInterface
@@ -87,6 +90,7 @@ export interface ConfigCrowdApiInterface {
     testCrowdConfigurationRaw(requestParameters: TestCrowdConfigurationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiStatusDTO>>;
 
     /**
+     * Use this method to test a new or an existing Atlassian Crowd Server configuration.
      */
     testCrowdConfiguration(requestParameters: TestCrowdConfigurationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiStatusDTO>;
 
@@ -98,6 +102,7 @@ export interface ConfigCrowdApiInterface {
 export class ConfigCrowdApi extends runtime.BaseAPI implements ConfigCrowdApiInterface {
 
     /**
+     * Use this method to remove an existing Atlassian Crowd Configuration.  Permissions required: Edit System Configuration and Users
      */
     async deleteCrowdConfigurationRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
         const queryParameters: any = {};
@@ -118,12 +123,14 @@ export class ConfigCrowdApi extends runtime.BaseAPI implements ConfigCrowdApiInt
     }
 
     /**
+     * Use this method to remove an existing Atlassian Crowd Configuration.  Permissions required: Edit System Configuration and Users
      */
     async deleteCrowdConfiguration(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
         await this.deleteCrowdConfigurationRaw(initOverrides);
     }
 
     /**
+     * Use this method to retrieve the configuration details for the Atlassian Crowd Server.  Permissions required: Edit System Configuration and Users
      */
     async getCrowdConfigurationRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiCrowdConfigurationDTO>> {
         const queryParameters: any = {};
@@ -144,6 +151,7 @@ export class ConfigCrowdApi extends runtime.BaseAPI implements ConfigCrowdApiInt
     }
 
     /**
+     * Use this method to retrieve the configuration details for the Atlassian Crowd Server.  Permissions required: Edit System Configuration and Users
      */
     async getCrowdConfiguration(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiCrowdConfigurationDTO> {
         const response = await this.getCrowdConfigurationRaw(initOverrides);
@@ -151,6 +159,7 @@ export class ConfigCrowdApi extends runtime.BaseAPI implements ConfigCrowdApiInt
     }
 
     /**
+     * Use this method to create a new or update an existing Atlassian Crowd Server configuration.  Permissions required: Edit System Configuration and Users
      */
     async insertOrUpdateCrowdConfigurationRaw(requestParameters: InsertOrUpdateCrowdConfigurationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
         const queryParameters: any = {};
@@ -174,12 +183,14 @@ export class ConfigCrowdApi extends runtime.BaseAPI implements ConfigCrowdApiInt
     }
 
     /**
+     * Use this method to create a new or update an existing Atlassian Crowd Server configuration.  Permissions required: Edit System Configuration and Users
      */
     async insertOrUpdateCrowdConfiguration(requestParameters: InsertOrUpdateCrowdConfigurationRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
         await this.insertOrUpdateCrowdConfigurationRaw(requestParameters, initOverrides);
     }
 
     /**
+     * Use this method to test a new or an existing Atlassian Crowd Server configuration.
      */
     async testCrowdConfigurationRaw(requestParameters: TestCrowdConfigurationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiStatusDTO>> {
         const queryParameters: any = {};
@@ -203,6 +214,7 @@ export class ConfigCrowdApi extends runtime.BaseAPI implements ConfigCrowdApiInt
     }
 
     /**
+     * Use this method to test a new or an existing Atlassian Crowd Server configuration.
      */
     async testCrowdConfiguration(requestParameters: TestCrowdConfigurationRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiStatusDTO> {
         const response = await this.testCrowdConfigurationRaw(requestParameters, initOverrides);

package/src/apis/{ConfigJIRAApi.ts → ConfigJiraApi.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.184.0-01
+ * The version of the OpenAPI document: 1.192.0-01
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -23,50 +23,53 @@ import {
 } from '../models/index';
 
 export interface SetConfiguration1Request {
-    body?: object;
+    apiJiraConfigurationDTO?: ApiJiraConfigurationDTO;
 }
 
 /**
- * ConfigJIRAApi - interface
+ * ConfigJiraApi - interface
  * 
  * @export
- * @interface ConfigJIRAApiInterface
+ * @interface ConfigJiraApiInterface
  */
-export interface ConfigJIRAApiInterface {
+export interface ConfigJiraApiInterface {
     /**
-     * 
+     * Use this method to delete a Jira configuration.  Permissions required: Edit System Configuration and Users
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof ConfigJIRAApiInterface
+     * @memberof ConfigJiraApiInterface
      */
     deleteConfiguration1Raw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
 
     /**
+     * Use this method to delete a Jira configuration.  Permissions required: Edit System Configuration and Users
      */
     deleteConfiguration1(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
 
     /**
-     * 
+     * Use this method to retrieve an existing configuration for Jira.  Permissions required: Edit System Configuration and Users
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof ConfigJIRAApiInterface
+     * @memberof ConfigJiraApiInterface
      */
     getConfiguration1Raw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiJiraConfigurationDTO>>;
 
     /**
+     * Use this method to retrieve an existing configuration for Jira.  Permissions required: Edit System Configuration and Users
      */
     getConfiguration1(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiJiraConfigurationDTO>;
 
     /**
-     * 
-     * @param {object} [body] 
+     * Use this method to set a Jira configuration. If a Jira configuration already exists, the values will be updated with the ones provided here. If the server URL is being changed, then the password (if any) will be required.  Permissions required: Edit System Configuration and Users
+     * @param {ApiJiraConfigurationDTO} [apiJiraConfigurationDTO] Enter the Jira configuration details here.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof ConfigJIRAApiInterface
+     * @memberof ConfigJiraApiInterface
      */
     setConfiguration1Raw(requestParameters: SetConfiguration1Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
 
     /**
+     * Use this method to set a Jira configuration. If a Jira configuration already exists, the values will be updated with the ones provided here. If the server URL is being changed, then the password (if any) will be required.  Permissions required: Edit System Configuration and Users
      */
     setConfiguration1(requestParameters: SetConfiguration1Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
 
@@ -75,9 +78,10 @@ export interface ConfigJIRAApiInterface {
 /**
  * 
  */
-export class ConfigJIRAApi extends runtime.BaseAPI implements ConfigJIRAApiInterface {
+export class ConfigJiraApi extends runtime.BaseAPI implements ConfigJiraApiInterface {
 
     /**
+     * Use this method to delete a Jira configuration.  Permissions required: Edit System Configuration and Users
      */
     async deleteConfiguration1Raw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
         const queryParameters: any = {};
@@ -98,12 +102,14 @@ export class ConfigJIRAApi extends runtime.BaseAPI implements ConfigJIRAApiInter
     }
 
     /**
+     * Use this method to delete a Jira configuration.  Permissions required: Edit System Configuration and Users
      */
     async deleteConfiguration1(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
         await this.deleteConfiguration1Raw(initOverrides);
     }
 
     /**
+     * Use this method to retrieve an existing configuration for Jira.  Permissions required: Edit System Configuration and Users
      */
     async getConfiguration1Raw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiJiraConfigurationDTO>> {
         const queryParameters: any = {};
@@ -124,6 +130,7 @@ export class ConfigJIRAApi extends runtime.BaseAPI implements ConfigJIRAApiInter
     }
 
     /**
+     * Use this method to retrieve an existing configuration for Jira.  Permissions required: Edit System Configuration and Users
      */
     async getConfiguration1(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiJiraConfigurationDTO> {
         const response = await this.getConfiguration1Raw(initOverrides);
@@ -131,6 +138,7 @@ export class ConfigJIRAApi extends runtime.BaseAPI implements ConfigJIRAApiInter
     }
 
     /**
+     * Use this method to set a Jira configuration. If a Jira configuration already exists, the values will be updated with the ones provided here. If the server URL is being changed, then the password (if any) will be required.  Permissions required: Edit System Configuration and Users
      */
     async setConfiguration1Raw(requestParameters: SetConfiguration1Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
         const queryParameters: any = {};
@@ -147,13 +155,14 @@ export class ConfigJIRAApi extends runtime.BaseAPI implements ConfigJIRAApiInter
             method: 'PUT',
             headers: headerParameters,
             query: queryParameters,
-            body: requestParameters['body'] as any,
+            body: ApiJiraConfigurationDTOToJSON(requestParameters['apiJiraConfigurationDTO']),
         }, initOverrides);
 
         return new runtime.VoidApiResponse(response);
     }
 
     /**
+     * Use this method to set a Jira configuration. If a Jira configuration already exists, the values will be updated with the ones provided here. If the server URL is being changed, then the password (if any) will be required.  Permissions required: Edit System Configuration and Users
      */
     async setConfiguration1(requestParameters: SetConfiguration1Request = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
         await this.setConfiguration1Raw(requestParameters, initOverrides);

package/src/apis/ConfigMailApi.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.184.0-01
+ * The version of the OpenAPI document: 1.192.0-01
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -39,7 +39,7 @@ export interface TestConfigurationRequest {
  */
 export interface ConfigMailApiInterface {
     /**
-     * 
+     * Use this method to disable or remove an SMTP configuration.  Permissions required: Edit System Configuration and Users
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof ConfigMailApiInterface
@@ -47,11 +47,12 @@ export interface ConfigMailApiInterface {
     deleteConfiguration2Raw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
 
     /**
+     * Use this method to disable or remove an SMTP configuration.  Permissions required: Edit System Configuration and Users
      */
     deleteConfiguration2(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
 
     /**
-     * 
+     * Use this method to review the configuration for an SMTP server.  Permissions required: Edit System Configuration and Users
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof ConfigMailApiInterface
@@ -59,12 +60,13 @@ export interface ConfigMailApiInterface {
     getConfiguration2Raw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiMailConfigurationDTO>>;
 
     /**
+     * Use this method to review the configuration for an SMTP server.  Permissions required: Edit System Configuration and Users
      */
     getConfiguration2(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiMailConfigurationDTO>;
 
     /**
-     * 
-     * @param {ApiMailConfigurationDTO} [apiMailConfigurationDTO] 
+     * Use this method to configure or update an existing SMTP server configuration.  Permissions required: Edit System Configuration and Users
+     * @param {ApiMailConfigurationDTO} [apiMailConfigurationDTO] Provide one or more values for the following in the JSON payload:&lt;ul&gt;&lt;li&gt;&#x60;hostname&#x60; - is the hostname or IP address of the SMTP server used for outgoing mail.&lt;/li&gt;&lt;li&gt;&#x60;port&#x60; - is the port number on which the SMTP server accepts email requests.&lt;/li&gt;&lt;li&gt;&#x60;password&#x60; - depends upon the value of &#x60;passwordIsIncluded&#x60;.&lt;/li&gt;&lt;li&gt;&#x60;passwordIsIncluded&#x60; - if set to true, value must be provided for &#x60;password&#x60;, null is allowed.If set to false, the previous value will remain unchanged, provided that &#x60;hostname&#x60; and &#x60;port&#x60; are not changed.&lt;li&gt;&#x60;sslEnabled&#x60; - is a boolean flag indicating if the connection to the SMTP server should use SSL/TLSright from the start.&lt;/li&gt;&lt;li&gt;&#x60;startIsEnabled&#x60;- is a boolean flag indicating if the connection to the SMTP server should attempt toupgrade to SSL/TLS using the STARTTLS command.&lt;li&gt;&#x60;systemEmail&#x60; - is the email address used for the FROM header in emails sent by the IQ Server.&lt;/li&gt;&lt;/ul&gt;
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof ConfigMailApiInterface
@@ -72,13 +74,14 @@ export interface ConfigMailApiInterface {
     setConfiguration2Raw(requestParameters: SetConfiguration2Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
 
     /**
+     * Use this method to configure or update an existing SMTP server configuration.  Permissions required: Edit System Configuration and Users
      */
     setConfiguration2(requestParameters: SetConfiguration2Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
 
     /**
-     * 
-     * @param {string} recipientEmail 
-     * @param {ApiMailConfigurationDTO} [apiMailConfigurationDTO] 
+     * Use this method to test an SMTP configuration, without affecting the current configuration.  Permissions required:Edit System Configuration and Users
+     * @param {string} recipientEmail Enter the test recipient email address.
+     * @param {ApiMailConfigurationDTO} [apiMailConfigurationDTO] Provide one or more values for the following in the JSON payload:&lt;ul&gt;&lt;li&gt;&#x60;hostname&#x60; - is the hostname or IP address of the SMTP server used for outgoing mail.&lt;/li&gt;&lt;li&gt;&#x60;port&#x60; - is the port number on which the SMTP server accepts email requests.&lt;/li&gt;&lt;li&gt;&#x60;password&#x60; - depends upon the value of &#x60;passwordIsIncluded&#x60;.&lt;/li&gt;&lt;li&gt;&#x60;passwordIsIncluded&#x60; - if set to true, value must be provided for &#x60;password&#x60;, null is allowed.If set to false, the previous value will remain unchanged, provided that &#x60;hostname&#x60; and &#x60;port&#x60; are not changed.&lt;li&gt;&#x60;sslEnabled&#x60; - is a boolean flag indicating if the connection to the SMTP server should use SSL/TLSright from the start.&lt;/li&gt;&lt;li&gt;&#x60;startIsEnabled&#x60;- is a boolean flag indicating if the connection to the SMTP server should attempt toupgrade to SSL/TLS using the STARTTLS command.&lt;li&gt;&#x60;systemEmail&#x60; - is the email address used for the FROM header in emails sent by the IQ Server.&lt;/li&gt;&lt;/ul&gt;
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof ConfigMailApiInterface
@@ -86,6 +89,7 @@ export interface ConfigMailApiInterface {
     testConfigurationRaw(requestParameters: TestConfigurationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
 
     /**
+     * Use this method to test an SMTP configuration, without affecting the current configuration.  Permissions required:Edit System Configuration and Users
      */
     testConfiguration(requestParameters: TestConfigurationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
 
@@ -97,6 +101,7 @@ export interface ConfigMailApiInterface {
 export class ConfigMailApi extends runtime.BaseAPI implements ConfigMailApiInterface {
 
     /**
+     * Use this method to disable or remove an SMTP configuration.  Permissions required: Edit System Configuration and Users
      */
     async deleteConfiguration2Raw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
         const queryParameters: any = {};
@@ -117,12 +122,14 @@ export class ConfigMailApi extends runtime.BaseAPI implements ConfigMailApiInter
     }
 
     /**
+     * Use this method to disable or remove an SMTP configuration.  Permissions required: Edit System Configuration and Users
      */
     async deleteConfiguration2(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
         await this.deleteConfiguration2Raw(initOverrides);
     }
 
     /**
+     * Use this method to review the configuration for an SMTP server.  Permissions required: Edit System Configuration and Users
      */
     async getConfiguration2Raw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiMailConfigurationDTO>> {
         const queryParameters: any = {};
@@ -143,6 +150,7 @@ export class ConfigMailApi extends runtime.BaseAPI implements ConfigMailApiInter
     }
 
     /**
+     * Use this method to review the configuration for an SMTP server.  Permissions required: Edit System Configuration and Users
      */
     async getConfiguration2(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiMailConfigurationDTO> {
         const response = await this.getConfiguration2Raw(initOverrides);
@@ -150,6 +158,7 @@ export class ConfigMailApi extends runtime.BaseAPI implements ConfigMailApiInter
     }
 
     /**
+     * Use this method to configure or update an existing SMTP server configuration.  Permissions required: Edit System Configuration and Users
      */
     async setConfiguration2Raw(requestParameters: SetConfiguration2Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
         const queryParameters: any = {};
@@ -173,12 +182,14 @@ export class ConfigMailApi extends runtime.BaseAPI implements ConfigMailApiInter
     }
 
     /**
+     * Use this method to configure or update an existing SMTP server configuration.  Permissions required: Edit System Configuration and Users
      */
     async setConfiguration2(requestParameters: SetConfiguration2Request = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
         await this.setConfiguration2Raw(requestParameters, initOverrides);
     }
 
     /**
+     * Use this method to test an SMTP configuration, without affecting the current configuration.  Permissions required:Edit System Configuration and Users
      */
     async testConfigurationRaw(requestParameters: TestConfigurationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
         if (requestParameters['recipientEmail'] == null) {
@@ -209,6 +220,7 @@ export class ConfigMailApi extends runtime.BaseAPI implements ConfigMailApiInter
     }
 
     /**
+     * Use this method to test an SMTP configuration, without affecting the current configuration.  Permissions required:Edit System Configuration and Users
      */
     async testConfiguration(requestParameters: TestConfigurationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
         await this.testConfigurationRaw(requestParameters, initOverrides);

package/src/apis/ConfigProxyServerApi.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.184.0-01
+ * The version of the OpenAPI document: 1.192.0-01
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -34,7 +34,7 @@ export interface SetConfiguration3Request {
  */
 export interface ConfigProxyServerApiInterface {
     /**
-     * 
+     * Use this method to remove an existing HTTP proxy server configuration.  Permissions required: Edit System Configuration and Users
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof ConfigProxyServerApiInterface
@@ -42,11 +42,12 @@ export interface ConfigProxyServerApiInterface {
     deleteConfiguration3Raw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
 
     /**
+     * Use this method to remove an existing HTTP proxy server configuration.  Permissions required: Edit System Configuration and Users
      */
     deleteConfiguration3(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
 
     /**
-     * 
+     * Use this method to inspect an existing HTTP proxy server configuration.  Permissions required: Edit System Configuration and Users
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof ConfigProxyServerApiInterface
@@ -54,12 +55,13 @@ export interface ConfigProxyServerApiInterface {
     getConfiguration3Raw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiProxyServerConfigurationDTO>>;
 
     /**
+     * Use this method to inspect an existing HTTP proxy server configuration.  Permissions required: Edit System Configuration and Users
      */
     getConfiguration3(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiProxyServerConfigurationDTO>;
 
     /**
-     * 
-     * @param {ApiProxyServerConfigurationDTO} [apiProxyServerConfigurationDTO] 
+     * Use this method to create or update an existing HTTP proxy server configuration.  Permissions required: Edit System Configuration and Users
+     * @param {ApiProxyServerConfigurationDTO} [apiProxyServerConfigurationDTO] The request JSON could include: &lt;ul&gt;&lt;li&gt;&#x60;hostname&#x60; is host name or IP address of the HTTP proxy server to use for outgoing HTTP connections.&lt;/li&gt;&lt;li&gt;&#x60;port&#x60; is the port number for the HTTP proxy server.&lt;/li&gt;&lt;li&gt;&#x60;username&#x60; is the username used to authenticate with the HTTP proxy server.&lt;/li&gt;&lt;li&gt;&#x60;password&#x60; is the password used for authentication with the HTTP proxy server.&lt;/li&gt;&lt;li&gt;&#x60;passwordIsIncluded&#x60; should be &#x60;true&#x60; if password is included in the request.&lt;ul&gt;&lt;li&gt;If &#x60;true&#x60; but the password is not included the password will be considered as &#x60;null&#x60;.&lt;/li&gt;&lt;li&gt;Can be &#x60;false&#x60; for update operations that do not a require password change. Note that updating the hostname and port requires a password to be provided.&lt;/li&gt; &lt;/ul&gt;&lt;li&gt;&#x60;excludeHosts&#x60; is a list of host names that are to be excluded from using the HTTP proxy server.&lt;/li&gt;&lt;/ul&gt;
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof ConfigProxyServerApiInterface
@@ -67,6 +69,7 @@ export interface ConfigProxyServerApiInterface {
     setConfiguration3Raw(requestParameters: SetConfiguration3Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
 
     /**
+     * Use this method to create or update an existing HTTP proxy server configuration.  Permissions required: Edit System Configuration and Users
      */
     setConfiguration3(requestParameters: SetConfiguration3Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
 
@@ -78,6 +81,7 @@ export interface ConfigProxyServerApiInterface {
 export class ConfigProxyServerApi extends runtime.BaseAPI implements ConfigProxyServerApiInterface {
 
     /**
+     * Use this method to remove an existing HTTP proxy server configuration.  Permissions required: Edit System Configuration and Users
      */
     async deleteConfiguration3Raw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
         const queryParameters: any = {};
@@ -98,12 +102,14 @@ export class ConfigProxyServerApi extends runtime.BaseAPI implements ConfigProxy
     }
 
     /**
+     * Use this method to remove an existing HTTP proxy server configuration.  Permissions required: Edit System Configuration and Users
      */
     async deleteConfiguration3(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
         await this.deleteConfiguration3Raw(initOverrides);
     }
 
     /**
+     * Use this method to inspect an existing HTTP proxy server configuration.  Permissions required: Edit System Configuration and Users
      */
     async getConfiguration3Raw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiProxyServerConfigurationDTO>> {
         const queryParameters: any = {};
@@ -124,6 +130,7 @@ export class ConfigProxyServerApi extends runtime.BaseAPI implements ConfigProxy
     }
 
     /**
+     * Use this method to inspect an existing HTTP proxy server configuration.  Permissions required: Edit System Configuration and Users
      */
     async getConfiguration3(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiProxyServerConfigurationDTO> {
         const response = await this.getConfiguration3Raw(initOverrides);
@@ -131,6 +138,7 @@ export class ConfigProxyServerApi extends runtime.BaseAPI implements ConfigProxy
     }
 
     /**
+     * Use this method to create or update an existing HTTP proxy server configuration.  Permissions required: Edit System Configuration and Users
      */
     async setConfiguration3Raw(requestParameters: SetConfiguration3Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
         const queryParameters: any = {};
@@ -154,6 +162,7 @@ export class ConfigProxyServerApi extends runtime.BaseAPI implements ConfigProxy
     }
 
     /**
+     * Use this method to create or update an existing HTTP proxy server configuration.  Permissions required: Edit System Configuration and Users
      */
     async setConfiguration3(requestParameters: SetConfiguration3Request = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
         await this.setConfiguration3Raw(requestParameters, initOverrides);

package/src/apis/ConfigReverseProxyAuthenticationApi.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.184.0-01
+ * The version of the OpenAPI document: 1.192.0-01
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -34,7 +34,7 @@ export interface SetConfiguration4Request {
  */
 export interface ConfigReverseProxyAuthenticationApiInterface {
     /**
-     * 
+     * Use this method to remove an existing reverse proxy server configuration.  Permissions required: Edit System Configuration and Users
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof ConfigReverseProxyAuthenticationApiInterface
@@ -42,11 +42,12 @@ export interface ConfigReverseProxyAuthenticationApiInterface {
     deleteConfiguration4Raw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
 
     /**
+     * Use this method to remove an existing reverse proxy server configuration.  Permissions required: Edit System Configuration and Users
      */
     deleteConfiguration4(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
 
     /**
-     * 
+     * Use this method to inspect an existing reverse proxy server configuration.  Permissions required: Edit System Configuration and Users
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof ConfigReverseProxyAuthenticationApiInterface
@@ -54,12 +55,13 @@ export interface ConfigReverseProxyAuthenticationApiInterface {
     getConfiguration4Raw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiReverseProxyAuthenticationConfigurationDTO>>;
 
     /**
+     * Use this method to inspect an existing reverse proxy server configuration.  Permissions required: Edit System Configuration and Users
      */
     getConfiguration4(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiReverseProxyAuthenticationConfigurationDTO>;
 
     /**
-     * 
-     * @param {ApiReverseProxyAuthenticationConfigurationDTO} [apiReverseProxyAuthenticationConfigurationDTO] 
+     * Use this method to configure the reverse proxy server.  Permissions required: Edit System Configuration and Users
+     * @param {ApiReverseProxyAuthenticationConfigurationDTO} [apiReverseProxyAuthenticationConfigurationDTO] The request JSON could include: &lt;ul&gt;&lt;li&gt;&#x60;enabled&#x60; indicates if the configuration is enabled.&lt;/li&gt;&lt;li&gt;&#x60;usernameHeader&#x60; is the name of the HTTP request header field that contains the username. The default value is &#x60;REMOTE_USER&#x60;.&lt;/li&gt;&lt;li&gt;&#x60;csrfProtectionDisabled&#x60; indicates if Cross-Site Request Forgery (CSRF) protection is disabled. Used for backward compatibility with old client plugins.&lt;/li&gt;&lt;li&gt;&#x60;logoutUrl&#x60; is the redirect URL when a user logs out. If set to &#x60;null&#x60; the user will not be redirected.&lt;/li&gt;&lt;/ul&gt;
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof ConfigReverseProxyAuthenticationApiInterface
@@ -67,6 +69,7 @@ export interface ConfigReverseProxyAuthenticationApiInterface {
     setConfiguration4Raw(requestParameters: SetConfiguration4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
 
     /**
+     * Use this method to configure the reverse proxy server.  Permissions required: Edit System Configuration and Users
      */
     setConfiguration4(requestParameters: SetConfiguration4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
 
@@ -78,6 +81,7 @@ export interface ConfigReverseProxyAuthenticationApiInterface {
 export class ConfigReverseProxyAuthenticationApi extends runtime.BaseAPI implements ConfigReverseProxyAuthenticationApiInterface {
 
     /**
+     * Use this method to remove an existing reverse proxy server configuration.  Permissions required: Edit System Configuration and Users
      */
     async deleteConfiguration4Raw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
         const queryParameters: any = {};
@@ -98,12 +102,14 @@ export class ConfigReverseProxyAuthenticationApi extends runtime.BaseAPI impleme
     }
 
     /**
+     * Use this method to remove an existing reverse proxy server configuration.  Permissions required: Edit System Configuration and Users
      */
     async deleteConfiguration4(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
         await this.deleteConfiguration4Raw(initOverrides);
     }
 
     /**
+     * Use this method to inspect an existing reverse proxy server configuration.  Permissions required: Edit System Configuration and Users
      */
     async getConfiguration4Raw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiReverseProxyAuthenticationConfigurationDTO>> {
         const queryParameters: any = {};
@@ -124,6 +130,7 @@ export class ConfigReverseProxyAuthenticationApi extends runtime.BaseAPI impleme
     }
 
     /**
+     * Use this method to inspect an existing reverse proxy server configuration.  Permissions required: Edit System Configuration and Users
      */
     async getConfiguration4(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiReverseProxyAuthenticationConfigurationDTO> {
         const response = await this.getConfiguration4Raw(initOverrides);
@@ -131,6 +138,7 @@ export class ConfigReverseProxyAuthenticationApi extends runtime.BaseAPI impleme
     }
 
     /**
+     * Use this method to configure the reverse proxy server.  Permissions required: Edit System Configuration and Users
      */
     async setConfiguration4Raw(requestParameters: SetConfiguration4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
         const queryParameters: any = {};
@@ -154,6 +162,7 @@ export class ConfigReverseProxyAuthenticationApi extends runtime.BaseAPI impleme
     }
 
     /**
+     * Use this method to configure the reverse proxy server.  Permissions required: Edit System Configuration and Users
      */
     async setConfiguration4(requestParameters: SetConfiguration4Request = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
         await this.setConfiguration4Raw(requestParameters, initOverrides);