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

package/dist/apis/UserTokensApi.d.ts

@@ -2,7 +2,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).
@@ -31,79 +31,86 @@ export interface GetUserTokensByCreatedBetweenAndRealmIdRequest {
  */
 export interface UserTokensApiInterface {
     /**
-     *
+     * Use this method to generate a user token for the currently logged in user.  Permissions required: None
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof UserTokensApiInterface
      */
     createUserTokenRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiUserTokenDTO>>;
     /**
+     * Use this method to generate a user token for the currently logged in user.  Permissions required: None
      */
     createUserToken(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiUserTokenDTO>;
     /**
-     *
+     * Use this method to delete an existing user token for the currently logged in user.  Permissions required: None
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof UserTokensApiInterface
      */
     deleteCurrentUserTokenRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
+     * Use this method to delete an existing user token for the currently logged in user.  Permissions required: None
      */
     deleteCurrentUserToken(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
-     *
-     * @param {string} userCode
+     * Use this method to delete an existing user token by specifying the userCode.  Permissions required: Edit System Configuration and Users
+     * @param {string} userCode Enter the &#x60;userCode&#x60; to be deleted.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof UserTokensApiInterface
      */
     deleteUserTokenByUserCodeRaw(requestParameters: DeleteUserTokenByUserCodeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
+     * Use this method to delete an existing user token by specifying the userCode.  Permissions required: Edit System Configuration and Users
      */
     deleteUserTokenByUserCode(requestParameters: DeleteUserTokenByUserCodeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
-     *
-     * @param {string} username
-     * @param {string} [realm]
+     * Use this method to retrieve a user token by specifying a username and realmId.  Permissions required: Edit System Configuration and Users
+     * @param {string} username Enter the username.
+     * @param {string} [realm] Enter the realmId. Possible values are &#x60;Internal&#x60;, &#x60;SAML&#x60; , &#x60;OAUTH2&#x60; , and &#x60;Crowd&#x60;.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof UserTokensApiInterface
      */
     getUserTokenByUsernameAndRealmIdRaw(requestParameters: GetUserTokenByUsernameAndRealmIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiUserTokenDTO>>;
     /**
+     * Use this method to retrieve a user token by specifying a username and realmId.  Permissions required: Edit System Configuration and Users
      */
     getUserTokenByUsernameAndRealmId(requestParameters: GetUserTokenByUsernameAndRealmIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiUserTokenDTO>;
     /**
-     *
+     * Use this method to check if a user token has been issued to the logged in user.  Permissions required: None
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof UserTokensApiInterface
      */
     getUserTokenExistsForCurrentUserRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiUserTokenExistsDTO>>;
     /**
+     * Use this method to check if a user token has been issued to the logged in user.  Permissions required: None
      */
     getUserTokenExistsForCurrentUser(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiUserTokenExistsDTO>;
     /**
-     *
-     * @param {string} [createdAfter]
-     * @param {string} [createdBefore]
-     * @param {string} [realm]
+     * Use this method to retrieve user tokens created within a date range, in the supported IQ Server realms.  Permissions required: Edit System Configuration and Users.
+     * @param {string} [createdAfter] Enter the start date for the date range in &#x60;yyyy-mm-dd&#x60; format.
+     * @param {string} [createdBefore] Enter the end date for the date range in &#x60;yyyy-mm-dd&#x60; format.
+     * @param {string} [realm] Enter the &#x60;realmId&#x60;. Possible values are &#x60;Internal&#x60;, &#x60;SAML&#x60; , &#x60;OAUTH2&#x60;, and &#x60;Crowd&#x60;.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof UserTokensApiInterface
      */
     getUserTokensByCreatedBetweenAndRealmIdRaw(requestParameters: GetUserTokensByCreatedBetweenAndRealmIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<ApiUserTokenDTO>>>;
     /**
+     * Use this method to retrieve user tokens created within a date range, in the supported IQ Server realms.  Permissions required: Edit System Configuration and Users.
      */
     getUserTokensByCreatedBetweenAndRealmId(requestParameters: GetUserTokensByCreatedBetweenAndRealmIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<ApiUserTokenDTO>>;
     /**
-     *
+     * Use this method to delete all existing LDAP user tokens.  Permissions required: Edit System Configuration and Users
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof UserTokensApiInterface
      */
     purgeUserTokensRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
+     * Use this method to delete all existing LDAP user tokens.  Permissions required: Edit System Configuration and Users
      */
     purgeUserTokens(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
 }
@@ -112,45 +119,59 @@ export interface UserTokensApiInterface {
  */
 export declare class UserTokensApi extends runtime.BaseAPI implements UserTokensApiInterface {
     /**
+     * Use this method to generate a user token for the currently logged in user.  Permissions required: None
      */
     createUserTokenRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiUserTokenDTO>>;
     /**
+     * Use this method to generate a user token for the currently logged in user.  Permissions required: None
      */
     createUserToken(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiUserTokenDTO>;
     /**
+     * Use this method to delete an existing user token for the currently logged in user.  Permissions required: None
      */
     deleteCurrentUserTokenRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
+     * Use this method to delete an existing user token for the currently logged in user.  Permissions required: None
      */
     deleteCurrentUserToken(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
+     * Use this method to delete an existing user token by specifying the userCode.  Permissions required: Edit System Configuration and Users
      */
     deleteUserTokenByUserCodeRaw(requestParameters: DeleteUserTokenByUserCodeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
+     * Use this method to delete an existing user token by specifying the userCode.  Permissions required: Edit System Configuration and Users
      */
     deleteUserTokenByUserCode(requestParameters: DeleteUserTokenByUserCodeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
+     * Use this method to retrieve a user token by specifying a username and realmId.  Permissions required: Edit System Configuration and Users
      */
     getUserTokenByUsernameAndRealmIdRaw(requestParameters: GetUserTokenByUsernameAndRealmIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiUserTokenDTO>>;
     /**
+     * Use this method to retrieve a user token by specifying a username and realmId.  Permissions required: Edit System Configuration and Users
      */
     getUserTokenByUsernameAndRealmId(requestParameters: GetUserTokenByUsernameAndRealmIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiUserTokenDTO>;
     /**
+     * Use this method to check if a user token has been issued to the logged in user.  Permissions required: None
      */
     getUserTokenExistsForCurrentUserRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiUserTokenExistsDTO>>;
     /**
+     * Use this method to check if a user token has been issued to the logged in user.  Permissions required: None
      */
     getUserTokenExistsForCurrentUser(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiUserTokenExistsDTO>;
     /**
+     * Use this method to retrieve user tokens created within a date range, in the supported IQ Server realms.  Permissions required: Edit System Configuration and Users.
      */
     getUserTokensByCreatedBetweenAndRealmIdRaw(requestParameters: GetUserTokensByCreatedBetweenAndRealmIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<ApiUserTokenDTO>>>;
     /**
+     * Use this method to retrieve user tokens created within a date range, in the supported IQ Server realms.  Permissions required: Edit System Configuration and Users.
      */
     getUserTokensByCreatedBetweenAndRealmId(requestParameters?: GetUserTokensByCreatedBetweenAndRealmIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<ApiUserTokenDTO>>;
     /**
+     * Use this method to delete all existing LDAP user tokens.  Permissions required: Edit System Configuration and Users
      */
     purgeUserTokensRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
+     * Use this method to delete all existing LDAP user tokens.  Permissions required: Edit System Configuration and Users
      */
     purgeUserTokens(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
 }

package/dist/apis/UserTokensApi.js

@@ -5,7 +5,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).
@@ -30,6 +30,7 @@ const index_1 = require("../models/index");
  */
 class UserTokensApi extends runtime.BaseAPI {
     /**
+     * Use this method to generate a user token for the currently logged in user.  Permissions required: None
      */
     createUserTokenRaw(initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -48,6 +49,7 @@ class UserTokensApi extends runtime.BaseAPI {
         });
     }
     /**
+     * Use this method to generate a user token for the currently logged in user.  Permissions required: None
      */
     createUserToken(initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -56,6 +58,7 @@ class UserTokensApi extends runtime.BaseAPI {
         });
     }
     /**
+     * Use this method to delete an existing user token for the currently logged in user.  Permissions required: None
      */
     deleteCurrentUserTokenRaw(initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -74,6 +77,7 @@ class UserTokensApi extends runtime.BaseAPI {
         });
     }
     /**
+     * Use this method to delete an existing user token for the currently logged in user.  Permissions required: None
      */
     deleteCurrentUserToken(initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -81,6 +85,7 @@ class UserTokensApi extends runtime.BaseAPI {
         });
     }
     /**
+     * Use this method to delete an existing user token by specifying the userCode.  Permissions required: Edit System Configuration and Users
      */
     deleteUserTokenByUserCodeRaw(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -102,6 +107,7 @@ class UserTokensApi extends runtime.BaseAPI {
         });
     }
     /**
+     * Use this method to delete an existing user token by specifying the userCode.  Permissions required: Edit System Configuration and Users
      */
     deleteUserTokenByUserCode(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -109,6 +115,7 @@ class UserTokensApi extends runtime.BaseAPI {
         });
     }
     /**
+     * Use this method to retrieve a user token by specifying a username and realmId.  Permissions required: Edit System Configuration and Users
      */
     getUserTokenByUsernameAndRealmIdRaw(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -133,6 +140,7 @@ class UserTokensApi extends runtime.BaseAPI {
         });
     }
     /**
+     * Use this method to retrieve a user token by specifying a username and realmId.  Permissions required: Edit System Configuration and Users
      */
     getUserTokenByUsernameAndRealmId(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -141,6 +149,7 @@ class UserTokensApi extends runtime.BaseAPI {
         });
     }
     /**
+     * Use this method to check if a user token has been issued to the logged in user.  Permissions required: None
      */
     getUserTokenExistsForCurrentUserRaw(initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -159,6 +168,7 @@ class UserTokensApi extends runtime.BaseAPI {
         });
     }
     /**
+     * Use this method to check if a user token has been issued to the logged in user.  Permissions required: None
      */
     getUserTokenExistsForCurrentUser(initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -167,6 +177,7 @@ class UserTokensApi extends runtime.BaseAPI {
         });
     }
     /**
+     * Use this method to retrieve user tokens created within a date range, in the supported IQ Server realms.  Permissions required: Edit System Configuration and Users.
      */
     getUserTokensByCreatedBetweenAndRealmIdRaw(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -194,6 +205,7 @@ class UserTokensApi extends runtime.BaseAPI {
         });
     }
     /**
+     * Use this method to retrieve user tokens created within a date range, in the supported IQ Server realms.  Permissions required: Edit System Configuration and Users.
      */
     getUserTokensByCreatedBetweenAndRealmId() {
         return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
@@ -202,6 +214,7 @@ class UserTokensApi extends runtime.BaseAPI {
         });
     }
     /**
+     * Use this method to delete all existing LDAP user tokens.  Permissions required: Edit System Configuration and Users
      */
     purgeUserTokensRaw(initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -220,6 +233,7 @@ class UserTokensApi extends runtime.BaseAPI {
         });
     }
     /**
+     * Use this method to delete all existing LDAP user tokens.  Permissions required: Edit System Configuration and Users
      */
     purgeUserTokens(initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {

package/dist/apis/UsersApi.d.ts

@@ -2,7 +2,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).
@@ -37,61 +37,66 @@ export interface UpdateRequest {
  */
 export interface UsersApiInterface {
     /**
-     *
-     * @param {ApiUserDTO} [apiUserDTO]
+     * Use this method to create a new user.  Permissions required: Edit System Configuration and Users
+     * @param {ApiUserDTO} [apiUserDTO] Specify the user details for the new user to be created. All fields except `realm` are required.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof UsersApiInterface
      */
     addRaw(requestParameters: AddRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
+     * Use this method to create a new user.  Permissions required: Edit System Configuration and Users
      */
     add(requestParameters: AddRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
-     *
-     * @param {string} username
-     * @param {string} [realm]
+     * Use this method to delete an existing user.  Permissions required: Edit System Configuration and Users
+     * @param {string} username Enter the username to be deleted.
+     * @param {string} [realm] Enter the &#x60;realm&#x60;. Allowed values are &#x60;Internal&#x60;,&#x60;OAUTH2&#x60;, and &#x60;SAML&#x60;.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof UsersApiInterface
      */
     delete1Raw(requestParameters: Delete1Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
+     * Use this method to delete an existing user.  Permissions required: Edit System Configuration and Users
      */
     delete1(requestParameters: Delete1Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
-     *
-     * @param {string} username
-     * @param {string} [realm]
+     * Use this method to retrieve user details for the specified user.  Permissions required: Edit System Configuration and Users
+     * @param {string} username Enter the username.
+     * @param {string} [realm] Enter the &#x60;realm&#x60;. Allowed values are &#x60;Internal&#x60;,&#x60;OAUTH2&#x60;, and &#x60;SAML&#x60;.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof UsersApiInterface
      */
     get1Raw(requestParameters: Get1Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiUserDTO>>;
     /**
+     * Use this method to retrieve user details for the specified user.  Permissions required: Edit System Configuration and Users
      */
     get1(requestParameters: Get1Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiUserDTO>;
     /**
-     *
-     * @param {string} [realm]
+     * Use this method to retrieve user details for all users.  Permissions required: Edit System Configuration and Users
+     * @param {string} [realm] Enter the &#x60;realm&#x60;. Allowed values are &#x60;Internal&#x60;,&#x60;OAUTH2&#x60;, and &#x60;SAML&#x60;.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof UsersApiInterface
      */
     getAll2Raw(requestParameters: GetAll2Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiUserListDTO>>;
     /**
+     * Use this method to retrieve user details for all users.  Permissions required: Edit System Configuration and Users
      */
     getAll2(requestParameters: GetAll2Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiUserListDTO>;
     /**
-     *
-     * @param {string} username
-     * @param {ApiUserDTO} [apiUserDTO]
+     * Use this method to update user details for an existing internal user, by specifying the username.  Permissions required: Edit System Configuration and Users
+     * @param {string} username Enter the username.
+     * @param {ApiUserDTO} [apiUserDTO] Specify the user details to be updated. Any unspecified field will remain unchanged. Username, password, and realm cannot be updated.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof UsersApiInterface
      */
     updateRaw(requestParameters: UpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiUserDTO>>;
     /**
+     * Use this method to update user details for an existing internal user, by specifying the username.  Permissions required: Edit System Configuration and Users
      */
     update(requestParameters: UpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiUserDTO>;
 }
@@ -100,33 +105,43 @@ export interface UsersApiInterface {
  */
 export declare class UsersApi extends runtime.BaseAPI implements UsersApiInterface {
     /**
+     * Use this method to create a new user.  Permissions required: Edit System Configuration and Users
      */
     addRaw(requestParameters: AddRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
+     * Use this method to create a new user.  Permissions required: Edit System Configuration and Users
      */
     add(requestParameters?: AddRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
+     * Use this method to delete an existing user.  Permissions required: Edit System Configuration and Users
      */
     delete1Raw(requestParameters: Delete1Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
+     * Use this method to delete an existing user.  Permissions required: Edit System Configuration and Users
      */
     delete1(requestParameters: Delete1Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
+     * Use this method to retrieve user details for the specified user.  Permissions required: Edit System Configuration and Users
      */
     get1Raw(requestParameters: Get1Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiUserDTO>>;
     /**
+     * Use this method to retrieve user details for the specified user.  Permissions required: Edit System Configuration and Users
      */
     get1(requestParameters: Get1Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiUserDTO>;
     /**
+     * Use this method to retrieve user details for all users.  Permissions required: Edit System Configuration and Users
      */
     getAll2Raw(requestParameters: GetAll2Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiUserListDTO>>;
     /**
+     * Use this method to retrieve user details for all users.  Permissions required: Edit System Configuration and Users
      */
     getAll2(requestParameters?: GetAll2Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiUserListDTO>;
     /**
+     * Use this method to update user details for an existing internal user, by specifying the username.  Permissions required: Edit System Configuration and Users
      */
     updateRaw(requestParameters: UpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiUserDTO>>;
     /**
+     * Use this method to update user details for an existing internal user, by specifying the username.  Permissions required: Edit System Configuration and Users
      */
     update(requestParameters: UpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiUserDTO>;
 }

package/dist/apis/UsersApi.js

@@ -5,7 +5,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).
@@ -30,6 +30,7 @@ const index_1 = require("../models/index");
  */
 class UsersApi extends runtime.BaseAPI {
     /**
+     * Use this method to create a new user.  Permissions required: Edit System Configuration and Users
      */
     addRaw(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -50,6 +51,7 @@ class UsersApi extends runtime.BaseAPI {
         });
     }
     /**
+     * Use this method to create a new user.  Permissions required: Edit System Configuration and Users
      */
     add() {
         return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
@@ -57,6 +59,7 @@ class UsersApi extends runtime.BaseAPI {
         });
     }
     /**
+     * Use this method to delete an existing user.  Permissions required: Edit System Configuration and Users
      */
     delete1Raw(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -81,6 +84,7 @@ class UsersApi extends runtime.BaseAPI {
         });
     }
     /**
+     * Use this method to delete an existing user.  Permissions required: Edit System Configuration and Users
      */
     delete1(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -88,6 +92,7 @@ class UsersApi extends runtime.BaseAPI {
         });
     }
     /**
+     * Use this method to retrieve user details for the specified user.  Permissions required: Edit System Configuration and Users
      */
     get1Raw(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -112,6 +117,7 @@ class UsersApi extends runtime.BaseAPI {
         });
     }
     /**
+     * Use this method to retrieve user details for the specified user.  Permissions required: Edit System Configuration and Users
      */
     get1(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -120,6 +126,7 @@ class UsersApi extends runtime.BaseAPI {
         });
     }
     /**
+     * Use this method to retrieve user details for all users.  Permissions required: Edit System Configuration and Users
      */
     getAll2Raw(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -141,6 +148,7 @@ class UsersApi extends runtime.BaseAPI {
         });
     }
     /**
+     * Use this method to retrieve user details for all users.  Permissions required: Edit System Configuration and Users
      */
     getAll2() {
         return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
@@ -149,6 +157,7 @@ class UsersApi extends runtime.BaseAPI {
         });
     }
     /**
+     * Use this method to update user details for an existing internal user, by specifying the username.  Permissions required: Edit System Configuration and Users
      */
     updateRaw(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -172,6 +181,7 @@ class UsersApi extends runtime.BaseAPI {
         });
     }
     /**
+     * Use this method to update user details for an existing internal user, by specifying the username.  Permissions required: Edit System Configuration and Users
      */
     update(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {

package/dist/apis/VulnerabilityDetailsApi.d.ts

@@ -0,0 +1,71 @@
+/**
+ * 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.192.0-01
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import * as runtime from '../runtime';
+import type { ComponentIdentifier, SecurityVulnerabilityDataDTO } from '../models/index';
+export interface GetSecurityVulnerabilityDetailsRequest {
+    refId: string;
+    componentIdentifier?: ComponentIdentifier;
+    identificationSource?: string;
+    scanId?: string;
+    ownerType?: GetSecurityVulnerabilityDetailsOwnerTypeEnum;
+    ownerId?: string;
+}
+/**
+ * VulnerabilityDetailsApi - interface
+ *
+ * @export
+ * @interface VulnerabilityDetailsApiInterface
+ */
+export interface VulnerabilityDetailsApiInterface {
+    /**
+     * Use this method to retrieve details for a vulnerability using authenticated or non-authenticated requests. A non-authenticated request will retrieve limited details for the vulnerability.  Permissions required: View IQ Elements
+     * @param {string} refId Enter the vulnerability identifier (CVE ID or Sonatype Vulnerability Identifier)
+     * @param {ComponentIdentifier} [componentIdentifier] Enter the component identifier.
+     * @param {string} [identificationSource] Enter the name of the identification source (third-party) for this vulnerability. The response will retrieve vulnerability data from this third-party data source.
+     * @param {string} [scanId] Enter the scanId where the vulnerability was detected. The response will retrieve vulnerability data from the third-party data source and not HDS.
+     * @param {'application' | 'organization' | 'repository_container' | 'repository_manager' | 'repository' | 'global'} [ownerType] Enter the value for ownerType where this vulnerability was detected. The response will retrieve the vulnerability data from the third-party data source and not HDS.
+     * @param {string} [ownerId] Enter the ownerId where this vulnerability was detected. The response will retrieve data from the third-party data source and not HDS.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof VulnerabilityDetailsApiInterface
+     */
+    getSecurityVulnerabilityDetailsRaw(requestParameters: GetSecurityVulnerabilityDetailsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SecurityVulnerabilityDataDTO>>;
+    /**
+     * Use this method to retrieve details for a vulnerability using authenticated or non-authenticated requests. A non-authenticated request will retrieve limited details for the vulnerability.  Permissions required: View IQ Elements
+     */
+    getSecurityVulnerabilityDetails(requestParameters: GetSecurityVulnerabilityDetailsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SecurityVulnerabilityDataDTO>;
+}
+/**
+ *
+ */
+export declare class VulnerabilityDetailsApi extends runtime.BaseAPI implements VulnerabilityDetailsApiInterface {
+    /**
+     * Use this method to retrieve details for a vulnerability using authenticated or non-authenticated requests. A non-authenticated request will retrieve limited details for the vulnerability.  Permissions required: View IQ Elements
+     */
+    getSecurityVulnerabilityDetailsRaw(requestParameters: GetSecurityVulnerabilityDetailsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SecurityVulnerabilityDataDTO>>;
+    /**
+     * Use this method to retrieve details for a vulnerability using authenticated or non-authenticated requests. A non-authenticated request will retrieve limited details for the vulnerability.  Permissions required: View IQ Elements
+     */
+    getSecurityVulnerabilityDetails(requestParameters: GetSecurityVulnerabilityDetailsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SecurityVulnerabilityDataDTO>;
+}
+/**
+ * @export
+ */
+export declare const GetSecurityVulnerabilityDetailsOwnerTypeEnum: {
+    readonly Application: "application";
+    readonly Organization: "organization";
+    readonly RepositoryContainer: "repository_container";
+    readonly RepositoryManager: "repository_manager";
+    readonly Repository: "repository";
+    readonly Global: "global";
+};
+export type GetSecurityVulnerabilityDetailsOwnerTypeEnum = typeof GetSecurityVulnerabilityDetailsOwnerTypeEnum[keyof typeof GetSecurityVulnerabilityDetailsOwnerTypeEnum];

package/dist/apis/{VulnerabilitiesApi.js → VulnerabilityDetailsApi.js}

@@ -5,7 +5,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).
@@ -22,14 +22,15 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.GetSecurityVulnerabilityDetailsOwnerTypeEnum = exports.VulnerabilitiesApi = void 0;
+exports.GetSecurityVulnerabilityDetailsOwnerTypeEnum = exports.VulnerabilityDetailsApi = void 0;
 const runtime = require("../runtime");
 const index_1 = require("../models/index");
 /**
  *
  */
-class VulnerabilitiesApi extends runtime.BaseAPI {
+class VulnerabilityDetailsApi extends runtime.BaseAPI {
     /**
+     * Use this method to retrieve details for a vulnerability using authenticated or non-authenticated requests. A non-authenticated request will retrieve limited details for the vulnerability.  Permissions required: View IQ Elements
      */
     getSecurityVulnerabilityDetailsRaw(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -62,10 +63,11 @@ class VulnerabilitiesApi extends runtime.BaseAPI {
                 headers: headerParameters,
                 query: queryParameters,
             }, initOverrides);
-            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.SecurityVulnerabilityDataFromJSON)(jsonValue));
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.SecurityVulnerabilityDataDTOFromJSON)(jsonValue));
         });
     }
     /**
+     * Use this method to retrieve details for a vulnerability using authenticated or non-authenticated requests. A non-authenticated request will retrieve limited details for the vulnerability.  Permissions required: View IQ Elements
      */
     getSecurityVulnerabilityDetails(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -74,7 +76,7 @@ class VulnerabilitiesApi extends runtime.BaseAPI {
         });
     }
 }
-exports.VulnerabilitiesApi = VulnerabilitiesApi;
+exports.VulnerabilityDetailsApi = VulnerabilityDetailsApi;
 /**
  * @export
  */