RepositoryApi | dcs-js

RepositoryApi - object-oriented interface

export

Hierarchy

BaseAPI
- RepositoryApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new RepositoryApi(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): RepositoryApi

Inherited from BaseAPI.constructor
- Defined in base.ts:52
Parameters
- Optional configuration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns RepositoryApi

Properties

Protected axios

axios: AxiosInstance = globalAxios

Protected basePath

basePath: string = BASE_PATH

Protected configuration

configuration: Configuration

Methods

acceptRepoTransfer

acceptRepoTransfer(requestParameters: RepositoryApiAcceptRepoTransferRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<Repository>>

- Defined in apis/repository-api.ts:16729
summary
Accept a repo transfer

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiAcceptRepoTransferRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<Repository>>

createCurrentUserRepo

createCurrentUserRepo(requestParameters?: RepositoryApiCreateCurrentUserRepoRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<Repository>>

- Defined in apis/repository-api.ts:16741
summary
Create a repository

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiCreateCurrentUserRepoRequest = {}
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<Repository>>

createFork

createFork(requestParameters: RepositoryApiCreateForkRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<Repository>>

- Defined in apis/repository-api.ts:16753
summary
Fork a repository

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiCreateForkRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<Repository>>

generateRepo

generateRepo(requestParameters: RepositoryApiGenerateRepoRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<Repository>>

- Defined in apis/repository-api.ts:16765
summary
Create a repository using a template

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiGenerateRepoRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<Repository>>

getAnnotatedTag

getAnnotatedTag(requestParameters: RepositoryApiGetAnnotatedTagRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<AnnotatedTag>>

- Defined in apis/repository-api.ts:16777
summary
Gets the tag object of an annotated tag (not lightweight tags)

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiGetAnnotatedTagRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<AnnotatedTag>>

getBlob

getBlob(requestParameters: RepositoryApiGetBlobRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<GitBlobResponse>>

- Defined in apis/repository-api.ts:16789
summary
Gets the blob of a repository.

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiGetBlobRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<GitBlobResponse>>

getTree

getTree(requestParameters: RepositoryApiGetTreeRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<GitTreeResponse>>

- Defined in apis/repository-api.ts:16801
summary
Gets the tree of a repository.

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiGetTreeRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<GitTreeResponse>>

listForks

listForks(requestParameters: RepositoryApiListForksRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<Repository[]>>

- Defined in apis/repository-api.ts:16813
summary
List a repository's forks

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiListForksRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<Repository[]>>

rejectRepoTransfer

rejectRepoTransfer(requestParameters: RepositoryApiRejectRepoTransferRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<Repository>>

- Defined in apis/repository-api.ts:16825
summary
Reject a repo transfer

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRejectRepoTransferRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<Repository>>

repoAddCollaborator

repoAddCollaborator(requestParameters: RepositoryApiRepoAddCollaboratorRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>

- Defined in apis/repository-api.ts:16837
summary
Add a collaborator to a repository

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoAddCollaboratorRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<void>>

repoAddTeam

repoAddTeam(requestParameters: RepositoryApiRepoAddTeamRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>

- Defined in apis/repository-api.ts:16849
summary
Add a team to a repository

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoAddTeamRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<void>>

repoAddTopic

repoAddTopic(requestParameters: RepositoryApiRepoAddTopicRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>

- Defined in apis/repository-api.ts:16861
summary
Add a topic to a repository

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoAddTopicRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<void>>

repoApplyDiffPatch

repoApplyDiffPatch(requestParameters: RepositoryApiRepoApplyDiffPatchRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<FileResponse>>

- Defined in apis/repository-api.ts:16873
summary
Apply diff patch to repository

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoApplyDiffPatchRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<FileResponse>>

repoCancelScheduledAutoMerge

repoCancelScheduledAutoMerge(requestParameters: RepositoryApiRepoCancelScheduledAutoMergeRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>

- Defined in apis/repository-api.ts:16885
summary
Cancel the scheduled auto merge for the given pull request

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoCancelScheduledAutoMergeRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<void>>

repoCheckCollaborator

repoCheckCollaborator(requestParameters: RepositoryApiRepoCheckCollaboratorRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>

- Defined in apis/repository-api.ts:16897
summary
Check if a user is a collaborator of a repository

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoCheckCollaboratorRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<void>>

repoCheckTeam

repoCheckTeam(requestParameters: RepositoryApiRepoCheckTeamRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<Team>>

- Defined in apis/repository-api.ts:16909
summary
Check if a team is assigned to a repository

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoCheckTeamRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<Team>>

repoCreateBranch

repoCreateBranch(requestParameters: RepositoryApiRepoCreateBranchRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<Branch>>

- Defined in apis/repository-api.ts:16921
summary
Create a branch

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoCreateBranchRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<Branch>>

repoCreateBranchProtection

repoCreateBranchProtection(requestParameters: RepositoryApiRepoCreateBranchProtectionRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<BranchProtection>>

- Defined in apis/repository-api.ts:16933
summary
Create a branch protections for a repository

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoCreateBranchProtectionRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<BranchProtection>>

repoCreateFile

repoCreateFile(requestParameters: RepositoryApiRepoCreateFileRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<FileResponse>>

- Defined in apis/repository-api.ts:16945
summary
Create a file in a repository

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoCreateFileRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<FileResponse>>

repoCreateGitRef

repoCreateGitRef(requestParameters: RepositoryApiRepoCreateGitRefRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<Reference>>

- Defined in apis/repository-api.ts:16957
Creates a reference for your repository. You are unable to create new references for empty repositories, even if the commit SHA-1 hash used exists. Empty repositories are repositories without branches.

summary
Create a reference

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoCreateGitRefRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<Reference>>

repoCreateHook

repoCreateHook(requestParameters: RepositoryApiRepoCreateHookRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<Hook>>

- Defined in apis/repository-api.ts:16969
summary
Create a hook

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoCreateHookRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<Hook>>

repoCreateKey

repoCreateKey(requestParameters: RepositoryApiRepoCreateKeyRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<DeployKey>>

- Defined in apis/repository-api.ts:16981
summary
Add a key to a repository

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoCreateKeyRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<DeployKey>>

repoCreatePullRequest

repoCreatePullRequest(requestParameters: RepositoryApiRepoCreatePullRequestRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<PullRequest>>

- Defined in apis/repository-api.ts:16993
summary
Create a pull request

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoCreatePullRequestRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<PullRequest>>

repoCreatePullReview

repoCreatePullReview(requestParameters: RepositoryApiRepoCreatePullReviewRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<PullReview>>

- Defined in apis/repository-api.ts:17005
summary
Create a review to an pull request

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoCreatePullReviewRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<PullReview>>

repoCreatePullReviewRequests

repoCreatePullReviewRequests(requestParameters: RepositoryApiRepoCreatePullReviewRequestsRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<PullReview[]>>

- Defined in apis/repository-api.ts:17017
summary
create review requests for a pull request

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoCreatePullReviewRequestsRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<PullReview[]>>

repoCreateRelease

repoCreateRelease(requestParameters: RepositoryApiRepoCreateReleaseRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<Release>>

- Defined in apis/repository-api.ts:17029
summary
Create a release

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoCreateReleaseRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<Release>>

repoCreateReleaseAttachment

repoCreateReleaseAttachment(requestParameters: RepositoryApiRepoCreateReleaseAttachmentRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<Attachment>>

- Defined in apis/repository-api.ts:17041
summary
Create a release attachment

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoCreateReleaseAttachmentRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<Attachment>>

repoCreateStatus

repoCreateStatus(requestParameters: RepositoryApiRepoCreateStatusRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<CommitStatus>>

- Defined in apis/repository-api.ts:17053
summary
Create a commit status

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoCreateStatusRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<CommitStatus>>

repoCreateTag

repoCreateTag(requestParameters: RepositoryApiRepoCreateTagRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<Tag>>

- Defined in apis/repository-api.ts:17065
summary
Create a new git tag in a repository

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoCreateTagRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<Tag>>

repoCreateWikiPage

repoCreateWikiPage(requestParameters: RepositoryApiRepoCreateWikiPageRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<WikiPage>>

- Defined in apis/repository-api.ts:17077
summary
Create a wiki page

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoCreateWikiPageRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<WikiPage>>

repoDelete

repoDelete(requestParameters: RepositoryApiRepoDeleteRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>

- Defined in apis/repository-api.ts:17089
summary
Delete a repository

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoDeleteRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<void>>

repoDeleteBranch

repoDeleteBranch(requestParameters: RepositoryApiRepoDeleteBranchRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>

- Defined in apis/repository-api.ts:17101
summary
Delete a specific branch from a repository

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoDeleteBranchRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<void>>

repoDeleteBranchProtection

repoDeleteBranchProtection(requestParameters: RepositoryApiRepoDeleteBranchProtectionRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>

- Defined in apis/repository-api.ts:17113
summary
Delete a specific branch protection for the repository

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoDeleteBranchProtectionRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<void>>

repoDeleteCollaborator

repoDeleteCollaborator(requestParameters: RepositoryApiRepoDeleteCollaboratorRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>

- Defined in apis/repository-api.ts:17125
summary
Delete a collaborator from a repository

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoDeleteCollaboratorRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<void>>

repoDeleteFile

repoDeleteFile(requestParameters: RepositoryApiRepoDeleteFileRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<FileDeleteResponse>>

- Defined in apis/repository-api.ts:17137
summary
Delete a file in a repository

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoDeleteFileRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<FileDeleteResponse>>

repoDeleteGitHook

repoDeleteGitHook(requestParameters: RepositoryApiRepoDeleteGitHookRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>

- Defined in apis/repository-api.ts:17149
summary
Delete a Git hook in a repository

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoDeleteGitHookRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<void>>

repoDeleteGitRef

repoDeleteGitRef(requestParameters: RepositoryApiRepoDeleteGitRefRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>

- Defined in apis/repository-api.ts:17161
summary
Delete a reference

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoDeleteGitRefRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<void>>

repoDeleteHook

repoDeleteHook(requestParameters: RepositoryApiRepoDeleteHookRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>

- Defined in apis/repository-api.ts:17173
summary
Delete a hook in a repository

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoDeleteHookRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<void>>

repoDeleteKey

repoDeleteKey(requestParameters: RepositoryApiRepoDeleteKeyRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>

- Defined in apis/repository-api.ts:17185
summary
Delete a key from a repository

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoDeleteKeyRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<void>>

repoDeletePullReview

repoDeletePullReview(requestParameters: RepositoryApiRepoDeletePullReviewRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>

- Defined in apis/repository-api.ts:17197
summary
Delete a specific review from a pull request

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoDeletePullReviewRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<void>>

repoDeletePullReviewRequests

repoDeletePullReviewRequests(requestParameters: RepositoryApiRepoDeletePullReviewRequestsRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>

- Defined in apis/repository-api.ts:17209
summary
cancel review requests for a pull request

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoDeletePullReviewRequestsRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<void>>

repoDeleteRelease

repoDeleteRelease(requestParameters: RepositoryApiRepoDeleteReleaseRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>

- Defined in apis/repository-api.ts:17221
summary
Delete a release

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoDeleteReleaseRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<void>>

repoDeleteReleaseAttachment

repoDeleteReleaseAttachment(requestParameters: RepositoryApiRepoDeleteReleaseAttachmentRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>

- Defined in apis/repository-api.ts:17233
summary
Delete a release attachment

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoDeleteReleaseAttachmentRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<void>>

repoDeleteReleaseByTag

repoDeleteReleaseByTag(requestParameters: RepositoryApiRepoDeleteReleaseByTagRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>

- Defined in apis/repository-api.ts:17245
summary
Delete a release by tag name

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoDeleteReleaseByTagRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<void>>

repoDeleteTag

repoDeleteTag(requestParameters: RepositoryApiRepoDeleteTagRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>

- Defined in apis/repository-api.ts:17257
summary
Delete a repository's tag by name

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoDeleteTagRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<void>>

repoDeleteTeam

repoDeleteTeam(requestParameters: RepositoryApiRepoDeleteTeamRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>

- Defined in apis/repository-api.ts:17269
summary
Delete a team from a repository

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoDeleteTeamRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<void>>

repoDeleteTopic

repoDeleteTopic(requestParameters: RepositoryApiRepoDeleteTopicRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>

- Defined in apis/repository-api.ts:17281
summary
Delete a topic from a repository

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoDeleteTopicRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<void>>

repoDeleteWikiPage

repoDeleteWikiPage(requestParameters: RepositoryApiRepoDeleteWikiPageRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>

- Defined in apis/repository-api.ts:17293
summary
Delete a wiki page

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoDeleteWikiPageRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<void>>

repoDismissPullReview

repoDismissPullReview(requestParameters: RepositoryApiRepoDismissPullReviewRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<PullReview>>

- Defined in apis/repository-api.ts:17305
summary
Dismiss a review for a pull request

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoDismissPullReviewRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<PullReview>>

repoDownloadCommitDiffOrPatch

repoDownloadCommitDiffOrPatch(requestParameters: RepositoryApiRepoDownloadCommitDiffOrPatchRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<string>>

- Defined in apis/repository-api.ts:17317
summary
Get a commit's diff or patch

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoDownloadCommitDiffOrPatchRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<string>>

repoDownloadPullDiffOrPatch

repoDownloadPullDiffOrPatch(requestParameters: RepositoryApiRepoDownloadPullDiffOrPatchRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<string>>

- Defined in apis/repository-api.ts:17329
summary
Get a pull request diff or patch

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoDownloadPullDiffOrPatchRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<string>>

repoEdit

repoEdit(requestParameters: RepositoryApiRepoEditRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<Repository>>

- Defined in apis/repository-api.ts:17341
summary
Edit a repository's properties. Only fields that are set will be changed.

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoEditRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<Repository>>

repoEditBranchProtection

repoEditBranchProtection(requestParameters: RepositoryApiRepoEditBranchProtectionRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<BranchProtection>>

- Defined in apis/repository-api.ts:17353
summary
Edit a branch protections for a repository. Only fields that are set will be changed

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoEditBranchProtectionRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<BranchProtection>>

repoEditGitHook

repoEditGitHook(requestParameters: RepositoryApiRepoEditGitHookRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<GitHook>>

- Defined in apis/repository-api.ts:17365
summary
Edit a Git hook in a repository

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoEditGitHookRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<GitHook>>

repoEditHook

repoEditHook(requestParameters: RepositoryApiRepoEditHookRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<Hook>>

- Defined in apis/repository-api.ts:17377
summary
Edit a hook in a repository

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoEditHookRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<Hook>>

repoEditPullRequest

repoEditPullRequest(requestParameters: RepositoryApiRepoEditPullRequestRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<PullRequest>>

- Defined in apis/repository-api.ts:17389
summary
Update a pull request. If using deadline only the date will be taken into account, and time of day ignored.

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoEditPullRequestRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<PullRequest>>

repoEditRelease

repoEditRelease(requestParameters: RepositoryApiRepoEditReleaseRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<Release>>

- Defined in apis/repository-api.ts:17401
summary
Update a release

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoEditReleaseRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<Release>>

repoEditReleaseAttachment

repoEditReleaseAttachment(requestParameters: RepositoryApiRepoEditReleaseAttachmentRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<Attachment>>

- Defined in apis/repository-api.ts:17413
summary
Edit a release attachment

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoEditReleaseAttachmentRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<Attachment>>

repoEditWikiPage

repoEditWikiPage(requestParameters: RepositoryApiRepoEditWikiPageRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<WikiPage>>

- Defined in apis/repository-api.ts:17425
summary
Edit a wiki page

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoEditWikiPageRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<WikiPage>>

repoGet

repoGet(requestParameters: RepositoryApiRepoGetRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<Repository>>

- Defined in apis/repository-api.ts:17437
summary
Get a repository

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoGetRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<Repository>>

repoGetAllCommits

repoGetAllCommits(requestParameters: RepositoryApiRepoGetAllCommitsRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<Commit[]>>

- Defined in apis/repository-api.ts:17449
summary
Get a list of all commits from a repository

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoGetAllCommitsRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<Commit[]>>

repoGetArchive

repoGetArchive(requestParameters: RepositoryApiRepoGetArchiveRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>

- Defined in apis/repository-api.ts:17461
summary
Get an archive of a repository

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoGetArchiveRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<void>>

repoGetAssignees

repoGetAssignees(requestParameters: RepositoryApiRepoGetAssigneesRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<User[]>>

- Defined in apis/repository-api.ts:17473
summary
Return all users that have write access and can be assigned to issues

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoGetAssigneesRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<User[]>>

repoGetBranch

repoGetBranch(requestParameters: RepositoryApiRepoGetBranchRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<Branch>>

- Defined in apis/repository-api.ts:17485
summary
Retrieve a specific branch from a repository, including its effective branch protection

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoGetBranchRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<Branch>>

repoGetBranchProtection

repoGetBranchProtection(requestParameters: RepositoryApiRepoGetBranchProtectionRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<BranchProtection>>

- Defined in apis/repository-api.ts:17497
summary
Get a specific branch protection for the repository

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoGetBranchProtectionRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<BranchProtection>>

repoGetByID

repoGetByID(requestParameters: RepositoryApiRepoGetByIDRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<Repository>>

- Defined in apis/repository-api.ts:17509
summary
Get a repository by id

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoGetByIDRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<Repository>>

repoGetCombinedStatusByRef

repoGetCombinedStatusByRef(requestParameters: RepositoryApiRepoGetCombinedStatusByRefRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<CombinedStatus>>

- Defined in apis/repository-api.ts:17521
summary
Get a commit's combined status, by branch/tag/commit reference

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoGetCombinedStatusByRefRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<CombinedStatus>>

repoGetContents

repoGetContents(requestParameters: RepositoryApiRepoGetContentsRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<ContentsResponse>>

- Defined in apis/repository-api.ts:17533
summary
Gets the metadata and contents (if a file) of an entry in a repository, or a list of entries if a dir

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoGetContentsRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<ContentsResponse>>

repoGetContentsList

repoGetContentsList(requestParameters: RepositoryApiRepoGetContentsListRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<ContentsResponse[]>>

- Defined in apis/repository-api.ts:17545
summary
Gets the metadata of all the entries of the root dir

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoGetContentsListRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<ContentsResponse[]>>

repoGetEditorConfig

repoGetEditorConfig(requestParameters: RepositoryApiRepoGetEditorConfigRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>

- Defined in apis/repository-api.ts:17557
summary
Get the EditorConfig definitions of a file in a repository

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoGetEditorConfigRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<void>>

repoGetGitHook

repoGetGitHook(requestParameters: RepositoryApiRepoGetGitHookRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<GitHook>>

- Defined in apis/repository-api.ts:17569
summary
Get a Git hook

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoGetGitHookRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<GitHook>>

repoGetHook

repoGetHook(requestParameters: RepositoryApiRepoGetHookRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<Hook>>

- Defined in apis/repository-api.ts:17581
summary
Get a hook

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoGetHookRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<Hook>>

repoGetIssueTemplates

repoGetIssueTemplates(requestParameters: RepositoryApiRepoGetIssueTemplatesRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<IssueTemplate[]>>

- Defined in apis/repository-api.ts:17593
summary
Get available issue templates for a repository

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoGetIssueTemplatesRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<IssueTemplate[]>>

repoGetKey

repoGetKey(requestParameters: RepositoryApiRepoGetKeyRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<DeployKey>>

- Defined in apis/repository-api.ts:17605
summary
Get a repository's key by id

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoGetKeyRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<DeployKey>>

repoGetLanguages

repoGetLanguages(requestParameters: RepositoryApiRepoGetLanguagesRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<{}>>

- Defined in apis/repository-api.ts:17617
summary
Get languages and number of bytes of code written

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoGetLanguagesRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<{}>>

repoGetNote

repoGetNote(requestParameters: RepositoryApiRepoGetNoteRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<Note>>

- Defined in apis/repository-api.ts:17629
summary
Get a note corresponding to a single commit from a repository

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoGetNoteRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<Note>>

repoGetPullRequest

repoGetPullRequest(requestParameters: RepositoryApiRepoGetPullRequestRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<PullRequest>>

- Defined in apis/repository-api.ts:17641
summary
Get a pull request

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoGetPullRequestRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<PullRequest>>

repoGetPullRequestCommits

repoGetPullRequestCommits(requestParameters: RepositoryApiRepoGetPullRequestCommitsRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<Commit[]>>

- Defined in apis/repository-api.ts:17653
summary
Get commits for a pull request

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoGetPullRequestCommitsRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<Commit[]>>

repoGetPullReview

repoGetPullReview(requestParameters: RepositoryApiRepoGetPullReviewRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<PullReview>>

- Defined in apis/repository-api.ts:17665
summary
Get a specific review for a pull request

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoGetPullReviewRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<PullReview>>

repoGetPullReviewComments

repoGetPullReviewComments(requestParameters: RepositoryApiRepoGetPullReviewCommentsRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<PullReviewComment[]>>

- Defined in apis/repository-api.ts:17677
summary
Get a specific review for a pull request

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoGetPullReviewCommentsRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<PullReviewComment[]>>

repoGetRawFile

repoGetRawFile(requestParameters: RepositoryApiRepoGetRawFileRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>

- Defined in apis/repository-api.ts:17689
summary
Get a file from a repository

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoGetRawFileRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<void>>

repoGetRawFileOrLFS

repoGetRawFileOrLFS(requestParameters: RepositoryApiRepoGetRawFileOrLFSRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>

- Defined in apis/repository-api.ts:17701
summary
Get a file or it's LFS object from a repository

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoGetRawFileOrLFSRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<void>>

repoGetRelease

repoGetRelease(requestParameters: RepositoryApiRepoGetReleaseRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<Release>>

- Defined in apis/repository-api.ts:17713
summary
Get a release

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoGetReleaseRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<Release>>

repoGetReleaseAttachment

repoGetReleaseAttachment(requestParameters: RepositoryApiRepoGetReleaseAttachmentRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<Attachment>>

- Defined in apis/repository-api.ts:17725
summary
Get a release attachment

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoGetReleaseAttachmentRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<Attachment>>

repoGetReleaseByTag

repoGetReleaseByTag(requestParameters: RepositoryApiRepoGetReleaseByTagRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<Release>>

- Defined in apis/repository-api.ts:17737
summary
Get a release by tag name

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoGetReleaseByTagRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<Release>>

repoGetRepoPermissions

repoGetRepoPermissions(requestParameters: RepositoryApiRepoGetRepoPermissionsRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<RepoCollaboratorPermission>>

- Defined in apis/repository-api.ts:17749
summary
Get repository permissions for a user

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoGetRepoPermissionsRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<RepoCollaboratorPermission>>

repoGetReviewers

repoGetReviewers(requestParameters: RepositoryApiRepoGetReviewersRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<User[]>>

- Defined in apis/repository-api.ts:17761
summary
Return all users that can be requested to review in this repo

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoGetReviewersRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<User[]>>

repoGetSingleCommit

repoGetSingleCommit(requestParameters: RepositoryApiRepoGetSingleCommitRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<Commit>>

- Defined in apis/repository-api.ts:17773
summary
Get a single commit from a repository

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoGetSingleCommitRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<Commit>>

repoGetTag

repoGetTag(requestParameters: RepositoryApiRepoGetTagRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<Tag>>

- Defined in apis/repository-api.ts:17785
summary
Get the tag of a repository by tag name

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoGetTagRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<Tag>>

repoGetWikiPage

repoGetWikiPage(requestParameters: RepositoryApiRepoGetWikiPageRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<WikiPage>>

- Defined in apis/repository-api.ts:17797
summary
Get a wiki page

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoGetWikiPageRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<WikiPage>>

repoGetWikiPageRevisions

repoGetWikiPageRevisions(requestParameters: RepositoryApiRepoGetWikiPageRevisionsRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<WikiCommitList>>

- Defined in apis/repository-api.ts:17809
summary
Get revisions of a wiki page

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoGetWikiPageRevisionsRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<WikiCommitList>>

repoGetWikiPages

repoGetWikiPages(requestParameters: RepositoryApiRepoGetWikiPagesRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<WikiPageMetaData[]>>

- Defined in apis/repository-api.ts:17821
summary
Get all wiki pages

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoGetWikiPagesRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<WikiPageMetaData[]>>

repoListAllGitRefs

repoListAllGitRefs(requestParameters: RepositoryApiRepoListAllGitRefsRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<Reference[]>>

- Defined in apis/repository-api.ts:17833
summary
Get specified ref or filtered repository's refs

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoListAllGitRefsRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<Reference[]>>

repoListBranchProtection

repoListBranchProtection(requestParameters: RepositoryApiRepoListBranchProtectionRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<BranchProtection[]>>

- Defined in apis/repository-api.ts:17845
summary
List branch protections for a repository

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoListBranchProtectionRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<BranchProtection[]>>

repoListBranches

repoListBranches(requestParameters: RepositoryApiRepoListBranchesRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<Branch[]>>

- Defined in apis/repository-api.ts:17857
summary
List a repository's branches

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoListBranchesRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<Branch[]>>

repoListCollaborators

repoListCollaborators(requestParameters: RepositoryApiRepoListCollaboratorsRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<User[]>>

- Defined in apis/repository-api.ts:17869
summary
List a repository's collaborators

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoListCollaboratorsRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<User[]>>

repoListGitHooks

repoListGitHooks(requestParameters: RepositoryApiRepoListGitHooksRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<GitHook[]>>

- Defined in apis/repository-api.ts:17881
summary
List the Git hooks in a repository

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoListGitHooksRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<GitHook[]>>

repoListGitRefs

repoListGitRefs(requestParameters: RepositoryApiRepoListGitRefsRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<Reference[]>>

- Defined in apis/repository-api.ts:17893
summary
Get specified ref or filtered repository's refs

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoListGitRefsRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<Reference[]>>

repoListHooks

repoListHooks(requestParameters: RepositoryApiRepoListHooksRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<Hook[]>>

- Defined in apis/repository-api.ts:17905
summary
List the hooks in a repository

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoListHooksRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<Hook[]>>

repoListKeys

repoListKeys(requestParameters: RepositoryApiRepoListKeysRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<DeployKey[]>>

- Defined in apis/repository-api.ts:17917
summary
List a repository's keys

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoListKeysRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<DeployKey[]>>

repoListPullRequests

repoListPullRequests(requestParameters: RepositoryApiRepoListPullRequestsRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<PullRequest[]>>

- Defined in apis/repository-api.ts:17929
summary
List a repo's pull requests

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoListPullRequestsRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<PullRequest[]>>

repoListPullReviews

repoListPullReviews(requestParameters: RepositoryApiRepoListPullReviewsRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<PullReview[]>>

- Defined in apis/repository-api.ts:17941
summary
List all reviews for a pull request

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoListPullReviewsRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<PullReview[]>>

repoListReleaseAttachments

repoListReleaseAttachments(requestParameters: RepositoryApiRepoListReleaseAttachmentsRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<Attachment[]>>

- Defined in apis/repository-api.ts:17953
summary
List release's attachments

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoListReleaseAttachmentsRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<Attachment[]>>

repoListReleases

repoListReleases(requestParameters: RepositoryApiRepoListReleasesRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<Release[]>>

- Defined in apis/repository-api.ts:17965
summary
List a repo's releases

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoListReleasesRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<Release[]>>

repoListStargazers

repoListStargazers(requestParameters: RepositoryApiRepoListStargazersRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<User[]>>

- Defined in apis/repository-api.ts:17977
summary
List a repo's stargazers

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoListStargazersRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<User[]>>

repoListStatuses

repoListStatuses(requestParameters: RepositoryApiRepoListStatusesRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<CommitStatus[]>>

- Defined in apis/repository-api.ts:17989
summary
Get a commit's statuses

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoListStatusesRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<CommitStatus[]>>

repoListStatusesByRef

repoListStatusesByRef(requestParameters: RepositoryApiRepoListStatusesByRefRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<CommitStatus[]>>

- Defined in apis/repository-api.ts:18001
summary
Get a commit's statuses, by branch/tag/commit reference

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoListStatusesByRefRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<CommitStatus[]>>

repoListSubscribers

repoListSubscribers(requestParameters: RepositoryApiRepoListSubscribersRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<User[]>>

- Defined in apis/repository-api.ts:18013
summary
List a repo's watchers

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoListSubscribersRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<User[]>>

repoListTags

repoListTags(requestParameters: RepositoryApiRepoListTagsRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<Tag[]>>

- Defined in apis/repository-api.ts:18025
summary
List a repository's tags

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoListTagsRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<Tag[]>>

repoListTeams

repoListTeams(requestParameters: RepositoryApiRepoListTeamsRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<Team[]>>

- Defined in apis/repository-api.ts:18037
summary
List a repository's teams

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoListTeamsRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<Team[]>>

repoListTopics

repoListTopics(requestParameters: RepositoryApiRepoListTopicsRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<TopicName>>

- Defined in apis/repository-api.ts:18049
summary
Get list of topics that a repository has

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoListTopicsRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<TopicName>>

repoMergePullRequest

repoMergePullRequest(requestParameters: RepositoryApiRepoMergePullRequestRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>

- Defined in apis/repository-api.ts:18061
summary
Merge a pull request

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoMergePullRequestRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<void>>

repoMigrate

repoMigrate(requestParameters?: RepositoryApiRepoMigrateRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<Repository>>

- Defined in apis/repository-api.ts:18073
summary
Migrate a remote git repository

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoMigrateRequest = {}
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<Repository>>

repoMirrorSync

repoMirrorSync(requestParameters: RepositoryApiRepoMirrorSyncRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>

- Defined in apis/repository-api.ts:18085
summary
Sync a mirrored repository

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoMirrorSyncRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<void>>

repoPullRequestIsMerged

repoPullRequestIsMerged(requestParameters: RepositoryApiRepoPullRequestIsMergedRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>

- Defined in apis/repository-api.ts:18097
summary
Check if a pull request has been merged

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoPullRequestIsMergedRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<void>>

repoSearch

repoSearch(requestParameters?: RepositoryApiRepoSearchRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<SearchResults>>

- Defined in apis/repository-api.ts:18109
summary
Search for repositories

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoSearchRequest = {}
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<SearchResults>>

repoSigningKey

repoSigningKey(requestParameters: RepositoryApiRepoSigningKeyRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<string>>

- Defined in apis/repository-api.ts:18121
summary
Get signing-key.gpg for given repository

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoSigningKeyRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<string>>

repoSubmitPullReview

repoSubmitPullReview(requestParameters: RepositoryApiRepoSubmitPullReviewRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<PullReview>>

- Defined in apis/repository-api.ts:18133
summary
Submit a pending review to an pull request

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoSubmitPullReviewRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<PullReview>>

repoTestHook

repoTestHook(requestParameters: RepositoryApiRepoTestHookRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>

- Defined in apis/repository-api.ts:18145
summary
Test a push webhook

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoTestHookRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<void>>

repoTrackedTimes

repoTrackedTimes(requestParameters: RepositoryApiRepoTrackedTimesRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<TrackedTime[]>>

- Defined in apis/repository-api.ts:18157
summary
List a repo's tracked times

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoTrackedTimesRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<TrackedTime[]>>

repoTransfer

repoTransfer(requestParameters: RepositoryApiRepoTransferRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<Repository>>

- Defined in apis/repository-api.ts:18169
summary
Transfer a repo ownership

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoTransferRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<Repository>>

repoUnDismissPullReview

repoUnDismissPullReview(requestParameters: RepositoryApiRepoUnDismissPullReviewRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<PullReview>>

- Defined in apis/repository-api.ts:18181
summary
Cancel to dismiss a review for a pull request

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoUnDismissPullReviewRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<PullReview>>

repoUpdateFile

repoUpdateFile(requestParameters: RepositoryApiRepoUpdateFileRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<FileResponse>>

- Defined in apis/repository-api.ts:18193
summary
Update a file in a repository

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoUpdateFileRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<FileResponse>>

repoUpdateGitRef

repoUpdateGitRef(requestParameters: RepositoryApiRepoUpdateGitRefRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<Reference>>

- Defined in apis/repository-api.ts:18205
summary
Update a reference

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoUpdateGitRefRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<Reference>>

repoUpdatePullRequest

repoUpdatePullRequest(requestParameters: RepositoryApiRepoUpdatePullRequestRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>

- Defined in apis/repository-api.ts:18217
summary
Merge PR's baseBranch into headBranch

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoUpdatePullRequestRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<void>>

repoUpdateTopics

repoUpdateTopics(requestParameters: RepositoryApiRepoUpdateTopicsRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>

- Defined in apis/repository-api.ts:18229
summary
Replace list of topics for a repository

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiRepoUpdateTopicsRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<void>>

topicSearch

topicSearch(requestParameters: RepositoryApiTopicSearchRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<TopicResponse[]>>

- Defined in apis/repository-api.ts:18241
summary
search topics via keyword

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiTopicSearchRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<TopicResponse[]>>

userCurrentCheckSubscription

userCurrentCheckSubscription(requestParameters: RepositoryApiUserCurrentCheckSubscriptionRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<WatchInfo>>

- Defined in apis/repository-api.ts:18253
summary
Check if the current user is watching a repo

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiUserCurrentCheckSubscriptionRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<WatchInfo>>

userCurrentDeleteSubscription

userCurrentDeleteSubscription(requestParameters: RepositoryApiUserCurrentDeleteSubscriptionRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>

- Defined in apis/repository-api.ts:18265
summary
Unwatch a repo

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiUserCurrentDeleteSubscriptionRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<void>>

userCurrentPutSubscription

userCurrentPutSubscription(requestParameters: RepositoryApiUserCurrentPutSubscriptionRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<WatchInfo>>

- Defined in apis/repository-api.ts:18277
summary
Watch a repo

throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiUserCurrentPutSubscriptionRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<WatchInfo>>

userTrackedTimes

userTrackedTimes(requestParameters: RepositoryApiUserTrackedTimesRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<TrackedTime[]>>

- Defined in apis/repository-api.ts:18290
summary
List a user's tracked times in a repo

deprecated
throws
{RequiredError}

memberof
RepositoryApi

Parameters
- requestParameters: RepositoryApiUserTrackedTimesRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<TrackedTime[]>>

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional configuration: Configuration

basePath: string = BASE_PATH

axios: AxiosInstance = globalAxios

Returns RepositoryApi

Properties

Protected axios

Protected basePath

Protected configuration

Methods

acceptRepoTransfer

Parameters

requestParameters: RepositoryApiAcceptRepoTransferRequest

Optional options: AxiosRequestConfig

Returns Promise<AxiosResponse<Repository>>

createCurrentUserRepo

Parameters

requestParameters: RepositoryApiCreateCurrentUserRepoRequest = {}

Optional options: AxiosRequestConfig

Returns Promise<AxiosResponse<Repository>>

createFork

Parameters

requestParameters: RepositoryApiCreateForkRequest

Optional options: AxiosRequestConfig

Returns Promise<AxiosResponse<Repository>>

generateRepo

Parameters

requestParameters: RepositoryApiGenerateRepoRequest

Optional options: AxiosRequestConfig

Returns Promise<AxiosResponse<Repository>>

getAnnotatedTag

Parameters

requestParameters: RepositoryApiGetAnnotatedTagRequest

Optional options: AxiosRequestConfig

Returns Promise<AxiosResponse<AnnotatedTag>>

getBlob

Parameters

requestParameters: RepositoryApiGetBlobRequest

Optional options: AxiosRequestConfig

Returns Promise<AxiosResponse<GitBlobResponse>>

getTree

Parameters

requestParameters: RepositoryApiGetTreeRequest

Optional options: AxiosRequestConfig

Returns Promise<AxiosResponse<GitTreeResponse>>

listForks

Parameters

requestParameters: RepositoryApiListForksRequest

Optional options: AxiosRequestConfig

Returns Promise<AxiosResponse<Repository[]>>

rejectRepoTransfer

Parameters

requestParameters: RepositoryApiRejectRepoTransferRequest

Optional options: AxiosRequestConfig

Returns Promise<AxiosResponse<Repository>>

repoAddCollaborator

Parameters

requestParameters: RepositoryApiRepoAddCollaboratorRequest

Optional options: AxiosRequestConfig

Returns Promise<AxiosResponse<void>>

repoAddTeam

Parameters

requestParameters: RepositoryApiRepoAddTeamRequest

Optional options: AxiosRequestConfig

Returns Promise<AxiosResponse<void>>

repoAddTopic

Parameters

requestParameters: RepositoryApiRepoAddTopicRequest

Optional options: AxiosRequestConfig

Returns Promise<AxiosResponse<void>>

repoApplyDiffPatch

Parameters

requestParameters: RepositoryApiRepoApplyDiffPatchRequest