@codacy/codacy-mcp
Version:
Codacy MCP server
1,050 lines • 52.3 kB
JavaScript
import { OpenAPI } from '../core/OpenAPI.js';
import { request as __request } from '../core/request.js';
export class RepositoryService {
/**
* 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 Git provider integration settings for a repository
* @param provider Git provider* @param remoteOrganizationName Organization name on the Git provider* @param repositoryName Repository name on the Git provider organization * @returns RepositoryIntegrationSettings Successful operation
* @throws ApiError
*/
static getRepositoryIntegrationsSettings(provider, remoteOrganizationName, repositoryName, abortSignal) {
return __request(OpenAPI, {
method: 'GET',
url: '/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/integrations/providerSettings',
path: {
'provider': provider,
'remoteOrganizationName': remoteOrganizationName,
'repositoryName': repositoryName,
},
abortSignal,
errors: {
400: `Bad Request`,
401: `Unauthorized`,
404: `Not Found`,
500: `Internal Server Error`,
502: `Bad Gateway`,
},
});
}
/**
* Update Git provider integration settings for 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 * @returns void
* @throws ApiError
*/
static updateRepositoryIntegrationsSettings(provider, remoteOrganizationName, repositoryName, requestBody, abortSignal) {
return __request(OpenAPI, {
method: 'PATCH',
url: '/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/integrations/providerSettings',
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`,
502: `Bad Gateway`,
},
});
}
/**
* Creates a [post-commit hook](https://docs.codacy.com/repositories-configure/integrations/post-commit-hooks/) for 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 createPostCommitHook(provider, remoteOrganizationName, repositoryName, abortSignal) {
return __request(OpenAPI, {
method: 'GET',
url: '/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/integrations/postCommitHook',
path: {
'provider': provider,
'remoteOrganizationName': remoteOrganizationName,
'repositoryName': repositoryName,
},
abortSignal,
errors: {
400: `Bad Request`,
401: `Unauthorized`,
403: `Forbidden`,
404: `Not Found`,
500: `An unexpected error occurred while creating the post-commit hook`,
},
});
}
/**
* Refresh the Git provider integration for a repository (GitLab and Bitbucket only)
* Codacy will use the authenticated user to create comments on new pull requests
* @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 refreshProviderRepositoryIntegration(provider, remoteOrganizationName, repositoryName, abortSignal) {
return __request(OpenAPI, {
method: 'POST',
url: '/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/integrations/refreshProvider',
path: {
'provider': provider,
'remoteOrganizationName': remoteOrganizationName,
'repositoryName': repositoryName,
},
abortSignal,
errors: {
400: `Bad Request`,
401: `Unauthorized`,
403: `Forbidden`,
404: `Not Found`,
500: `An unexpected error occurred while refreshing the repository Git provider integration`,
},
});
}
/**
* Reanalyze a specific commit in 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 UUID or SHA string that identifies the commit * @returns void
* @throws ApiError
*/
static reanalyzeCommitById(provider, remoteOrganizationName, repositoryName, requestBody, abortSignal) {
return __request(OpenAPI, {
method: 'POST',
url: '/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/reanalyzeCommit',
path: {
'provider': provider,
'remoteOrganizationName': remoteOrganizationName,
'repositoryName': repositoryName,
},
abortSignal,
body: requestBody,
mediaType: 'application/json',
errors: {
400: `Bad Request`,
401: `Unauthorized`,
403: `Forbidden`,
404: `Not Found`,
500: `Internal Server Error`,
},
});
}
/**
* Fetch the specified 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 * @returns RepositoryResponse Successful operation
* @throws ApiError
*/
static getRepository(provider, remoteOrganizationName, repositoryName, abortSignal) {
return __request(OpenAPI, {
method: 'GET',
url: '/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}',
path: {
'provider': provider,
'remoteOrganizationName': remoteOrganizationName,
'repositoryName': repositoryName,
},
abortSignal,
errors: {
400: `Bad Request`,
401: `Unauthorized`,
403: `Forbidden`,
404: `Not Found`,
500: `Internal Server Error`,
},
});
}
/**
* Delete the specified 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 deleteRepository(provider, remoteOrganizationName, repositoryName, abortSignal) {
return __request(OpenAPI, {
method: 'DELETE',
url: '/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}',
path: {
'provider': provider,
'remoteOrganizationName': remoteOrganizationName,
'repositoryName': repositoryName,
},
abortSignal,
errors: {
400: `Bad Request`,
401: `Unauthorized`,
403: `Forbidden`,
404: `Not Found`,
500: `Internal Server Error`,
},
});
}
/**
* List repository branches
* **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 enabled Returns only the enabled or disabled branches.* @param cursor Cursor to [specify a batch of results to request](https://docs.codacy.com/codacy-api/using-the-codacy-api/#using-pagination)* @param limit Maximum number of items to return* @param search Filter the results searching by this string.* @param sort Field used to sort the list of branches. The allowed values are 'name' and 'last-updated'.* @param direction Sort direction. Possible values are 'asc' (ascending) or 'desc' (descending). * @returns BranchListResponse Successful operation
* @throws ApiError
*/
static listRepositoryBranches(provider, remoteOrganizationName, repositoryName, enabled, cursor, limit = 100, search, sort, direction, abortSignal) {
return __request(OpenAPI, {
method: 'GET',
url: '/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/branches',
path: {
'provider': provider,
'remoteOrganizationName': remoteOrganizationName,
'repositoryName': repositoryName,
},
query: {
'enabled': enabled,
'cursor': cursor,
'limit': limit,
'search': search,
'sort': sort,
'direction': direction,
},
abortSignal,
errors: {
400: `Bad Request`,
401: `Unauthorized`,
404: `Not Found`,
500: `Internal Server Error`,
},
});
}
/**
* Update the settings for a repository branch
* Toggle analysis for a branch.
*
* @param provider Git provider* @param remoteOrganizationName Organization name on the Git provider* @param repositoryName Repository name on the Git provider organization* @param branchName Repository branch name* @param requestBody * @returns void
* @throws ApiError
*/
static updateRepositoryBranchConfiguration(provider, remoteOrganizationName, repositoryName, branchName, requestBody, abortSignal) {
return __request(OpenAPI, {
method: 'PATCH',
url: '/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/branches/{branchName}',
path: {
'provider': provider,
'remoteOrganizationName': remoteOrganizationName,
'repositoryName': repositoryName,
'branchName': branchName,
},
abortSignal,
body: requestBody,
mediaType: 'application/json',
errors: {
400: `Bad Request`,
401: `Unauthorized`,
404: `Not Found`,
500: `Internal Server Error`,
},
});
}
/**
* Set branch as default
* Sets the default branch for a repository. The new default branch must already be enabled on Codacy.
*
* @param provider Git provider* @param remoteOrganizationName Organization name on the Git provider* @param repositoryName Repository name on the Git provider organization* @param branchName Repository branch name * @returns void
* @throws ApiError
*/
static setRepositoryBranchAsDefault(provider, remoteOrganizationName, repositoryName, branchName, abortSignal) {
return __request(OpenAPI, {
method: 'POST',
url: '/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/branches/{branchName}/setDefault',
path: {
'provider': provider,
'remoteOrganizationName': remoteOrganizationName,
'repositoryName': repositoryName,
'branchName': branchName,
},
abortSignal,
errors: {
400: `Bad Request`,
401: `Unauthorized`,
404: `Not Found`,
500: `Internal Server Error`,
},
});
}
/**
* Get branch required status checks
* Get branch required status checks
*
* @param provider Git provider* @param remoteOrganizationName Organization name on the Git provider* @param repositoryName Repository name on the Git provider organization* @param branchName Repository branch name * @returns BranchRequiredChecksResponse Successful operation
* @throws ApiError
*/
static getBranchRequiredChecks(provider, remoteOrganizationName, repositoryName, branchName, abortSignal) {
return __request(OpenAPI, {
method: 'GET',
url: '/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/branches/{branchName}/required-checks',
path: {
'provider': provider,
'remoteOrganizationName': remoteOrganizationName,
'repositoryName': repositoryName,
'branchName': branchName,
},
abortSignal,
errors: {
400: `Bad Request`,
401: `Unauthorized`,
404: `Not Found`,
500: `Internal Server Error`,
},
});
}
/**
* Create a pull request adding the Codacy analysis badge to the repository
* Creates a pull request adding the Codacy static code analysis badge
* to the README of the GitHub repository if the repository is public
* and doesn't already have a badge.
*
* **Note:** The pull request is created asynchronously and may fail
* even if this endpoint responds successfully.
*
* @param remoteOrganizationName Organization name on the Git provider* @param repositoryName Repository name on the Git provider organization * @returns void
* @throws ApiError
*/
static createBadgePullRequest(remoteOrganizationName, repositoryName, abortSignal) {
return __request(OpenAPI, {
method: 'POST',
url: '/organizations/gh/{remoteOrganizationName}/repositories/{repositoryName}/badge',
path: {
'remoteOrganizationName': remoteOrganizationName,
'repositoryName': repositoryName,
},
abortSignal,
errors: {
400: `Bad Request`,
401: `Unauthorized`,
404: `Not Found`,
500: `Internal Server Error`,
},
});
}
/**
* Add a repository to Codacy
* Add a new repository to an existing organization on Codacy
* @param requestBody Information of repository to add* @param caller Caller * @returns Repository Successful operation
* @throws ApiError
*/
static addRepository(requestBody, caller, abortSignal) {
return __request(OpenAPI, {
method: 'POST',
url: '/repositories',
headers: {
'caller': caller,
},
abortSignal,
body: requestBody,
mediaType: 'application/json',
errors: {
400: `Bad Request`,
401: `Unauthorized`,
402: `PaymentRequired`,
403: `Forbidden`,
404: `Not Found`,
409: `Conflict`,
500: `Internal Server Error`,
},
});
}
/**
* List files in a repository
* Returns the most recent analysis information for the files in a repository as available on the [Files page](https://docs.codacy.com/repositories/files-view/).
* Files that are [ignored on Codacy](https://docs.codacy.com/repositories-configure/ignoring-files/) aren't returned.
*
* **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 branch Name of a [repository branch enabled on Codacy](https://docs.codacy.com/repositories-configure/managing-branches/),
* as returned by the endpoint [listRepositoryBranches](#listrepositorybranches).
* By default, uses the main branch defined on the Codacy repository settings.
* * @param search Filter files that include this string anywhere in their relative path* @param sort Field used to sort the list of files. The allowed values are 'filename', 'issues', 'grade', 'duplication', 'complexity', and 'coverage'.* @param direction Sort direction. Possible values are 'asc' (ascending) or 'desc' (descending).* @param cursor Cursor to [specify a batch of results to request](https://docs.codacy.com/codacy-api/using-the-codacy-api/#using-pagination)* @param limit Maximum number of items to return * @returns FileListResponse List of files in the repository
* @throws ApiError
*/
static listFiles(provider, remoteOrganizationName, repositoryName, branch, search, sort, direction, cursor, limit = 100, abortSignal) {
return __request(OpenAPI, {
method: 'GET',
url: '/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/files',
path: {
'provider': provider,
'remoteOrganizationName': remoteOrganizationName,
'repositoryName': repositoryName,
},
query: {
'branch': branch,
'search': search,
'sort': sort,
'direction': direction,
'cursor': cursor,
'limit': limit,
},
abortSignal,
errors: {
400: `Bad Request`,
401: `Unauthorized`,
404: `Not Found`,
500: `Internal Server Error`,
},
});
}
/**
* Get analysis information and coverage metrics for a file in a repository
* @param provider Git provider* @param remoteOrganizationName Organization name on the Git provider* @param repositoryName Repository name on the Git provider organization* @param fileId Identifier of a file in a specific commit * @returns FileInformationWithAnalysis File with analysis
* @throws ApiError
*/
static getFileWithAnalysis(provider, remoteOrganizationName, repositoryName, fileId, abortSignal) {
return __request(OpenAPI, {
method: 'GET',
url: '/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/files/{fileId}',
path: {
'provider': provider,
'remoteOrganizationName': remoteOrganizationName,
'repositoryName': repositoryName,
'fileId': fileId,
},
abortSignal,
errors: {
400: `Bad Request`,
401: `Unauthorized`,
404: `Not Found`,
500: `Internal Server Error`,
},
});
}
/**
* Get the list of duplicated code blocks for a file in a repository
* @param provider Git provider* @param remoteOrganizationName Organization name on the Git provider* @param repositoryName Repository name on the Git provider organization* @param fileId Identifier of a file in a specific commit* @param cursor Cursor to [specify a batch of results to request](https://docs.codacy.com/codacy-api/using-the-codacy-api/#using-pagination)* @param limit Maximum number of items to return * @returns FileClonesResponse File clones
* @throws ApiError
*/
static getFileClones(provider, remoteOrganizationName, repositoryName, fileId, cursor, limit = 100, abortSignal) {
return __request(OpenAPI, {
method: 'GET',
url: '/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/files/{fileId}/duplication',
path: {
'provider': provider,
'remoteOrganizationName': remoteOrganizationName,
'repositoryName': repositoryName,
'fileId': fileId,
},
query: {
'cursor': cursor,
'limit': limit,
},
abortSignal,
errors: {
400: `Bad Request`,
401: `Unauthorized`,
404: `Not Found`,
500: `Internal Server Error`,
},
});
}
/**
* Get the issue list for a file in a repository
* @param provider Git provider* @param remoteOrganizationName Organization name on the Git provider* @param repositoryName Repository name on the Git provider organization* @param fileId Identifier of a file in a specific commit* @param cursor Cursor to [specify a batch of results to request](https://docs.codacy.com/codacy-api/using-the-codacy-api/#using-pagination)* @param limit Maximum number of items to return * @returns SearchRepositoryIssuesListResponse File issues
* @throws ApiError
*/
static getFileIssues(provider, remoteOrganizationName, repositoryName, fileId, cursor, limit = 100, abortSignal) {
return __request(OpenAPI, {
method: 'GET',
url: '/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/files/{fileId}/issues',
path: {
'provider': provider,
'remoteOrganizationName': remoteOrganizationName,
'repositoryName': repositoryName,
'fileId': fileId,
},
query: {
'cursor': cursor,
'limit': limit,
},
abortSignal,
errors: {
400: `Bad Request`,
401: `Unauthorized`,
404: `Not Found`,
500: `Internal Server Error`,
},
});
}
/**
* List the [repository API tokens](https://docs.codacy.com/codacy-api/api-tokens/)
* @param provider Git provider* @param remoteOrganizationName Organization name on the Git provider* @param repositoryName Repository name on the Git provider organization * @returns ApiTokenListResponse Successful operation
* @throws ApiError
*/
static listRepositoryApiTokens(provider, remoteOrganizationName, repositoryName, abortSignal) {
return __request(OpenAPI, {
method: 'GET',
url: '/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/tokens',
path: {
'provider': provider,
'remoteOrganizationName': remoteOrganizationName,
'repositoryName': repositoryName,
},
abortSignal,
errors: {
400: `Bad Request`,
401: `Unauthorized`,
404: `Not Found`,
500: `Internal Server Error`,
},
});
}
/**
* Create a new [repository API token](https://docs.codacy.com/codacy-api/api-tokens/)
* @param provider Git provider* @param remoteOrganizationName Organization name on the Git provider* @param repositoryName Repository name on the Git provider organization * @returns ApiTokenResponse Successful operation
* @throws ApiError
*/
static createRepositoryApiToken(provider, remoteOrganizationName, repositoryName, abortSignal) {
return __request(OpenAPI, {
method: 'POST',
url: '/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/tokens',
path: {
'provider': provider,
'remoteOrganizationName': remoteOrganizationName,
'repositoryName': repositoryName,
},
abortSignal,
errors: {
400: `Bad Request`,
401: `Unauthorized`,
404: `Not Found`,
500: `Internal Server Error`,
},
});
}
/**
* Delete a [repository API token](https://docs.codacy.com/codacy-api/api-tokens/) by ID
* @param provider Git provider* @param remoteOrganizationName Organization name on the Git provider* @param repositoryName Repository name on the Git provider organization* @param tokenId API token ID * @returns void
* @throws ApiError
*/
static deleteRepositoryApiToken(provider, remoteOrganizationName, repositoryName, tokenId, abortSignal) {
return __request(OpenAPI, {
method: 'DELETE',
url: '/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/tokens/{tokenId}',
path: {
'provider': provider,
'remoteOrganizationName': remoteOrganizationName,
'repositoryName': repositoryName,
'tokenId': tokenId,
},
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`,
},
});
}
/**
* Get coverage information for a file in the head commit of a repository branch.
* @param provider Git provider* @param remoteOrganizationName Organization name on the Git provider* @param repositoryName Repository name on the Git provider organization* @param fileId Identifier of a file in a specific commit * @returns GetFileCoverageResponse File Coverage
* @throws ApiError
*/
static getFileCoverage(provider, remoteOrganizationName, repositoryName, fileId, abortSignal) {
return __request(OpenAPI, {
method: 'GET',
url: '/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/files/{fileId}/coverage',
path: {
'provider': provider,
'remoteOrganizationName': remoteOrganizationName,
'repositoryName': repositoryName,
'fileId': fileId,
},
abortSignal,
errors: {
400: `Bad Request`,
401: `Unauthorized`,
403: `Forbidden`,
404: `Not Found`,
500: `Internal Server Error`,
},
});
}
/**
* Ignore or unignore a file
* @param provider Git provider* @param remoteOrganizationName Organization name on the Git provider* @param repositoryName Repository name on the Git provider organization* @param requestBody * @returns void
* @throws ApiError
*/
static updateFileState(provider, remoteOrganizationName, repositoryName, requestBody, abortSignal) {
return __request(OpenAPI, {
method: 'PATCH',
url: '/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/file',
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`,
},
});
}
/**
* 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 getPullRequestDiff(provider, remoteOrganizationName, repositoryName, pullRequestNumber, abortSignal) {
return __request(OpenAPI, {
method: 'GET',
url: '/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`,
},
});
}
/**
* Returns the human-readable Git diff of a commit
* @param provider Git provider* @param remoteOrganizationName Organization name on the Git provider* @param repositoryName Repository name on the Git provider organization* @param commitUuid UUID or SHA string that identifies the commit * @returns DiffResponse Successful operation
* @throws ApiError
*/
static getCommitDiff(provider, remoteOrganizationName, reposi