npm - @sonatype/nexus-iq-api-client - Versions diffs - 0.184.3 → 0.192.0 - Mend

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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (1602) hide show

package/src/apis/SourceControlApi.ts CHANGED Viewed

@@ -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).
@@ -16,10 +16,19 @@
 import * as runtime from '../runtime';
 import type {
   ApiSourceControlDTO,
+  SCMUserMappingsDTO,
+  SCMUserMappingsResponseDTO,
+  SCMUserMatchingResultDTO,
 } from '../models/index';
 import {
     ApiSourceControlDTOFromJSON,
     ApiSourceControlDTOToJSON,
+    SCMUserMappingsDTOFromJSON,
+    SCMUserMappingsDTOToJSON,
+    SCMUserMappingsResponseDTOFromJSON,
+    SCMUserMappingsResponseDTOToJSON,
+    SCMUserMatchingResultDTOFromJSON,
+    SCMUserMatchingResultDTOToJSON,
 } from '../models/index';
 export interface AddSourceControlRequest {
@@ -28,8 +37,14 @@ export interface AddSourceControlRequest {
     apiSourceControlDTO?: ApiSourceControlDTO;
 }
+export interface AddUserMappingsRequest {
+    organizationId: string;
+    sCMUserMappingsDTO?: SCMUserMappingsDTO;
+}
 export interface AutomaticRoleAssignmentRequest {
     publicId: string;
+    sCMUserMappingsDTO?: SCMUserMappingsDTO;
 }
 export interface DeleteSourceControlRequest {
@@ -37,11 +52,20 @@ export interface DeleteSourceControlRequest {
     internalOwnerId: string;
 }
+export interface DeleteUserMappingsRequest {
+    organizationId: string;
+}
 export interface GetSourceControl1Request {
     ownerType: GetSourceControl1OwnerTypeEnum;
     internalOwnerId: string;
 }
+export interface GetUserMappingsByOwnerRequest {
+    ownerType: GetUserMappingsByOwnerOwnerTypeEnum;
+    internalOwnerId: string;
+}
 export interface UpdateSourceControlRequest {
     ownerType: UpdateSourceControlOwnerTypeEnum;
     internalOwnerId: string;
@@ -57,7 +81,7 @@ export interface UpdateSourceControlRequest {
 export interface SourceControlApiInterface {
     /**
      * Use this method to create a source control configuration setting.  Permissions required: Edit IQ Elements
-     * @param {'application' | 'organization' | 'repository_container' | 'repository_manager' | 'repository' | 'global'} ownerType Enter the value for ownerType.
+     * @param {'application' | 'organization'} ownerType Enter the value for ownerType.
      * @param {string} internalOwnerId Enter the value for internal ownerId. Use ROOT_ORGANIZATION_ID for root organization.
      * @param {ApiSourceControlDTO} [apiSourceControlDTO] Specify the SCM settings for the ownerId specified above in the request JSON.&lt;ul&gt;&lt;li&gt;&lt;code&gt;id&lt;/code&gt; is the internal owner ID.&lt;/li&gt;&lt;li&gt;&lt;code&gt;repositoryUrl&lt;/code&gt; is the http(s) and ssh urls for the application specified in the ownerId.&lt;/li&gt;&lt;li&gt;&lt;code&gt;username&lt;/code&gt; is optional, can be provided for Bitbucket Server and Cloud.&lt;/li&gt;&lt;li&gt;&lt;code&gt;token&lt;/code&gt; is optional,if inherited. If provided, this value will override the value inherited from the root organization, organization or application level.&lt;li&gt;&lt;code&gt;provider&lt;/code&gt; is the name of of the SCM system. Allowed values are &lt;code&gt;azure&lt;/code&gt;, &lt;code&gt;github&lt;/code&gt;, &lt;code&gt;gitlab&lt;/code&gt;, and &lt;code&gt;bitbucket&lt;/code&gt;.&lt;/li&gt;&lt;li&gt;&lt;code&gt;baseBranch&lt;/code&gt; is required for the root organization. Organizations and applications inherit from the root unless overridden.&lt;/li&gt;&lt;li&gt;&lt;code&gt;enablePullRequests&lt;/code&gt; has been deprecated in version 124.&lt;/li&gt;&lt;li&gt;&lt;code&gt;remediationPullRequestsEnabled&lt;/code&gt; is optional. Set it to &#x60;true&#x60; to enable the Automated Pull Requests.&lt;/li&gt;&lt;li&gt;&lt;code&gt;enableStatusChecks&lt;/code&gt; has been deprecated in version 124.&lt;/li&gt;&lt;li&gt;&lt;code&gt;statusChecksEnabled&lt;/code&gt; is an internal field.&lt;/li&gt;&lt;li&gt;&lt;code&gt;pullRequestCommentingEnabled&lt;/code&gt; is optional. Set it to &#x60;true&#x60; to enable the  Pull Request Commenting feature.&lt;/li&gt;&lt;li&gt;&lt;code&gt;sourceControlEvaluationsEnabled&lt;/code&gt; is set to &#x60;true&#x60; to enable source control evaluations for the continuous risk profile feature.&lt;/li&gt;&lt;li&gt;&lt;code&gt;sourceControlScanTarget&lt;/code&gt; is the path inside the repository.&lt;/li&gt;&lt;li&gt;&lt;code&gt;sshEnabled&lt;/code&gt; is set to &#x60;true&#x60; to enable ssh.&lt;/li&gt;&lt;li&gt;&lt;code&gt;commitStatusEnabled&lt;/code&gt; is set to &#x60;true&#x60; if interaction with the commit statuses on the SCM is enabled.&lt;/li&gt;&lt;/ul&gt;
      * @param {*} [options] Override http request option.
@@ -72,22 +96,38 @@ export interface SourceControlApiInterface {
     addSourceControl(requestParameters: AddSourceControlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiSourceControlDTO>;
     /**
-     * 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
+     * @param {string} organizationId Enter the organizationId. Use &#x60;ROOT_ORGANIZATION_ID&#x60; for the root organization
+     * @param {SCMUserMappingsDTO} [sCMUserMappingsDTO] &lt;ul&gt;&lt;li&gt;Specify the &#x60;role&#x60; in lowercase, without whitespaces.&lt;/li&gt;&lt;li&gt;&#x60;mappings&#x60; is an array of objects consisting of &#x60;from&#x60; and &#x60;to&#x60; fields.&lt;/li&gt;&lt;li&gt;Allowed values for the &#x60;from&#x60; field are &#x60;SCM_USERNAME&#x60;, &#x60;SCM_EMAIL&#x60;, &#x60;SCM_FULLNAME&#x60;, &#x60;GITLOG_EMAIL&#x60;, &#x60;GITLOG_FULLNAME&#x60;.&lt;/li&gt;&lt;li&gt;Allowed values for &#x60;to&#x60; field are &#x60;IQ_USERNAME&#x60;, &#x60;IQ_EMAIL&#x60;, &#x60;IQ_FULLNAME&#x60;.&lt;/li&gt;&lt;li&gt;Any combination of &#x60;from&#x60; and &#x60;to&#x60; fields can be used.&lt;/li&gt;&lt;/ul&gt;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SourceControlApiInterface
+     */
+    addUserMappingsRaw(requestParameters: AddUserMappingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * 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: AddUserMappingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * 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.
      * @param {string} publicId Enter the public applicationId for automatic role assignment.
+     * @param {SCMUserMappingsDTO} [sCMUserMappingsDTO]
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof SourceControlApiInterface
      */
-    automaticRoleAssignmentRaw(requestParameters: AutomaticRoleAssignmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Set<string>>>;
+    automaticRoleAssignmentRaw(requestParameters: AutomaticRoleAssignmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SCMUserMatchingResultDTO>>;
     /**
-     * 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: AutomaticRoleAssignmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Set<string>>;
+    automaticRoleAssignment(requestParameters: AutomaticRoleAssignmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SCMUserMatchingResultDTO>;
     /**
      * Use this method to delete a SCM setting for the specified ownerType/ownerId.  Permissions required: Edit IQ Elements
-     * @param {'application' | 'organization' | 'repository_container' | 'repository_manager' | 'repository' | 'global'} ownerType Enter the value for ownerType.
+     * @param {'application' | 'organization'} ownerType Enter the value for ownerType.
      * @param {string} internalOwnerId Enter the value for internal ownerId.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -100,9 +140,23 @@ export interface SourceControlApiInterface {
      */
     deleteSourceControl(requestParameters: DeleteSourceControlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Use this method to delete existing SCM user mappings for an organization.  Permissions required: Edit IQ Elements
+     * @param {string} organizationId Enter the organizationId.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SourceControlApiInterface
+     */
+    deleteUserMappingsRaw(requestParameters: DeleteUserMappingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Use this method to delete existing SCM user mappings for an organization.  Permissions required: Edit IQ Elements
+     */
+    deleteUserMappings(requestParameters: DeleteUserMappingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
      * Use this method to retrieve the source control configuration settings for an organization or an application.  Permissions required: View IQ Elements
-     * @param {'application' | 'organization' | 'repository_container' | 'repository_manager' | 'repository' | 'global'} ownerType Enter the value for ownerType.
+     * @param {'application' | 'organization'} ownerType Enter the value for ownerType.
      * @param {string} internalOwnerId Enter the value for internal ownerId. Use ROOT_ORGANIZATION_ID for the root organization
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -115,9 +169,24 @@ export interface SourceControlApiInterface {
      */
     getSourceControl1(requestParameters: GetSourceControl1Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiSourceControlDTO>;
+    /**
+     * Use this method to retrieve SCM user mappings for an organization or application.  Permissions required: View IQ Elements
+     * @param {'application' | 'organization'} ownerType Enter the value for ownerType.
+     * @param {string} internalOwnerId Enter the value for internal ownerId.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SourceControlApiInterface
+     */
+    getUserMappingsByOwnerRaw(requestParameters: GetUserMappingsByOwnerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SCMUserMappingsResponseDTO>>;
+    /**
+     * Use this method to retrieve SCM user mappings for an organization or application.  Permissions required: View IQ Elements
+     */
+    getUserMappingsByOwner(requestParameters: GetUserMappingsByOwnerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SCMUserMappingsResponseDTO>;
     /**
      * Use this method to update an existing SCM setting.  Permissions required: Edit IQ Elements
-     * @param {'application' | 'organization' | 'repository_container' | 'repository_manager' | 'repository' | 'global'} ownerType Enter the value for ownerType.
+     * @param {'application' | 'organization'} ownerType Enter the value for ownerType.
      * @param {string} internalOwnerId Enter the internal ownerId. Use ROOT_ORGANIZATION_ID for the root organization.
      * @param {ApiSourceControlDTO} [apiSourceControlDTO] Specify the SCM settings for the ownerId specified above in the request JSON.&lt;ul&gt;&lt;li&gt;&lt;code&gt;id&lt;/code&gt; is the internal owner ID.&lt;/li&gt;&lt;li&gt;&lt;code&gt;repositoryUrl&lt;/code&gt; is the http(s) and ssh urls for the application specified in the ownerId.&lt;/li&gt;&lt;li&gt;&lt;code&gt;username&lt;/code&gt; is optional, can be provided for Bitbucket Server and Cloud.&lt;/li&gt;&lt;li&gt;&lt;code&gt;token&lt;/code&gt; is optional if inherited. If provided, this value will override the value inherited from the root organization, organization or application level.&lt;li&gt;&lt;code&gt;provider&lt;/code&gt; is the name of of the SCM system. Allowed values are &lt;code&gt;azure&lt;/code&gt;, &lt;code&gt;github&lt;/code&gt;, &lt;code&gt;gitlab&lt;/code&gt;, and &lt;code&gt;bitbucket&lt;/code&gt;.&lt;/li&gt;&lt;li&gt;&lt;code&gt;baseBranch&lt;/code&gt; is required for the root organization. Organizations and applications inherit from the root unless overridden.&lt;/li&gt;&lt;li&gt;&lt;code&gt;enablePullRequests&lt;/code&gt; has been deprecated in version 124.&lt;/li&gt;&lt;li&gt;&lt;code&gt;remediationPullRequestsEnabled&lt;/code&gt; is optional. Set it to &#x60;true&#x60; to enable the Automated Pull Requests.&lt;/li&gt;&lt;li&gt;&lt;code&gt;enableStatusChecks&lt;/code&gt; has been deprecated in version 124.&lt;/li&gt;&lt;li&gt;&lt;code&gt;statusChecksEnabled&lt;/code&gt; is an internal field.&lt;/li&gt;&lt;li&gt;&lt;code&gt;pullRequestCommentingEnabled&lt;/code&gt; is optional. Set it to &#x60;true&#x60; to enable the  Pull Request Commenting feature.&lt;/li&gt;&lt;li&gt;&lt;code&gt;sourceControlEvaluationsEnabled&lt;/code&gt; is set to &#x60;true&#x60; to enable source control evaluations for the continuous risk profile feature.&lt;/li&gt;&lt;li&gt;&lt;code&gt;sourceControlScanTarget&lt;/code&gt; is the path inside the repository.&lt;/li&gt;&lt;li&gt;&lt;code&gt;sshEnabled&lt;/code&gt; is set to &#x60;true&#x60; to enable ssh.&lt;/li&gt;&lt;li&gt;&lt;code&gt;commitStatusEnabled&lt;/code&gt; is set to &#x60;true&#x60; if interaction with the commit statuses on the SCM is enabled.&lt;/li&gt;&lt;/ul&gt;
      * @param {*} [options] Override http request option.
@@ -185,9 +254,47 @@ export class SourceControlApi extends runtime.BaseAPI implements SourceControlAp
     }
     /**
-     * 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
+     */
+    async addUserMappingsRaw(requestParameters: AddUserMappingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        if (requestParameters['organizationId'] == null) {
+            throw new runtime.RequiredError(
+                'organizationId',
+                'Required parameter "organizationId" was null or undefined when calling addUserMappings().'
+            );
+        }
+        const queryParameters: any = {};
+        const headerParameters: runtime.HTTPHeaders = {};
+        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 = await 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
+     */
+    async addUserMappings(requestParameters: AddUserMappingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await 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.
      */
-    async automaticRoleAssignmentRaw(requestParameters: AutomaticRoleAssignmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Set<string>>> {
+    async automaticRoleAssignmentRaw(requestParameters: AutomaticRoleAssignmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SCMUserMatchingResultDTO>> {
         if (requestParameters['publicId'] == null) {
             throw new runtime.RequiredError(
                 'publicId',
@@ -199,6 +306,8 @@ export class SourceControlApi extends runtime.BaseAPI implements SourceControlAp
         const headerParameters: runtime.HTTPHeaders = {};
+        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);
         }
@@ -207,15 +316,16 @@ export class SourceControlApi extends runtime.BaseAPI implements SourceControlAp
             method: 'POST',
             headers: headerParameters,
             query: queryParameters,
+            body: SCMUserMappingsDTOToJSON(requestParameters['sCMUserMappingsDTO']),
         }, initOverrides);
-        return new runtime.JSONApiResponse<any>(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.
      */
-    async automaticRoleAssignment(requestParameters: AutomaticRoleAssignmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Set<string>> {
+    async automaticRoleAssignment(requestParameters: AutomaticRoleAssignmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SCMUserMatchingResultDTO> {
         const response = await this.automaticRoleAssignmentRaw(requestParameters, initOverrides);
         return await response.value();
     }
@@ -262,6 +372,41 @@ export class SourceControlApi extends runtime.BaseAPI implements SourceControlAp
         await this.deleteSourceControlRaw(requestParameters, initOverrides);
     }
+    /**
+     * Use this method to delete existing SCM user mappings for an organization.  Permissions required: Edit IQ Elements
+     */
+    async deleteUserMappingsRaw(requestParameters: DeleteUserMappingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        if (requestParameters['organizationId'] == null) {
+            throw new runtime.RequiredError(
+                'organizationId',
+                'Required parameter "organizationId" was null or undefined when calling deleteUserMappings().'
+            );
+        }
+        const queryParameters: any = {};
+        const headerParameters: runtime.HTTPHeaders = {};
+        if (this.configuration && (this.configuration.username !== undefined || this.configuration.password !== undefined)) {
+            headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password);
+        }
+        const response = await 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
+     */
+    async deleteUserMappings(requestParameters: DeleteUserMappingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await 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
      */
@@ -305,6 +450,49 @@ export class SourceControlApi extends runtime.BaseAPI implements SourceControlAp
         return await response.value();
     }
+    /**
+     * Use this method to retrieve SCM user mappings for an organization or application.  Permissions required: View IQ Elements
+     */
+    async getUserMappingsByOwnerRaw(requestParameters: GetUserMappingsByOwnerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SCMUserMappingsResponseDTO>> {
+        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: any = {};
+        const headerParameters: runtime.HTTPHeaders = {};
+        if (this.configuration && (this.configuration.username !== undefined || this.configuration.password !== undefined)) {
+            headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password);
+        }
+        const response = await 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
+     */
+    async getUserMappingsByOwner(requestParameters: GetUserMappingsByOwnerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SCMUserMappingsResponseDTO> {
+        const response = await this.getUserMappingsByOwnerRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
     /**
      * Use this method to update an existing SCM setting.  Permissions required: Edit IQ Elements
      */
@@ -358,11 +546,7 @@ export class SourceControlApi extends runtime.BaseAPI implements SourceControlAp
  */
 export const AddSourceControlOwnerTypeEnum = {
     Application: 'application',
-    Organization: 'organization',
-    RepositoryContainer: 'repository_container',
-    RepositoryManager: 'repository_manager',
-    Repository: 'repository',
-    Global: 'global'
+    Organization: 'organization'
 } as const;
 export type AddSourceControlOwnerTypeEnum = typeof AddSourceControlOwnerTypeEnum[keyof typeof AddSourceControlOwnerTypeEnum];
 /**
@@ -370,11 +554,7 @@ export type AddSourceControlOwnerTypeEnum = typeof AddSourceControlOwnerTypeEnum
  */
 export const DeleteSourceControlOwnerTypeEnum = {
     Application: 'application',
-    Organization: 'organization',
-    RepositoryContainer: 'repository_container',
-    RepositoryManager: 'repository_manager',
-    Repository: 'repository',
-    Global: 'global'
+    Organization: 'organization'
 } as const;
 export type DeleteSourceControlOwnerTypeEnum = typeof DeleteSourceControlOwnerTypeEnum[keyof typeof DeleteSourceControlOwnerTypeEnum];
 /**
@@ -382,22 +562,22 @@ export type DeleteSourceControlOwnerTypeEnum = typeof DeleteSourceControlOwnerTy
  */
 export const GetSourceControl1OwnerTypeEnum = {
     Application: 'application',
-    Organization: 'organization',
-    RepositoryContainer: 'repository_container',
-    RepositoryManager: 'repository_manager',
-    Repository: 'repository',
-    Global: 'global'
+    Organization: 'organization'
 } as const;
 export type GetSourceControl1OwnerTypeEnum = typeof GetSourceControl1OwnerTypeEnum[keyof typeof GetSourceControl1OwnerTypeEnum];
+/**
+ * @export
+ */
+export const GetUserMappingsByOwnerOwnerTypeEnum = {
+    Application: 'application',
+    Organization: 'organization'
+} as const;
+export type GetUserMappingsByOwnerOwnerTypeEnum = typeof GetUserMappingsByOwnerOwnerTypeEnum[keyof typeof GetUserMappingsByOwnerOwnerTypeEnum];
 /**
  * @export
  */
 export const UpdateSourceControlOwnerTypeEnum = {
     Application: 'application',
-    Organization: 'organization',
-    RepositoryContainer: 'repository_container',
-    RepositoryManager: 'repository_manager',
-    Repository: 'repository',
-    Global: 'global'
+    Organization: 'organization'
 } as const;
 export type UpdateSourceControlOwnerTypeEnum = typeof UpdateSourceControlOwnerTypeEnum[keyof typeof UpdateSourceControlOwnerTypeEnum];

package/src/apis/SourceControlMetricsApi.ts CHANGED Viewed

@@ -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).
@@ -35,9 +35,9 @@ 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
@@ -45,6 +45,7 @@ export interface 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>;
@@ -56,6 +57,7 @@ export interface SourceControlMetricsApiInterface {
 export class SourceControlMetricsApi extends runtime.BaseAPI implements SourceControlMetricsApiInterface {
     /**
+     * Use this method to view the source control pull request metrics.  Permissions required: View IQ Elements
      */
     async getSourceControlRaw(requestParameters: GetSourceControlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiPullRequestResults>> {
         if (requestParameters['ownerType'] == null) {
@@ -90,6 +92,7 @@ export class SourceControlMetricsApi extends runtime.BaseAPI implements SourceCo
     }
     /**
+     * Use this method to view the source control pull request metrics.  Permissions required: View IQ Elements
      */
     async getSourceControl(requestParameters: GetSourceControlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiPullRequestResults> {
         const response = await this.getSourceControlRaw(requestParameters, initOverrides);
@@ -103,10 +106,6 @@ export class SourceControlMetricsApi extends runtime.BaseAPI implements SourceCo
  */
 export const GetSourceControlOwnerTypeEnum = {
     Application: 'application',
-    Organization: 'organization',
-    RepositoryContainer: 'repository_container',
-    RepositoryManager: 'repository_manager',
-    Repository: 'repository',
-    Global: 'global'
+    Organization: 'organization'
 } as const;
 export type GetSourceControlOwnerTypeEnum = typeof GetSourceControlOwnerTypeEnum[keyof typeof GetSourceControlOwnerTypeEnum];

package/src/apis/TelemetryApi.ts CHANGED Viewed

@@ -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/src/apis/{ScanApi.ts → ThirdPartyAnalysisApi.ts} RENAMED Viewed

@@ -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).
@@ -17,21 +17,14 @@ import * as runtime from '../runtime';
 import type {
   ApiThirdPartyScanResultDTO,
   ApiThirdPartyScanTicketDTO,
-  IdeUsersOverviewDTO,
 } from '../models/index';
 import {
     ApiThirdPartyScanResultDTOFromJSON,
     ApiThirdPartyScanResultDTOToJSON,
     ApiThirdPartyScanTicketDTOFromJSON,
     ApiThirdPartyScanTicketDTOToJSON,
-    IdeUsersOverviewDTOFromJSON,
-    IdeUsersOverviewDTOToJSON,
 } from '../models/index';
-export interface GetIdeUsersOverviewRequest {
-    sinceUtcTimestamp?: number;
-}
 export interface GetScanStatusRequest {
     applicationId: string;
     scanRequestId: string;
@@ -45,52 +38,41 @@ export interface ScanComponentsRequest {
 }
 /**
- * ScanApi - interface
+ * ThirdPartyAnalysisApi - interface
  *
  * @export
- * @interface ScanApiInterface
+ * @interface ThirdPartyAnalysisApiInterface
  */
-export interface ScanApiInterface {
+export interface ThirdPartyAnalysisApiInterface {
     /**
-     *
-     * @param {number} [sinceUtcTimestamp]
+     * 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 ScanApiInterface
-     */
-    getIdeUsersOverviewRaw(requestParameters: GetIdeUsersOverviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IdeUsersOverviewDTO>>;
-    /**
-     */
-    getIdeUsersOverview(requestParameters: GetIdeUsersOverviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IdeUsersOverviewDTO>;
-    /**
-     *
-     * @param {string} applicationId
-     * @param {string} scanRequestId
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof ScanApiInterface
+     * @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>;
     /**
-     *
-     * @param {string} applicationId
-     * @param {string} source
-     * @param {string} [stageId]
-     * @param {string} [body]
+     * 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 ScanApiInterface
+     * @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>;
@@ -99,40 +81,10 @@ export interface ScanApiInterface {
 /**
  *
  */
-export class ScanApi extends runtime.BaseAPI implements ScanApiInterface {
-    /**
-     */
-    async getIdeUsersOverviewRaw(requestParameters: GetIdeUsersOverviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IdeUsersOverviewDTO>> {
-        const queryParameters: any = {};
-        if (requestParameters['sinceUtcTimestamp'] != null) {
-            queryParameters['sinceUtcTimestamp'] = requestParameters['sinceUtcTimestamp'];
-        }
-        const headerParameters: runtime.HTTPHeaders = {};
-        if (this.configuration && (this.configuration.username !== undefined || this.configuration.password !== undefined)) {
-            headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password);
-        }
-        const response = await this.request({
-            path: `/api/v2/scan/applications/ideUser/overview`,
-            method: 'GET',
-            headers: headerParameters,
-            query: queryParameters,
-        }, initOverrides);
-        return new runtime.JSONApiResponse(response, (jsonValue) => IdeUsersOverviewDTOFromJSON(jsonValue));
-    }
-    /**
-     */
-    async getIdeUsersOverview(requestParameters: GetIdeUsersOverviewRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IdeUsersOverviewDTO> {
-        const response = await this.getIdeUsersOverviewRaw(requestParameters, initOverrides);
-        return await response.value();
-    }
+export 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
      */
     async getScanStatusRaw(requestParameters: GetScanStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiThirdPartyScanResultDTO>> {
         if (requestParameters['applicationId'] == null) {
@@ -167,6 +119,7 @@ export class ScanApi extends runtime.BaseAPI implements ScanApiInterface {
     }
     /**
+     * SBOM evaluation is an asynchronous operation. Use this method to check on the status of the SBOM evaluation.  Permissions required: Evaluate Applications
      */
     async getScanStatus(requestParameters: GetScanStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiThirdPartyScanResultDTO> {
         const response = await this.getScanStatusRaw(requestParameters, initOverrides);
@@ -174,6 +127,7 @@ export class ScanApi extends runtime.BaseAPI implements ScanApiInterface {
     }
     /**
+     * Use this method to perform an analysis of an SBOM.  Permissions required: Evaluate Applications
      */
     async scanComponentsRaw(requestParameters: ScanComponentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiThirdPartyScanTicketDTO>> {
         if (requestParameters['applicationId'] == null) {
@@ -215,6 +169,7 @@ export class ScanApi extends runtime.BaseAPI implements ScanApiInterface {
     }
     /**
+     * Use this method to perform an analysis of an SBOM.  Permissions required: Evaluate Applications
      */
     async scanComponents(requestParameters: ScanComponentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiThirdPartyScanTicketDTO> {
         const response = await this.scanComponentsRaw(requestParameters, initOverrides);