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

package/dist/esm/apis/FirewallApi.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).
@@ -10,13 +10,17 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { ApiFirewallMetricsResultDTO, ApiFirewallQuarantineSummaryDTO, ApiFirewallReleaseQuarantineConfigDTO, ApiFirewallReleaseQuarantineSummaryDTO, ApiRepositoryComponentEvaluationRequestList, ApiRepositoryComponentEvaluationResultList, ApiRepositoryContainerDTO, ApiRepositoryListDTO, ApiRepositoryManagerDTO, ApiRepositoryManagerListDTO } from '../models/index';
+import type { ApiFirewallQuarantineSummaryDTO, ApiFirewallReleaseQuarantineConfigDTO, ApiFirewallReleaseQuarantineSummaryDTO, ApiMalwareComponentEvaluationRequestList, ApiRepositoryComponentEvaluationRequestList, ApiRepositoryComponentEvaluationResultList, ApiRepositoryContainerDTO, ApiRepositoryListDTO, ApiRepositoryManagerDTO, ApiRepositoryManagerListDTO, MalwareDefenseResponseList, RoiFirewallMetricsDTO } from '../models/index';
+export interface AddProprietaryComponentNamesRequest {
+    format: string;
+    requestBody?: Array<string>;
+}
 export interface AddRepositoryManagerRequest {
-    apiRepositoryManagerDTO?: ApiRepositoryManagerDTO;
+    apiRepositoryManagerDTO: ApiRepositoryManagerDTO;
 }
 export interface ConfigureRepositoriesRequest {
     repositoryManagerId: string;
-    apiRepositoryListDTO?: ApiRepositoryListDTO;
+    apiRepositoryListDTO: ApiRepositoryListDTO;
 }
 export interface DeleteRepositoryManagerRequest {
     repositoryManagerId: string;
@@ -24,7 +28,10 @@ export interface DeleteRepositoryManagerRequest {
 export interface EvaluateComponents1Request {
     repositoryManagerId: string;
     repositoryId: string;
-    apiRepositoryComponentEvaluationRequestList?: ApiRepositoryComponentEvaluationRequestList;
+    apiRepositoryComponentEvaluationRequestList: ApiRepositoryComponentEvaluationRequestList;
+}
+export interface EvaluateMalwareRequest {
+    apiMalwareComponentEvaluationRequestList?: ApiMalwareComponentEvaluationRequestList;
 }
 export interface GetConfiguredRepositoriesRequest {
     repositoryManagerId: string;
@@ -36,12 +43,16 @@ export interface GetQuarantineListRequest {
     policyId?: Set<string>;
     componentName?: string;
     repositoryPublicId?: string;
+    quarantineTime?: number;
     sortBy?: string;
     asc?: boolean;
 }
 export interface GetRepositoryManagerRequest {
     repositoryManagerId: string;
 }
+export interface GetRoiFirewallMetricsRequest {
+    currencyType: string;
+}
 export interface GetUnquarantineListRequest {
     page?: number;
     pageSize?: number;
@@ -50,8 +61,11 @@ export interface GetUnquarantineListRequest {
     sortBy?: string;
     asc?: boolean;
 }
+export interface RemoveProprietaryComponentNamesRequest {
+    format: string;
+}
 export interface SetFirewallAutoUnquarantineConfigRequest {
-    apiFirewallReleaseQuarantineConfigDTO?: Array<ApiFirewallReleaseQuarantineConfigDTO>;
+    apiFirewallReleaseQuarantineConfigDTO: Array<ApiFirewallReleaseQuarantineConfigDTO>;
 }
 export interface SetQuarantinedComponentViewAnonymousAccessRequest {
     enabled: boolean;
@@ -65,201 +79,276 @@ export interface SetQuarantinedComponentViewAnonymousAccessRequest {
 export interface FirewallApiInterface {
     /**
      *
-     * @param {ApiRepositoryManagerDTO} [apiRepositoryManagerDTO]
+     * @param {string} format
+     * @param {Array<string>} [requestBody]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof FirewallApiInterface
+     */
+    addProprietaryComponentNamesRaw(requestParameters: AddProprietaryComponentNamesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     */
+    addProprietaryComponentNames(requestParameters: AddProprietaryComponentNamesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Use this method to add a new repository manager.  Permissions required: Edit IQ Elements
+     * @param {ApiRepositoryManagerDTO} apiRepositoryManagerDTO Enter values for the new repository manager.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof FirewallApiInterface
      */
     addRepositoryManagerRaw(requestParameters: AddRepositoryManagerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiRepositoryManagerDTO>>;
     /**
+     * Use this method to add a new repository manager.  Permissions required: Edit IQ Elements
      */
     addRepositoryManager(requestParameters: AddRepositoryManagerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiRepositoryManagerDTO>;
     /**
-     *
-     * @param {string} repositoryManagerId
-     * @param {ApiRepositoryListDTO} [apiRepositoryListDTO]
+     * Use this method to update the repositories for an existing repository manager.  Permissions required: Edit IQ Elements
+     * @param {string} repositoryManagerId Enter the repository manager ID.
+     * @param {ApiRepositoryListDTO} apiRepositoryListDTO Enter values for the repository configuration properties to be updated.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof FirewallApiInterface
      */
     configureRepositoriesRaw(requestParameters: ConfigureRepositoriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
+     * Use this method to update the repositories for an existing repository manager.  Permissions required: Edit IQ Elements
      */
     configureRepositories(requestParameters: ConfigureRepositoriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
-     *
-     * @param {string} repositoryManagerId
+     * Use this method to delete an existing repository manager.  Permissions required: Edit IQ Elements
+     * @param {string} repositoryManagerId Enter the repository manager ID.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof FirewallApiInterface
      */
     deleteRepositoryManagerRaw(requestParameters: DeleteRepositoryManagerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
+     * Use this method to delete an existing repository manager.  Permissions required: Edit IQ Elements
      */
     deleteRepositoryManager(requestParameters: DeleteRepositoryManagerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
-     *
-     * @param {string} repositoryManagerId
-     * @param {string} repositoryId
-     * @param {ApiRepositoryComponentEvaluationRequestList} [apiRepositoryComponentEvaluationRequestList]
+     * Use this method to evaluate components (max. 100).  Permissions required: Evaluate Individual Components
+     * @param {string} repositoryManagerId Enter the repository manager ID.
+     * @param {string} repositoryId Enter the repository ID.
+     * @param {ApiRepositoryComponentEvaluationRequestList} apiRepositoryComponentEvaluationRequestList Provide the array of the component identifiers to be evaluated, using the component hash and the (packageUrl or pathname). A maximum of 100 components can be evaluated in one request.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof FirewallApiInterface
      */
     evaluateComponents1Raw(requestParameters: EvaluateComponents1Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiRepositoryComponentEvaluationResultList>>;
     /**
+     * Use this method to evaluate components (max. 100).  Permissions required: Evaluate Individual Components
      */
     evaluateComponents1(requestParameters: EvaluateComponents1Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiRepositoryComponentEvaluationResultList>;
     /**
-     *
-     * @param {string} repositoryManagerId
-     * @param {number} [sinceUtcTimestamp]
+     * Evaluate malware for a list of components.<p>Use this endpoint to evaluate malware for a list of components up to a maximum of 100 components in a single request.A hash or packageUrl (or both) can be supplied for each component that are of the same format type.
+     * @param {ApiMalwareComponentEvaluationRequestList} [apiMalwareComponentEvaluationRequestList]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof FirewallApiInterface
+     */
+    evaluateMalwareRaw(requestParameters: EvaluateMalwareRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MalwareDefenseResponseList>>;
+    /**
+     * Evaluate malware for a list of components.<p>Use this endpoint to evaluate malware for a list of components up to a maximum of 100 components in a single request.A hash or packageUrl (or both) can be supplied for each component that are of the same format type.
+     */
+    evaluateMalware(requestParameters: EvaluateMalwareRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MalwareDefenseResponseList>;
+    /**
+     * Use this method to retrieve the configuration details of an existing repository manager.  Permissions required: View IQ Elements
+     * @param {string} repositoryManagerId Enter the repository manager ID.
+     * @param {number} [sinceUtcTimestamp] Enter the epoch time in milliseconds when the repository was last updated.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof FirewallApiInterface
      */
     getConfiguredRepositoriesRaw(requestParameters: GetConfiguredRepositoriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiRepositoryListDTO>>;
     /**
+     * Use this method to retrieve the configuration details of an existing repository manager.  Permissions required: View IQ Elements
      */
     getConfiguredRepositories(requestParameters: GetConfiguredRepositoriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiRepositoryListDTO>;
     /**
-     *
+     * Use this method to retrieve the configuration settings for auto-release from quarantine for repositories.  Permissions required: View IQ Elements
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof FirewallApiInterface
      */
     getFirewallAutoUnquarantineConfigRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<ApiFirewallReleaseQuarantineConfigDTO>>>;
     /**
+     * Use this method to retrieve the configuration settings for auto-release from quarantine for repositories.  Permissions required: View IQ Elements
      */
     getFirewallAutoUnquarantineConfig(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<ApiFirewallReleaseQuarantineConfigDTO>>;
     /**
-     *
+     * Use this method to retrieve malware defense dashboard metrics.  Permissions required: View IQ Elements
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof FirewallApiInterface
      */
-    getFirewallMetricsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<{
-        [key: string]: ApiFirewallMetricsResultDTO;
-    }>>;
+    getFirewallMetricsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
+     * Use this method to retrieve malware defense dashboard metrics.  Permissions required: View IQ Elements
      */
-    getFirewallMetrics(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<{
-        [key: string]: ApiFirewallMetricsResultDTO;
-    }>;
+    getFirewallMetrics(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
-     *
+     * Use this method to track how many components have been automatically released from quarantine over different time periods.  Permissions required: View IQ Elements
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof FirewallApiInterface
      */
     getFirewallUnquarantineSummaryRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiFirewallReleaseQuarantineSummaryDTO>>;
     /**
+     * Use this method to track how many components have been automatically released from quarantine over different time periods.  Permissions required: View IQ Elements
      */
     getFirewallUnquarantineSummary(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiFirewallReleaseQuarantineSummaryDTO>;
     /**
-     *
-     * @param {number} [page]
-     * @param {number} [pageSize]
-     * @param {Set<string>} [policyId]
-     * @param {string} [componentName]
-     * @param {string} [repositoryPublicId]
-     * @param {string} [sortBy]
-     * @param {boolean} [asc]
+     * The response contains malware defense API metrics.<p>Use this endpoint to get the count of malicious components evaluated via malware defense API grouped by format.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof FirewallApiInterface
+     */
+    getMalwareDefenseMetricsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<{
+        [key: string]: number;
+    }>>;
+    /**
+     * The response contains malware defense API metrics.<p>Use this endpoint to get the count of malicious components evaluated via malware defense API grouped by format.
+     */
+    getMalwareDefenseMetrics(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<{
+        [key: string]: number;
+    }>;
+    /**
+     * Use this method to request a list of quarantined components.  Permissions required: View IQ Elements
+     * @param {number} [page] Enter the starting page number for the response.
+     * @param {number} [pageSize] Enter the page size for the response.
+     * @param {Set<string>} [policyId] Enter the list of policy IDs causing the quarantine.
+     * @param {string} [componentName] Enter the component name.
+     * @param {string} [repositoryPublicId] Enter the repository public ID of the quarantined component.
+     * @param {number} [quarantineTime] Enter the quarantine time of the component.
+     * @param {string} [sortBy] Enter &#x60;quarantineTime&#x60; to sort the results by quarantine time.
+     * @param {boolean} [asc] Select the sort order.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof FirewallApiInterface
      */
     getQuarantineListRaw(requestParameters: GetQuarantineListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
+     * Use this method to request a list of quarantined components.  Permissions required: View IQ Elements
      */
     getQuarantineList(requestParameters: GetQuarantineListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
-     *
+     * Use this method to request a summary of quarantined components.  Permissions required: View IQ Elements
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof FirewallApiInterface
      */
     getQuarantineSummaryRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiFirewallQuarantineSummaryDTO>>;
     /**
+     * Use this method to request a summary of quarantined components.  Permissions required: View IQ Elements
      */
     getQuarantineSummary(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiFirewallQuarantineSummaryDTO>;
     /**
-     *
+     * Use this method to determine if the quarantined component(s) details can be accessed anonymously.  Permissions required: None
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof FirewallApiInterface
      */
     getQuarantinedComponentViewAnonymousAccessRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
+     * Use this method to determine if the quarantined component(s) details can be accessed anonymously.  Permissions required: None
      */
     getQuarantinedComponentViewAnonymousAccess(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
-     *
+     * Use this method to retrieve the ID and name for the repository container.  Permissions required: View IQ Elements
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof FirewallApiInterface
      */
     getRepositoryContainerRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiRepositoryContainerDTO>>;
     /**
+     * Use this method to retrieve the ID and name for the repository container.  Permissions required: View IQ Elements
      */
     getRepositoryContainer(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiRepositoryContainerDTO>;
     /**
-     *
-     * @param {string} repositoryManagerId
+     * Use this method to retrieve details of an existing repository manager.  Permissions required: View IQ Elements
+     * @param {string} repositoryManagerId Enter the repository manager ID.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof FirewallApiInterface
      */
     getRepositoryManagerRaw(requestParameters: GetRepositoryManagerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiRepositoryManagerDTO>>;
     /**
+     * Use this method to retrieve details of an existing repository manager.  Permissions required: View IQ Elements
      */
     getRepositoryManager(requestParameters: GetRepositoryManagerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiRepositoryManagerDTO>;
     /**
-     *
+     * Use this method to retrieve all configured repository managers.  Permissions required: View IQ Elements
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof FirewallApiInterface
      */
     getRepositoryManagersRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiRepositoryManagerListDTO>>;
     /**
+     * Use this method to retrieve all configured repository managers.  Permissions required: View IQ Elements
      */
     getRepositoryManagers(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiRepositoryManagerListDTO>;
     /**
      *
-     * @param {number} [page]
-     * @param {number} [pageSize]
-     * @param {string} [policyId]
-     * @param {string} [componentName]
-     * @param {string} [sortBy]
-     * @param {boolean} [asc]
+     * @param {string} currencyType
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof FirewallApiInterface
+     */
+    getRoiFirewallMetricsRaw(requestParameters: GetRoiFirewallMetricsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RoiFirewallMetricsDTO>>;
+    /**
+     */
+    getRoiFirewallMetrics(requestParameters: GetRoiFirewallMetricsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RoiFirewallMetricsDTO>;
+    /**
+     * Use this method to retrieve the details of components that are auto-released from quarantine.  Permissions required: View IQ Elements
+     * @param {number} [page] Enter the page number.
+     * @param {number} [pageSize] Enter the number of results to be returned for a page.
+     * @param {string} [policyId] Enter the &#x60;policyId&#x60;. When provided, the results will include the components that have a policy violation for the policyId.
+     * @param {string} [componentName] Enter the component name. When provided, the results will include components with display names (case-insensitive) that match the given name.
+     * @param {string} [sortBy] Enter the sort criteria &#x60;releaseQuarantineTime&#x60; or &#x60;quarantineTime&#x60;.
+     * @param {boolean} [asc] Select &#x60;true&#x60; to set the sort order to ascending.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof FirewallApiInterface
      */
     getUnquarantineListRaw(requestParameters: GetUnquarantineListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
+     * Use this method to retrieve the details of components that are auto-released from quarantine.  Permissions required: View IQ Elements
      */
     getUnquarantineList(requestParameters: GetUnquarantineListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
      *
-     * @param {Array<ApiFirewallReleaseQuarantineConfigDTO>} [apiFirewallReleaseQuarantineConfigDTO]
+     * @param {string} format
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof FirewallApiInterface
+     */
+    removeProprietaryComponentNamesRaw(requestParameters: RemoveProprietaryComponentNamesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     */
+    removeProprietaryComponentNames(requestParameters: RemoveProprietaryComponentNamesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Use this method to set the configurations for auto-release from quarantine for a list of repositories.  Permissions required: Edit IQ Elements
+     * @param {Array<ApiFirewallReleaseQuarantineConfigDTO>} apiFirewallReleaseQuarantineConfigDTO Enter value for each repository and the required status for auto-release as &#x60;true&#x60; or &#x60;false&#x60;.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof FirewallApiInterface
      */
     setFirewallAutoUnquarantineConfigRaw(requestParameters: SetFirewallAutoUnquarantineConfigRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<ApiFirewallReleaseQuarantineConfigDTO>>>;
     /**
+     * Use this method to set the configurations for auto-release from quarantine for a list of repositories.  Permissions required: Edit IQ Elements
      */
     setFirewallAutoUnquarantineConfig(requestParameters: SetFirewallAutoUnquarantineConfigRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<ApiFirewallReleaseQuarantineConfigDTO>>;
     /**
-     *
-     * @param {boolean} enabled
+     * Use this method to enable/disable anonymous access to view the quarantined components.  Permissions required: Edit IQ Elements
+     * @param {boolean} enabled Select &#x60;true&#x60; or &#x60;false&#x60; to enable or disable anonymous access.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof FirewallApiInterface
      */
     setQuarantinedComponentViewAnonymousAccessRaw(requestParameters: SetQuarantinedComponentViewAnonymousAccessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
+     * Use this method to enable/disable anonymous access to view the quarantined components.  Permissions required: Edit IQ Elements
      */
     setQuarantinedComponentViewAnonymousAccess(requestParameters: SetQuarantinedComponentViewAnonymousAccessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
 }
@@ -269,108 +358,176 @@ export interface FirewallApiInterface {
 export declare class FirewallApi extends runtime.BaseAPI implements FirewallApiInterface {
     /**
      */
+    addProprietaryComponentNamesRaw(requestParameters: AddProprietaryComponentNamesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     */
+    addProprietaryComponentNames(requestParameters: AddProprietaryComponentNamesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Use this method to add a new repository manager.  Permissions required: Edit IQ Elements
+     */
     addRepositoryManagerRaw(requestParameters: AddRepositoryManagerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiRepositoryManagerDTO>>;
     /**
+     * Use this method to add a new repository manager.  Permissions required: Edit IQ Elements
      */
-    addRepositoryManager(requestParameters?: AddRepositoryManagerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiRepositoryManagerDTO>;
+    addRepositoryManager(requestParameters: AddRepositoryManagerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiRepositoryManagerDTO>;
     /**
+     * Use this method to update the repositories for an existing repository manager.  Permissions required: Edit IQ Elements
      */
     configureRepositoriesRaw(requestParameters: ConfigureRepositoriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
+     * Use this method to update the repositories for an existing repository manager.  Permissions required: Edit IQ Elements
      */
     configureRepositories(requestParameters: ConfigureRepositoriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
+     * Use this method to delete an existing repository manager.  Permissions required: Edit IQ Elements
      */
     deleteRepositoryManagerRaw(requestParameters: DeleteRepositoryManagerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
+     * Use this method to delete an existing repository manager.  Permissions required: Edit IQ Elements
      */
     deleteRepositoryManager(requestParameters: DeleteRepositoryManagerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
+     * Use this method to evaluate components (max. 100).  Permissions required: Evaluate Individual Components
      */
     evaluateComponents1Raw(requestParameters: EvaluateComponents1Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiRepositoryComponentEvaluationResultList>>;
     /**
+     * Use this method to evaluate components (max. 100).  Permissions required: Evaluate Individual Components
      */
     evaluateComponents1(requestParameters: EvaluateComponents1Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiRepositoryComponentEvaluationResultList>;
     /**
+     * Evaluate malware for a list of components.<p>Use this endpoint to evaluate malware for a list of components up to a maximum of 100 components in a single request.A hash or packageUrl (or both) can be supplied for each component that are of the same format type.
+     */
+    evaluateMalwareRaw(requestParameters: EvaluateMalwareRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MalwareDefenseResponseList>>;
+    /**
+     * Evaluate malware for a list of components.<p>Use this endpoint to evaluate malware for a list of components up to a maximum of 100 components in a single request.A hash or packageUrl (or both) can be supplied for each component that are of the same format type.
+     */
+    evaluateMalware(requestParameters?: EvaluateMalwareRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MalwareDefenseResponseList>;
+    /**
+     * Use this method to retrieve the configuration details of an existing repository manager.  Permissions required: View IQ Elements
      */
     getConfiguredRepositoriesRaw(requestParameters: GetConfiguredRepositoriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiRepositoryListDTO>>;
     /**
+     * Use this method to retrieve the configuration details of an existing repository manager.  Permissions required: View IQ Elements
      */
     getConfiguredRepositories(requestParameters: GetConfiguredRepositoriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiRepositoryListDTO>;
     /**
+     * Use this method to retrieve the configuration settings for auto-release from quarantine for repositories.  Permissions required: View IQ Elements
      */
     getFirewallAutoUnquarantineConfigRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<ApiFirewallReleaseQuarantineConfigDTO>>>;
     /**
+     * Use this method to retrieve the configuration settings for auto-release from quarantine for repositories.  Permissions required: View IQ Elements
      */
     getFirewallAutoUnquarantineConfig(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<ApiFirewallReleaseQuarantineConfigDTO>>;
     /**
+     * Use this method to retrieve malware defense dashboard metrics.  Permissions required: View IQ Elements
      */
-    getFirewallMetricsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<{
-        [key: string]: ApiFirewallMetricsResultDTO;
-    }>>;
+    getFirewallMetricsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
+     * Use this method to retrieve malware defense dashboard metrics.  Permissions required: View IQ Elements
      */
-    getFirewallMetrics(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<{
-        [key: string]: ApiFirewallMetricsResultDTO;
-    }>;
+    getFirewallMetrics(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
+     * Use this method to track how many components have been automatically released from quarantine over different time periods.  Permissions required: View IQ Elements
      */
     getFirewallUnquarantineSummaryRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiFirewallReleaseQuarantineSummaryDTO>>;
     /**
+     * Use this method to track how many components have been automatically released from quarantine over different time periods.  Permissions required: View IQ Elements
      */
     getFirewallUnquarantineSummary(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiFirewallReleaseQuarantineSummaryDTO>;
     /**
+     * The response contains malware defense API metrics.<p>Use this endpoint to get the count of malicious components evaluated via malware defense API grouped by format.
+     */
+    getMalwareDefenseMetricsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<{
+        [key: string]: number;
+    }>>;
+    /**
+     * The response contains malware defense API metrics.<p>Use this endpoint to get the count of malicious components evaluated via malware defense API grouped by format.
+     */
+    getMalwareDefenseMetrics(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<{
+        [key: string]: number;
+    }>;
+    /**
+     * Use this method to request a list of quarantined components.  Permissions required: View IQ Elements
      */
     getQuarantineListRaw(requestParameters: GetQuarantineListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
+     * Use this method to request a list of quarantined components.  Permissions required: View IQ Elements
      */
     getQuarantineList(requestParameters?: GetQuarantineListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
+     * Use this method to request a summary of quarantined components.  Permissions required: View IQ Elements
      */
     getQuarantineSummaryRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiFirewallQuarantineSummaryDTO>>;
     /**
+     * Use this method to request a summary of quarantined components.  Permissions required: View IQ Elements
      */
     getQuarantineSummary(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiFirewallQuarantineSummaryDTO>;
     /**
+     * Use this method to determine if the quarantined component(s) details can be accessed anonymously.  Permissions required: None
      */
     getQuarantinedComponentViewAnonymousAccessRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
+     * Use this method to determine if the quarantined component(s) details can be accessed anonymously.  Permissions required: None
      */
     getQuarantinedComponentViewAnonymousAccess(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
+     * Use this method to retrieve the ID and name for the repository container.  Permissions required: View IQ Elements
      */
     getRepositoryContainerRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiRepositoryContainerDTO>>;
     /**
+     * Use this method to retrieve the ID and name for the repository container.  Permissions required: View IQ Elements
      */
     getRepositoryContainer(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiRepositoryContainerDTO>;
     /**
+     * Use this method to retrieve details of an existing repository manager.  Permissions required: View IQ Elements
      */
     getRepositoryManagerRaw(requestParameters: GetRepositoryManagerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiRepositoryManagerDTO>>;
     /**
+     * Use this method to retrieve details of an existing repository manager.  Permissions required: View IQ Elements
      */
     getRepositoryManager(requestParameters: GetRepositoryManagerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiRepositoryManagerDTO>;
     /**
+     * Use this method to retrieve all configured repository managers.  Permissions required: View IQ Elements
      */
     getRepositoryManagersRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiRepositoryManagerListDTO>>;
     /**
+     * Use this method to retrieve all configured repository managers.  Permissions required: View IQ Elements
      */
     getRepositoryManagers(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiRepositoryManagerListDTO>;
     /**
      */
+    getRoiFirewallMetricsRaw(requestParameters: GetRoiFirewallMetricsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RoiFirewallMetricsDTO>>;
+    /**
+     */
+    getRoiFirewallMetrics(requestParameters: GetRoiFirewallMetricsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RoiFirewallMetricsDTO>;
+    /**
+     * Use this method to retrieve the details of components that are auto-released from quarantine.  Permissions required: View IQ Elements
+     */
     getUnquarantineListRaw(requestParameters: GetUnquarantineListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
+     * Use this method to retrieve the details of components that are auto-released from quarantine.  Permissions required: View IQ Elements
      */
     getUnquarantineList(requestParameters?: GetUnquarantineListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
      */
+    removeProprietaryComponentNamesRaw(requestParameters: RemoveProprietaryComponentNamesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     */
+    removeProprietaryComponentNames(requestParameters: RemoveProprietaryComponentNamesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Use this method to set the configurations for auto-release from quarantine for a list of repositories.  Permissions required: Edit IQ Elements
+     */
     setFirewallAutoUnquarantineConfigRaw(requestParameters: SetFirewallAutoUnquarantineConfigRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<ApiFirewallReleaseQuarantineConfigDTO>>>;
     /**
+     * Use this method to set the configurations for auto-release from quarantine for a list of repositories.  Permissions required: Edit IQ Elements
      */
-    setFirewallAutoUnquarantineConfig(requestParameters?: SetFirewallAutoUnquarantineConfigRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<ApiFirewallReleaseQuarantineConfigDTO>>;
+    setFirewallAutoUnquarantineConfig(requestParameters: SetFirewallAutoUnquarantineConfigRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<ApiFirewallReleaseQuarantineConfigDTO>>;
     /**
+     * Use this method to enable/disable anonymous access to view the quarantined components.  Permissions required: Edit IQ Elements
      */
     setQuarantinedComponentViewAnonymousAccessRaw(requestParameters: SetQuarantinedComponentViewAnonymousAccessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
+     * Use this method to enable/disable anonymous access to view the quarantined components.  Permissions required: Edit IQ Elements
      */
     setQuarantinedComponentViewAnonymousAccess(requestParameters: SetQuarantinedComponentViewAnonymousAccessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
 }