/** * 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.207.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 { ApiAppliedLicenseOverridesDTO, ApiLicenseOverrideDTO, ComponentIdentifier } from '../models/index'; export interface LicenseOverridesApiAddLicenseOverrideRequest { ownerType: AddLicenseOverrideOwnerTypeEnum; ownerId: string; apiLicenseOverrideDTO: ApiLicenseOverrideDTO; where?: string; } export interface LicenseOverridesApiDeleteLicenseOverrideRequest { ownerType: DeleteLicenseOverrideOwnerTypeEnum; ownerId: string; licenseOverrideId: string; where?: string; } export interface LicenseOverridesApiGetAppliedLicenseOverridesRequest { ownerType: GetAppliedLicenseOverridesOwnerTypeEnum; ownerId: string; componentIdentifier: ComponentIdentifier; } export interface LicenseOverridesApiGetAppliedLicenseOverridesForLegalReviewerRequest { ownerType: GetAppliedLicenseOverridesForLegalReviewerOwnerTypeEnum; ownerId: string; componentIdentifier: ComponentIdentifier; } /** * LicenseOverridesApi - interface * * @export * @interface LicenseOverridesApiInterface */ export interface LicenseOverridesApiInterface { /** * Use this method to add or update a license override to a component for a given owner scope. Permissions required: Change Licenses * @param {'application' | 'organization' | 'repository_container' | 'repository_manager' | 'repository' | 'hosted_repository_component'} ownerType Select the `ownerType` scope for which you want to add or update a license override * @param {string} ownerId Enter the id of the application, organization or the repository. * @param {ApiLicenseOverrideDTO} apiLicenseOverrideDTO Enter the license override details to add or update a license override for a component. The request body should contain the following fields: - `ownerId`: Enter the id of the application, organization or the repository. - `comment`: Enter a comment for the license override. - `licenseIds`: Enter the license ids for the license override. - `componentIdentifier`: Enter the componentIdentifier consisting of format and coordinates. - `status`: Enter the status of the license override. The possible values are `OPEN`, `ACKNOWLEDGED`, `OVERRIDDEN`, `SELECTED`, and `CONFIRMED`. * @param {string} [where] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof LicenseOverridesApiInterface */ addLicenseOverrideRaw(requestParameters: LicenseOverridesApiAddLicenseOverrideRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Use this method to add or update a license override to a component for a given owner scope. Permissions required: Change Licenses */ addLicenseOverride(requestParameters: LicenseOverridesApiAddLicenseOverrideRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Use this method to delete a license override for a component. Permissions required: Change Licenses * @param {'application' | 'organization' | 'repository_container' | 'repository_manager' | 'repository' | 'hosted_repository_component'} ownerType Select the `ownerType` scope for which you want to delete license override * @param {string} ownerId Enter the id of the application, organization or the repository. * @param {string} licenseOverrideId Enter the id of the license override you want to delete. * @param {string} [where] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof LicenseOverridesApiInterface */ deleteLicenseOverrideRaw(requestParameters: LicenseOverridesApiDeleteLicenseOverrideRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Use this method to delete a license override for a component. Permissions required: Change Licenses */ deleteLicenseOverride(requestParameters: LicenseOverridesApiDeleteLicenseOverrideRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Use this method to retrieve the applied license overrides for a component. Permissions required: View IQ Elements * @param {'application' | 'organization' | 'repository_container' | 'repository_manager' | 'repository' | 'hosted_repository_component'} ownerType Select the `ownerType` for which you want to retrieve the applied license overrides. * @param {string} ownerId Enter the id of the application, organization or the repository. * @param {ComponentIdentifier} componentIdentifier Enter the componentIdentifier consisting of format and coordinates as a JSON e.g., `?componentIdentifier={\"format\":\"maven\",\"coordinates\":\"{...}}\"} * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof LicenseOverridesApiInterface */ getAppliedLicenseOverridesRaw(requestParameters: LicenseOverridesApiGetAppliedLicenseOverridesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Use this method to retrieve the applied license overrides for a component. Permissions required: View IQ Elements */ getAppliedLicenseOverrides(requestParameters: LicenseOverridesApiGetAppliedLicenseOverridesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Use this method to retrieve the applied license overrides for a given component and owner. Permissions required: Review Legal Obligations For Components Licenses * @param {'application' | 'organization' | 'repository_container' | 'repository_manager' | 'repository' | 'hosted_repository_component'} ownerType Select the `ownerType` for which you want to retrieve the applied license overrides. * @param {string} ownerId Enter the id of the owner. * @param {ComponentIdentifier} componentIdentifier Enter the component format and coordinates. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof LicenseOverridesApiInterface */ getAppliedLicenseOverridesForLegalReviewerRaw(requestParameters: LicenseOverridesApiGetAppliedLicenseOverridesForLegalReviewerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Use this method to retrieve the applied license overrides for a given component and owner. Permissions required: Review Legal Obligations For Components Licenses */ getAppliedLicenseOverridesForLegalReviewer(requestParameters: LicenseOverridesApiGetAppliedLicenseOverridesForLegalReviewerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; } /** * */ export declare class LicenseOverridesApi extends runtime.BaseAPI implements LicenseOverridesApiInterface { /** * Use this method to add or update a license override to a component for a given owner scope. Permissions required: Change Licenses */ addLicenseOverrideRaw(requestParameters: LicenseOverridesApiAddLicenseOverrideRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Use this method to add or update a license override to a component for a given owner scope. Permissions required: Change Licenses */ addLicenseOverride(requestParameters: LicenseOverridesApiAddLicenseOverrideRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Use this method to delete a license override for a component. Permissions required: Change Licenses */ deleteLicenseOverrideRaw(requestParameters: LicenseOverridesApiDeleteLicenseOverrideRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Use this method to delete a license override for a component. Permissions required: Change Licenses */ deleteLicenseOverride(requestParameters: LicenseOverridesApiDeleteLicenseOverrideRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Use this method to retrieve the applied license overrides for a component. Permissions required: View IQ Elements */ getAppliedLicenseOverridesRaw(requestParameters: LicenseOverridesApiGetAppliedLicenseOverridesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Use this method to retrieve the applied license overrides for a component. Permissions required: View IQ Elements */ getAppliedLicenseOverrides(requestParameters: LicenseOverridesApiGetAppliedLicenseOverridesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Use this method to retrieve the applied license overrides for a given component and owner. Permissions required: Review Legal Obligations For Components Licenses */ getAppliedLicenseOverridesForLegalReviewerRaw(requestParameters: LicenseOverridesApiGetAppliedLicenseOverridesForLegalReviewerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Use this method to retrieve the applied license overrides for a given component and owner. Permissions required: Review Legal Obligations For Components Licenses */ getAppliedLicenseOverridesForLegalReviewer(requestParameters: LicenseOverridesApiGetAppliedLicenseOverridesForLegalReviewerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; } /** * @export */ export declare const AddLicenseOverrideOwnerTypeEnum: { readonly Application: "application"; readonly Organization: "organization"; readonly RepositoryContainer: "repository_container"; readonly RepositoryManager: "repository_manager"; readonly Repository: "repository"; readonly HostedRepositoryComponent: "hosted_repository_component"; }; export type AddLicenseOverrideOwnerTypeEnum = typeof AddLicenseOverrideOwnerTypeEnum[keyof typeof AddLicenseOverrideOwnerTypeEnum]; /** * @export */ export declare const DeleteLicenseOverrideOwnerTypeEnum: { readonly Application: "application"; readonly Organization: "organization"; readonly RepositoryContainer: "repository_container"; readonly RepositoryManager: "repository_manager"; readonly Repository: "repository"; readonly HostedRepositoryComponent: "hosted_repository_component"; }; export type DeleteLicenseOverrideOwnerTypeEnum = typeof DeleteLicenseOverrideOwnerTypeEnum[keyof typeof DeleteLicenseOverrideOwnerTypeEnum]; /** * @export */ export declare const GetAppliedLicenseOverridesOwnerTypeEnum: { readonly Application: "application"; readonly Organization: "organization"; readonly RepositoryContainer: "repository_container"; readonly RepositoryManager: "repository_manager"; readonly Repository: "repository"; readonly HostedRepositoryComponent: "hosted_repository_component"; }; export type GetAppliedLicenseOverridesOwnerTypeEnum = typeof GetAppliedLicenseOverridesOwnerTypeEnum[keyof typeof GetAppliedLicenseOverridesOwnerTypeEnum]; /** * @export */ export declare const GetAppliedLicenseOverridesForLegalReviewerOwnerTypeEnum: { readonly Application: "application"; readonly Organization: "organization"; readonly RepositoryContainer: "repository_container"; readonly RepositoryManager: "repository_manager"; readonly Repository: "repository"; readonly HostedRepositoryComponent: "hosted_repository_component"; }; export type GetAppliedLicenseOverridesForLegalReviewerOwnerTypeEnum = typeof GetAppliedLicenseOverridesForLegalReviewerOwnerTypeEnum[keyof typeof GetAppliedLicenseOverridesForLegalReviewerOwnerTypeEnum];