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

package/dist/esm/apis/SourceControlApi.js

@@ -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).
@@ -21,7 +21,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import * as runtime from '../runtime';
-import { ApiSourceControlDTOFromJSON, ApiSourceControlDTOToJSON, } from '../models/index';
+import { ApiSourceControlDTOFromJSON, ApiSourceControlDTOToJSON, SCMUserMappingsDTOToJSON, SCMUserMappingsResponseDTOFromJSON, SCMUserMatchingResultDTOFromJSON, } from '../models/index';
 /**
  *
  */
@@ -63,7 +63,39 @@ export class SourceControlApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Use this method to automatically grant the \'developer\' role to all contributors of a repository on a given application.  Prerequisites for automatic role assignment are:<ol><li>SCM configuration for the application and authentication token should exist.</li><li>The contributors to the repository should have a matching username in IQ.</li></ol>  Permissions required: Edit access control on the application.
+     * Use this method to apply user mappings from SCM (GitHub) to Lifecycle. The user mappings will be inherited by all child organizations and applications in the organization hierarchy. If a user mapping for an organization already exists, it will be replaced with new mappings provided here.  Permissions required: Edit IQ Elements
+     */
+    addUserMappingsRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['organizationId'] == null) {
+                throw new runtime.RequiredError('organizationId', 'Required parameter "organizationId" was null or undefined when calling addUserMappings().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            if (this.configuration && (this.configuration.username !== undefined || this.configuration.password !== undefined)) {
+                headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password);
+            }
+            const response = yield this.request({
+                path: `/api/v2/sourceControl/automaticRoleAssignment/userMappings/{organizationId}`.replace(`{${"organizationId"}}`, encodeURIComponent(String(requestParameters['organizationId']))),
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: SCMUserMappingsDTOToJSON(requestParameters['sCMUserMappingsDTO']),
+            }, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Use this method to apply user mappings from SCM (GitHub) to Lifecycle. The user mappings will be inherited by all child organizations and applications in the organization hierarchy. If a user mapping for an organization already exists, it will be replaced with new mappings provided here.  Permissions required: Edit IQ Elements
+     */
+    addUserMappings(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.addUserMappingsRaw(requestParameters, initOverrides);
+        });
+    }
+    /**
+     * Use this method to automatically grant the supplied role to all contributors of a repository on a given application.  Prerequisites for automatic role assignment are:<ol><li>SCM configuration for the application and authentication token should exist.</li><li>The contributors to the repository should match a user in IQ based on the supplied mappings.</li><li>Either user mapping strategies have been configured for your organization, or they are provided in the request</li></ol>  Permissions required: Edit access control on the application.
      */
     automaticRoleAssignmentRaw(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -72,6 +104,7 @@ export class SourceControlApi extends runtime.BaseAPI {
             }
             const queryParameters = {};
             const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
             if (this.configuration && (this.configuration.username !== undefined || this.configuration.password !== undefined)) {
                 headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password);
             }
@@ -80,12 +113,13 @@ export class SourceControlApi extends runtime.BaseAPI {
                 method: 'POST',
                 headers: headerParameters,
                 query: queryParameters,
+                body: SCMUserMappingsDTOToJSON(requestParameters['sCMUserMappingsDTO']),
             }, initOverrides);
-            return new runtime.JSONApiResponse(response);
+            return new runtime.JSONApiResponse(response, (jsonValue) => SCMUserMatchingResultDTOFromJSON(jsonValue));
         });
     }
     /**
-     * Use this method to automatically grant the \'developer\' role to all contributors of a repository on a given application.  Prerequisites for automatic role assignment are:<ol><li>SCM configuration for the application and authentication token should exist.</li><li>The contributors to the repository should have a matching username in IQ.</li></ol>  Permissions required: Edit access control on the application.
+     * Use this method to automatically grant the supplied role to all contributors of a repository on a given application.  Prerequisites for automatic role assignment are:<ol><li>SCM configuration for the application and authentication token should exist.</li><li>The contributors to the repository should match a user in IQ based on the supplied mappings.</li><li>Either user mapping strategies have been configured for your organization, or they are provided in the request</li></ol>  Permissions required: Edit access control on the application.
      */
     automaticRoleAssignment(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -126,6 +160,36 @@ export class SourceControlApi extends runtime.BaseAPI {
             yield this.deleteSourceControlRaw(requestParameters, initOverrides);
         });
     }
+    /**
+     * Use this method to delete existing SCM user mappings for an organization.  Permissions required: Edit IQ Elements
+     */
+    deleteUserMappingsRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['organizationId'] == null) {
+                throw new runtime.RequiredError('organizationId', 'Required parameter "organizationId" was null or undefined when calling deleteUserMappings().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            if (this.configuration && (this.configuration.username !== undefined || this.configuration.password !== undefined)) {
+                headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password);
+            }
+            const response = yield this.request({
+                path: `/api/v2/sourceControl/automaticRoleAssignment/userMappings/{organizationId}`.replace(`{${"organizationId"}}`, encodeURIComponent(String(requestParameters['organizationId']))),
+                method: 'DELETE',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Use this method to delete existing SCM user mappings for an organization.  Permissions required: Edit IQ Elements
+     */
+    deleteUserMappings(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.deleteUserMappingsRaw(requestParameters, initOverrides);
+        });
+    }
     /**
      * Use this method to retrieve the source control configuration settings for an organization or an application.  Permissions required: View IQ Elements
      */
@@ -160,6 +224,40 @@ export class SourceControlApi extends runtime.BaseAPI {
             return yield response.value();
         });
     }
+    /**
+     * Use this method to retrieve SCM user mappings for an organization or application.  Permissions required: View IQ Elements
+     */
+    getUserMappingsByOwnerRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['ownerType'] == null) {
+                throw new runtime.RequiredError('ownerType', 'Required parameter "ownerType" was null or undefined when calling getUserMappingsByOwner().');
+            }
+            if (requestParameters['internalOwnerId'] == null) {
+                throw new runtime.RequiredError('internalOwnerId', 'Required parameter "internalOwnerId" was null or undefined when calling getUserMappingsByOwner().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            if (this.configuration && (this.configuration.username !== undefined || this.configuration.password !== undefined)) {
+                headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password);
+            }
+            const response = yield this.request({
+                path: `/api/v2/sourceControl/automaticRoleAssignment/userMappings/{ownerType}/{internalOwnerId}`.replace(`{${"ownerType"}}`, encodeURIComponent(String(requestParameters['ownerType']))).replace(`{${"internalOwnerId"}}`, encodeURIComponent(String(requestParameters['internalOwnerId']))),
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => SCMUserMappingsResponseDTOFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Use this method to retrieve SCM user mappings for an organization or application.  Permissions required: View IQ Elements
+     */
+    getUserMappingsByOwner(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getUserMappingsByOwnerRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * Use this method to update an existing SCM setting.  Permissions required: Edit IQ Elements
      */
@@ -202,42 +300,33 @@ export class SourceControlApi extends runtime.BaseAPI {
  */
 export const AddSourceControlOwnerTypeEnum = {
     Application: 'application',
-    Organization: 'organization',
-    RepositoryContainer: 'repository_container',
-    RepositoryManager: 'repository_manager',
-    Repository: 'repository',
-    Global: 'global'
+    Organization: 'organization'
 };
 /**
  * @export
  */
 export const DeleteSourceControlOwnerTypeEnum = {
     Application: 'application',
-    Organization: 'organization',
-    RepositoryContainer: 'repository_container',
-    RepositoryManager: 'repository_manager',
-    Repository: 'repository',
-    Global: 'global'
+    Organization: 'organization'
 };
 /**
  * @export
  */
 export const GetSourceControl1OwnerTypeEnum = {
     Application: 'application',
-    Organization: 'organization',
-    RepositoryContainer: 'repository_container',
-    RepositoryManager: 'repository_manager',
-    Repository: 'repository',
-    Global: 'global'
+    Organization: 'organization'
+};
+/**
+ * @export
+ */
+export const GetUserMappingsByOwnerOwnerTypeEnum = {
+    Application: 'application',
+    Organization: 'organization'
 };
 /**
  * @export
  */
 export const UpdateSourceControlOwnerTypeEnum = {
     Application: 'application',
-    Organization: 'organization',
-    RepositoryContainer: 'repository_container',
-    RepositoryManager: 'repository_manager',
-    Repository: 'repository',
-    Global: 'global'
+    Organization: 'organization'
 };

package/dist/esm/apis/SourceControlMetricsApi.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).
@@ -23,15 +23,16 @@ export interface GetSourceControlRequest {
  */
 export interface SourceControlMetricsApiInterface {
     /**
-     *
-     * @param {'application' | 'organization' | 'repository_container' | 'repository_manager' | 'repository' | 'global'} ownerType
-     * @param {string} internalOwnerId
+     * Use this method to view the source control pull request metrics.  Permissions required: View IQ Elements
+     * @param {'application' | 'organization'} ownerType Select the ownerType for the pull requests.
+     * @param {string} internalOwnerId Enter the ownerId corresponding to the ownerType.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof SourceControlMetricsApiInterface
      */
     getSourceControlRaw(requestParameters: GetSourceControlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiPullRequestResults>>;
     /**
+     * Use this method to view the source control pull request metrics.  Permissions required: View IQ Elements
      */
     getSourceControl(requestParameters: GetSourceControlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiPullRequestResults>;
 }
@@ -40,9 +41,11 @@ export interface SourceControlMetricsApiInterface {
  */
 export declare class SourceControlMetricsApi extends runtime.BaseAPI implements SourceControlMetricsApiInterface {
     /**
+     * Use this method to view the source control pull request metrics.  Permissions required: View IQ Elements
      */
     getSourceControlRaw(requestParameters: GetSourceControlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiPullRequestResults>>;
     /**
+     * Use this method to view the source control pull request metrics.  Permissions required: View IQ Elements
      */
     getSourceControl(requestParameters: GetSourceControlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiPullRequestResults>;
 }
@@ -52,9 +55,5 @@ export declare class SourceControlMetricsApi extends runtime.BaseAPI implements
 export declare const GetSourceControlOwnerTypeEnum: {
     readonly Application: "application";
     readonly Organization: "organization";
-    readonly RepositoryContainer: "repository_container";
-    readonly RepositoryManager: "repository_manager";
-    readonly Repository: "repository";
-    readonly Global: "global";
 };
 export type GetSourceControlOwnerTypeEnum = typeof GetSourceControlOwnerTypeEnum[keyof typeof GetSourceControlOwnerTypeEnum];

package/dist/esm/apis/SourceControlMetricsApi.js

@@ -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).
@@ -27,6 +27,7 @@ import { ApiPullRequestResultsFromJSON, } from '../models/index';
  */
 export class SourceControlMetricsApi extends runtime.BaseAPI {
     /**
+     * Use this method to view the source control pull request metrics.  Permissions required: View IQ Elements
      */
     getSourceControlRaw(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -51,6 +52,7 @@ export class SourceControlMetricsApi extends runtime.BaseAPI {
         });
     }
     /**
+     * Use this method to view the source control pull request metrics.  Permissions required: View IQ Elements
      */
     getSourceControl(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -64,9 +66,5 @@ export class SourceControlMetricsApi extends runtime.BaseAPI {
  */
 export const GetSourceControlOwnerTypeEnum = {
     Application: 'application',
-    Organization: 'organization',
-    RepositoryContainer: 'repository_container',
-    RepositoryManager: 'repository_manager',
-    Repository: 'repository',
-    Global: 'global'
+    Organization: 'organization'
 };

package/dist/esm/apis/TelemetryApi.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).

package/dist/esm/apis/TelemetryApi.js

@@ -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).

package/dist/esm/apis/ThirdPartyAnalysisApi.d.ts

@@ -0,0 +1,80 @@
+/**
+ * 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 { ApiThirdPartyScanResultDTO, ApiThirdPartyScanTicketDTO } from '../models/index';
+export interface GetScanStatusRequest {
+    applicationId: string;
+    scanRequestId: string;
+}
+export interface ScanComponentsRequest {
+    applicationId: string;
+    source: string;
+    stageId?: string;
+    body?: string;
+}
+/**
+ * ThirdPartyAnalysisApi - interface
+ *
+ * @export
+ * @interface ThirdPartyAnalysisApiInterface
+ */
+export interface ThirdPartyAnalysisApiInterface {
+    /**
+     * SBOM evaluation is an asynchronous operation. Use this method to check on the status of the SBOM evaluation.  Permissions required: Evaluate Applications
+     * @param {string} applicationId Enter the application internal id for the SBOM to be evaluated.
+     * @param {string} scanRequestId Enter the statusId from the statusUrl generated as a response to the POST request to perform the evaluation.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ThirdPartyAnalysisApiInterface
+     */
+    getScanStatusRaw(requestParameters: GetScanStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiThirdPartyScanResultDTO>>;
+    /**
+     * SBOM evaluation is an asynchronous operation. Use this method to check on the status of the SBOM evaluation.  Permissions required: Evaluate Applications
+     */
+    getScanStatus(requestParameters: GetScanStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiThirdPartyScanResultDTO>;
+    /**
+     * Use this method to perform an analysis of an SBOM.  Permissions required: Evaluate Applications
+     * @param {string} applicationId Enter the application internal id. Use the Applications REST API to retrieve theapplication internal id.
+     * @param {string} source Specify the specification name of the SBOM to be evaluated. Allowed values are &#x60;cyclonedx&#x60; and &#x60;spdx&#x60;
+     * @param {string} [stageId] Enter the stageId to run the evaluation for. The policy actions will be determined by the stage selected. Allowed values are &#x60;develop&#x60;, &#x60;build&#x60;, &#x60;stage-release&#x60;, &#x60;release&#x60; and &#x60;operate&#x60;
+     * @param {string} [body] Select the request header content-type from the dropdown, depending on whether the SBOM is in XML or JSON format.  Embed the contents of the SBOM here or enter the file path for the SBOM. A component in the SBOM can be identified by: &lt;ol&gt;&lt;li&gt;packageUrl&lt;/li&gt;&lt;li&gt;Component hash&lt;/li&gt;&lt;li&gt;Component name and version&lt;/li&gt;&lt;/ol&gt;  Any SPE and SWID tags for the component will be preserved in the evaluation report.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ThirdPartyAnalysisApiInterface
+     */
+    scanComponentsRaw(requestParameters: ScanComponentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiThirdPartyScanTicketDTO>>;
+    /**
+     * Use this method to perform an analysis of an SBOM.  Permissions required: Evaluate Applications
+     */
+    scanComponents(requestParameters: ScanComponentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiThirdPartyScanTicketDTO>;
+}
+/**
+ *
+ */
+export declare class ThirdPartyAnalysisApi extends runtime.BaseAPI implements ThirdPartyAnalysisApiInterface {
+    /**
+     * SBOM evaluation is an asynchronous operation. Use this method to check on the status of the SBOM evaluation.  Permissions required: Evaluate Applications
+     */
+    getScanStatusRaw(requestParameters: GetScanStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiThirdPartyScanResultDTO>>;
+    /**
+     * SBOM evaluation is an asynchronous operation. Use this method to check on the status of the SBOM evaluation.  Permissions required: Evaluate Applications
+     */
+    getScanStatus(requestParameters: GetScanStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiThirdPartyScanResultDTO>;
+    /**
+     * Use this method to perform an analysis of an SBOM.  Permissions required: Evaluate Applications
+     */
+    scanComponentsRaw(requestParameters: ScanComponentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiThirdPartyScanTicketDTO>>;
+    /**
+     * Use this method to perform an analysis of an SBOM.  Permissions required: Evaluate Applications
+     */
+    scanComponents(requestParameters: ScanComponentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiThirdPartyScanTicketDTO>;
+}

package/dist/esm/apis/{ScanApi.js → ThirdPartyAnalysisApi.js}

@@ -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).
@@ -21,41 +21,13 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import * as runtime from '../runtime';
-import { ApiThirdPartyScanResultDTOFromJSON, ApiThirdPartyScanTicketDTOFromJSON, IdeUsersOverviewDTOFromJSON, } from '../models/index';
+import { ApiThirdPartyScanResultDTOFromJSON, ApiThirdPartyScanTicketDTOFromJSON, } from '../models/index';
 /**
  *
  */
-export class ScanApi extends runtime.BaseAPI {
-    /**
-     */
-    getIdeUsersOverviewRaw(requestParameters, initOverrides) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const queryParameters = {};
-            if (requestParameters['sinceUtcTimestamp'] != null) {
-                queryParameters['sinceUtcTimestamp'] = requestParameters['sinceUtcTimestamp'];
-            }
-            const headerParameters = {};
-            if (this.configuration && (this.configuration.username !== undefined || this.configuration.password !== undefined)) {
-                headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password);
-            }
-            const response = yield this.request({
-                path: `/api/v2/scan/applications/ideUser/overview`,
-                method: 'GET',
-                headers: headerParameters,
-                query: queryParameters,
-            }, initOverrides);
-            return new runtime.JSONApiResponse(response, (jsonValue) => IdeUsersOverviewDTOFromJSON(jsonValue));
-        });
-    }
-    /**
-     */
-    getIdeUsersOverview() {
-        return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
-            const response = yield this.getIdeUsersOverviewRaw(requestParameters, initOverrides);
-            return yield response.value();
-        });
-    }
+export class ThirdPartyAnalysisApi extends runtime.BaseAPI {
     /**
+     * SBOM evaluation is an asynchronous operation. Use this method to check on the status of the SBOM evaluation.  Permissions required: Evaluate Applications
      */
     getScanStatusRaw(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -80,6 +52,7 @@ export class ScanApi extends runtime.BaseAPI {
         });
     }
     /**
+     * SBOM evaluation is an asynchronous operation. Use this method to check on the status of the SBOM evaluation.  Permissions required: Evaluate Applications
      */
     getScanStatus(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -88,6 +61,7 @@ export class ScanApi extends runtime.BaseAPI {
         });
     }
     /**
+     * Use this method to perform an analysis of an SBOM.  Permissions required: Evaluate Applications
      */
     scanComponentsRaw(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -117,6 +91,7 @@ export class ScanApi extends runtime.BaseAPI {
         });
     }
     /**
+     * Use this method to perform an analysis of an SBOM.  Permissions required: Evaluate Applications
      */
     scanComponents(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {

package/dist/esm/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>;
 }