/** * Sonatype Guide API * REST API into [Sonatype Guide](https://guide.sonatype.com). * * The version of the OpenAPI document: 202607 * * * 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 { ComponentReportGet, ComponentReportPost, PurlRequestPost } from '../models/index'; export interface OSSIndexCompatibilityApiGetComponentReportRequest { userAgent?: string; } export interface OSSIndexCompatibilityApiGetComponentReport1Request { userAgent?: string; } export interface OSSIndexCompatibilityApiGetComponentReportsRequest { purlRequestPost: PurlRequestPost; userAgent?: string; } export interface OSSIndexCompatibilityApiGetComponentReports1Request { purlRequestPost: PurlRequestPost; userAgent?: string; } /** * */ export declare class OSSIndexCompatibilityApi extends runtime.BaseAPI { /** * Retrieves a component report for a single Package URL (PURL). Authentication: - HTTP Basic Authentication required - Authorization header: Basic Response Headers: - X-Credits-Used: Credits consumed for this request - X-Credits-Remaining: Available credit balance - X-Credits-Warning: Alert when approaching credit limit (JSON) Note: Credits are only charged when a component is found. Requests for the same component on the same day are not charged multiple times. * Get component report by PURL */ getComponentReportRaw(requestParameters: OSSIndexCompatibilityApiGetComponentReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Retrieves a component report for a single Package URL (PURL). Authentication: - HTTP Basic Authentication required - Authorization header: Basic Response Headers: - X-Credits-Used: Credits consumed for this request - X-Credits-Remaining: Available credit balance - X-Credits-Warning: Alert when approaching credit limit (JSON) Note: Credits are only charged when a component is found. Requests for the same component on the same day are not charged multiple times. * Get component report by PURL */ getComponentReport(requestParameters?: OSSIndexCompatibilityApiGetComponentReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Retrieves a component report for a single Package URL (PURL). Authentication: - HTTP Basic Authentication required - Authorization header: Basic Response Headers: - X-Credits-Used: Credits consumed for this request - X-Credits-Remaining: Available credit balance - X-Credits-Warning: Alert when approaching credit limit (JSON) Note: Credits are only charged when a component is found. Requests for the same component on the same day are not charged multiple times. * Get component report by PURL */ getComponentReport1Raw(requestParameters: OSSIndexCompatibilityApiGetComponentReport1Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Retrieves a component report for a single Package URL (PURL). Authentication: - HTTP Basic Authentication required - Authorization header: Basic Response Headers: - X-Credits-Used: Credits consumed for this request - X-Credits-Remaining: Available credit balance - X-Credits-Warning: Alert when approaching credit limit (JSON) Note: Credits are only charged when a component is found. Requests for the same component on the same day are not charged multiple times. * Get component report by PURL */ getComponentReport1(requestParameters?: OSSIndexCompatibilityApiGetComponentReport1Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Retrieves component reports for multiple Package URLs (PURLs) in a single request. Authentication: - HTTP Basic Authentication required - Authorization header: Basic Request Body: - Array of PURLs (max 128 components) - Each PURL must include a version Response Headers: - X-Batch-Size: Total number of components requested - X-Batch-Found: Number of components found - X-Credits-Used: Credits consumed for this request - X-Credits-Remaining: Available credit balance - X-Credits-Warning: Alert when approaching credit limit (JSON) Note: Credits are only charged for components found. Requests for the same components on the same day are not charged multiple times. * Get component reports for multiple PURLs */ getComponentReportsRaw(requestParameters: OSSIndexCompatibilityApiGetComponentReportsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>>; /** * Retrieves component reports for multiple Package URLs (PURLs) in a single request. Authentication: - HTTP Basic Authentication required - Authorization header: Basic Request Body: - Array of PURLs (max 128 components) - Each PURL must include a version Response Headers: - X-Batch-Size: Total number of components requested - X-Batch-Found: Number of components found - X-Credits-Used: Credits consumed for this request - X-Credits-Remaining: Available credit balance - X-Credits-Warning: Alert when approaching credit limit (JSON) Note: Credits are only charged for components found. Requests for the same components on the same day are not charged multiple times. * Get component reports for multiple PURLs */ getComponentReports(requestParameters: OSSIndexCompatibilityApiGetComponentReportsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Retrieves component reports for multiple Package URLs (PURLs) in a single request. Authentication: - HTTP Basic Authentication required - Authorization header: Basic Request Body: - Array of PURLs (max 128 components) - Each PURL must include a version Response Headers: - X-Batch-Size: Total number of components requested - X-Batch-Found: Number of components found - X-Credits-Used: Credits consumed for this request - X-Credits-Remaining: Available credit balance - X-Credits-Warning: Alert when approaching credit limit (JSON) Note: Credits are only charged for components found. Requests for the same components on the same day are not charged multiple times. * Get component reports for multiple PURLs */ getComponentReports1Raw(requestParameters: OSSIndexCompatibilityApiGetComponentReports1Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>>; /** * Retrieves component reports for multiple Package URLs (PURLs) in a single request. Authentication: - HTTP Basic Authentication required - Authorization header: Basic Request Body: - Array of PURLs (max 128 components) - Each PURL must include a version Response Headers: - X-Batch-Size: Total number of components requested - X-Batch-Found: Number of components found - X-Credits-Used: Credits consumed for this request - X-Credits-Remaining: Available credit balance - X-Credits-Warning: Alert when approaching credit limit (JSON) Note: Credits are only charged for components found. Requests for the same components on the same day are not charged multiple times. * Get component reports for multiple PURLs */ getComponentReports1(requestParameters: OSSIndexCompatibilityApiGetComponentReports1Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Returns the API version information. This endpoint is public and does not require authentication. * Get API version * @deprecated */ getVersionRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Returns the API version information. This endpoint is public and does not require authentication. * Get API version * @deprecated */ getVersion(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; }