@codacy/codacy-mcp/dist/src/api/client/services/CoverageService.js

Codacy MCP server

import { OpenAPI } from '../core/OpenAPI.js';
import { request as __request } from '../core/request.js';
export class CoverageService {
    /**
     * Get pull request coverage information from a repository
     * **Note:** When applied to public repositories, this operation does not require authentication.
     *
     * @param provider Git provider* @param remoteOrganizationName Organization name on the Git provider* @param repositoryName Repository name on the Git provider organization* @param pullRequestNumber Pull request number   * @returns PullRequestWithCoverageResponse Successful operation
     * @throws ApiError
     */
    static getRepositoryPullRequestCoverage(provider, remoteOrganizationName, repositoryName, pullRequestNumber, abortSignal) {
        return __request(OpenAPI, {
            method: 'GET',
            url: '/coverage/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/pull-requests/{pullRequestNumber}',
            path: {
                'provider': provider,
                'remoteOrganizationName': remoteOrganizationName,
                'repositoryName': repositoryName,
                'pullRequestNumber': pullRequestNumber,
            },
            abortSignal,
            errors: {
                400: `Bad Request`,
                401: `Unauthorized`,
                404: `Not Found`,
                500: `Internal Server Error`,
            },
        });
    }
    /**
     * Get pull request files coverage information from a repository
     * **Note:** When applied to public repositories, this operation does not require authentication.
     *
     * @param provider Git provider* @param remoteOrganizationName Organization name on the Git provider* @param repositoryName Repository name on the Git provider organization* @param pullRequestNumber Pull request number   * @returns PullRequestFilesCoverageResponse Successful operation
     * @throws ApiError
     */
    static getRepositoryPullRequestFilesCoverage(provider, remoteOrganizationName, repositoryName, pullRequestNumber, abortSignal) {
        return __request(OpenAPI, {
            method: 'GET',
            url: '/coverage/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/pull-requests/{pullRequestNumber}/files',
            path: {
                'provider': provider,
                'remoteOrganizationName': remoteOrganizationName,
                'repositoryName': repositoryName,
                'pullRequestNumber': pullRequestNumber,
            },
            abortSignal,
            errors: {
                400: `Bad Request`,
                401: `Unauthorized`,
                404: `Not Found`,
                500: `Internal Server Error`,
            },
        });
    }
    /**
     * Triggers the reanalysis of the latest coverage report uploaded for the pull request
     * @param provider Git provider* @param remoteOrganizationName Organization name on the Git provider* @param repositoryName Repository name on the Git provider organization* @param pullRequestNumber Pull request number   * @returns void
     * @throws ApiError
     */
    static reanalyzeCoverage(provider, remoteOrganizationName, repositoryName, pullRequestNumber, abortSignal) {
        return __request(OpenAPI, {
            method: 'GET',
            url: '/coverage/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/pull-requests/{pullRequestNumber}/reanalyze',
            path: {
                'provider': provider,
                'remoteOrganizationName': remoteOrganizationName,
                'repositoryName': repositoryName,
                'pullRequestNumber': pullRequestNumber,
            },
            abortSignal,
            errors: {
                400: `Bad Request`,
                401: `Unauthorized`,
                404: `Not Found`,
                500: `Internal Server Error`,
            },
        });
    }
    /**
     * List all coverage reports uploaded for the common ancestor commit and head commit of a pull request branch
     * @param provider Git provider* @param remoteOrganizationName Organization name on the Git provider* @param repositoryName Repository name on the Git provider organization* @param pullRequestNumber Pull request number   * @returns CoveragePullRequestResponse Successful operation
     * @throws ApiError
     */
    static getPullRequestCoverageReports(provider, remoteOrganizationName, repositoryName, pullRequestNumber, abortSignal) {
        return __request(OpenAPI, {
            method: 'GET',
            url: '/analysis/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/pull-requests/{pullRequestNumber}/coverage/status',
            path: {
                'provider': provider,
                'remoteOrganizationName': remoteOrganizationName,
                'repositoryName': repositoryName,
                'pullRequestNumber': pullRequestNumber,
            },
            abortSignal,
            errors: {
                400: `Bad Request`,
                401: `Unauthorized`,
                404: `Not Found`,
                500: `Internal Server Error`,
            },
        });
    }
    /**
     * Returns a list of the most recent coverage reports and their respective status
     * @param provider Git provider* @param remoteOrganizationName Organization name on the Git provider* @param repositoryName Repository name on the Git provider organization* @param limit Maximum number of items to return   * @returns CoverageReportResponse Successful operation
     * @throws ApiError
     */
    static listCoverageReports(provider, remoteOrganizationName, repositoryName, limit = 100, abortSignal) {
        return __request(OpenAPI, {
            method: 'GET',
            url: '/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/coverage/status',
            path: {
                'provider': provider,
                'remoteOrganizationName': remoteOrganizationName,
                'repositoryName': repositoryName,
            },
            query: {
                'limit': limit,
            },
            abortSignal,
            errors: {
                400: `Bad Request`,
                401: `Unauthorized`,
                404: `Not Found`,
                500: `Internal Server Error`,
            },
        });
    }
    /**
     * Deprecated: use [GetDiffBetweenCommits](#getDiffBetweenCommits) instead. Returns the human-readable Git diff of a pull request
     * @param provider Git provider* @param remoteOrganizationName Organization name on the Git provider* @param repositoryName Repository name on the Git provider organization* @param pullRequestNumber Pull request number   * @returns DiffResponse Successful operation
     * @throws ApiError
     */
    static getPullRequestGitDiff(provider, remoteOrganizationName, repositoryName, pullRequestNumber, abortSignal) {
        return __request(OpenAPI, {
            method: 'GET',
            url: '/coverage/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/pull-requests/{pullRequestNumber}/diff',
            path: {
                'provider': provider,
                'remoteOrganizationName': remoteOrganizationName,
                'repositoryName': repositoryName,
                'pullRequestNumber': pullRequestNumber,
            },
            abortSignal,
            errors: {
                400: `Bad Request`,
                401: `Unauthorized`,
                403: `Forbidden`,
                404: `Not Found`,
                422: `Unprocessable Entity`,
                500: `Internal Server Error`,
            },
        });
    }
}