/** * 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 { ApiLabelDTO, ApplicableContext, ApplicableLabels } from '../models/index'; export interface ComponentLabelsApiAddLabelRequest { ownerType: AddLabelOwnerTypeEnum; ownerId: string; apiLabelDTO?: ApiLabelDTO; } export interface ComponentLabelsApiDeleteLabelRequest { ownerType: DeleteLabelOwnerTypeEnum; ownerId: string; labelId: string; } export interface ComponentLabelsApiGetApplicableContextsRequest { ownerType: GetApplicableContextsOwnerTypeEnum; ownerId: string; labelId: string; } export interface ComponentLabelsApiGetApplicableLabelsRequest { ownerType: GetApplicableLabelsOwnerTypeEnum; ownerId: string; } export interface ComponentLabelsApiGetLabelsRequest { ownerType: GetLabelsOwnerTypeEnum; ownerId: string; inherit?: boolean; } export interface ComponentLabelsApiUpdateLabelRequest { ownerType: UpdateLabelOwnerTypeEnum; ownerId: string; apiLabelDTO?: ApiLabelDTO; } /** * ComponentLabelsApi - interface * * @export * @interface ComponentLabelsApiInterface */ export interface ComponentLabelsApiInterface { /** * Use this method to create and assign a component label to an application, organization or repository. Permissions required: Edit IQ Elements * @param {'application' | 'organization' | 'repository_container' | 'repository_manager' | 'repository' | 'hosted_repository_component'} ownerType Select the ownerType to which the label will be assigned. * @param {string} ownerId Enter the id for the selected ownerType. * @param {ApiLabelDTO} [apiLabelDTO] Specify a label name, description and color for the label. Valid values for color are `light-red` , `light-green` , `light-blue` , `light-purple`, `dark-red` , `dark-green` , `dark-blue` , `dark-purple` , `orange` , `yellow`. Do not enter value for the `id` field. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ComponentLabelsApiInterface */ addLabelRaw(requestParameters: ComponentLabelsApiAddLabelRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Use this method to create and assign a component label to an application, organization or repository. Permissions required: Edit IQ Elements */ addLabel(requestParameters: ComponentLabelsApiAddLabelRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Use this method to delete an existing component label. Permissions required: Edit IQ Elements * @param {'application' | 'organization' | 'repository_container' | 'repository_manager' | 'repository' | 'hosted_repository_component'} ownerType Select the ownerType for which the label will be deleted. * @param {string} ownerId Enter the id for the selected ownerType. * @param {string} labelId Enter the id for the label to be deleted. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ComponentLabelsApiInterface */ deleteLabelRaw(requestParameters: ComponentLabelsApiDeleteLabelRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Use this method to delete an existing component label. Permissions required: Edit IQ Elements */ deleteLabel(requestParameters: ComponentLabelsApiDeleteLabelRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Use this method to retrieve the hierarchy of owners (applications, organizations, repositories) in which the label can be applied. Permissions required: Edit IQ Elements * @param {'application' | 'organization' | 'repository_container' | 'repository_manager' | 'repository' | 'hosted_repository_component'} ownerType Select the ownerType. * @param {string} ownerId Enter the ownerId * @param {string} labelId Enter the labelId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ComponentLabelsApiInterface */ getApplicableContextsRaw(requestParameters: ComponentLabelsApiGetApplicableContextsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Use this method to retrieve the hierarchy of owners (applications, organizations, repositories) in which the label can be applied. Permissions required: Edit IQ Elements */ getApplicableContexts(requestParameters: ComponentLabelsApiGetApplicableContextsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Use this method to retrieve all component labels that are applicable to the specified application, organization or repository. Permissions required: View IQ Elements * @param {'application' | 'organization' | 'repository_container' | 'repository_manager' | 'repository' | 'hosted_repository_component'} ownerType Select the ownerType to retrieve the component label information for. * @param {string} ownerId Enter the id for the application, organization or repository * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ComponentLabelsApiInterface */ getApplicableLabelsRaw(requestParameters: ComponentLabelsApiGetApplicableLabelsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Use this method to retrieve all component labels that are applicable to the specified application, organization or repository. Permissions required: View IQ Elements */ getApplicableLabels(requestParameters: ComponentLabelsApiGetApplicableLabelsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Use this method to retrieve the details for component labels for an application, organization or a repository. 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 component label information. * @param {string} ownerId Enter the id of the application, organization or the repository. * @param {boolean} [inherit] Set to `true` to retrieve inherited component labels. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ComponentLabelsApiInterface */ getLabelsRaw(requestParameters: ComponentLabelsApiGetLabelsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>>; /** * Use this method to retrieve the details for component labels for an application, organization or a repository. Permissions required: View IQ Elements */ getLabels(requestParameters: ComponentLabelsApiGetLabelsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Use this method to update an existing component label for an application, organization or repository. Permissions required: Edit IQ Elements * @param {'application' | 'organization' | 'repository_container' | 'repository_manager' | 'repository' | 'hosted_repository_component'} ownerType Select the ownerType for which the label will be updated. * @param {string} ownerId Enter the id for the selected ownerType. * @param {ApiLabelDTO} [apiLabelDTO] Specify the new values for label name, description, color and the corresponding label id for the component label to be updated. Valid values for color are `light-red` , `light-green` , `light-blue` , `light--purple`, `dark-red` , `dark-green` ,`dark-blue` , `dark-purple` ,`orange` , `yellow`. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ComponentLabelsApiInterface */ updateLabelRaw(requestParameters: ComponentLabelsApiUpdateLabelRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Use this method to update an existing component label for an application, organization or repository. Permissions required: Edit IQ Elements */ updateLabel(requestParameters: ComponentLabelsApiUpdateLabelRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; } /** * */ export declare class ComponentLabelsApi extends runtime.BaseAPI implements ComponentLabelsApiInterface { /** * Use this method to create and assign a component label to an application, organization or repository. Permissions required: Edit IQ Elements */ addLabelRaw(requestParameters: ComponentLabelsApiAddLabelRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Use this method to create and assign a component label to an application, organization or repository. Permissions required: Edit IQ Elements */ addLabel(requestParameters: ComponentLabelsApiAddLabelRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Use this method to delete an existing component label. Permissions required: Edit IQ Elements */ deleteLabelRaw(requestParameters: ComponentLabelsApiDeleteLabelRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Use this method to delete an existing component label. Permissions required: Edit IQ Elements */ deleteLabel(requestParameters: ComponentLabelsApiDeleteLabelRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Use this method to retrieve the hierarchy of owners (applications, organizations, repositories) in which the label can be applied. Permissions required: Edit IQ Elements */ getApplicableContextsRaw(requestParameters: ComponentLabelsApiGetApplicableContextsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Use this method to retrieve the hierarchy of owners (applications, organizations, repositories) in which the label can be applied. Permissions required: Edit IQ Elements */ getApplicableContexts(requestParameters: ComponentLabelsApiGetApplicableContextsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Use this method to retrieve all component labels that are applicable to the specified application, organization or repository. Permissions required: View IQ Elements */ getApplicableLabelsRaw(requestParameters: ComponentLabelsApiGetApplicableLabelsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Use this method to retrieve all component labels that are applicable to the specified application, organization or repository. Permissions required: View IQ Elements */ getApplicableLabels(requestParameters: ComponentLabelsApiGetApplicableLabelsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Use this method to retrieve the details for component labels for an application, organization or a repository. Permissions required: View IQ Elements */ getLabelsRaw(requestParameters: ComponentLabelsApiGetLabelsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>>; /** * Use this method to retrieve the details for component labels for an application, organization or a repository. Permissions required: View IQ Elements */ getLabels(requestParameters: ComponentLabelsApiGetLabelsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Use this method to update an existing component label for an application, organization or repository. Permissions required: Edit IQ Elements */ updateLabelRaw(requestParameters: ComponentLabelsApiUpdateLabelRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Use this method to update an existing component label for an application, organization or repository. Permissions required: Edit IQ Elements */ updateLabel(requestParameters: ComponentLabelsApiUpdateLabelRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; } /** * @export */ export declare const AddLabelOwnerTypeEnum: { readonly Application: "application"; readonly Organization: "organization"; readonly RepositoryContainer: "repository_container"; readonly RepositoryManager: "repository_manager"; readonly Repository: "repository"; readonly HostedRepositoryComponent: "hosted_repository_component"; }; export type AddLabelOwnerTypeEnum = typeof AddLabelOwnerTypeEnum[keyof typeof AddLabelOwnerTypeEnum]; /** * @export */ export declare const DeleteLabelOwnerTypeEnum: { readonly Application: "application"; readonly Organization: "organization"; readonly RepositoryContainer: "repository_container"; readonly RepositoryManager: "repository_manager"; readonly Repository: "repository"; readonly HostedRepositoryComponent: "hosted_repository_component"; }; export type DeleteLabelOwnerTypeEnum = typeof DeleteLabelOwnerTypeEnum[keyof typeof DeleteLabelOwnerTypeEnum]; /** * @export */ export declare const GetApplicableContextsOwnerTypeEnum: { readonly Application: "application"; readonly Organization: "organization"; readonly RepositoryContainer: "repository_container"; readonly RepositoryManager: "repository_manager"; readonly Repository: "repository"; readonly HostedRepositoryComponent: "hosted_repository_component"; }; export type GetApplicableContextsOwnerTypeEnum = typeof GetApplicableContextsOwnerTypeEnum[keyof typeof GetApplicableContextsOwnerTypeEnum]; /** * @export */ export declare const GetApplicableLabelsOwnerTypeEnum: { readonly Application: "application"; readonly Organization: "organization"; readonly RepositoryContainer: "repository_container"; readonly RepositoryManager: "repository_manager"; readonly Repository: "repository"; readonly HostedRepositoryComponent: "hosted_repository_component"; }; export type GetApplicableLabelsOwnerTypeEnum = typeof GetApplicableLabelsOwnerTypeEnum[keyof typeof GetApplicableLabelsOwnerTypeEnum]; /** * @export */ export declare const GetLabelsOwnerTypeEnum: { readonly Application: "application"; readonly Organization: "organization"; readonly RepositoryContainer: "repository_container"; readonly RepositoryManager: "repository_manager"; readonly Repository: "repository"; readonly HostedRepositoryComponent: "hosted_repository_component"; }; export type GetLabelsOwnerTypeEnum = typeof GetLabelsOwnerTypeEnum[keyof typeof GetLabelsOwnerTypeEnum]; /** * @export */ export declare const UpdateLabelOwnerTypeEnum: { readonly Application: "application"; readonly Organization: "organization"; readonly RepositoryContainer: "repository_container"; readonly RepositoryManager: "repository_manager"; readonly Repository: "repository"; readonly HostedRepositoryComponent: "hosted_repository_component"; }; export type UpdateLabelOwnerTypeEnum = typeof UpdateLabelOwnerTypeEnum[keyof typeof UpdateLabelOwnerTypeEnum];