/* tslint:disable */ /* eslint-disable */ /** * 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 { ApiZScalerConfigurationDTO, ApiZScalerQuotaDTO, } from '../models/index'; import { ApiZScalerConfigurationDTOFromJSON, ApiZScalerConfigurationDTOToJSON, ApiZScalerQuotaDTOFromJSON, ApiZScalerQuotaDTOToJSON, } from '../models/index'; export interface ConfigZscalerApiDeleteCategoryRequest { format: DeleteCategoryFormatEnum; } export interface ConfigZscalerApiSetConfiguration7Request { apiZScalerConfigurationDTO?: ApiZScalerConfigurationDTO; } export interface ConfigZscalerApiTestConfiguration1Request { apiZScalerConfigurationDTO?: ApiZScalerConfigurationDTO; } export interface ConfigZscalerApiTriggerUpdateRequest { format: TriggerUpdateFormatEnum; } /** * ConfigZscalerApi - interface * * @export * @interface ConfigZscalerApiInterface */ export interface ConfigZscalerApiInterface { /** * Use this endpoint to delete all configured formats from your Zscaler instance Permissions required: Edit System Configuration and Users * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ConfigZscalerApiInterface */ deleteAllCategoriesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Use this endpoint to delete all configured formats from your Zscaler instance Permissions required: Edit System Configuration and Users */ deleteAllCategories(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Use this endpoint to delete a specific format from your Zscaler instance Permissions required: Edit System Configuration and Users * @param {'MAVEN' | 'NPM' | 'PYPI' | 'NUGET'} format * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ConfigZscalerApiInterface */ deleteCategoryRaw(requestParameters: ConfigZscalerApiDeleteCategoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Use this endpoint to delete a specific format from your Zscaler instance Permissions required: Edit System Configuration and Users */ deleteCategory(requestParameters: ConfigZscalerApiDeleteCategoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Use this method to disable or remove the Zscaler configuration. Permissions required: Edit System Configuration and Users * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ConfigZscalerApiInterface */ deleteConfiguration8Raw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Use this method to disable or remove the Zscaler configuration. Permissions required: Edit System Configuration and Users */ deleteConfiguration8(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Use this method to review the configuration for a Zscaler server. Permissions required: Edit System Configuration and Users * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ConfigZscalerApiInterface */ getConfiguration9Raw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Use this method to review the configuration for a Zscaler server. Permissions required: Edit System Configuration and Users */ getConfiguration9(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Returns the current Zscaler quota. Permissions required: None * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ConfigZscalerApiInterface */ getQuotaRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Returns the current Zscaler quota. Permissions required: None */ getQuota(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Use this method to configure or update an existing Zscaler server configuration. Permissions required: Edit System Configuration and Users * @param {ApiZScalerConfigurationDTO} [apiZScalerConfigurationDTO] Provide one or more values for the following in the JSON payload:<ul><li>`username` - is the username for the Zscaler server.</li><li>`password` - is the password for the Zscaler server.</li><li>`hostname` - is the hostname or IP address of the Zscaler server.</li><li>`apiKey` - is the apiKey for the Zscaler Server.</li><li>`eulaAgreed` - is the agreement to the Sonatype\'s end user license agreement.</li><li>`mavenFormatEnabled` - is the flag to enable or disable the Maven format for Zscaler.</li><li>`npmFormatEnabled` - is the flag to enable or disable the Npm format for Zscaler.</li><li>`pypiFormatEnabled` - is the flag to enable or disable the Pypi format for Zscaler.</li><li>`nugetFormatEnabled` - is the flag to enable or disable the Nuget format for Zscaler.</li></ul> * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ConfigZscalerApiInterface */ setConfiguration7Raw(requestParameters: ConfigZscalerApiSetConfiguration7Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Use this method to configure or update an existing Zscaler server configuration. Permissions required: Edit System Configuration and Users */ setConfiguration7(requestParameters: ConfigZscalerApiSetConfiguration7Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Use this method to test Zscaler server configuration. Permissions required: Edit System Configuration and Users * @param {ApiZScalerConfigurationDTO} [apiZScalerConfigurationDTO] Provide one or more values for the following in the JSON payload:<ul><li>`username` - is the username for the Zscaler server.</li><li>`password` - is the password for the Zscaler server.</li><li>`hostname` - is the hostname or IP address of the Zscaler server.</li><li>`apiKey` - is the apiKey for the Zscaler Server.</li></ul> * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ConfigZscalerApiInterface */ testConfiguration1Raw(requestParameters: ConfigZscalerApiTestConfiguration1Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Use this method to test Zscaler server configuration. Permissions required: Edit System Configuration and Users */ testConfiguration1(requestParameters: ConfigZscalerApiTestConfiguration1Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Use this endpoint to trigger an update to your Zscaler instance Permissions required: Edit System Configuration and Users * @param {'MAVEN' | 'NPM' | 'PYPI' | 'NUGET'} format * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ConfigZscalerApiInterface */ triggerUpdateRaw(requestParameters: ConfigZscalerApiTriggerUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Use this endpoint to trigger an update to your Zscaler instance Permissions required: Edit System Configuration and Users */ triggerUpdate(requestParameters: ConfigZscalerApiTriggerUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Use this endpoint to trigger an update of all configured formats to your Zscaler instance Permissions required: Edit System Configuration and Users * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ConfigZscalerApiInterface */ triggerUpdateAllRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Use this endpoint to trigger an update of all configured formats to your Zscaler instance Permissions required: Edit System Configuration and Users */ triggerUpdateAll(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; } /** * */ export class ConfigZscalerApi extends runtime.BaseAPI implements ConfigZscalerApiInterface { /** * Use this endpoint to delete all configured formats from your Zscaler instance Permissions required: Edit System Configuration and Users */ async deleteAllCategoriesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise> { const queryParameters: any = {}; const headerParameters: runtime.HTTPHeaders = {}; if (this.configuration && (this.configuration.username !== undefined || this.configuration.password !== undefined)) { headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password); } if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = await token("BearerAuth", []); if (tokenString) { headerParameters["Authorization"] = `Bearer ${tokenString}`; } } let urlPath = `/api/v2/config/zscaler/update`; const response = await this.request({ path: urlPath, method: 'DELETE', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.VoidApiResponse(response); } /** * Use this endpoint to delete all configured formats from your Zscaler instance Permissions required: Edit System Configuration and Users */ async deleteAllCategories(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise { await this.deleteAllCategoriesRaw(initOverrides); } /** * Use this endpoint to delete a specific format from your Zscaler instance Permissions required: Edit System Configuration and Users */ async deleteCategoryRaw(requestParameters: ConfigZscalerApiDeleteCategoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise> { if (requestParameters['format'] == null) { throw new runtime.RequiredError( 'format', 'Required parameter "format" was null or undefined when calling deleteCategory().' ); } const queryParameters: any = {}; const headerParameters: runtime.HTTPHeaders = {}; if (this.configuration && (this.configuration.username !== undefined || this.configuration.password !== undefined)) { headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password); } if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = await token("BearerAuth", []); if (tokenString) { headerParameters["Authorization"] = `Bearer ${tokenString}`; } } let urlPath = `/api/v2/config/zscaler/update/{format}`; urlPath = urlPath.replace(`{${"format"}}`, encodeURIComponent(String(requestParameters['format']))); const response = await this.request({ path: urlPath, method: 'DELETE', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.VoidApiResponse(response); } /** * Use this endpoint to delete a specific format from your Zscaler instance Permissions required: Edit System Configuration and Users */ async deleteCategory(requestParameters: ConfigZscalerApiDeleteCategoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise { await this.deleteCategoryRaw(requestParameters, initOverrides); } /** * Use this method to disable or remove the Zscaler configuration. Permissions required: Edit System Configuration and Users */ async deleteConfiguration8Raw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise> { const queryParameters: any = {}; const headerParameters: runtime.HTTPHeaders = {}; if (this.configuration && (this.configuration.username !== undefined || this.configuration.password !== undefined)) { headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password); } if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = await token("BearerAuth", []); if (tokenString) { headerParameters["Authorization"] = `Bearer ${tokenString}`; } } let urlPath = `/api/v2/config/zscaler`; const response = await this.request({ path: urlPath, method: 'DELETE', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.VoidApiResponse(response); } /** * Use this method to disable or remove the Zscaler configuration. Permissions required: Edit System Configuration and Users */ async deleteConfiguration8(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise { await this.deleteConfiguration8Raw(initOverrides); } /** * Use this method to review the configuration for a Zscaler server. Permissions required: Edit System Configuration and Users */ async getConfiguration9Raw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise> { const queryParameters: any = {}; const headerParameters: runtime.HTTPHeaders = {}; if (this.configuration && (this.configuration.username !== undefined || this.configuration.password !== undefined)) { headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password); } if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = await token("BearerAuth", []); if (tokenString) { headerParameters["Authorization"] = `Bearer ${tokenString}`; } } let urlPath = `/api/v2/config/zscaler`; const response = await this.request({ path: urlPath, method: 'GET', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.JSONApiResponse(response, (jsonValue) => ApiZScalerConfigurationDTOFromJSON(jsonValue)); } /** * Use this method to review the configuration for a Zscaler server. Permissions required: Edit System Configuration and Users */ async getConfiguration9(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise { const response = await this.getConfiguration9Raw(initOverrides); return await response.value(); } /** * Returns the current Zscaler quota. Permissions required: None */ async getQuotaRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise> { const queryParameters: any = {}; const headerParameters: runtime.HTTPHeaders = {}; if (this.configuration && (this.configuration.username !== undefined || this.configuration.password !== undefined)) { headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password); } if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = await token("BearerAuth", []); if (tokenString) { headerParameters["Authorization"] = `Bearer ${tokenString}`; } } let urlPath = `/api/v2/config/zscaler/zscalerLimits`; const response = await this.request({ path: urlPath, method: 'GET', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.JSONApiResponse(response, (jsonValue) => ApiZScalerQuotaDTOFromJSON(jsonValue)); } /** * Returns the current Zscaler quota. Permissions required: None */ async getQuota(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise { const response = await this.getQuotaRaw(initOverrides); return await response.value(); } /** * Use this method to configure or update an existing Zscaler server configuration. Permissions required: Edit System Configuration and Users */ async setConfiguration7Raw(requestParameters: ConfigZscalerApiSetConfiguration7Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise> { const queryParameters: any = {}; const headerParameters: runtime.HTTPHeaders = {}; headerParameters['Content-Type'] = 'application/json'; if (this.configuration && (this.configuration.username !== undefined || this.configuration.password !== undefined)) { headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password); } if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = await token("BearerAuth", []); if (tokenString) { headerParameters["Authorization"] = `Bearer ${tokenString}`; } } let urlPath = `/api/v2/config/zscaler`; const response = await this.request({ path: urlPath, method: 'PUT', headers: headerParameters, query: queryParameters, body: ApiZScalerConfigurationDTOToJSON(requestParameters['apiZScalerConfigurationDTO']), }, initOverrides); if (this.isJsonMime(response.headers.get('content-type'))) { return new runtime.JSONApiResponse(response); } else { return new runtime.TextApiResponse(response) as any; } } /** * Use this method to configure or update an existing Zscaler server configuration. Permissions required: Edit System Configuration and Users */ async setConfiguration7(requestParameters: ConfigZscalerApiSetConfiguration7Request = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise { const response = await this.setConfiguration7Raw(requestParameters, initOverrides); return await response.value(); } /** * Use this method to test Zscaler server configuration. Permissions required: Edit System Configuration and Users */ async testConfiguration1Raw(requestParameters: ConfigZscalerApiTestConfiguration1Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise> { const queryParameters: any = {}; const headerParameters: runtime.HTTPHeaders = {}; headerParameters['Content-Type'] = 'application/json'; if (this.configuration && (this.configuration.username !== undefined || this.configuration.password !== undefined)) { headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password); } if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = await token("BearerAuth", []); if (tokenString) { headerParameters["Authorization"] = `Bearer ${tokenString}`; } } let urlPath = `/api/v2/config/zscaler/testConfig`; const response = await this.request({ path: urlPath, method: 'POST', headers: headerParameters, query: queryParameters, body: ApiZScalerConfigurationDTOToJSON(requestParameters['apiZScalerConfigurationDTO']), }, initOverrides); return new runtime.VoidApiResponse(response); } /** * Use this method to test Zscaler server configuration. Permissions required: Edit System Configuration and Users */ async testConfiguration1(requestParameters: ConfigZscalerApiTestConfiguration1Request = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise { await this.testConfiguration1Raw(requestParameters, initOverrides); } /** * Use this endpoint to trigger an update to your Zscaler instance Permissions required: Edit System Configuration and Users */ async triggerUpdateRaw(requestParameters: ConfigZscalerApiTriggerUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise> { if (requestParameters['format'] == null) { throw new runtime.RequiredError( 'format', 'Required parameter "format" was null or undefined when calling triggerUpdate().' ); } const queryParameters: any = {}; const headerParameters: runtime.HTTPHeaders = {}; if (this.configuration && (this.configuration.username !== undefined || this.configuration.password !== undefined)) { headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password); } if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = await token("BearerAuth", []); if (tokenString) { headerParameters["Authorization"] = `Bearer ${tokenString}`; } } let urlPath = `/api/v2/config/zscaler/update/{format}`; urlPath = urlPath.replace(`{${"format"}}`, encodeURIComponent(String(requestParameters['format']))); const response = await this.request({ path: urlPath, method: 'POST', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.VoidApiResponse(response); } /** * Use this endpoint to trigger an update to your Zscaler instance Permissions required: Edit System Configuration and Users */ async triggerUpdate(requestParameters: ConfigZscalerApiTriggerUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise { await this.triggerUpdateRaw(requestParameters, initOverrides); } /** * Use this endpoint to trigger an update of all configured formats to your Zscaler instance Permissions required: Edit System Configuration and Users */ async triggerUpdateAllRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise> { const queryParameters: any = {}; const headerParameters: runtime.HTTPHeaders = {}; if (this.configuration && (this.configuration.username !== undefined || this.configuration.password !== undefined)) { headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password); } if (this.configuration && this.configuration.accessToken) { const token = this.configuration.accessToken; const tokenString = await token("BearerAuth", []); if (tokenString) { headerParameters["Authorization"] = `Bearer ${tokenString}`; } } let urlPath = `/api/v2/config/zscaler/update`; const response = await this.request({ path: urlPath, method: 'POST', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.VoidApiResponse(response); } /** * Use this endpoint to trigger an update of all configured formats to your Zscaler instance Permissions required: Edit System Configuration and Users */ async triggerUpdateAll(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise { await this.triggerUpdateAllRaw(initOverrides); } } /** * @export */ export const DeleteCategoryFormatEnum = { Maven: 'MAVEN', Npm: 'NPM', Pypi: 'PYPI', Nuget: 'NUGET' } as const; export type DeleteCategoryFormatEnum = typeof DeleteCategoryFormatEnum[keyof typeof DeleteCategoryFormatEnum]; /** * @export */ export const TriggerUpdateFormatEnum = { Maven: 'MAVEN', Npm: 'NPM', Pypi: 'PYPI', Nuget: 'NUGET' } as const; export type TriggerUpdateFormatEnum = typeof TriggerUpdateFormatEnum[keyof typeof TriggerUpdateFormatEnum];