@sonatype/nexus-iq-api-client 0.196.4 → 0.197.0

package/dist/apis/SBOMApi.d.ts

@@ -1,398 +0,0 @@
-/**
- * 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.196.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 { ApiThirdPartyScanTicketDTO, ComponentLocator, SbomVulnerabilityAnalysisRequest } from '../models/index';
-export interface SBOMApiDeleteSbomVersionRequest {
-    applicationId: string;
-    version: string;
-}
-export interface SBOMApiDeleteVulnerabilityAnalysisRequest {
-    applicationId: string;
-    version: string;
-    refId: string;
-    componentLocator: ComponentLocator;
-}
-export interface SBOMApiGetActiveSbomVersionListByApplicationRequest {
-    applicationId: string;
-}
-export interface SBOMApiGetImportStatusRequest {
-    applicationId: string;
-    importRequestId: string;
-}
-export interface SBOMApiGetSbomComponentsRequest {
-    applicationId: string;
-    version: string;
-    vulnerabilityThreatLevels?: Set<GetSbomComponentsVulnerabilityThreatLevelsEnum>;
-    dependencyTypes?: Set<GetSbomComponentsDependencyTypesEnum>;
-    filter?: string;
-    sortBy?: GetSbomComponentsSortByEnum;
-    asc?: boolean;
-    page?: number;
-    pageSize?: number;
-}
-export interface SBOMApiGetSbomMetadataSummaryForApplicationRequest {
-    applicationId: string;
-    sortByDate?: string;
-    pageSize?: number;
-    page?: number;
-    sortBy?: GetSbomMetadataSummaryForApplicationSortByEnum;
-    asc?: boolean;
-}
-export interface SBOMApiGetSbomVersionRequest {
-    applicationId: string;
-    version: string;
-    state?: string;
-    specification?: string;
-    accept?: string;
-}
-export interface SBOMApiGetVulnerabilityDetailsRequest {
-    applicationId: string;
-    version: string;
-    refId: string;
-    packageUrl?: string;
-    componentHash?: string;
-}
-export interface SBOMApiImportSbomRequest {
-    applicationId: string;
-    file: Blob;
-    enableBinaryImport?: boolean;
-    ignoreValidationError?: boolean;
-    applicationVersion?: string;
-}
-export interface SBOMApiSaveVulnerabilityAnalysisRequest {
-    applicationId: string;
-    version: string;
-    refId: string;
-    sbomVulnerabilityAnalysisRequest: SbomVulnerabilityAnalysisRequest;
-}
-/**
- * SBOMApi - interface
- *
- * @export
- * @interface SBOMApiInterface
- */
-export interface SBOMApiInterface {
-    /**
-     * Deletes a specific sbom version including it\'s original contents and updates
-     * @summary Delete sbom version
-     * @param {string} applicationId The internal id of the application
-     * @param {string} version URL Encoded version value of the sbom to be deleted
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof SBOMApiInterface
-     */
-    deleteSbomVersionRaw(requestParameters: SBOMApiDeleteSbomVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
-    /**
-     * Deletes a specific sbom version including it\'s original contents and updates
-     * Delete sbom version
-     */
-    deleteSbomVersion(requestParameters: SBOMApiDeleteSbomVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
-    /**
-     * Deletes a Vulnerability analysis for a given component.
-     * @summary Deletes a Vulnerability analysis for a given component.
-     * @param {string} applicationId The internal id of the application
-     * @param {string} version The version for a specific SBOM where the vulnerability is present
-     * @param {string} refId The vulnerability id of a vulnerability
-     * @param {ComponentLocator} componentLocator Hash or packageUrl to identify the component
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof SBOMApiInterface
-     */
-    deleteVulnerabilityAnalysisRaw(requestParameters: SBOMApiDeleteVulnerabilityAnalysisRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
-    /**
-     * Deletes a Vulnerability analysis for a given component.
-     * Deletes a Vulnerability analysis for a given component.
-     */
-    deleteVulnerabilityAnalysis(requestParameters: SBOMApiDeleteVulnerabilityAnalysisRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
-    /**
-     * Gets a list of active sbom versions by application id
-     * @summary Gets a list of active sbom versions by application id
-     * @param {string} applicationId The internal id of the application
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof SBOMApiInterface
-     */
-    getActiveSbomVersionListByApplicationRaw(requestParameters: SBOMApiGetActiveSbomVersionListByApplicationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
-    /**
-     * Gets a list of active sbom versions by application id
-     * Gets a list of active sbom versions by application id
-     */
-    getActiveSbomVersionListByApplication(requestParameters: SBOMApiGetActiveSbomVersionListByApplicationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
-    /**
-     * Gets status of a sbom import.
-     * @summary Get sbom import status
-     * @param {string} applicationId The internal id of the application
-     * @param {string} importRequestId The id of the import request
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof SBOMApiInterface
-     */
-    getImportStatusRaw(requestParameters: SBOMApiGetImportStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
-    /**
-     * Gets status of a sbom import.
-     * Get sbom import status
-     */
-    getImportStatus(requestParameters: SBOMApiGetImportStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
-    /**
-     * Lists the components in a specific sbom version with data about vulnerabilities and licenses
-     * @summary Gets the components found in a specific sbom version
-     * @param {string} applicationId The internal id of the application
-     * @param {string} version URL Encoded version value of the sbom to query its components
-     * @param {Set<'NONE' | 'LOW' | 'MEDIUM' | 'HIGH' | 'CRITICAL'>} [vulnerabilityThreatLevels] If provided, filter components by the given threat level on their vulnerabilities
-     * @param {Set<'DIRECT' | 'TRANSITIVE' | 'UNSPECIFIED'>} [dependencyTypes] If provided, filter components by the given dependency types
-     * @param {string} [filter] If provided, filter components by the given search criteria
-     * @param {'TYPE' | 'PERCENTAGE_ANNOTATED' | 'RELEASE_STATUS_PERCENTAGE' | 'VULNERABILITIES' | 'DISPLAY_NAME'} [sortBy] Criteria to sort the results. default &#x3D; VULNERABILITIES
-     * @param {boolean} [asc] Order mode ASC&#x3D;true or DESC&#x3D;false. default &#x3D; false
-     * @param {number} [page] Current page number. default &#x3D; 1
-     * @param {number} [pageSize] Number of items to return by page. default &#x3D; 50
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof SBOMApiInterface
-     */
-    getSbomComponentsRaw(requestParameters: SBOMApiGetSbomComponentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
-    /**
-     * Lists the components in a specific sbom version with data about vulnerabilities and licenses
-     * Gets the components found in a specific sbom version
-     */
-    getSbomComponents(requestParameters: SBOMApiGetSbomComponentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
-    /**
-     * Gets a paginated list of SBOMs for an application
-     * @summary Gets a paginated list of SBOMs for an application
-     * @param {string} applicationId The internal id of the application
-     * @param {string} [sortByDate] Deprecated, use sortBy and asc instead. Sort results by import date. Allowed values [asc|desc]. default &#x3D; asc
-     * @param {number} [pageSize] Number of items to return by page. default &#x3D; 10
-     * @param {number} [page] Current page number. default &#x3D; 1
-     * @param {'IMPORT_DATE' | 'RELEASE_STATUS' | 'VULNERABILITY'} [sortBy] Criteria to sort the results. default &#x3D; IMPORT_DATE, when used sortByDate is ignored
-     * @param {boolean} [asc] Order mode ASC&#x3D;true or DESC&#x3D;false. default &#x3D; true
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof SBOMApiInterface
-     */
-    getSbomMetadataSummaryForApplicationRaw(requestParameters: SBOMApiGetSbomMetadataSummaryForApplicationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
-    /**
-     * Gets a paginated list of SBOMs for an application
-     * Gets a paginated list of SBOMs for an application
-     */
-    getSbomMetadataSummaryForApplication(requestParameters: SBOMApiGetSbomMetadataSummaryForApplicationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
-    /**
-     * Downloads a specific sbom version in its original or current form
-     * @summary Gets a sbom version
-     * @param {string} applicationId The internal id of the application
-     * @param {string} version URL Encoded version value of the sbom
-     * @param {string} [state] The state of the sbom version. Allowed values [original|current]. default &#x3D; current
-     * @param {string} [specification] Target specification of the sbom. Allowed values [cyclonedx1.6|cyclonedx1.5|spdx2.2|spdx2.3]. default &#x3D; cyclonedx1.6
-     * @param {string} [accept] Output format(json/xml) of the sbom. Changing the output format only applicable when downloading the current form of the SBOM. The original sbom will always return in the original form that it was ingested. When requesting &#x60;current&#x60; form and if this header value is not present the sbom will be returned in its original ingested format. Allowed values {\&#39;application/json\&#39;|\&#39;application/xml\&#39;}. default &#x3D; null
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof SBOMApiInterface
-     */
-    getSbomVersionRaw(requestParameters: SBOMApiGetSbomVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
-    /**
-     * Downloads a specific sbom version in its original or current form
-     * Gets a sbom version
-     */
-    getSbomVersion(requestParameters: SBOMApiGetSbomVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
-    /**
-     * Use this method to retrieve details for a vulnerability belongs to a specific sbom version
-     * @param {string} applicationId The internal id of the application
-     * @param {string} version The version for a specific SBOM where the vulnerability is present
-     * @param {string} refId The vulnerability id of a vulnerability
-     * @param {string} [packageUrl] (One of packageUrl or componentHash is required) Enter the packageUrl of the component with the vulnerability
-     * @param {string} [componentHash] (One of packageUrl or componentHash is required) Enter the componentHash of the component with the vulnerability
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof SBOMApiInterface
-     */
-    getVulnerabilityDetailsRaw(requestParameters: SBOMApiGetVulnerabilityDetailsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
-    /**
-     * Use this method to retrieve details for a vulnerability belongs to a specific sbom version
-     */
-    getVulnerabilityDetails(requestParameters: SBOMApiGetVulnerabilityDetailsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
-    /**
-     * Imports a new sbom version to an existing application
-     * @summary Import a new sbom version
-     * @param {string} applicationId The internal id of the application.
-     * @param {Blob} file Your SBOM.
-     * @param {boolean} [enableBinaryImport] Enable importing as a binary file.
-     * @param {boolean} [ignoreValidationError] Skip the SBOM validation if an error occurs.
-     * @param {string} [applicationVersion] The SBOM version.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof SBOMApiInterface
-     */
-    importSbomRaw(requestParameters: SBOMApiImportSbomRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiThirdPartyScanTicketDTO>>;
-    /**
-     * Imports a new sbom version to an existing application
-     * Import a new sbom version
-     */
-    importSbom(requestParameters: SBOMApiImportSbomRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiThirdPartyScanTicketDTO>;
-    /**
-     * Updates a vulnerability analysis annotation for a specific SBOM vulnerability
-     * @summary Updates a vulnerability analysis annotation for a specific SBOM vulnerability
-     * @param {string} applicationId The internal id of the application
-     * @param {string} version The version for a specific SBOM where the vulnerability is present
-     * @param {string} refId The vulnerability id of a vulnerability
-     * @param {SbomVulnerabilityAnalysisRequest} sbomVulnerabilityAnalysisRequest Vulnerability analysis details with component information
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof SBOMApiInterface
-     */
-    saveVulnerabilityAnalysisRaw(requestParameters: SBOMApiSaveVulnerabilityAnalysisRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
-    /**
-     * Updates a vulnerability analysis annotation for a specific SBOM vulnerability
-     * Updates a vulnerability analysis annotation for a specific SBOM vulnerability
-     */
-    saveVulnerabilityAnalysis(requestParameters: SBOMApiSaveVulnerabilityAnalysisRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
-}
-/**
- *
- */
-export declare class SBOMApi extends runtime.BaseAPI implements SBOMApiInterface {
-    /**
-     * Deletes a specific sbom version including it\'s original contents and updates
-     * Delete sbom version
-     */
-    deleteSbomVersionRaw(requestParameters: SBOMApiDeleteSbomVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
-    /**
-     * Deletes a specific sbom version including it\'s original contents and updates
-     * Delete sbom version
-     */
-    deleteSbomVersion(requestParameters: SBOMApiDeleteSbomVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
-    /**
-     * Deletes a Vulnerability analysis for a given component.
-     * Deletes a Vulnerability analysis for a given component.
-     */
-    deleteVulnerabilityAnalysisRaw(requestParameters: SBOMApiDeleteVulnerabilityAnalysisRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
-    /**
-     * Deletes a Vulnerability analysis for a given component.
-     * Deletes a Vulnerability analysis for a given component.
-     */
-    deleteVulnerabilityAnalysis(requestParameters: SBOMApiDeleteVulnerabilityAnalysisRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
-    /**
-     * Gets a list of active sbom versions by application id
-     * Gets a list of active sbom versions by application id
-     */
-    getActiveSbomVersionListByApplicationRaw(requestParameters: SBOMApiGetActiveSbomVersionListByApplicationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
-    /**
-     * Gets a list of active sbom versions by application id
-     * Gets a list of active sbom versions by application id
-     */
-    getActiveSbomVersionListByApplication(requestParameters: SBOMApiGetActiveSbomVersionListByApplicationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
-    /**
-     * Gets status of a sbom import.
-     * Get sbom import status
-     */
-    getImportStatusRaw(requestParameters: SBOMApiGetImportStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
-    /**
-     * Gets status of a sbom import.
-     * Get sbom import status
-     */
-    getImportStatus(requestParameters: SBOMApiGetImportStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
-    /**
-     * Lists the components in a specific sbom version with data about vulnerabilities and licenses
-     * Gets the components found in a specific sbom version
-     */
-    getSbomComponentsRaw(requestParameters: SBOMApiGetSbomComponentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
-    /**
-     * Lists the components in a specific sbom version with data about vulnerabilities and licenses
-     * Gets the components found in a specific sbom version
-     */
-    getSbomComponents(requestParameters: SBOMApiGetSbomComponentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
-    /**
-     * Gets a paginated list of SBOMs for an application
-     * Gets a paginated list of SBOMs for an application
-     */
-    getSbomMetadataSummaryForApplicationRaw(requestParameters: SBOMApiGetSbomMetadataSummaryForApplicationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
-    /**
-     * Gets a paginated list of SBOMs for an application
-     * Gets a paginated list of SBOMs for an application
-     */
-    getSbomMetadataSummaryForApplication(requestParameters: SBOMApiGetSbomMetadataSummaryForApplicationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
-    /**
-     * Downloads a specific sbom version in its original or current form
-     * Gets a sbom version
-     */
-    getSbomVersionRaw(requestParameters: SBOMApiGetSbomVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
-    /**
-     * Downloads a specific sbom version in its original or current form
-     * Gets a sbom version
-     */
-    getSbomVersion(requestParameters: SBOMApiGetSbomVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
-    /**
-     * Use this method to retrieve details for a vulnerability belongs to a specific sbom version
-     */
-    getVulnerabilityDetailsRaw(requestParameters: SBOMApiGetVulnerabilityDetailsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
-    /**
-     * Use this method to retrieve details for a vulnerability belongs to a specific sbom version
-     */
-    getVulnerabilityDetails(requestParameters: SBOMApiGetVulnerabilityDetailsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
-    /**
-     * Imports a new sbom version to an existing application
-     * Import a new sbom version
-     */
-    importSbomRaw(requestParameters: SBOMApiImportSbomRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiThirdPartyScanTicketDTO>>;
-    /**
-     * Imports a new sbom version to an existing application
-     * Import a new sbom version
-     */
-    importSbom(requestParameters: SBOMApiImportSbomRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiThirdPartyScanTicketDTO>;
-    /**
-     * Updates a vulnerability analysis annotation for a specific SBOM vulnerability
-     * Updates a vulnerability analysis annotation for a specific SBOM vulnerability
-     */
-    saveVulnerabilityAnalysisRaw(requestParameters: SBOMApiSaveVulnerabilityAnalysisRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
-    /**
-     * Updates a vulnerability analysis annotation for a specific SBOM vulnerability
-     * Updates a vulnerability analysis annotation for a specific SBOM vulnerability
-     */
-    saveVulnerabilityAnalysis(requestParameters: SBOMApiSaveVulnerabilityAnalysisRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
-}
-/**
- * @export
- */
-export declare const GetSbomComponentsVulnerabilityThreatLevelsEnum: {
-    readonly None: "NONE";
-    readonly Low: "LOW";
-    readonly Medium: "MEDIUM";
-    readonly High: "HIGH";
-    readonly Critical: "CRITICAL";
-};
-export type GetSbomComponentsVulnerabilityThreatLevelsEnum = typeof GetSbomComponentsVulnerabilityThreatLevelsEnum[keyof typeof GetSbomComponentsVulnerabilityThreatLevelsEnum];
-/**
- * @export
- */
-export declare const GetSbomComponentsDependencyTypesEnum: {
-    readonly Direct: "DIRECT";
-    readonly Transitive: "TRANSITIVE";
-    readonly Unspecified: "UNSPECIFIED";
-};
-export type GetSbomComponentsDependencyTypesEnum = typeof GetSbomComponentsDependencyTypesEnum[keyof typeof GetSbomComponentsDependencyTypesEnum];
-/**
- * @export
- */
-export declare const GetSbomComponentsSortByEnum: {
-    readonly Type: "TYPE";
-    readonly PercentageAnnotated: "PERCENTAGE_ANNOTATED";
-    readonly ReleaseStatusPercentage: "RELEASE_STATUS_PERCENTAGE";
-    readonly Vulnerabilities: "VULNERABILITIES";
-    readonly DisplayName: "DISPLAY_NAME";
-};
-export type GetSbomComponentsSortByEnum = typeof GetSbomComponentsSortByEnum[keyof typeof GetSbomComponentsSortByEnum];
-/**
- * @export
- */
-export declare const GetSbomMetadataSummaryForApplicationSortByEnum: {
-    readonly ImportDate: "IMPORT_DATE";
-    readonly ReleaseStatus: "RELEASE_STATUS";
-    readonly Vulnerability: "VULNERABILITY";
-};
-export type GetSbomMetadataSummaryForApplicationSortByEnum = typeof GetSbomMetadataSummaryForApplicationSortByEnum[keyof typeof GetSbomMetadataSummaryForApplicationSortByEnum];