UNPKG

@codacy/codacy-mcp

Version:

Codacy MCP server

427 lines (426 loc) 19.9 kB
import { OpenAPI } from '../core/OpenAPI.js'; import { request as __request } from '../core/request.js'; export class ConfigurationService { /** * Follow a repository that was already added to Codacy * @param provider Git provider* @param remoteOrganizationName Organization name on the Git provider* @param repositoryName Repository name on the Git provider organization * @returns AddedStateResponse Successful operation * @throws ApiError */ static followAddedRepository(provider, remoteOrganizationName, repositoryName, abortSignal) { return __request(OpenAPI, { method: 'POST', url: '/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/follow', path: { 'provider': provider, 'remoteOrganizationName': remoteOrganizationName, 'repositoryName': repositoryName, }, abortSignal, errors: { 400: `Bad Request`, 401: `Unauthorized`, 404: `Not Found`, 500: `Internal Server Error`, }, }); } /** * unfollow a repository * @param provider Git provider* @param remoteOrganizationName Organization name on the Git provider* @param repositoryName Repository name on the Git provider organization * @returns void * @throws ApiError */ static unfollowRepository(provider, remoteOrganizationName, repositoryName, abortSignal) { return __request(OpenAPI, { method: 'DELETE', url: '/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/follow', path: { 'provider': provider, 'remoteOrganizationName': remoteOrganizationName, 'repositoryName': repositoryName, }, abortSignal, errors: { 400: `Bad Request`, 401: `Unauthorized`, 404: `Not Found`, 500: `Internal Server Error`, }, }); } /** * Get quality settings for the specific repository * @param provider Git provider* @param remoteOrganizationName Organization name on the Git provider* @param repositoryName Repository name on the Git provider organization * @returns RepositoryQualitySettingsResponse Successful operation * @throws ApiError */ static getQualitySettingsForRepository(provider, remoteOrganizationName, repositoryName, abortSignal) { return __request(OpenAPI, { method: 'GET', url: '/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/settings/quality/repository', path: { 'provider': provider, 'remoteOrganizationName': remoteOrganizationName, 'repositoryName': repositoryName, }, abortSignal, errors: { 400: `Bad Request`, 401: `Unauthorized`, 404: `Not Found`, 500: `Internal Server Error`, }, }); } /** * Update quality settings for the specific repository * @param provider Git provider* @param remoteOrganizationName Organization name on the Git provider* @param repositoryName Repository name on the Git provider organization* @param requestBody The new value for the quality settings of the repository * @returns RepositoryQualitySettingsResponse Successful operation * @throws ApiError */ static updateRepositoryQualitySettings(provider, remoteOrganizationName, repositoryName, requestBody, abortSignal) { return __request(OpenAPI, { method: 'PUT', url: '/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/settings/quality/repository', path: { 'provider': provider, 'remoteOrganizationName': remoteOrganizationName, 'repositoryName': repositoryName, }, abortSignal, body: requestBody, mediaType: 'application/json', errors: { 400: `Bad Request`, 401: `Unauthorized`, 404: `Not Found`, 500: `Internal Server Error`, }, }); } /** * Regenerate the user SSH key that Codacy uses to clone the repository * Codacy automatically adds the new public user SSH key to the user account on the Git provider. Using a user SSH key is recommended if your repository includes submodules. * @param provider Git provider* @param remoteOrganizationName Organization name on the Git provider* @param repositoryName Repository name on the Git provider organization * @returns SshKeySettingResponse Successful operation * @throws ApiError */ static regenerateUserSshKey(provider, remoteOrganizationName, repositoryName, abortSignal) { return __request(OpenAPI, { method: 'POST', url: '/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/settings/ssh-user-key', path: { 'provider': provider, 'remoteOrganizationName': remoteOrganizationName, 'repositoryName': repositoryName, }, abortSignal, errors: { 400: `Bad Request`, 401: `Unauthorized`, 404: `Not Found`, 500: `Internal Server Error`, }, }); } /** * Regenerate the SSH key that Codacy uses to clone the repository * Codacy automatically adds the new public SSH key to the repository on the Git provider. * @param provider Git provider* @param remoteOrganizationName Organization name on the Git provider* @param repositoryName Repository name on the Git provider organization * @returns SshKeySettingResponse Successful operation * @throws ApiError */ static regenerateRepositorySshKey(provider, remoteOrganizationName, repositoryName, abortSignal) { return __request(OpenAPI, { method: 'POST', url: '/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/settings/ssh-repository-key', path: { 'provider': provider, 'remoteOrganizationName': remoteOrganizationName, 'repositoryName': repositoryName, }, abortSignal, errors: { 400: `Bad Request`, 401: `Unauthorized`, 404: `Not Found`, 500: `Internal Server Error`, }, }); } /** * Get the public SSH key for the repository * Returns the most recently generated public SSH key, which can be either a user or repository SSH key. * @param provider Git provider* @param remoteOrganizationName Organization name on the Git provider* @param repositoryName Repository name on the Git provider organization * @returns SshKeySettingResponse Successful operation * @throws ApiError */ static getRepositoryPublicSshKey(provider, remoteOrganizationName, repositoryName, abortSignal) { return __request(OpenAPI, { method: 'GET', url: '/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/settings/stored-ssh-key', path: { 'provider': provider, 'remoteOrganizationName': remoteOrganizationName, 'repositoryName': repositoryName, }, abortSignal, errors: { 400: `Bad Request`, 401: `Unauthorized`, 404: `Not Found`, 500: `Internal Server Error`, }, }); } /** * Synchronize repository name and visibility with Git provider * @param provider Git provider* @param remoteOrganizationName Organization name on the Git provider* @param repositoryName Repository name on the Git provider organization * @returns SyncProviderSettingResponse Successful operation * @throws ApiError */ static syncRepositoryWithProvider(provider, remoteOrganizationName, repositoryName, abortSignal) { return __request(OpenAPI, { method: 'POST', url: '/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/settings/sync', path: { 'provider': provider, 'remoteOrganizationName': remoteOrganizationName, 'repositoryName': repositoryName, }, abortSignal, errors: { 400: `Bad Request`, 401: `Unauthorized`, 404: `Not Found`, 500: `Internal Server Error`, }, }); } /** * Get the status of the repository setting **Run analysis on your build server** * @param provider Git provider* @param remoteOrganizationName Organization name on the Git provider* @param repositoryName Repository name on the Git provider organization * @returns BuildServerAnalysisSettingResponse Successful operation * @throws ApiError */ static getBuildServerAnalysisSetting(provider, remoteOrganizationName, repositoryName, abortSignal) { return __request(OpenAPI, { method: 'GET', url: '/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/settings/analysis', path: { 'provider': provider, 'remoteOrganizationName': remoteOrganizationName, 'repositoryName': repositoryName, }, abortSignal, errors: { 400: `Bad Request`, 401: `Unauthorized`, 404: `Not Found`, 405: `Method Not Allowed`, 500: `Internal Server Error`, }, }); } /** * Updates the status of the repository setting **Run analysis on your build server** * @param provider Git provider* @param remoteOrganizationName Organization name on the Git provider* @param repositoryName Repository name on the Git provider organization* @param requestBody New value for the repository setting **Run analysis on your build server** * @returns BuildServerAnalysisSettingResponse Successful operation * @throws ApiError */ static updateBuildServerAnalysisSetting(provider, remoteOrganizationName, repositoryName, requestBody, abortSignal) { return __request(OpenAPI, { method: 'PATCH', url: '/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/settings/analysis', path: { 'provider': provider, 'remoteOrganizationName': remoteOrganizationName, 'repositoryName': repositoryName, }, abortSignal, body: requestBody, mediaType: 'application/json', errors: { 400: `Bad Request`, 401: `Unauthorized`, 404: `Not Found`, 405: `Method Not Allowed`, 500: `Internal Server Error`, }, }); } /** * Get quality settings for the commits of a repository. * `diffCoverageThreshold` is never returned because this threshold isn't currently supported for commits. * * @param provider Git provider* @param remoteOrganizationName Organization name on the Git provider* @param repositoryName Repository name on the Git provider organization * @returns QualitySettingsResponse Successful operation * @throws ApiError */ static getCommitQualitySettings(provider, remoteOrganizationName, repositoryName, abortSignal) { return __request(OpenAPI, { method: 'GET', url: '/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/settings/quality/commits', path: { 'provider': provider, 'remoteOrganizationName': remoteOrganizationName, 'repositoryName': repositoryName, }, abortSignal, errors: { 400: `Bad Request`, 401: `Unauthorized`, 404: `Not Found`, 500: `Internal Server Error`, }, }); } /** * Update quality settings for the commits of a repository * @param provider Git provider* @param remoteOrganizationName Organization name on the Git provider* @param repositoryName Repository name on the Git provider organization* @param requestBody The new value for the quality settings of commits in a repository * @returns QualitySettingsResponse Successful operation * @throws ApiError */ static updateCommitQualitySettings(provider, remoteOrganizationName, repositoryName, requestBody, abortSignal) { return __request(OpenAPI, { method: 'PUT', url: '/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/settings/quality/commits', path: { 'provider': provider, 'remoteOrganizationName': remoteOrganizationName, 'repositoryName': repositoryName, }, abortSignal, body: requestBody, mediaType: 'application/json', errors: { 400: `Bad Request`, 401: `Unauthorized`, 404: `Not Found`, 500: `Internal Server Error`, }, }); } /** * Reset quality settings for the commits of a repository to Codacy’s default values * @param provider Git provider* @param remoteOrganizationName Organization name on the Git provider* @param repositoryName Repository name on the Git provider organization * @returns QualitySettingsResponse Successful operation * @throws ApiError */ static resetCommitsQualitySettings(provider, remoteOrganizationName, repositoryName, abortSignal) { return __request(OpenAPI, { method: 'POST', url: '/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/settings/quality/commits/reset', path: { 'provider': provider, 'remoteOrganizationName': remoteOrganizationName, 'repositoryName': repositoryName, }, abortSignal, errors: { 400: `Bad Request`, 401: `Unauthorized`, 404: `Not Found`, 500: `Internal Server Error`, }, }); } /** * Reset quality settings for the pull requests of a repository to Codacy’s default values * @param provider Git provider* @param remoteOrganizationName Organization name on the Git provider* @param repositoryName Repository name on the Git provider organization * @returns QualitySettingsResponse Successful operation * @throws ApiError */ static resetPullRequestsQualitySettings(provider, remoteOrganizationName, repositoryName, abortSignal) { return __request(OpenAPI, { method: 'POST', url: '/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/settings/quality/pull-requests/reset', path: { 'provider': provider, 'remoteOrganizationName': remoteOrganizationName, 'repositoryName': repositoryName, }, abortSignal, errors: { 400: `Bad Request`, 401: `Unauthorized`, 404: `Not Found`, 500: `Internal Server Error`, }, }); } /** * Reset quality settings for the repository to Codacy’s default values * @param provider Git provider* @param remoteOrganizationName Organization name on the Git provider* @param repositoryName Repository name on the Git provider organization * @returns RepositoryQualitySettingsResponse Successful operation * @throws ApiError */ static resetRepositoryQualitySettings(provider, remoteOrganizationName, repositoryName, abortSignal) { return __request(OpenAPI, { method: 'POST', url: '/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/settings/quality/repository/reset', path: { 'provider': provider, 'remoteOrganizationName': remoteOrganizationName, 'repositoryName': repositoryName, }, abortSignal, errors: { 400: `Bad Request`, 401: `Unauthorized`, 404: `Not Found`, 500: `Internal Server Error`, }, }); } /** * Get quality settings for the pull requests of a repository * @param provider Git provider* @param remoteOrganizationName Organization name on the Git provider* @param repositoryName Repository name on the Git provider organization * @returns QualitySettingsResponse Successful operation * @throws ApiError */ static getPullRequestQualitySettings(provider, remoteOrganizationName, repositoryName, abortSignal) { return __request(OpenAPI, { method: 'GET', url: '/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/settings/quality/pull-requests', path: { 'provider': provider, 'remoteOrganizationName': remoteOrganizationName, 'repositoryName': repositoryName, }, abortSignal, errors: { 400: `Bad Request`, 401: `Unauthorized`, 404: `Not Found`, 500: `Internal Server Error`, }, }); } /** * Update quality settings for the pull requests of a repository * @param provider Git provider* @param remoteOrganizationName Organization name on the Git provider* @param repositoryName Repository name on the Git provider organization* @param requestBody The new value for the quality settings of pull requests in the repository * @returns QualitySettingsResponse Successful operation * @throws ApiError */ static updatePullRequestQualitySettings(provider, remoteOrganizationName, repositoryName, requestBody, abortSignal) { return __request(OpenAPI, { method: 'PUT', url: '/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/settings/quality/pull-requests', path: { 'provider': provider, 'remoteOrganizationName': remoteOrganizationName, 'repositoryName': repositoryName, }, abortSignal, body: requestBody, mediaType: 'application/json', errors: { 400: `Bad Request`, 401: `Unauthorized`, 404: `Not Found`, 500: `Internal Server Error`, }, }); } /** * Get configuration status * Get configuration status * @returns ConfigurationStatusResponse Successful operation * @throws ApiError */ static getConfigurationStatus(abortSignal) { return __request(OpenAPI, { method: 'GET', url: '/configuration/status', abortSignal, errors: { 500: `Internal Server Error`, }, }); } }