7649 lines
272 KiB
TypeScript
7649 lines
272 KiB
TypeScript
/** APIError is an api error with a message */
|
||
interface APIError {
|
||
message?: string;
|
||
url?: string;
|
||
}
|
||
/** AccessToken represents an API access token. */
|
||
interface AccessToken {
|
||
/** @format int64 */
|
||
id?: number;
|
||
name?: string;
|
||
scopes?: string[];
|
||
sha1?: string;
|
||
token_last_eight?: string;
|
||
}
|
||
/** ActionTask represents a ActionTask */
|
||
interface ActionTask {
|
||
/** @format date-time */
|
||
created_at?: string;
|
||
display_title?: string;
|
||
event?: string;
|
||
head_branch?: string;
|
||
head_sha?: string;
|
||
/** @format int64 */
|
||
id?: number;
|
||
name?: string;
|
||
/** @format int64 */
|
||
run_number?: number;
|
||
/** @format date-time */
|
||
run_started_at?: string;
|
||
status?: string;
|
||
/** @format date-time */
|
||
updated_at?: string;
|
||
url?: string;
|
||
workflow_id?: string;
|
||
}
|
||
/** ActionTaskResponse returns a ActionTask */
|
||
interface ActionTaskResponse {
|
||
/** @format int64 */
|
||
total_count?: number;
|
||
workflow_runs?: ActionTask[];
|
||
}
|
||
/** ActionVariable return value of the query API */
|
||
interface ActionVariable {
|
||
/** the value of the variable */
|
||
data?: string;
|
||
/** the name of the variable */
|
||
name?: string;
|
||
/**
|
||
* the owner to which the variable belongs
|
||
* @format int64
|
||
*/
|
||
owner_id?: number;
|
||
/**
|
||
* the repository to which the variable belongs
|
||
* @format int64
|
||
*/
|
||
repo_id?: number;
|
||
}
|
||
interface Activity {
|
||
/** User represents a user */
|
||
act_user?: User;
|
||
/** @format int64 */
|
||
act_user_id?: number;
|
||
/** Comment represents a comment on a commit or issue */
|
||
comment?: Comment;
|
||
/** @format int64 */
|
||
comment_id?: number;
|
||
content?: string;
|
||
/** @format date-time */
|
||
created?: string;
|
||
/** @format int64 */
|
||
id?: number;
|
||
is_private?: boolean;
|
||
/** the type of action */
|
||
op_type?: 'create_repo' | 'rename_repo' | 'star_repo' | 'watch_repo' | 'commit_repo' | 'create_issue' | 'create_pull_request' | 'transfer_repo' | 'push_tag' | 'comment_issue' | 'merge_pull_request' | 'close_issue' | 'reopen_issue' | 'close_pull_request' | 'reopen_pull_request' | 'delete_tag' | 'delete_branch' | 'mirror_sync_push' | 'mirror_sync_create' | 'mirror_sync_delete' | 'approve_pull_request' | 'reject_pull_request' | 'comment_pull' | 'publish_release' | 'pull_review_dismissed' | 'pull_request_ready_for_review' | 'auto_merge_pull_request';
|
||
ref_name?: string;
|
||
/** Repository represents a repository */
|
||
repo?: Repository;
|
||
/** @format int64 */
|
||
repo_id?: number;
|
||
/** @format int64 */
|
||
user_id?: number;
|
||
}
|
||
/** ActivityPub type */
|
||
interface ActivityPub {
|
||
'@context'?: string;
|
||
}
|
||
/** AddCollaboratorOption options when adding a user as a collaborator of a repository */
|
||
interface AddCollaboratorOption {
|
||
permission?: 'read' | 'write' | 'admin';
|
||
}
|
||
/** AddTimeOption options for adding time to an issue */
|
||
interface AddTimeOption {
|
||
/** @format date-time */
|
||
created?: string;
|
||
/**
|
||
* time in seconds
|
||
* @format int64
|
||
*/
|
||
time: number;
|
||
/** User who spent the time (optional) */
|
||
user_name?: string;
|
||
}
|
||
/** AnnotatedTag represents an annotated tag */
|
||
interface AnnotatedTag {
|
||
message?: string;
|
||
/** AnnotatedTagObject contains meta information of the tag object */
|
||
object?: AnnotatedTagObject;
|
||
sha?: string;
|
||
tag?: string;
|
||
tagger?: CommitUser;
|
||
url?: string;
|
||
/** PayloadCommitVerification represents the GPG verification of a commit */
|
||
verification?: PayloadCommitVerification;
|
||
}
|
||
/** AnnotatedTagObject contains meta information of the tag object */
|
||
interface AnnotatedTagObject {
|
||
sha?: string;
|
||
type?: string;
|
||
url?: string;
|
||
}
|
||
/** Attachment a generic attachment */
|
||
interface Attachment {
|
||
browser_download_url?: string;
|
||
/** @format date-time */
|
||
created_at?: string;
|
||
/** @format int64 */
|
||
download_count?: number;
|
||
/** @format int64 */
|
||
id?: number;
|
||
name?: string;
|
||
/** @format int64 */
|
||
size?: number;
|
||
uuid?: string;
|
||
}
|
||
/** Badge represents a user badge */
|
||
interface Badge {
|
||
description?: string;
|
||
/** @format int64 */
|
||
id?: number;
|
||
image_url?: string;
|
||
slug?: string;
|
||
}
|
||
/** Branch represents a repository branch */
|
||
interface Branch {
|
||
/** PayloadCommit represents a commit */
|
||
commit?: PayloadCommit;
|
||
effective_branch_protection_name?: string;
|
||
enable_status_check?: boolean;
|
||
name?: string;
|
||
protected?: boolean;
|
||
/** @format int64 */
|
||
required_approvals?: number;
|
||
status_check_contexts?: string[];
|
||
user_can_merge?: boolean;
|
||
user_can_push?: boolean;
|
||
}
|
||
/** BranchProtection represents a branch protection for a repository */
|
||
interface BranchProtection {
|
||
approvals_whitelist_teams?: string[];
|
||
approvals_whitelist_username?: string[];
|
||
block_admin_merge_override?: boolean;
|
||
block_on_official_review_requests?: boolean;
|
||
block_on_outdated_branch?: boolean;
|
||
block_on_rejected_reviews?: boolean;
|
||
/** Deprecated: true */
|
||
branch_name?: string;
|
||
/** @format date-time */
|
||
created_at?: string;
|
||
dismiss_stale_approvals?: boolean;
|
||
enable_approvals_whitelist?: boolean;
|
||
enable_force_push?: boolean;
|
||
enable_force_push_allowlist?: boolean;
|
||
enable_merge_whitelist?: boolean;
|
||
enable_push?: boolean;
|
||
enable_push_whitelist?: boolean;
|
||
enable_status_check?: boolean;
|
||
force_push_allowlist_deploy_keys?: boolean;
|
||
force_push_allowlist_teams?: string[];
|
||
force_push_allowlist_usernames?: string[];
|
||
ignore_stale_approvals?: boolean;
|
||
merge_whitelist_teams?: string[];
|
||
merge_whitelist_usernames?: string[];
|
||
/** @format int64 */
|
||
priority?: number;
|
||
protected_file_patterns?: string;
|
||
push_whitelist_deploy_keys?: boolean;
|
||
push_whitelist_teams?: string[];
|
||
push_whitelist_usernames?: string[];
|
||
require_signed_commits?: boolean;
|
||
/** @format int64 */
|
||
required_approvals?: number;
|
||
rule_name?: string;
|
||
status_check_contexts?: string[];
|
||
unprotected_file_patterns?: string;
|
||
/** @format date-time */
|
||
updated_at?: string;
|
||
}
|
||
/** ChangeFileOperation for creating, updating or deleting a file */
|
||
interface ChangeFileOperation {
|
||
/** new or updated file content, must be base64 encoded */
|
||
content?: string;
|
||
/** old path of the file to move */
|
||
from_path?: string;
|
||
/** indicates what to do with the file */
|
||
operation: 'create' | 'update' | 'delete';
|
||
/** path to the existing or new file */
|
||
path: string;
|
||
/** sha is the SHA for the file that already exists, required for update or delete */
|
||
sha?: string;
|
||
}
|
||
/**
|
||
* ChangeFilesOptions options for creating, updating or deleting multiple files
|
||
* Note: `author` and `committer` are optional (if only one is given, it will be used for the other, otherwise the authenticated user will be used)
|
||
*/
|
||
interface ChangeFilesOptions {
|
||
/** Identity for a person's identity like an author or committer */
|
||
author?: Identity;
|
||
/** branch (optional) to base this file from. if not given, the default branch is used */
|
||
branch?: string;
|
||
/** Identity for a person's identity like an author or committer */
|
||
committer?: Identity;
|
||
/** CommitDateOptions store dates for GIT_AUTHOR_DATE and GIT_COMMITTER_DATE */
|
||
dates?: CommitDateOptions;
|
||
/** list of file operations */
|
||
files: ChangeFileOperation[];
|
||
/** message (optional) for the commit of this file. if not supplied, a default message will be used */
|
||
message?: string;
|
||
/** new_branch (optional) will make a new branch from `branch` before creating the file */
|
||
new_branch?: string;
|
||
/** Add a Signed-off-by trailer by the committer at the end of the commit log message. */
|
||
signoff?: boolean;
|
||
}
|
||
/** ChangedFile store information about files affected by the pull request */
|
||
interface ChangedFile {
|
||
/** @format int64 */
|
||
additions?: number;
|
||
/** @format int64 */
|
||
changes?: number;
|
||
contents_url?: string;
|
||
/** @format int64 */
|
||
deletions?: number;
|
||
filename?: string;
|
||
html_url?: string;
|
||
previous_filename?: string;
|
||
raw_url?: string;
|
||
status?: string;
|
||
}
|
||
/** CombinedStatus holds the combined state of several statuses for a single commit */
|
||
interface CombinedStatus {
|
||
commit_url?: string;
|
||
/** Repository represents a repository */
|
||
repository?: Repository;
|
||
sha?: string;
|
||
/**
|
||
* CommitStatusState holds the state of a CommitStatus
|
||
* It can be "pending", "success", "error" and "failure"
|
||
*/
|
||
state?: CommitStatusState;
|
||
statuses?: CommitStatus[];
|
||
/** @format int64 */
|
||
total_count?: number;
|
||
url?: string;
|
||
}
|
||
/** Comment represents a comment on a commit or issue */
|
||
interface Comment {
|
||
assets?: Attachment[];
|
||
body?: string;
|
||
/** @format date-time */
|
||
created_at?: string;
|
||
html_url?: string;
|
||
/** @format int64 */
|
||
id?: number;
|
||
issue_url?: string;
|
||
original_author?: string;
|
||
/** @format int64 */
|
||
original_author_id?: number;
|
||
pull_request_url?: string;
|
||
/** @format date-time */
|
||
updated_at?: string;
|
||
/** User represents a user */
|
||
user?: User;
|
||
}
|
||
/** Commit contains information generated from a Git commit. */
|
||
interface Commit {
|
||
/** User represents a user */
|
||
author?: User;
|
||
commit?: RepoCommit;
|
||
/** User represents a user */
|
||
committer?: User;
|
||
/** @format date-time */
|
||
created?: string;
|
||
files?: CommitAffectedFiles[];
|
||
html_url?: string;
|
||
parents?: CommitMeta[];
|
||
sha?: string;
|
||
/** CommitStats is statistics for a RepoCommit */
|
||
stats?: CommitStats;
|
||
url?: string;
|
||
}
|
||
/** CommitAffectedFiles store information about files affected by the commit */
|
||
interface CommitAffectedFiles {
|
||
filename?: string;
|
||
status?: string;
|
||
}
|
||
/** CommitDateOptions store dates for GIT_AUTHOR_DATE and GIT_COMMITTER_DATE */
|
||
interface CommitDateOptions {
|
||
/** @format date-time */
|
||
author?: string;
|
||
/** @format date-time */
|
||
committer?: string;
|
||
}
|
||
/** CommitMeta contains meta information of a commit in terms of API. */
|
||
interface CommitMeta {
|
||
/** @format date-time */
|
||
created?: string;
|
||
sha?: string;
|
||
url?: string;
|
||
}
|
||
/** CommitStats is statistics for a RepoCommit */
|
||
interface CommitStats {
|
||
/** @format int64 */
|
||
additions?: number;
|
||
/** @format int64 */
|
||
deletions?: number;
|
||
/** @format int64 */
|
||
total?: number;
|
||
}
|
||
/** CommitStatus holds a single status of a single Commit */
|
||
interface CommitStatus {
|
||
context?: string;
|
||
/** @format date-time */
|
||
created_at?: string;
|
||
/** User represents a user */
|
||
creator?: User;
|
||
description?: string;
|
||
/** @format int64 */
|
||
id?: number;
|
||
/**
|
||
* CommitStatusState holds the state of a CommitStatus
|
||
* It can be "pending", "success", "error" and "failure"
|
||
*/
|
||
status?: CommitStatusState;
|
||
target_url?: string;
|
||
/** @format date-time */
|
||
updated_at?: string;
|
||
url?: string;
|
||
}
|
||
/**
|
||
* CommitStatusState holds the state of a CommitStatus
|
||
* It can be "pending", "success", "error" and "failure"
|
||
*/
|
||
type CommitStatusState = string;
|
||
/** CommitUser contains information of a user in the context of a commit. */
|
||
interface CommitUser {
|
||
date?: string;
|
||
/** @format email */
|
||
email?: string;
|
||
name?: string;
|
||
}
|
||
/** Compare represents a comparison between two commits. */
|
||
interface Compare {
|
||
commits?: Commit[];
|
||
/** @format int64 */
|
||
total_commits?: number;
|
||
}
|
||
/** ContentsResponse contains information about a repo's entry's (dir, file, symlink, submodule) metadata and content */
|
||
interface ContentsResponse {
|
||
/** FileLinksResponse contains the links for a repo's file */
|
||
_links?: FileLinksResponse;
|
||
/** `content` is populated when `type` is `file`, otherwise null */
|
||
content?: string;
|
||
download_url?: string;
|
||
/** `encoding` is populated when `type` is `file`, otherwise null */
|
||
encoding?: string;
|
||
git_url?: string;
|
||
html_url?: string;
|
||
last_commit_sha?: string;
|
||
name?: string;
|
||
path?: string;
|
||
sha?: string;
|
||
/** @format int64 */
|
||
size?: number;
|
||
/** `submodule_git_url` is populated when `type` is `submodule`, otherwise null */
|
||
submodule_git_url?: string;
|
||
/** `target` is populated when `type` is `symlink`, otherwise null */
|
||
target?: string;
|
||
/** `type` will be `file`, `dir`, `symlink`, or `submodule` */
|
||
type?: string;
|
||
url?: string;
|
||
}
|
||
/** CreateAccessTokenOption options when create access token */
|
||
interface CreateAccessTokenOption {
|
||
name: string;
|
||
scopes?: string[];
|
||
}
|
||
/** CreateBranchProtectionOption options for creating a branch protection */
|
||
interface CreateBranchProtectionOption {
|
||
approvals_whitelist_teams?: string[];
|
||
approvals_whitelist_username?: string[];
|
||
block_admin_merge_override?: boolean;
|
||
block_on_official_review_requests?: boolean;
|
||
block_on_outdated_branch?: boolean;
|
||
block_on_rejected_reviews?: boolean;
|
||
/** Deprecated: true */
|
||
branch_name?: string;
|
||
dismiss_stale_approvals?: boolean;
|
||
enable_approvals_whitelist?: boolean;
|
||
enable_force_push?: boolean;
|
||
enable_force_push_allowlist?: boolean;
|
||
enable_merge_whitelist?: boolean;
|
||
enable_push?: boolean;
|
||
enable_push_whitelist?: boolean;
|
||
enable_status_check?: boolean;
|
||
force_push_allowlist_deploy_keys?: boolean;
|
||
force_push_allowlist_teams?: string[];
|
||
force_push_allowlist_usernames?: string[];
|
||
ignore_stale_approvals?: boolean;
|
||
merge_whitelist_teams?: string[];
|
||
merge_whitelist_usernames?: string[];
|
||
/** @format int64 */
|
||
priority?: number;
|
||
protected_file_patterns?: string;
|
||
push_whitelist_deploy_keys?: boolean;
|
||
push_whitelist_teams?: string[];
|
||
push_whitelist_usernames?: string[];
|
||
require_signed_commits?: boolean;
|
||
/** @format int64 */
|
||
required_approvals?: number;
|
||
rule_name?: string;
|
||
status_check_contexts?: string[];
|
||
unprotected_file_patterns?: string;
|
||
}
|
||
/** CreateBranchRepoOption options when creating a branch in a repository */
|
||
interface CreateBranchRepoOption {
|
||
/**
|
||
* Name of the branch to create
|
||
* @uniqueItems true
|
||
*/
|
||
new_branch_name: string;
|
||
/**
|
||
* Deprecated: true
|
||
* Name of the old branch to create from
|
||
* @uniqueItems true
|
||
*/
|
||
old_branch_name?: string;
|
||
/**
|
||
* Name of the old branch/tag/commit to create from
|
||
* @uniqueItems true
|
||
*/
|
||
old_ref_name?: string;
|
||
}
|
||
/** CreateEmailOption options when creating email addresses */
|
||
interface CreateEmailOption {
|
||
/** email addresses to add */
|
||
emails?: string[];
|
||
}
|
||
/**
|
||
* CreateFileOptions options for creating files
|
||
* Note: `author` and `committer` are optional (if only one is given, it will be used for the other, otherwise the authenticated user will be used)
|
||
*/
|
||
interface CreateFileOptions {
|
||
/** Identity for a person's identity like an author or committer */
|
||
author?: Identity;
|
||
/** branch (optional) to base this file from. if not given, the default branch is used */
|
||
branch?: string;
|
||
/** Identity for a person's identity like an author or committer */
|
||
committer?: Identity;
|
||
/** content must be base64 encoded */
|
||
content: string;
|
||
/** CommitDateOptions store dates for GIT_AUTHOR_DATE and GIT_COMMITTER_DATE */
|
||
dates?: CommitDateOptions;
|
||
/** message (optional) for the commit of this file. if not supplied, a default message will be used */
|
||
message?: string;
|
||
/** new_branch (optional) will make a new branch from `branch` before creating the file */
|
||
new_branch?: string;
|
||
/** Add a Signed-off-by trailer by the committer at the end of the commit log message. */
|
||
signoff?: boolean;
|
||
}
|
||
/** CreateForkOption options for creating a fork */
|
||
interface CreateForkOption {
|
||
/** name of the forked repository */
|
||
name?: string;
|
||
/** organization name, if forking into an organization */
|
||
organization?: string;
|
||
}
|
||
/** CreateGPGKeyOption options create user GPG key */
|
||
interface CreateGPGKeyOption {
|
||
/**
|
||
* An armored GPG key to add
|
||
* @uniqueItems true
|
||
*/
|
||
armored_public_key: string;
|
||
armored_signature?: string;
|
||
}
|
||
/** CreateHookOption options when create a hook */
|
||
interface CreateHookOption {
|
||
/** @default false */
|
||
active?: boolean;
|
||
authorization_header?: string;
|
||
branch_filter?: string;
|
||
/**
|
||
* CreateHookOptionConfig has all config options in it
|
||
* required are "content_type" and "url" Required
|
||
*/
|
||
config: CreateHookOptionConfig;
|
||
events?: string[];
|
||
type: 'dingtalk' | 'discord' | 'gitea' | 'gogs' | 'msteams' | 'slack' | 'telegram' | 'feishu' | 'wechatwork' | 'packagist';
|
||
}
|
||
/**
|
||
* CreateHookOptionConfig has all config options in it
|
||
* required are "content_type" and "url" Required
|
||
*/
|
||
type CreateHookOptionConfig = Record<string, string>;
|
||
/** CreateIssueCommentOption options for creating a comment on an issue */
|
||
interface CreateIssueCommentOption {
|
||
body: string;
|
||
}
|
||
/** CreateIssueOption options to create one issue */
|
||
interface CreateIssueOption {
|
||
/** deprecated */
|
||
assignee?: string;
|
||
assignees?: string[];
|
||
body?: string;
|
||
closed?: boolean;
|
||
/** @format date-time */
|
||
due_date?: string;
|
||
/** list of label ids */
|
||
labels?: number[];
|
||
/**
|
||
* milestone id
|
||
* @format int64
|
||
*/
|
||
milestone?: number;
|
||
ref?: string;
|
||
title: string;
|
||
}
|
||
/** CreateKeyOption options when creating a key */
|
||
interface CreateKeyOption {
|
||
/**
|
||
* An armored SSH key to add
|
||
* @uniqueItems true
|
||
*/
|
||
key: string;
|
||
/** Describe if the key has only read access or read/write */
|
||
read_only?: boolean;
|
||
/**
|
||
* Title of the key to add
|
||
* @uniqueItems true
|
||
*/
|
||
title: string;
|
||
}
|
||
/** CreateLabelOption options for creating a label */
|
||
interface CreateLabelOption {
|
||
/** @example "#00aabb" */
|
||
color: string;
|
||
description?: string;
|
||
/** @example false */
|
||
exclusive?: boolean;
|
||
/** @example false */
|
||
is_archived?: boolean;
|
||
name: string;
|
||
}
|
||
/** CreateMilestoneOption options for creating a milestone */
|
||
interface CreateMilestoneOption {
|
||
description?: string;
|
||
/** @format date-time */
|
||
due_on?: string;
|
||
state?: 'open' | 'closed';
|
||
title?: string;
|
||
}
|
||
/** CreateOAuth2ApplicationOptions holds options to create an oauth2 application */
|
||
interface CreateOAuth2ApplicationOptions {
|
||
confidential_client?: boolean;
|
||
name?: string;
|
||
redirect_uris?: string[];
|
||
skip_secondary_authorization?: boolean;
|
||
}
|
||
/** CreateOrUpdateSecretOption options when creating or updating secret */
|
||
interface CreateOrUpdateSecretOption {
|
||
/** Data of the secret to update */
|
||
data: string;
|
||
}
|
||
/** CreateOrgOption options for creating an organization */
|
||
interface CreateOrgOption {
|
||
description?: string;
|
||
email?: string;
|
||
full_name?: string;
|
||
location?: string;
|
||
repo_admin_change_team_access?: boolean;
|
||
username: string;
|
||
/** possible values are `public` (default), `limited` or `private` */
|
||
visibility?: 'public' | 'limited' | 'private';
|
||
website?: string;
|
||
}
|
||
/** CreatePullRequestOption options when creating a pull request */
|
||
interface CreatePullRequestOption {
|
||
assignee?: string;
|
||
assignees?: string[];
|
||
base?: string;
|
||
body?: string;
|
||
/** @format date-time */
|
||
due_date?: string;
|
||
head?: string;
|
||
labels?: number[];
|
||
/** @format int64 */
|
||
milestone?: number;
|
||
reviewers?: string[];
|
||
team_reviewers?: string[];
|
||
title?: string;
|
||
}
|
||
/** CreatePullReviewComment represent a review comment for creation api */
|
||
interface CreatePullReviewComment {
|
||
body?: string;
|
||
/**
|
||
* if comment to new file line or 0
|
||
* @format int64
|
||
*/
|
||
new_position?: number;
|
||
/**
|
||
* if comment to old file line or 0
|
||
* @format int64
|
||
*/
|
||
old_position?: number;
|
||
/** the tree path */
|
||
path?: string;
|
||
}
|
||
/** CreatePullReviewOptions are options to create a pull review */
|
||
interface CreatePullReviewOptions {
|
||
body?: string;
|
||
comments?: CreatePullReviewComment[];
|
||
commit_id?: string;
|
||
/** ReviewStateType review state type */
|
||
event?: ReviewStateType;
|
||
}
|
||
/** CreatePushMirrorOption represents need information to create a push mirror of a repository. */
|
||
interface CreatePushMirrorOption {
|
||
interval?: string;
|
||
remote_address?: string;
|
||
remote_password?: string;
|
||
remote_username?: string;
|
||
sync_on_commit?: boolean;
|
||
}
|
||
/** CreateReleaseOption options when creating a release */
|
||
interface CreateReleaseOption {
|
||
body?: string;
|
||
draft?: boolean;
|
||
name?: string;
|
||
prerelease?: boolean;
|
||
tag_name: string;
|
||
target_commitish?: string;
|
||
}
|
||
/** CreateRepoOption options when creating repository */
|
||
interface CreateRepoOption {
|
||
/** Whether the repository should be auto-initialized? */
|
||
auto_init?: boolean;
|
||
/** DefaultBranch of the repository (used when initializes and in template) */
|
||
default_branch?: string;
|
||
/** Description of the repository to create */
|
||
description?: string;
|
||
/** Gitignores to use */
|
||
gitignores?: string;
|
||
/** Label-Set to use */
|
||
issue_labels?: string;
|
||
/** License to use */
|
||
license?: string;
|
||
/**
|
||
* Name of the repository to create
|
||
* @uniqueItems true
|
||
*/
|
||
name: string;
|
||
/** ObjectFormatName of the underlying git repository */
|
||
object_format_name?: 'sha1' | 'sha256';
|
||
/** Whether the repository is private */
|
||
private?: boolean;
|
||
/** Readme of the repository to create */
|
||
readme?: string;
|
||
/** Whether the repository is template */
|
||
template?: boolean;
|
||
/** TrustModel of the repository */
|
||
trust_model?: 'default' | 'collaborator' | 'committer' | 'collaboratorcommitter';
|
||
}
|
||
/** CreateStatusOption holds the information needed to create a new CommitStatus for a Commit */
|
||
interface CreateStatusOption {
|
||
context?: string;
|
||
description?: string;
|
||
/**
|
||
* CommitStatusState holds the state of a CommitStatus
|
||
* It can be "pending", "success", "error" and "failure"
|
||
*/
|
||
state?: CommitStatusState;
|
||
target_url?: string;
|
||
}
|
||
/** CreateTagOption options when creating a tag */
|
||
interface CreateTagOption {
|
||
message?: string;
|
||
tag_name: string;
|
||
target?: string;
|
||
}
|
||
/** CreateTagProtectionOption options for creating a tag protection */
|
||
interface CreateTagProtectionOption {
|
||
name_pattern?: string;
|
||
whitelist_teams?: string[];
|
||
whitelist_usernames?: string[];
|
||
}
|
||
/** CreateTeamOption options for creating a team */
|
||
interface CreateTeamOption {
|
||
can_create_org_repo?: boolean;
|
||
description?: string;
|
||
includes_all_repositories?: boolean;
|
||
name: string;
|
||
permission?: 'read' | 'write' | 'admin';
|
||
/** @example ["repo.actions","repo.code","repo.issues","repo.ext_issues","repo.wiki","repo.ext_wiki","repo.pulls","repo.releases","repo.projects","repo.ext_wiki"] */
|
||
units?: string[];
|
||
/** @example "{"repo.actions","repo.packages","repo.code":"read","repo.issues":"write","repo.ext_issues":"none","repo.wiki":"admin","repo.pulls":"owner","repo.releases":"none","repo.projects":"none","repo.ext_wiki":"none"}" */
|
||
units_map?: Record<string, string>;
|
||
}
|
||
/** CreateUserOption create user options */
|
||
interface CreateUserOption {
|
||
/**
|
||
* For explicitly setting the user creation timestamp. Useful when users are
|
||
* migrated from other systems. When omitted, the user's creation timestamp
|
||
* will be set to "now".
|
||
* @format date-time
|
||
*/
|
||
created_at?: string;
|
||
/** @format email */
|
||
email: string;
|
||
full_name?: string;
|
||
login_name?: string;
|
||
must_change_password?: boolean;
|
||
password?: string;
|
||
restricted?: boolean;
|
||
send_notify?: boolean;
|
||
/** @format int64 */
|
||
source_id?: number;
|
||
username: string;
|
||
visibility?: string;
|
||
}
|
||
/** CreateVariableOption the option when creating variable */
|
||
interface CreateVariableOption {
|
||
/** Value of the variable to create */
|
||
value: string;
|
||
}
|
||
/** CreateWikiPageOptions form for creating wiki */
|
||
interface CreateWikiPageOptions {
|
||
/** content must be base64 encoded */
|
||
content_base64?: string;
|
||
/** optional commit message summarizing the change */
|
||
message?: string;
|
||
/** page title. leave empty to keep unchanged */
|
||
title?: string;
|
||
}
|
||
/** Cron represents a Cron task */
|
||
interface Cron {
|
||
/** @format int64 */
|
||
exec_times?: number;
|
||
name?: string;
|
||
/** @format date-time */
|
||
next?: string;
|
||
/** @format date-time */
|
||
prev?: string;
|
||
schedule?: string;
|
||
}
|
||
/** DeleteEmailOption options when deleting email addresses */
|
||
interface DeleteEmailOption {
|
||
/** email addresses to delete */
|
||
emails?: string[];
|
||
}
|
||
/**
|
||
* DeleteFileOptions options for deleting files (used for other File structs below)
|
||
* Note: `author` and `committer` are optional (if only one is given, it will be used for the other, otherwise the authenticated user will be used)
|
||
*/
|
||
interface DeleteFileOptions {
|
||
/** Identity for a person's identity like an author or committer */
|
||
author?: Identity;
|
||
/** branch (optional) to base this file from. if not given, the default branch is used */
|
||
branch?: string;
|
||
/** Identity for a person's identity like an author or committer */
|
||
committer?: Identity;
|
||
/** CommitDateOptions store dates for GIT_AUTHOR_DATE and GIT_COMMITTER_DATE */
|
||
dates?: CommitDateOptions;
|
||
/** message (optional) for the commit of this file. if not supplied, a default message will be used */
|
||
message?: string;
|
||
/** new_branch (optional) will make a new branch from `branch` before creating the file */
|
||
new_branch?: string;
|
||
/** sha is the SHA for the file that already exists */
|
||
sha: string;
|
||
/** Add a Signed-off-by trailer by the committer at the end of the commit log message. */
|
||
signoff?: boolean;
|
||
}
|
||
/** DeployKey a deploy key */
|
||
interface DeployKey {
|
||
/** @format date-time */
|
||
created_at?: string;
|
||
fingerprint?: string;
|
||
/** @format int64 */
|
||
id?: number;
|
||
key?: string;
|
||
/** @format int64 */
|
||
key_id?: number;
|
||
read_only?: boolean;
|
||
/** Repository represents a repository */
|
||
repository?: Repository;
|
||
title?: string;
|
||
url?: string;
|
||
}
|
||
/** DismissPullReviewOptions are options to dismiss a pull review */
|
||
interface DismissPullReviewOptions {
|
||
message?: string;
|
||
priors?: boolean;
|
||
}
|
||
/** EditAttachmentOptions options for editing attachments */
|
||
interface EditAttachmentOptions {
|
||
name?: string;
|
||
}
|
||
/** EditBranchProtectionOption options for editing a branch protection */
|
||
interface EditBranchProtectionOption {
|
||
approvals_whitelist_teams?: string[];
|
||
approvals_whitelist_username?: string[];
|
||
block_admin_merge_override?: boolean;
|
||
block_on_official_review_requests?: boolean;
|
||
block_on_outdated_branch?: boolean;
|
||
block_on_rejected_reviews?: boolean;
|
||
dismiss_stale_approvals?: boolean;
|
||
enable_approvals_whitelist?: boolean;
|
||
enable_force_push?: boolean;
|
||
enable_force_push_allowlist?: boolean;
|
||
enable_merge_whitelist?: boolean;
|
||
enable_push?: boolean;
|
||
enable_push_whitelist?: boolean;
|
||
enable_status_check?: boolean;
|
||
force_push_allowlist_deploy_keys?: boolean;
|
||
force_push_allowlist_teams?: string[];
|
||
force_push_allowlist_usernames?: string[];
|
||
ignore_stale_approvals?: boolean;
|
||
merge_whitelist_teams?: string[];
|
||
merge_whitelist_usernames?: string[];
|
||
/** @format int64 */
|
||
priority?: number;
|
||
protected_file_patterns?: string;
|
||
push_whitelist_deploy_keys?: boolean;
|
||
push_whitelist_teams?: string[];
|
||
push_whitelist_usernames?: string[];
|
||
require_signed_commits?: boolean;
|
||
/** @format int64 */
|
||
required_approvals?: number;
|
||
status_check_contexts?: string[];
|
||
unprotected_file_patterns?: string;
|
||
}
|
||
/** EditDeadlineOption options for creating a deadline */
|
||
interface EditDeadlineOption {
|
||
/** @format date-time */
|
||
due_date: string;
|
||
}
|
||
/** EditGitHookOption options when modifying one Git hook */
|
||
interface EditGitHookOption {
|
||
content?: string;
|
||
}
|
||
/** EditHookOption options when modify one hook */
|
||
interface EditHookOption {
|
||
active?: boolean;
|
||
authorization_header?: string;
|
||
branch_filter?: string;
|
||
config?: Record<string, string>;
|
||
events?: string[];
|
||
}
|
||
/** EditIssueCommentOption options for editing a comment */
|
||
interface EditIssueCommentOption {
|
||
body: string;
|
||
}
|
||
/** EditIssueOption options for editing an issue */
|
||
interface EditIssueOption {
|
||
/** deprecated */
|
||
assignee?: string;
|
||
assignees?: string[];
|
||
body?: string;
|
||
/** @format date-time */
|
||
due_date?: string;
|
||
/** @format int64 */
|
||
milestone?: number;
|
||
ref?: string;
|
||
state?: string;
|
||
title?: string;
|
||
unset_due_date?: boolean;
|
||
}
|
||
/** EditLabelOption options for editing a label */
|
||
interface EditLabelOption {
|
||
/** @example "#00aabb" */
|
||
color?: string;
|
||
description?: string;
|
||
/** @example false */
|
||
exclusive?: boolean;
|
||
/** @example false */
|
||
is_archived?: boolean;
|
||
name?: string;
|
||
}
|
||
/** EditMilestoneOption options for editing a milestone */
|
||
interface EditMilestoneOption {
|
||
description?: string;
|
||
/** @format date-time */
|
||
due_on?: string;
|
||
state?: string;
|
||
title?: string;
|
||
}
|
||
/** EditOrgOption options for editing an organization */
|
||
interface EditOrgOption {
|
||
description?: string;
|
||
email?: string;
|
||
full_name?: string;
|
||
location?: string;
|
||
repo_admin_change_team_access?: boolean;
|
||
/** possible values are `public`, `limited` or `private` */
|
||
visibility?: 'public' | 'limited' | 'private';
|
||
website?: string;
|
||
}
|
||
/** EditPullRequestOption options when modify pull request */
|
||
interface EditPullRequestOption {
|
||
allow_maintainer_edit?: boolean;
|
||
assignee?: string;
|
||
assignees?: string[];
|
||
base?: string;
|
||
body?: string;
|
||
/** @format date-time */
|
||
due_date?: string;
|
||
labels?: number[];
|
||
/** @format int64 */
|
||
milestone?: number;
|
||
state?: string;
|
||
title?: string;
|
||
unset_due_date?: boolean;
|
||
}
|
||
/** EditReactionOption contain the reaction type */
|
||
interface EditReactionOption {
|
||
content?: string;
|
||
}
|
||
/** EditReleaseOption options when editing a release */
|
||
interface EditReleaseOption {
|
||
body?: string;
|
||
draft?: boolean;
|
||
name?: string;
|
||
prerelease?: boolean;
|
||
tag_name?: string;
|
||
target_commitish?: string;
|
||
}
|
||
/** EditRepoOption options when editing a repository's properties */
|
||
interface EditRepoOption {
|
||
/** either `true` to allow fast-forward-only merging pull requests, or `false` to prevent fast-forward-only merging. */
|
||
allow_fast_forward_only_merge?: boolean;
|
||
/** either `true` to allow mark pr as merged manually, or `false` to prevent it. */
|
||
allow_manual_merge?: boolean;
|
||
/** either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits. */
|
||
allow_merge_commits?: boolean;
|
||
/** either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging. */
|
||
allow_rebase?: boolean;
|
||
/** either `true` to allow rebase with explicit merge commits (--no-ff), or `false` to prevent rebase with explicit merge commits. */
|
||
allow_rebase_explicit?: boolean;
|
||
/** either `true` to allow updating pull request branch by rebase, or `false` to prevent it. */
|
||
allow_rebase_update?: boolean;
|
||
/** either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging. */
|
||
allow_squash_merge?: boolean;
|
||
/** set to `true` to archive this repository. */
|
||
archived?: boolean;
|
||
/** either `true` to enable AutodetectManualMerge, or `false` to prevent it. Note: In some special cases, misjudgments can occur. */
|
||
autodetect_manual_merge?: boolean;
|
||
/** set to `true` to allow edits from maintainers by default */
|
||
default_allow_maintainer_edit?: boolean;
|
||
/** sets the default branch for this repository. */
|
||
default_branch?: string;
|
||
/** set to `true` to delete pr branch after merge by default */
|
||
default_delete_branch_after_merge?: boolean;
|
||
/** set to a merge style to be used by this repository: "merge", "rebase", "rebase-merge", "squash", or "fast-forward-only". */
|
||
default_merge_style?: string;
|
||
/** a short description of the repository. */
|
||
description?: string;
|
||
/** enable prune - remove obsolete remote-tracking references when mirroring */
|
||
enable_prune?: boolean;
|
||
/** ExternalTracker represents settings for external tracker */
|
||
external_tracker?: ExternalTracker;
|
||
/** ExternalWiki represents setting for external wiki */
|
||
external_wiki?: ExternalWiki;
|
||
/** either `true` to enable actions unit, or `false` to disable them. */
|
||
has_actions?: boolean;
|
||
/** either `true` to enable issues for this repository or `false` to disable them. */
|
||
has_issues?: boolean;
|
||
/** either `true` to enable packages unit, or `false` to disable them. */
|
||
has_packages?: boolean;
|
||
/** either `true` to enable project unit, or `false` to disable them. */
|
||
has_projects?: boolean;
|
||
/** either `true` to allow pull requests, or `false` to prevent pull request. */
|
||
has_pull_requests?: boolean;
|
||
/** either `true` to enable releases unit, or `false` to disable them. */
|
||
has_releases?: boolean;
|
||
/** either `true` to enable the wiki for this repository or `false` to disable it. */
|
||
has_wiki?: boolean;
|
||
/** either `true` to ignore whitespace for conflicts, or `false` to not ignore whitespace. */
|
||
ignore_whitespace_conflicts?: boolean;
|
||
/** InternalTracker represents settings for internal tracker */
|
||
internal_tracker?: InternalTracker;
|
||
/** set to a string like `8h30m0s` to set the mirror interval time */
|
||
mirror_interval?: string;
|
||
/**
|
||
* name of the repository
|
||
* @uniqueItems true
|
||
*/
|
||
name?: string;
|
||
/**
|
||
* either `true` to make the repository private or `false` to make it public.
|
||
* Note: you will get a 422 error if the organization restricts changing repository visibility to organization
|
||
* owners and a non-owner tries to change the value of private.
|
||
*/
|
||
private?: boolean;
|
||
/** `repo` to only allow repo-level projects, `owner` to only allow owner projects, `all` to allow both. */
|
||
projects_mode?: string;
|
||
/** either `true` to make this repository a template or `false` to make it a normal repository */
|
||
template?: boolean;
|
||
/** a URL with more information about the repository. */
|
||
website?: string;
|
||
}
|
||
/** EditTagProtectionOption options for editing a tag protection */
|
||
interface EditTagProtectionOption {
|
||
name_pattern?: string;
|
||
whitelist_teams?: string[];
|
||
whitelist_usernames?: string[];
|
||
}
|
||
/** EditTeamOption options for editing a team */
|
||
interface EditTeamOption {
|
||
can_create_org_repo?: boolean;
|
||
description?: string;
|
||
includes_all_repositories?: boolean;
|
||
name: string;
|
||
permission?: 'read' | 'write' | 'admin';
|
||
/** @example ["repo.code","repo.issues","repo.ext_issues","repo.wiki","repo.pulls","repo.releases","repo.projects","repo.ext_wiki"] */
|
||
units?: string[];
|
||
/** @example {"repo.code":"read","repo.ext_issues":"none","repo.ext_wiki":"none","repo.issues":"write","repo.projects":"none","repo.pulls":"owner","repo.releases":"none","repo.wiki":"admin"} */
|
||
units_map?: Record<string, string>;
|
||
}
|
||
/** EditUserOption edit user options */
|
||
interface EditUserOption {
|
||
active?: boolean;
|
||
admin?: boolean;
|
||
allow_create_organization?: boolean;
|
||
allow_git_hook?: boolean;
|
||
allow_import_local?: boolean;
|
||
description?: string;
|
||
/** @format email */
|
||
email?: string;
|
||
full_name?: string;
|
||
location?: string;
|
||
login_name: string;
|
||
/** @format int64 */
|
||
max_repo_creation?: number;
|
||
must_change_password?: boolean;
|
||
password?: string;
|
||
prohibit_login?: boolean;
|
||
restricted?: boolean;
|
||
/** @format int64 */
|
||
source_id: number;
|
||
visibility?: string;
|
||
website?: string;
|
||
}
|
||
/** Email an email address belonging to a user */
|
||
interface Email {
|
||
/** @format email */
|
||
email?: string;
|
||
primary?: boolean;
|
||
/** @format int64 */
|
||
user_id?: number;
|
||
username?: string;
|
||
verified?: boolean;
|
||
}
|
||
/** ExternalTracker represents settings for external tracker */
|
||
interface ExternalTracker {
|
||
/** External Issue Tracker URL Format. Use the placeholders {user}, {repo} and {index} for the username, repository name and issue index. */
|
||
external_tracker_format?: string;
|
||
/** External Issue Tracker issue regular expression */
|
||
external_tracker_regexp_pattern?: string;
|
||
/** External Issue Tracker Number Format, either `numeric`, `alphanumeric`, or `regexp` */
|
||
external_tracker_style?: string;
|
||
/** URL of external issue tracker. */
|
||
external_tracker_url?: string;
|
||
}
|
||
/** ExternalWiki represents setting for external wiki */
|
||
interface ExternalWiki {
|
||
/** URL of external wiki. */
|
||
external_wiki_url?: string;
|
||
}
|
||
/** FileCommitResponse contains information generated from a Git commit for a repo's file. */
|
||
interface FileCommitResponse {
|
||
author?: CommitUser;
|
||
committer?: CommitUser;
|
||
/** @format date-time */
|
||
created?: string;
|
||
html_url?: string;
|
||
message?: string;
|
||
parents?: CommitMeta[];
|
||
sha?: string;
|
||
tree?: CommitMeta;
|
||
url?: string;
|
||
}
|
||
/** FileDeleteResponse contains information about a repo's file that was deleted */
|
||
interface FileDeleteResponse {
|
||
commit?: FileCommitResponse;
|
||
content?: any;
|
||
/** PayloadCommitVerification represents the GPG verification of a commit */
|
||
verification?: PayloadCommitVerification;
|
||
}
|
||
/** FileLinksResponse contains the links for a repo's file */
|
||
interface FileLinksResponse {
|
||
git?: string;
|
||
html?: string;
|
||
self?: string;
|
||
}
|
||
/** FileResponse contains information about a repo's file */
|
||
interface FileResponse {
|
||
commit?: FileCommitResponse;
|
||
/** ContentsResponse contains information about a repo's entry's (dir, file, symlink, submodule) metadata and content */
|
||
content?: ContentsResponse;
|
||
/** PayloadCommitVerification represents the GPG verification of a commit */
|
||
verification?: PayloadCommitVerification;
|
||
}
|
||
/** FilesResponse contains information about multiple files from a repo */
|
||
interface FilesResponse {
|
||
commit?: FileCommitResponse;
|
||
files?: ContentsResponse[];
|
||
/** PayloadCommitVerification represents the GPG verification of a commit */
|
||
verification?: PayloadCommitVerification;
|
||
}
|
||
/** GPGKey a user GPG key to sign commit and tag in repository */
|
||
interface GPGKey {
|
||
can_certify?: boolean;
|
||
can_encrypt_comms?: boolean;
|
||
can_encrypt_storage?: boolean;
|
||
can_sign?: boolean;
|
||
/** @format date-time */
|
||
created_at?: string;
|
||
emails?: GPGKeyEmail[];
|
||
/** @format date-time */
|
||
expires_at?: string;
|
||
/** @format int64 */
|
||
id?: number;
|
||
key_id?: string;
|
||
primary_key_id?: string;
|
||
public_key?: string;
|
||
subkeys?: GPGKey[];
|
||
verified?: boolean;
|
||
}
|
||
/** GPGKeyEmail an email attached to a GPGKey */
|
||
interface GPGKeyEmail {
|
||
email?: string;
|
||
verified?: boolean;
|
||
}
|
||
/** GeneralAPISettings contains global api settings exposed by it */
|
||
interface GeneralAPISettings {
|
||
/** @format int64 */
|
||
default_git_trees_per_page?: number;
|
||
/** @format int64 */
|
||
default_max_blob_size?: number;
|
||
/** @format int64 */
|
||
default_paging_num?: number;
|
||
/** @format int64 */
|
||
max_response_items?: number;
|
||
}
|
||
/** GeneralAttachmentSettings contains global Attachment settings exposed by API */
|
||
interface GeneralAttachmentSettings {
|
||
allowed_types?: string;
|
||
enabled?: boolean;
|
||
/** @format int64 */
|
||
max_files?: number;
|
||
/** @format int64 */
|
||
max_size?: number;
|
||
}
|
||
/** GeneralRepoSettings contains global repository settings exposed by API */
|
||
interface GeneralRepoSettings {
|
||
http_git_disabled?: boolean;
|
||
lfs_disabled?: boolean;
|
||
migrations_disabled?: boolean;
|
||
mirrors_disabled?: boolean;
|
||
stars_disabled?: boolean;
|
||
time_tracking_disabled?: boolean;
|
||
}
|
||
/** GeneralUISettings contains global ui settings exposed by API */
|
||
interface GeneralUISettings {
|
||
allowed_reactions?: string[];
|
||
custom_emojis?: string[];
|
||
default_theme?: string;
|
||
}
|
||
/** GenerateRepoOption options when creating repository using a template */
|
||
interface GenerateRepoOption {
|
||
/** include avatar of the template repo */
|
||
avatar?: boolean;
|
||
/** Default branch of the new repository */
|
||
default_branch?: string;
|
||
/** Description of the repository to create */
|
||
description?: string;
|
||
/** include git content of default branch in template repo */
|
||
git_content?: boolean;
|
||
/** include git hooks in template repo */
|
||
git_hooks?: boolean;
|
||
/** include labels in template repo */
|
||
labels?: boolean;
|
||
/**
|
||
* Name of the repository to create
|
||
* @uniqueItems true
|
||
*/
|
||
name: string;
|
||
/** The organization or person who will own the new repository */
|
||
owner: string;
|
||
/** Whether the repository is private */
|
||
private?: boolean;
|
||
/** include protected branches in template repo */
|
||
protected_branch?: boolean;
|
||
/** include topics in template repo */
|
||
topics?: boolean;
|
||
/** include webhooks in template repo */
|
||
webhooks?: boolean;
|
||
}
|
||
/** GitBlobResponse represents a git blob */
|
||
interface GitBlobResponse {
|
||
content?: string;
|
||
encoding?: string;
|
||
sha?: string;
|
||
/** @format int64 */
|
||
size?: number;
|
||
url?: string;
|
||
}
|
||
/** GitEntry represents a git tree */
|
||
interface GitEntry {
|
||
mode?: string;
|
||
path?: string;
|
||
sha?: string;
|
||
/** @format int64 */
|
||
size?: number;
|
||
type?: string;
|
||
url?: string;
|
||
}
|
||
/** GitHook represents a Git repository hook */
|
||
interface GitHook {
|
||
content?: string;
|
||
is_active?: boolean;
|
||
name?: string;
|
||
}
|
||
/** GitObject represents a Git object. */
|
||
interface GitObject {
|
||
sha?: string;
|
||
type?: string;
|
||
url?: string;
|
||
}
|
||
/** GitTreeResponse returns a git tree */
|
||
interface GitTreeResponse {
|
||
/** @format int64 */
|
||
page?: number;
|
||
sha?: string;
|
||
/** @format int64 */
|
||
total_count?: number;
|
||
tree?: GitEntry[];
|
||
truncated?: boolean;
|
||
url?: string;
|
||
}
|
||
/** GitignoreTemplateInfo name and text of a gitignore template */
|
||
interface GitignoreTemplateInfo {
|
||
name?: string;
|
||
source?: string;
|
||
}
|
||
/** Hook a hook is a web hook when one repository changed */
|
||
interface Hook {
|
||
active?: boolean;
|
||
authorization_header?: string;
|
||
branch_filter?: string;
|
||
config?: Record<string, string>;
|
||
/** @format date-time */
|
||
created_at?: string;
|
||
events?: string[];
|
||
/** @format int64 */
|
||
id?: number;
|
||
type?: string;
|
||
/** @format date-time */
|
||
updated_at?: string;
|
||
}
|
||
/** Identity for a person's identity like an author or committer */
|
||
interface Identity {
|
||
/** @format email */
|
||
email?: string;
|
||
name?: string;
|
||
}
|
||
/** InternalTracker represents settings for internal tracker */
|
||
interface InternalTracker {
|
||
/** Let only contributors track time (Built-in issue tracker) */
|
||
allow_only_contributors_to_track_time?: boolean;
|
||
/** Enable dependencies for issues and pull requests (Built-in issue tracker) */
|
||
enable_issue_dependencies?: boolean;
|
||
/** Enable time tracking (Built-in issue tracker) */
|
||
enable_time_tracker?: boolean;
|
||
}
|
||
/** Issue represents an issue in a repository */
|
||
interface Issue {
|
||
assets?: Attachment[];
|
||
/** User represents a user */
|
||
assignee?: User;
|
||
assignees?: User[];
|
||
body?: string;
|
||
/** @format date-time */
|
||
closed_at?: string;
|
||
/** @format int64 */
|
||
comments?: number;
|
||
/** @format date-time */
|
||
created_at?: string;
|
||
/** @format date-time */
|
||
due_date?: string;
|
||
html_url?: string;
|
||
/** @format int64 */
|
||
id?: number;
|
||
is_locked?: boolean;
|
||
labels?: Label[];
|
||
/** Milestone milestone is a collection of issues on one repository */
|
||
milestone?: Milestone;
|
||
/** @format int64 */
|
||
number?: number;
|
||
original_author?: string;
|
||
/** @format int64 */
|
||
original_author_id?: number;
|
||
/** @format int64 */
|
||
pin_order?: number;
|
||
/** PullRequestMeta PR info if an issue is a PR */
|
||
pull_request?: PullRequestMeta;
|
||
ref?: string;
|
||
/** RepositoryMeta basic repository information */
|
||
repository?: RepositoryMeta;
|
||
/** StateType issue state type */
|
||
state?: StateType;
|
||
title?: string;
|
||
/** @format date-time */
|
||
updated_at?: string;
|
||
url?: string;
|
||
/** User represents a user */
|
||
user?: User;
|
||
}
|
||
interface IssueConfig {
|
||
blank_issues_enabled?: boolean;
|
||
contact_links?: IssueConfigContactLink[];
|
||
}
|
||
interface IssueConfigContactLink {
|
||
about?: string;
|
||
name?: string;
|
||
url?: string;
|
||
}
|
||
interface IssueConfigValidation {
|
||
message?: string;
|
||
valid?: boolean;
|
||
}
|
||
/** IssueDeadline represents an issue deadline */
|
||
interface IssueDeadline {
|
||
/** @format date-time */
|
||
due_date?: string;
|
||
}
|
||
/** IssueFormField represents a form field */
|
||
interface IssueFormField {
|
||
attributes?: Record<string, any>;
|
||
id?: string;
|
||
type?: IssueFormFieldType;
|
||
validations?: Record<string, any>;
|
||
visible?: IssueFormFieldVisible[];
|
||
}
|
||
/** IssueFormFieldType defines issue form field type, can be "markdown", "textarea", "input", "dropdown" or "checkboxes" */
|
||
type IssueFormFieldType = string;
|
||
/** IssueFormFieldVisible defines issue form field visible */
|
||
type IssueFormFieldVisible = string;
|
||
/** IssueLabelsOption a collection of labels */
|
||
interface IssueLabelsOption {
|
||
/**
|
||
* Labels can be a list of integers representing label IDs
|
||
* or a list of strings representing label names
|
||
*/
|
||
labels?: any[];
|
||
}
|
||
/** IssueMeta basic issue information */
|
||
interface IssueMeta {
|
||
/** @format int64 */
|
||
index?: number;
|
||
owner?: string;
|
||
repo?: string;
|
||
}
|
||
/** IssueTemplate represents an issue template for a repository */
|
||
interface IssueTemplate {
|
||
about?: string;
|
||
assignees?: IssueTemplateStringSlice;
|
||
body?: IssueFormField[];
|
||
content?: string;
|
||
file_name?: string;
|
||
labels?: IssueTemplateStringSlice;
|
||
name?: string;
|
||
ref?: string;
|
||
title?: string;
|
||
}
|
||
type IssueTemplateStringSlice = string[];
|
||
/** Label a label to an issue or a pr */
|
||
interface Label {
|
||
/** @example "00aabb" */
|
||
color?: string;
|
||
description?: string;
|
||
/** @example false */
|
||
exclusive?: boolean;
|
||
/** @format int64 */
|
||
id?: number;
|
||
/** @example false */
|
||
is_archived?: boolean;
|
||
name?: string;
|
||
url?: string;
|
||
}
|
||
/** LabelTemplate info of a Label template */
|
||
interface LabelTemplate {
|
||
/** @example "00aabb" */
|
||
color?: string;
|
||
description?: string;
|
||
/** @example false */
|
||
exclusive?: boolean;
|
||
name?: string;
|
||
}
|
||
/** LicensesInfo contains information about a License */
|
||
interface LicenseTemplateInfo {
|
||
body?: string;
|
||
implementation?: string;
|
||
key?: string;
|
||
name?: string;
|
||
url?: string;
|
||
}
|
||
/** LicensesListEntry is used for the API */
|
||
interface LicensesTemplateListEntry {
|
||
key?: string;
|
||
name?: string;
|
||
url?: string;
|
||
}
|
||
/** MarkdownOption markdown options */
|
||
interface MarkdownOption {
|
||
/**
|
||
* URL path for rendering issue, media and file links
|
||
* Expected format: /subpath/{user}/{repo}/src/{branch, commit, tag}/{identifier/path}/{file/dir}
|
||
*
|
||
* in: body
|
||
*/
|
||
Context?: string;
|
||
/**
|
||
* Mode to render (markdown, comment, wiki, file)
|
||
*
|
||
* in: body
|
||
*/
|
||
Mode?: string;
|
||
/**
|
||
* Text markdown to render
|
||
*
|
||
* in: body
|
||
*/
|
||
Text?: string;
|
||
/**
|
||
* Is it a wiki page? (use mode=wiki instead)
|
||
*
|
||
* Deprecated: true
|
||
* in: body
|
||
*/
|
||
Wiki?: boolean;
|
||
}
|
||
/** MarkupOption markup options */
|
||
interface MarkupOption {
|
||
/**
|
||
* URL path for rendering issue, media and file links
|
||
* Expected format: /subpath/{user}/{repo}/src/{branch, commit, tag}/{identifier/path}/{file/dir}
|
||
*
|
||
* in: body
|
||
*/
|
||
Context?: string;
|
||
/**
|
||
* File path for detecting extension in file mode
|
||
*
|
||
* in: body
|
||
*/
|
||
FilePath?: string;
|
||
/**
|
||
* Mode to render (markdown, comment, wiki, file)
|
||
*
|
||
* in: body
|
||
*/
|
||
Mode?: string;
|
||
/**
|
||
* Text markup to render
|
||
*
|
||
* in: body
|
||
*/
|
||
Text?: string;
|
||
/**
|
||
* Is it a wiki page? (use mode=wiki instead)
|
||
*
|
||
* Deprecated: true
|
||
* in: body
|
||
*/
|
||
Wiki?: boolean;
|
||
}
|
||
/** MergePullRequestForm form for merging Pull Request */
|
||
interface MergePullRequestOption {
|
||
Do: 'merge' | 'rebase' | 'rebase-merge' | 'squash' | 'fast-forward-only' | 'manually-merged';
|
||
MergeCommitID?: string;
|
||
MergeMessageField?: string;
|
||
MergeTitleField?: string;
|
||
delete_branch_after_merge?: boolean;
|
||
force_merge?: boolean;
|
||
head_commit_id?: string;
|
||
merge_when_checks_succeed?: boolean;
|
||
}
|
||
interface MergeUpstreamRequest {
|
||
branch?: string;
|
||
}
|
||
interface MergeUpstreamResponse {
|
||
merge_type?: string;
|
||
}
|
||
/**
|
||
* MigrateRepoOptions options for migrating repository's
|
||
* this is used to interact with api v1
|
||
*/
|
||
interface MigrateRepoOptions {
|
||
auth_password?: string;
|
||
auth_token?: string;
|
||
auth_username?: string;
|
||
aws_access_key_id?: string;
|
||
aws_secret_access_key?: string;
|
||
clone_addr: string;
|
||
description?: string;
|
||
issues?: boolean;
|
||
labels?: boolean;
|
||
lfs?: boolean;
|
||
lfs_endpoint?: string;
|
||
milestones?: boolean;
|
||
mirror?: boolean;
|
||
mirror_interval?: string;
|
||
private?: boolean;
|
||
pull_requests?: boolean;
|
||
releases?: boolean;
|
||
repo_name: string;
|
||
/** Name of User or Organisation who will own Repo after migration */
|
||
repo_owner?: string;
|
||
service?: 'git' | 'github' | 'gitea' | 'gitlab' | 'gogs' | 'onedev' | 'gitbucket' | 'codebase';
|
||
/**
|
||
* deprecated (only for backwards compatibility)
|
||
* @format int64
|
||
*/
|
||
uid?: number;
|
||
wiki?: boolean;
|
||
}
|
||
/** Milestone milestone is a collection of issues on one repository */
|
||
interface Milestone {
|
||
/** @format date-time */
|
||
closed_at?: string;
|
||
/** @format int64 */
|
||
closed_issues?: number;
|
||
/** @format date-time */
|
||
created_at?: string;
|
||
description?: string;
|
||
/** @format date-time */
|
||
due_on?: string;
|
||
/** @format int64 */
|
||
id?: number;
|
||
/** @format int64 */
|
||
open_issues?: number;
|
||
/** StateType issue state type */
|
||
state?: StateType;
|
||
title?: string;
|
||
/** @format date-time */
|
||
updated_at?: string;
|
||
}
|
||
/** NewIssuePinsAllowed represents an API response that says if new Issue Pins are allowed */
|
||
interface NewIssuePinsAllowed {
|
||
issues?: boolean;
|
||
pull_requests?: boolean;
|
||
}
|
||
/** NodeInfo contains standardized way of exposing metadata about a server running one of the distributed social networks */
|
||
interface NodeInfo {
|
||
metadata?: object;
|
||
openRegistrations?: boolean;
|
||
protocols?: string[];
|
||
/** NodeInfoServices contains the third party sites this server can connect to via their application API */
|
||
services?: NodeInfoServices;
|
||
/** NodeInfoSoftware contains Metadata about server software in use */
|
||
software?: NodeInfoSoftware;
|
||
/** NodeInfoUsage contains usage statistics for this server */
|
||
usage?: NodeInfoUsage;
|
||
version?: string;
|
||
}
|
||
/** NodeInfoServices contains the third party sites this server can connect to via their application API */
|
||
interface NodeInfoServices {
|
||
inbound?: string[];
|
||
outbound?: string[];
|
||
}
|
||
/** NodeInfoSoftware contains Metadata about server software in use */
|
||
interface NodeInfoSoftware {
|
||
homepage?: string;
|
||
name?: string;
|
||
repository?: string;
|
||
version?: string;
|
||
}
|
||
/** NodeInfoUsage contains usage statistics for this server */
|
||
interface NodeInfoUsage {
|
||
/** @format int64 */
|
||
localComments?: number;
|
||
/** @format int64 */
|
||
localPosts?: number;
|
||
/** NodeInfoUsageUsers contains statistics about the users of this server */
|
||
users?: NodeInfoUsageUsers;
|
||
}
|
||
/** NodeInfoUsageUsers contains statistics about the users of this server */
|
||
interface NodeInfoUsageUsers {
|
||
/** @format int64 */
|
||
activeHalfyear?: number;
|
||
/** @format int64 */
|
||
activeMonth?: number;
|
||
/** @format int64 */
|
||
total?: number;
|
||
}
|
||
/** Note contains information related to a git note */
|
||
interface Note {
|
||
commit?: Commit;
|
||
message?: string;
|
||
}
|
||
/** NotificationCount number of unread notifications */
|
||
interface NotificationCount {
|
||
/** @format int64 */
|
||
new?: number;
|
||
}
|
||
/** NotificationSubject contains the notification subject (Issue/Pull/Commit) */
|
||
interface NotificationSubject {
|
||
html_url?: string;
|
||
latest_comment_html_url?: string;
|
||
latest_comment_url?: string;
|
||
/** StateType issue state type */
|
||
state?: StateType;
|
||
title?: string;
|
||
/** NotifySubjectType represent type of notification subject */
|
||
type?: NotifySubjectType;
|
||
url?: string;
|
||
}
|
||
/** NotificationThread expose Notification on API */
|
||
interface NotificationThread {
|
||
/** @format int64 */
|
||
id?: number;
|
||
pinned?: boolean;
|
||
/** Repository represents a repository */
|
||
repository?: Repository;
|
||
/** NotificationSubject contains the notification subject (Issue/Pull/Commit) */
|
||
subject?: NotificationSubject;
|
||
unread?: boolean;
|
||
/** @format date-time */
|
||
updated_at?: string;
|
||
url?: string;
|
||
}
|
||
/** NotifySubjectType represent type of notification subject */
|
||
type NotifySubjectType = string;
|
||
/** OAuth2Application represents an OAuth2 application. */
|
||
interface OAuth2Application {
|
||
client_id?: string;
|
||
client_secret?: string;
|
||
confidential_client?: boolean;
|
||
/** @format date-time */
|
||
created?: string;
|
||
/** @format int64 */
|
||
id?: number;
|
||
name?: string;
|
||
redirect_uris?: string[];
|
||
skip_secondary_authorization?: boolean;
|
||
}
|
||
/** Organization represents an organization */
|
||
interface Organization {
|
||
avatar_url?: string;
|
||
description?: string;
|
||
email?: string;
|
||
full_name?: string;
|
||
/** @format int64 */
|
||
id?: number;
|
||
location?: string;
|
||
name?: string;
|
||
repo_admin_change_team_access?: boolean;
|
||
/** deprecated */
|
||
username?: string;
|
||
visibility?: string;
|
||
website?: string;
|
||
}
|
||
/** OrganizationPermissions list different users permissions on an organization */
|
||
interface OrganizationPermissions {
|
||
can_create_repository?: boolean;
|
||
can_read?: boolean;
|
||
can_write?: boolean;
|
||
is_admin?: boolean;
|
||
is_owner?: boolean;
|
||
}
|
||
/** PRBranchInfo information about a branch */
|
||
interface PRBranchInfo {
|
||
label?: string;
|
||
ref?: string;
|
||
/** Repository represents a repository */
|
||
repo?: Repository;
|
||
/** @format int64 */
|
||
repo_id?: number;
|
||
sha?: string;
|
||
}
|
||
/** Package represents a package */
|
||
interface Package {
|
||
/** @format date-time */
|
||
created_at?: string;
|
||
/** User represents a user */
|
||
creator?: User;
|
||
html_url?: string;
|
||
/** @format int64 */
|
||
id?: number;
|
||
name?: string;
|
||
/** User represents a user */
|
||
owner?: User;
|
||
/** Repository represents a repository */
|
||
repository?: Repository;
|
||
type?: string;
|
||
version?: string;
|
||
}
|
||
/** PackageFile represents a package file */
|
||
interface PackageFile {
|
||
/** @format int64 */
|
||
Size?: number;
|
||
/** @format int64 */
|
||
id?: number;
|
||
md5?: string;
|
||
name?: string;
|
||
sha1?: string;
|
||
sha256?: string;
|
||
sha512?: string;
|
||
}
|
||
/** PayloadCommit represents a commit */
|
||
interface PayloadCommit {
|
||
added?: string[];
|
||
/** PayloadUser represents the author or committer of a commit */
|
||
author?: PayloadUser;
|
||
/** PayloadUser represents the author or committer of a commit */
|
||
committer?: PayloadUser;
|
||
/** sha1 hash of the commit */
|
||
id?: string;
|
||
message?: string;
|
||
modified?: string[];
|
||
removed?: string[];
|
||
/** @format date-time */
|
||
timestamp?: string;
|
||
url?: string;
|
||
/** PayloadCommitVerification represents the GPG verification of a commit */
|
||
verification?: PayloadCommitVerification;
|
||
}
|
||
/** PayloadCommitVerification represents the GPG verification of a commit */
|
||
interface PayloadCommitVerification {
|
||
payload?: string;
|
||
reason?: string;
|
||
signature?: string;
|
||
/** PayloadUser represents the author or committer of a commit */
|
||
signer?: PayloadUser;
|
||
verified?: boolean;
|
||
}
|
||
/** PayloadUser represents the author or committer of a commit */
|
||
interface PayloadUser {
|
||
/** @format email */
|
||
email?: string;
|
||
/** Full name of the commit author */
|
||
name?: string;
|
||
username?: string;
|
||
}
|
||
/** Permission represents a set of permissions */
|
||
interface Permission {
|
||
admin?: boolean;
|
||
pull?: boolean;
|
||
push?: boolean;
|
||
}
|
||
/** PublicKey publickey is a user key to push code to repository */
|
||
interface PublicKey {
|
||
/** @format date-time */
|
||
created_at?: string;
|
||
fingerprint?: string;
|
||
/** @format int64 */
|
||
id?: number;
|
||
key?: string;
|
||
key_type?: string;
|
||
read_only?: boolean;
|
||
title?: string;
|
||
url?: string;
|
||
/** User represents a user */
|
||
user?: User;
|
||
}
|
||
/** PullRequest represents a pull request */
|
||
interface PullRequest {
|
||
/** @format int64 */
|
||
additions?: number;
|
||
allow_maintainer_edit?: boolean;
|
||
/** User represents a user */
|
||
assignee?: User;
|
||
assignees?: User[];
|
||
/** PRBranchInfo information about a branch */
|
||
base?: PRBranchInfo;
|
||
body?: string;
|
||
/** @format int64 */
|
||
changed_files?: number;
|
||
/** @format date-time */
|
||
closed_at?: string;
|
||
/** @format int64 */
|
||
comments?: number;
|
||
/** @format date-time */
|
||
created_at?: string;
|
||
/** @format int64 */
|
||
deletions?: number;
|
||
diff_url?: string;
|
||
draft?: boolean;
|
||
/** @format date-time */
|
||
due_date?: string;
|
||
/** PRBranchInfo information about a branch */
|
||
head?: PRBranchInfo;
|
||
html_url?: string;
|
||
/** @format int64 */
|
||
id?: number;
|
||
is_locked?: boolean;
|
||
labels?: Label[];
|
||
merge_base?: string;
|
||
merge_commit_sha?: string;
|
||
mergeable?: boolean;
|
||
merged?: boolean;
|
||
/** @format date-time */
|
||
merged_at?: string;
|
||
/** User represents a user */
|
||
merged_by?: User;
|
||
/** Milestone milestone is a collection of issues on one repository */
|
||
milestone?: Milestone;
|
||
/** @format int64 */
|
||
number?: number;
|
||
patch_url?: string;
|
||
/** @format int64 */
|
||
pin_order?: number;
|
||
requested_reviewers?: User[];
|
||
requested_reviewers_teams?: Team[];
|
||
/**
|
||
* number of review comments made on the diff of a PR review (not including comments on commits or issues in a PR)
|
||
* @format int64
|
||
*/
|
||
review_comments?: number;
|
||
/** StateType issue state type */
|
||
state?: StateType;
|
||
title?: string;
|
||
/** @format date-time */
|
||
updated_at?: string;
|
||
url?: string;
|
||
/** User represents a user */
|
||
user?: User;
|
||
}
|
||
/** PullRequestMeta PR info if an issue is a PR */
|
||
interface PullRequestMeta {
|
||
draft?: boolean;
|
||
html_url?: string;
|
||
merged?: boolean;
|
||
/** @format date-time */
|
||
merged_at?: string;
|
||
}
|
||
/** PullReview represents a pull request review */
|
||
interface PullReview {
|
||
body?: string;
|
||
/** @format int64 */
|
||
comments_count?: number;
|
||
commit_id?: string;
|
||
dismissed?: boolean;
|
||
html_url?: string;
|
||
/** @format int64 */
|
||
id?: number;
|
||
official?: boolean;
|
||
pull_request_url?: string;
|
||
stale?: boolean;
|
||
/** ReviewStateType review state type */
|
||
state?: ReviewStateType;
|
||
/** @format date-time */
|
||
submitted_at?: string;
|
||
/** Team represents a team in an organization */
|
||
team?: Team;
|
||
/** @format date-time */
|
||
updated_at?: string;
|
||
/** User represents a user */
|
||
user?: User;
|
||
}
|
||
/** PullReviewComment represents a comment on a pull request review */
|
||
interface PullReviewComment {
|
||
body?: string;
|
||
commit_id?: string;
|
||
/** @format date-time */
|
||
created_at?: string;
|
||
diff_hunk?: string;
|
||
html_url?: string;
|
||
/** @format int64 */
|
||
id?: number;
|
||
original_commit_id?: string;
|
||
/** @format uint64 */
|
||
original_position?: number;
|
||
path?: string;
|
||
/** @format uint64 */
|
||
position?: number;
|
||
/** @format int64 */
|
||
pull_request_review_id?: number;
|
||
pull_request_url?: string;
|
||
/** User represents a user */
|
||
resolver?: User;
|
||
/** @format date-time */
|
||
updated_at?: string;
|
||
/** User represents a user */
|
||
user?: User;
|
||
}
|
||
/** PullReviewRequestOptions are options to add or remove pull review requests */
|
||
interface PullReviewRequestOptions {
|
||
reviewers?: string[];
|
||
team_reviewers?: string[];
|
||
}
|
||
/** PushMirror represents information of a push mirror */
|
||
interface PushMirror {
|
||
/** @format date-time */
|
||
created?: string;
|
||
interval?: string;
|
||
last_error?: string;
|
||
/** @format date-time */
|
||
last_update?: string;
|
||
remote_address?: string;
|
||
remote_name?: string;
|
||
repo_name?: string;
|
||
sync_on_commit?: boolean;
|
||
}
|
||
/** Reaction contain one reaction */
|
||
interface Reaction {
|
||
content?: string;
|
||
/** @format date-time */
|
||
created_at?: string;
|
||
/** User represents a user */
|
||
user?: User;
|
||
}
|
||
/** Reference represents a Git reference. */
|
||
interface Reference {
|
||
object?: GitObject;
|
||
ref?: string;
|
||
url?: string;
|
||
}
|
||
/** Release represents a repository release */
|
||
interface Release {
|
||
assets?: Attachment[];
|
||
/** User represents a user */
|
||
author?: User;
|
||
body?: string;
|
||
/** @format date-time */
|
||
created_at?: string;
|
||
draft?: boolean;
|
||
html_url?: string;
|
||
/** @format int64 */
|
||
id?: number;
|
||
name?: string;
|
||
prerelease?: boolean;
|
||
/** @format date-time */
|
||
published_at?: string;
|
||
tag_name?: string;
|
||
tarball_url?: string;
|
||
target_commitish?: string;
|
||
upload_url?: string;
|
||
url?: string;
|
||
zipball_url?: string;
|
||
}
|
||
/** RenameUserOption options when renaming a user */
|
||
interface RenameUserOption {
|
||
/**
|
||
* New username for this user. This name cannot be in use yet by any other user.
|
||
* @uniqueItems true
|
||
*/
|
||
new_username: string;
|
||
}
|
||
/** RepoCollaboratorPermission to get repository permission for a collaborator */
|
||
interface RepoCollaboratorPermission {
|
||
permission?: string;
|
||
role_name?: string;
|
||
/** User represents a user */
|
||
user?: User;
|
||
}
|
||
/** RepoCommit contains information of a commit in the context of a repository. */
|
||
interface RepoCommit {
|
||
author?: CommitUser;
|
||
committer?: CommitUser;
|
||
message?: string;
|
||
tree?: CommitMeta;
|
||
url?: string;
|
||
/** PayloadCommitVerification represents the GPG verification of a commit */
|
||
verification?: PayloadCommitVerification;
|
||
}
|
||
/** RepoTopicOptions a collection of repo topic names */
|
||
interface RepoTopicOptions {
|
||
/** list of topic names */
|
||
topics?: string[];
|
||
}
|
||
/** RepoTransfer represents a pending repo transfer */
|
||
interface RepoTransfer {
|
||
/** User represents a user */
|
||
doer?: User;
|
||
/** User represents a user */
|
||
recipient?: User;
|
||
teams?: Team[];
|
||
}
|
||
/** Repository represents a repository */
|
||
interface Repository {
|
||
allow_fast_forward_only_merge?: boolean;
|
||
allow_merge_commits?: boolean;
|
||
allow_rebase?: boolean;
|
||
allow_rebase_explicit?: boolean;
|
||
allow_rebase_update?: boolean;
|
||
allow_squash_merge?: boolean;
|
||
archived?: boolean;
|
||
/** @format date-time */
|
||
archived_at?: string;
|
||
avatar_url?: string;
|
||
clone_url?: string;
|
||
/** @format date-time */
|
||
created_at?: string;
|
||
default_allow_maintainer_edit?: boolean;
|
||
default_branch?: string;
|
||
default_delete_branch_after_merge?: boolean;
|
||
default_merge_style?: string;
|
||
description?: string;
|
||
empty?: boolean;
|
||
/** ExternalTracker represents settings for external tracker */
|
||
external_tracker?: ExternalTracker;
|
||
/** ExternalWiki represents setting for external wiki */
|
||
external_wiki?: ExternalWiki;
|
||
fork?: boolean;
|
||
/** @format int64 */
|
||
forks_count?: number;
|
||
full_name?: string;
|
||
has_actions?: boolean;
|
||
has_issues?: boolean;
|
||
has_packages?: boolean;
|
||
has_projects?: boolean;
|
||
has_pull_requests?: boolean;
|
||
has_releases?: boolean;
|
||
has_wiki?: boolean;
|
||
html_url?: string;
|
||
/** @format int64 */
|
||
id?: number;
|
||
ignore_whitespace_conflicts?: boolean;
|
||
internal?: boolean;
|
||
/** InternalTracker represents settings for internal tracker */
|
||
internal_tracker?: InternalTracker;
|
||
language?: string;
|
||
languages_url?: string;
|
||
licenses?: string[];
|
||
link?: string;
|
||
mirror?: boolean;
|
||
mirror_interval?: string;
|
||
/** @format date-time */
|
||
mirror_updated?: string;
|
||
name?: string;
|
||
/** ObjectFormatName of the underlying git repository */
|
||
object_format_name?: 'sha1' | 'sha256';
|
||
/** @format int64 */
|
||
open_issues_count?: number;
|
||
/** @format int64 */
|
||
open_pr_counter?: number;
|
||
original_url?: string;
|
||
/** User represents a user */
|
||
owner?: User;
|
||
/** Repository represents a repository */
|
||
parent?: Repository;
|
||
/** Permission represents a set of permissions */
|
||
permissions?: Permission;
|
||
private?: boolean;
|
||
projects_mode?: string;
|
||
/** @format int64 */
|
||
release_counter?: number;
|
||
/** RepoTransfer represents a pending repo transfer */
|
||
repo_transfer?: RepoTransfer;
|
||
/** @format int64 */
|
||
size?: number;
|
||
ssh_url?: string;
|
||
/** @format int64 */
|
||
stars_count?: number;
|
||
template?: boolean;
|
||
topics?: string[];
|
||
/** @format date-time */
|
||
updated_at?: string;
|
||
url?: string;
|
||
/** @format int64 */
|
||
watchers_count?: number;
|
||
website?: string;
|
||
}
|
||
/** RepositoryMeta basic repository information */
|
||
interface RepositoryMeta {
|
||
full_name?: string;
|
||
/** @format int64 */
|
||
id?: number;
|
||
name?: string;
|
||
owner?: string;
|
||
}
|
||
/** ReviewStateType review state type */
|
||
type ReviewStateType = string;
|
||
/** SearchResults results of a successful search */
|
||
interface SearchResults {
|
||
data?: Repository[];
|
||
ok?: boolean;
|
||
}
|
||
/** Secret represents a secret */
|
||
interface Secret {
|
||
/** @format date-time */
|
||
created_at?: string;
|
||
/** the secret's name */
|
||
name?: string;
|
||
}
|
||
/** ServerVersion wraps the version of the server */
|
||
interface ServerVersion {
|
||
version?: string;
|
||
}
|
||
/** StateType issue state type */
|
||
type StateType = string;
|
||
/** StopWatch represent a running stopwatch */
|
||
interface StopWatch {
|
||
/** @format date-time */
|
||
created?: string;
|
||
duration?: string;
|
||
/** @format int64 */
|
||
issue_index?: number;
|
||
issue_title?: string;
|
||
repo_name?: string;
|
||
repo_owner_name?: string;
|
||
/** @format int64 */
|
||
seconds?: number;
|
||
}
|
||
/** SubmitPullReviewOptions are options to submit a pending pull review */
|
||
interface SubmitPullReviewOptions {
|
||
body?: string;
|
||
/** ReviewStateType review state type */
|
||
event?: ReviewStateType;
|
||
}
|
||
/** Tag represents a repository tag */
|
||
interface Tag {
|
||
commit?: CommitMeta;
|
||
id?: string;
|
||
message?: string;
|
||
name?: string;
|
||
tarball_url?: string;
|
||
zipball_url?: string;
|
||
}
|
||
/** TagProtection represents a tag protection */
|
||
interface TagProtection {
|
||
/** @format date-time */
|
||
created_at?: string;
|
||
/** @format int64 */
|
||
id?: number;
|
||
name_pattern?: string;
|
||
/** @format date-time */
|
||
updated_at?: string;
|
||
whitelist_teams?: string[];
|
||
whitelist_usernames?: string[];
|
||
}
|
||
/** Team represents a team in an organization */
|
||
interface Team {
|
||
can_create_org_repo?: boolean;
|
||
description?: string;
|
||
/** @format int64 */
|
||
id?: number;
|
||
includes_all_repositories?: boolean;
|
||
name?: string;
|
||
/** Organization represents an organization */
|
||
organization?: Organization;
|
||
permission?: 'none' | 'read' | 'write' | 'admin' | 'owner';
|
||
/** @example ["repo.code","repo.issues","repo.ext_issues","repo.wiki","repo.pulls","repo.releases","repo.projects","repo.ext_wiki"] */
|
||
units?: string[];
|
||
/** @example {"repo.code":"read","repo.ext_issues":"none","repo.ext_wiki":"none","repo.issues":"write","repo.projects":"none","repo.pulls":"owner","repo.releases":"none","repo.wiki":"admin"} */
|
||
units_map?: Record<string, string>;
|
||
}
|
||
/**
|
||
* TimeStamp defines a timestamp
|
||
* @format int64
|
||
*/
|
||
type TimeStamp = number;
|
||
/** TimelineComment represents a timeline comment (comment of any type) on a commit or issue */
|
||
interface TimelineComment {
|
||
/** User represents a user */
|
||
assignee?: User;
|
||
/** Team represents a team in an organization */
|
||
assignee_team?: Team;
|
||
body?: string;
|
||
/** @format date-time */
|
||
created_at?: string;
|
||
/** Issue represents an issue in a repository */
|
||
dependent_issue?: Issue;
|
||
html_url?: string;
|
||
/** @format int64 */
|
||
id?: number;
|
||
issue_url?: string;
|
||
/** Label a label to an issue or a pr */
|
||
label?: Label;
|
||
/** Milestone milestone is a collection of issues on one repository */
|
||
milestone?: Milestone;
|
||
new_ref?: string;
|
||
new_title?: string;
|
||
/** Milestone milestone is a collection of issues on one repository */
|
||
old_milestone?: Milestone;
|
||
/** @format int64 */
|
||
old_project_id?: number;
|
||
old_ref?: string;
|
||
old_title?: string;
|
||
/** @format int64 */
|
||
project_id?: number;
|
||
pull_request_url?: string;
|
||
ref_action?: string;
|
||
/** Comment represents a comment on a commit or issue */
|
||
ref_comment?: Comment;
|
||
/** commit SHA where issue/PR was referenced */
|
||
ref_commit_sha?: string;
|
||
/** Issue represents an issue in a repository */
|
||
ref_issue?: Issue;
|
||
/** whether the assignees were removed or added */
|
||
removed_assignee?: boolean;
|
||
/** User represents a user */
|
||
resolve_doer?: User;
|
||
/** @format int64 */
|
||
review_id?: number;
|
||
/** TrackedTime worked time for an issue / pr */
|
||
tracked_time?: TrackedTime;
|
||
type?: string;
|
||
/** @format date-time */
|
||
updated_at?: string;
|
||
/** User represents a user */
|
||
user?: User;
|
||
}
|
||
/** TopicName a list of repo topic names */
|
||
interface TopicName {
|
||
topics?: string[];
|
||
}
|
||
/** TopicResponse for returning topics */
|
||
interface TopicResponse {
|
||
/** @format date-time */
|
||
created?: string;
|
||
/** @format int64 */
|
||
id?: number;
|
||
/** @format int64 */
|
||
repo_count?: number;
|
||
topic_name?: string;
|
||
/** @format date-time */
|
||
updated?: string;
|
||
}
|
||
/** TrackedTime worked time for an issue / pr */
|
||
interface TrackedTime {
|
||
/** @format date-time */
|
||
created?: string;
|
||
/** @format int64 */
|
||
id?: number;
|
||
/** Issue represents an issue in a repository */
|
||
issue?: Issue;
|
||
/**
|
||
* deprecated (only for backwards compatibility)
|
||
* @format int64
|
||
*/
|
||
issue_id?: number;
|
||
/**
|
||
* Time in seconds
|
||
* @format int64
|
||
*/
|
||
time?: number;
|
||
/**
|
||
* deprecated (only for backwards compatibility)
|
||
* @format int64
|
||
*/
|
||
user_id?: number;
|
||
user_name?: string;
|
||
}
|
||
/** TransferRepoOption options when transfer a repository's ownership */
|
||
interface TransferRepoOption {
|
||
new_owner: string;
|
||
/** ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories. */
|
||
team_ids?: number[];
|
||
}
|
||
/** UpdateBranchProtectionPriories a list to update the branch protection rule priorities */
|
||
interface UpdateBranchProtectionPriories {
|
||
ids?: number[];
|
||
}
|
||
/** UpdateBranchRepoOption options when updating a branch in a repository */
|
||
interface UpdateBranchRepoOption {
|
||
/**
|
||
* New branch name
|
||
* @uniqueItems true
|
||
*/
|
||
name: string;
|
||
}
|
||
/**
|
||
* UpdateFileOptions options for updating files
|
||
* Note: `author` and `committer` are optional (if only one is given, it will be used for the other, otherwise the authenticated user will be used)
|
||
*/
|
||
interface UpdateFileOptions {
|
||
/** Identity for a person's identity like an author or committer */
|
||
author?: Identity;
|
||
/** branch (optional) to base this file from. if not given, the default branch is used */
|
||
branch?: string;
|
||
/** Identity for a person's identity like an author or committer */
|
||
committer?: Identity;
|
||
/** content must be base64 encoded */
|
||
content: string;
|
||
/** CommitDateOptions store dates for GIT_AUTHOR_DATE and GIT_COMMITTER_DATE */
|
||
dates?: CommitDateOptions;
|
||
/** from_path (optional) is the path of the original file which will be moved/renamed to the path in the URL */
|
||
from_path?: string;
|
||
/** message (optional) for the commit of this file. if not supplied, a default message will be used */
|
||
message?: string;
|
||
/** new_branch (optional) will make a new branch from `branch` before creating the file */
|
||
new_branch?: string;
|
||
/** sha is the SHA for the file that already exists */
|
||
sha: string;
|
||
/** Add a Signed-off-by trailer by the committer at the end of the commit log message. */
|
||
signoff?: boolean;
|
||
}
|
||
/** UpdateRepoAvatarUserOption options when updating the repo avatar */
|
||
interface UpdateRepoAvatarOption {
|
||
/** image must be base64 encoded */
|
||
image?: string;
|
||
}
|
||
/** UpdateUserAvatarUserOption options when updating the user avatar */
|
||
interface UpdateUserAvatarOption {
|
||
/** image must be base64 encoded */
|
||
image?: string;
|
||
}
|
||
/** UpdateVariableOption the option when updating variable */
|
||
interface UpdateVariableOption {
|
||
/** New name for the variable. If the field is empty, the variable name won't be updated. */
|
||
name?: string;
|
||
/** Value of the variable to update */
|
||
value: string;
|
||
}
|
||
/** User represents a user */
|
||
interface User {
|
||
/** Is user active */
|
||
active?: boolean;
|
||
/** URL to the user's avatar */
|
||
avatar_url?: string;
|
||
/** @format date-time */
|
||
created?: string;
|
||
/** the user's description */
|
||
description?: string;
|
||
/** @format email */
|
||
email?: string;
|
||
/**
|
||
* user counts
|
||
* @format int64
|
||
*/
|
||
followers_count?: number;
|
||
/** @format int64 */
|
||
following_count?: number;
|
||
/** the user's full name */
|
||
full_name?: string;
|
||
/** URL to the user's gitea page */
|
||
html_url?: string;
|
||
/**
|
||
* the user's id
|
||
* @format int64
|
||
*/
|
||
id?: number;
|
||
/** Is the user an administrator */
|
||
is_admin?: boolean;
|
||
/** User locale */
|
||
language?: string;
|
||
/** @format date-time */
|
||
last_login?: string;
|
||
/** the user's location */
|
||
location?: string;
|
||
/** the user's username */
|
||
login?: string;
|
||
/**
|
||
* the user's authentication sign-in name.
|
||
* @default "empty"
|
||
*/
|
||
login_name?: string;
|
||
/** Is user login prohibited */
|
||
prohibit_login?: boolean;
|
||
/** Is user restricted */
|
||
restricted?: boolean;
|
||
/**
|
||
* The ID of the user's Authentication Source
|
||
* @format int64
|
||
*/
|
||
source_id?: number;
|
||
/** @format int64 */
|
||
starred_repos_count?: number;
|
||
/** User visibility level option: public, limited, private */
|
||
visibility?: string;
|
||
/** the user's website */
|
||
website?: string;
|
||
}
|
||
/** UserBadgeOption options for link between users and badges */
|
||
interface UserBadgeOption {
|
||
/** @example ["badge1","badge2"] */
|
||
badge_slugs?: string[];
|
||
}
|
||
/** UserHeatmapData represents the data needed to create a heatmap */
|
||
interface UserHeatmapData {
|
||
/** @format int64 */
|
||
contributions?: number;
|
||
/** TimeStamp defines a timestamp */
|
||
timestamp?: TimeStamp;
|
||
}
|
||
/** UserSettings represents user settings */
|
||
interface UserSettings {
|
||
description?: string;
|
||
diff_view_style?: string;
|
||
full_name?: string;
|
||
hide_activity?: boolean;
|
||
/** Privacy */
|
||
hide_email?: boolean;
|
||
language?: string;
|
||
location?: string;
|
||
theme?: string;
|
||
website?: string;
|
||
}
|
||
/** UserSettingsOptions represents options to change user settings */
|
||
interface UserSettingsOptions {
|
||
description?: string;
|
||
diff_view_style?: string;
|
||
full_name?: string;
|
||
hide_activity?: boolean;
|
||
/** Privacy */
|
||
hide_email?: boolean;
|
||
language?: string;
|
||
location?: string;
|
||
theme?: string;
|
||
website?: string;
|
||
}
|
||
/** WatchInfo represents an API watch status of one repository */
|
||
interface WatchInfo {
|
||
/** @format date-time */
|
||
created_at?: string;
|
||
ignored?: boolean;
|
||
reason?: any;
|
||
repository_url?: string;
|
||
subscribed?: boolean;
|
||
url?: string;
|
||
}
|
||
/** WikiCommit page commit/revision */
|
||
interface WikiCommit {
|
||
author?: CommitUser;
|
||
commiter?: CommitUser;
|
||
message?: string;
|
||
sha?: string;
|
||
}
|
||
/** WikiCommitList commit/revision list */
|
||
interface WikiCommitList {
|
||
commits?: WikiCommit[];
|
||
/** @format int64 */
|
||
count?: number;
|
||
}
|
||
/** WikiPage a wiki page */
|
||
interface WikiPage {
|
||
/** @format int64 */
|
||
commit_count?: number;
|
||
/** Page content, base64 encoded */
|
||
content_base64?: string;
|
||
footer?: string;
|
||
html_url?: string;
|
||
/** WikiCommit page commit/revision */
|
||
last_commit?: WikiCommit;
|
||
sidebar?: string;
|
||
sub_url?: string;
|
||
title?: string;
|
||
}
|
||
/** WikiPageMetaData wiki page meta information */
|
||
interface WikiPageMetaData {
|
||
html_url?: string;
|
||
/** WikiCommit page commit/revision */
|
||
last_commit?: WikiCommit;
|
||
sub_url?: string;
|
||
title?: string;
|
||
}
|
||
type QueryParamsType = Record<string | number, any>;
|
||
type ResponseFormat = keyof Omit<Body, 'body' | 'bodyUsed'>;
|
||
interface FullRequestParams extends Omit<RequestInit, 'body'> {
|
||
/** set parameter to `true` for call `securityWorker` for this request */
|
||
secure?: boolean;
|
||
/** request path */
|
||
path: string;
|
||
/** content type of request body */
|
||
type?: ContentType;
|
||
/** query params */
|
||
query?: QueryParamsType;
|
||
/** format of response (i.e. response.json() -> format: "json") */
|
||
format?: ResponseFormat;
|
||
/** request body */
|
||
body?: unknown;
|
||
/** base url */
|
||
baseUrl?: string;
|
||
/** request cancellation token */
|
||
cancelToken?: CancelToken;
|
||
}
|
||
type RequestParams = Omit<FullRequestParams, 'body' | 'method' | 'query' | 'path'>;
|
||
interface ApiConfig<SecurityDataType = unknown> {
|
||
baseUrl?: string;
|
||
baseApiParams?: Omit<RequestParams, 'baseUrl' | 'cancelToken' | 'signal'>;
|
||
securityWorker?: (securityData: SecurityDataType | null) => Promise<RequestParams | void> | RequestParams | void;
|
||
customFetch?: typeof fetch;
|
||
}
|
||
interface HttpResponse<D extends unknown, E extends unknown = unknown> extends Response {
|
||
data: D;
|
||
error: E;
|
||
}
|
||
type CancelToken = Symbol | string | number;
|
||
declare enum ContentType {
|
||
Json = "application/json",
|
||
FormData = "multipart/form-data",
|
||
UrlEncoded = "application/x-www-form-urlencoded",
|
||
Text = "text/plain"
|
||
}
|
||
declare class HttpClient<SecurityDataType = unknown> {
|
||
baseUrl: string;
|
||
private securityData;
|
||
private securityWorker?;
|
||
private abortControllers;
|
||
private customFetch;
|
||
private baseApiParams;
|
||
constructor(apiConfig?: ApiConfig<SecurityDataType>);
|
||
setSecurityData: (data: SecurityDataType | null) => void;
|
||
protected encodeQueryParam(key: string, value: any): string;
|
||
protected addQueryParam(query: QueryParamsType, key: string): string;
|
||
protected addArrayQueryParam(query: QueryParamsType, key: string): any;
|
||
protected toQueryString(rawQuery?: QueryParamsType): string;
|
||
protected addQueryParams(rawQuery?: QueryParamsType): string;
|
||
private contentFormatters;
|
||
protected mergeRequestParams(params1: RequestParams, params2?: RequestParams): RequestParams;
|
||
protected createAbortSignal: (cancelToken: CancelToken) => AbortSignal | undefined;
|
||
abortRequest: (cancelToken: CancelToken) => void;
|
||
request: <T = any, E = any>({ body, secure, path, type, query, format, baseUrl, cancelToken, ...params }: FullRequestParams) => Promise<HttpResponse<T, E>>;
|
||
}
|
||
/**
|
||
* @title Gitea API
|
||
* @version 1.23.1
|
||
* @license MIT (http://opensource.org/licenses/MIT)
|
||
* @baseUrl /api/v1
|
||
*
|
||
* This documentation describes the Gitea API.
|
||
*/
|
||
declare class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDataType> {
|
||
activitypub: {
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags activitypub
|
||
* @name ActivitypubPerson
|
||
* @summary Returns the Person actor for a user
|
||
* @request GET:/activitypub/user-id/{user-id}
|
||
* @secure
|
||
*/
|
||
activitypubPerson: (userId: number, params?: RequestParams) => Promise<HttpResponse<ActivityPub, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags activitypub
|
||
* @name ActivitypubPersonInbox
|
||
* @summary Send to the inbox
|
||
* @request POST:/activitypub/user-id/{user-id}/inbox
|
||
* @secure
|
||
*/
|
||
activitypubPersonInbox: (userId: number, params?: RequestParams) => Promise<HttpResponse<any, any>>;
|
||
};
|
||
admin: {
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags admin
|
||
* @name AdminCronList
|
||
* @summary List cron tasks
|
||
* @request GET:/admin/cron
|
||
* @secure
|
||
*/
|
||
adminCronList: (query?: {
|
||
/** page number of results to return (1-based) */
|
||
page?: number;
|
||
/** page size of results */
|
||
limit?: number;
|
||
}, params?: RequestParams) => Promise<HttpResponse<Cron[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags admin
|
||
* @name AdminCronRun
|
||
* @summary Run cron task
|
||
* @request POST:/admin/cron/{task}
|
||
* @secure
|
||
*/
|
||
adminCronRun: (task: string, params?: RequestParams) => Promise<HttpResponse<any, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags admin
|
||
* @name AdminGetAllEmails
|
||
* @summary List all emails
|
||
* @request GET:/admin/emails
|
||
* @secure
|
||
*/
|
||
adminGetAllEmails: (query?: {
|
||
/** page number of results to return (1-based) */
|
||
page?: number;
|
||
/** page size of results */
|
||
limit?: number;
|
||
}, params?: RequestParams) => Promise<HttpResponse<Email[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags admin
|
||
* @name AdminSearchEmails
|
||
* @summary Search all emails
|
||
* @request GET:/admin/emails/search
|
||
* @secure
|
||
*/
|
||
adminSearchEmails: (query?: {
|
||
/** keyword */
|
||
q?: string;
|
||
/** page number of results to return (1-based) */
|
||
page?: number;
|
||
/** page size of results */
|
||
limit?: number;
|
||
}, params?: RequestParams) => Promise<HttpResponse<Email[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags admin
|
||
* @name AdminListHooks
|
||
* @summary List system's webhooks
|
||
* @request GET:/admin/hooks
|
||
* @secure
|
||
*/
|
||
adminListHooks: (query?: {
|
||
/** page number of results to return (1-based) */
|
||
page?: number;
|
||
/** page size of results */
|
||
limit?: number;
|
||
}, params?: RequestParams) => Promise<HttpResponse<Hook[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags admin
|
||
* @name AdminCreateHook
|
||
* @summary Create a hook
|
||
* @request POST:/admin/hooks
|
||
* @secure
|
||
*/
|
||
adminCreateHook: (body: CreateHookOption, params?: RequestParams) => Promise<HttpResponse<Hook, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags admin
|
||
* @name AdminGetHook
|
||
* @summary Get a hook
|
||
* @request GET:/admin/hooks/{id}
|
||
* @secure
|
||
*/
|
||
adminGetHook: (id: number, params?: RequestParams) => Promise<HttpResponse<Hook, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags admin
|
||
* @name AdminDeleteHook
|
||
* @summary Delete a hook
|
||
* @request DELETE:/admin/hooks/{id}
|
||
* @secure
|
||
*/
|
||
adminDeleteHook: (id: number, params?: RequestParams) => Promise<HttpResponse<any, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags admin
|
||
* @name AdminEditHook
|
||
* @summary Update a hook
|
||
* @request PATCH:/admin/hooks/{id}
|
||
* @secure
|
||
*/
|
||
adminEditHook: (id: number, body: EditHookOption, params?: RequestParams) => Promise<HttpResponse<Hook, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags admin
|
||
* @name AdminGetAllOrgs
|
||
* @summary List all organizations
|
||
* @request GET:/admin/orgs
|
||
* @secure
|
||
*/
|
||
adminGetAllOrgs: (query?: {
|
||
/** page number of results to return (1-based) */
|
||
page?: number;
|
||
/** page size of results */
|
||
limit?: number;
|
||
}, params?: RequestParams) => Promise<HttpResponse<Organization[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags admin
|
||
* @name AdminGetRunnerRegistrationToken
|
||
* @summary Get an global actions runner registration token
|
||
* @request GET:/admin/runners/registration-token
|
||
* @secure
|
||
*/
|
||
adminGetRunnerRegistrationToken: (params?: RequestParams) => Promise<HttpResponse<any, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags admin
|
||
* @name AdminUnadoptedList
|
||
* @summary List unadopted repositories
|
||
* @request GET:/admin/unadopted
|
||
* @secure
|
||
*/
|
||
adminUnadoptedList: (query?: {
|
||
/** page number of results to return (1-based) */
|
||
page?: number;
|
||
/** page size of results */
|
||
limit?: number;
|
||
/** pattern of repositories to search for */
|
||
pattern?: string;
|
||
}, params?: RequestParams) => Promise<HttpResponse<string[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags admin
|
||
* @name AdminAdoptRepository
|
||
* @summary Adopt unadopted files as a repository
|
||
* @request POST:/admin/unadopted/{owner}/{repo}
|
||
* @secure
|
||
*/
|
||
adminAdoptRepository: (owner: string, repo: string, params?: RequestParams) => Promise<HttpResponse<any, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags admin
|
||
* @name AdminDeleteUnadoptedRepository
|
||
* @summary Delete unadopted files
|
||
* @request DELETE:/admin/unadopted/{owner}/{repo}
|
||
* @secure
|
||
*/
|
||
adminDeleteUnadoptedRepository: (owner: string, repo: string, params?: RequestParams) => Promise<HttpResponse<any, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags admin
|
||
* @name AdminSearchUsers
|
||
* @summary Search users according filter conditions
|
||
* @request GET:/admin/users
|
||
* @secure
|
||
*/
|
||
adminSearchUsers: (query?: {
|
||
/**
|
||
* ID of the user's login source to search for
|
||
* @format int64
|
||
*/
|
||
source_id?: number;
|
||
/** user's login name to search for */
|
||
login_name?: string;
|
||
/** page number of results to return (1-based) */
|
||
page?: number;
|
||
/** page size of results */
|
||
limit?: number;
|
||
}, params?: RequestParams) => Promise<HttpResponse<User[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags admin
|
||
* @name AdminCreateUser
|
||
* @summary Create a user
|
||
* @request POST:/admin/users
|
||
* @secure
|
||
*/
|
||
adminCreateUser: (body: CreateUserOption, params?: RequestParams) => Promise<HttpResponse<User, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags admin
|
||
* @name AdminDeleteUser
|
||
* @summary Delete a user
|
||
* @request DELETE:/admin/users/{username}
|
||
* @secure
|
||
*/
|
||
adminDeleteUser: (username: string, query?: {
|
||
/** purge the user from the system completely */
|
||
purge?: boolean;
|
||
}, params?: RequestParams) => Promise<HttpResponse<any, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags admin
|
||
* @name AdminEditUser
|
||
* @summary Edit an existing user
|
||
* @request PATCH:/admin/users/{username}
|
||
* @secure
|
||
*/
|
||
adminEditUser: (username: string, body: EditUserOption, params?: RequestParams) => Promise<HttpResponse<User, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags admin
|
||
* @name AdminListUserBadges
|
||
* @summary List a user's badges
|
||
* @request GET:/admin/users/{username}/badges
|
||
* @secure
|
||
*/
|
||
adminListUserBadges: (username: string, params?: RequestParams) => Promise<HttpResponse<Badge[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags admin
|
||
* @name AdminAddUserBadges
|
||
* @summary Add a badge to a user
|
||
* @request POST:/admin/users/{username}/badges
|
||
* @secure
|
||
*/
|
||
adminAddUserBadges: (username: string, body: UserBadgeOption, params?: RequestParams) => Promise<HttpResponse<any, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags admin
|
||
* @name AdminDeleteUserBadges
|
||
* @summary Remove a badge from a user
|
||
* @request DELETE:/admin/users/{username}/badges
|
||
* @secure
|
||
*/
|
||
adminDeleteUserBadges: (username: string, body: UserBadgeOption, params?: RequestParams) => Promise<HttpResponse<any, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags admin
|
||
* @name AdminCreatePublicKey
|
||
* @summary Add a public key on behalf of a user
|
||
* @request POST:/admin/users/{username}/keys
|
||
* @secure
|
||
*/
|
||
adminCreatePublicKey: (username: string, key: CreateKeyOption, params?: RequestParams) => Promise<HttpResponse<PublicKey, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags admin
|
||
* @name AdminDeleteUserPublicKey
|
||
* @summary Delete a user's public key
|
||
* @request DELETE:/admin/users/{username}/keys/{id}
|
||
* @secure
|
||
*/
|
||
adminDeleteUserPublicKey: (username: string, id: number, params?: RequestParams) => Promise<HttpResponse<any, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags admin
|
||
* @name AdminCreateOrg
|
||
* @summary Create an organization
|
||
* @request POST:/admin/users/{username}/orgs
|
||
* @secure
|
||
*/
|
||
adminCreateOrg: (username: string, organization: CreateOrgOption, params?: RequestParams) => Promise<HttpResponse<Organization, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags admin
|
||
* @name AdminRenameUser
|
||
* @summary Rename a user
|
||
* @request POST:/admin/users/{username}/rename
|
||
* @secure
|
||
*/
|
||
adminRenameUser: (username: string, body: RenameUserOption, params?: RequestParams) => Promise<HttpResponse<any, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags admin
|
||
* @name AdminCreateRepo
|
||
* @summary Create a repository on behalf of a user
|
||
* @request POST:/admin/users/{username}/repos
|
||
* @secure
|
||
*/
|
||
adminCreateRepo: (username: string, repository: CreateRepoOption, params?: RequestParams) => Promise<HttpResponse<Repository, any>>;
|
||
};
|
||
gitignore: {
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags miscellaneous
|
||
* @name ListGitignoresTemplates
|
||
* @summary Returns a list of all gitignore templates
|
||
* @request GET:/gitignore/templates
|
||
* @secure
|
||
*/
|
||
listGitignoresTemplates: (params?: RequestParams) => Promise<HttpResponse<string[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags miscellaneous
|
||
* @name GetGitignoreTemplateInfo
|
||
* @summary Returns information about a gitignore template
|
||
* @request GET:/gitignore/templates/{name}
|
||
* @secure
|
||
*/
|
||
getGitignoreTemplateInfo: (name: string, params?: RequestParams) => Promise<HttpResponse<GitignoreTemplateInfo, any>>;
|
||
};
|
||
label: {
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags miscellaneous
|
||
* @name ListLabelTemplates
|
||
* @summary Returns a list of all label templates
|
||
* @request GET:/label/templates
|
||
* @secure
|
||
*/
|
||
listLabelTemplates: (params?: RequestParams) => Promise<HttpResponse<string[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags miscellaneous
|
||
* @name GetLabelTemplateInfo
|
||
* @summary Returns all labels in a template
|
||
* @request GET:/label/templates/{name}
|
||
* @secure
|
||
*/
|
||
getLabelTemplateInfo: (name: string, params?: RequestParams) => Promise<HttpResponse<LabelTemplate[], any>>;
|
||
};
|
||
licenses: {
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags miscellaneous
|
||
* @name ListLicenseTemplates
|
||
* @summary Returns a list of all license templates
|
||
* @request GET:/licenses
|
||
* @secure
|
||
*/
|
||
listLicenseTemplates: (params?: RequestParams) => Promise<HttpResponse<LicensesTemplateListEntry[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags miscellaneous
|
||
* @name GetLicenseTemplateInfo
|
||
* @summary Returns information about a license template
|
||
* @request GET:/licenses/{name}
|
||
* @secure
|
||
*/
|
||
getLicenseTemplateInfo: (name: string, params?: RequestParams) => Promise<HttpResponse<LicenseTemplateInfo, any>>;
|
||
};
|
||
markdown: {
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags miscellaneous
|
||
* @name RenderMarkdown
|
||
* @summary Render a markdown document as HTML
|
||
* @request POST:/markdown
|
||
* @secure
|
||
*/
|
||
renderMarkdown: (body: MarkdownOption, params?: RequestParams) => Promise<HttpResponse<string, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags miscellaneous
|
||
* @name RenderMarkdownRaw
|
||
* @summary Render raw markdown as HTML
|
||
* @request POST:/markdown/raw
|
||
* @secure
|
||
*/
|
||
renderMarkdownRaw: (body: CommitStatusState, params?: RequestParams) => Promise<HttpResponse<string, any>>;
|
||
};
|
||
markup: {
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags miscellaneous
|
||
* @name RenderMarkup
|
||
* @summary Render a markup document as HTML
|
||
* @request POST:/markup
|
||
* @secure
|
||
*/
|
||
renderMarkup: (body: MarkupOption, params?: RequestParams) => Promise<HttpResponse<string, any>>;
|
||
};
|
||
nodeinfo: {
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags miscellaneous
|
||
* @name GetNodeInfo
|
||
* @summary Returns the nodeinfo of the Gitea application
|
||
* @request GET:/nodeinfo
|
||
* @secure
|
||
*/
|
||
getNodeInfo: (params?: RequestParams) => Promise<HttpResponse<NodeInfo, any>>;
|
||
};
|
||
notifications: {
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags notification
|
||
* @name NotifyGetList
|
||
* @summary List users's notification threads
|
||
* @request GET:/notifications
|
||
* @secure
|
||
*/
|
||
notifyGetList: (query?: {
|
||
/** If true, show notifications marked as read. Default value is false */
|
||
all?: boolean;
|
||
/** Show notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread & pinned. */
|
||
'status-types'?: string[];
|
||
/** filter notifications by subject type */
|
||
'subject-type'?: ('issue' | 'pull' | 'commit' | 'repository')[];
|
||
/**
|
||
* Only show notifications updated after the given time. This is a timestamp in RFC 3339 format
|
||
* @format date-time
|
||
*/
|
||
since?: string;
|
||
/**
|
||
* Only show notifications updated before the given time. This is a timestamp in RFC 3339 format
|
||
* @format date-time
|
||
*/
|
||
before?: string;
|
||
/** page number of results to return (1-based) */
|
||
page?: number;
|
||
/** page size of results */
|
||
limit?: number;
|
||
}, params?: RequestParams) => Promise<HttpResponse<NotificationThread[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags notification
|
||
* @name NotifyReadList
|
||
* @summary Mark notification threads as read, pinned or unread
|
||
* @request PUT:/notifications
|
||
* @secure
|
||
*/
|
||
notifyReadList: (query?: {
|
||
/**
|
||
* Describes the last point that notifications were checked. Anything updated since this time will not be updated.
|
||
* @format date-time
|
||
*/
|
||
last_read_at?: string;
|
||
/** If true, mark all notifications on this repo. Default value is false */
|
||
all?: string;
|
||
/** Mark notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread. */
|
||
'status-types'?: string[];
|
||
/** Status to mark notifications as, Defaults to read. */
|
||
'to-status'?: string;
|
||
}, params?: RequestParams) => Promise<HttpResponse<NotificationThread[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags notification
|
||
* @name NotifyNewAvailable
|
||
* @summary Check if unread notifications exist
|
||
* @request GET:/notifications/new
|
||
* @secure
|
||
*/
|
||
notifyNewAvailable: (params?: RequestParams) => Promise<HttpResponse<NotificationCount, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags notification
|
||
* @name NotifyGetThread
|
||
* @summary Get notification thread by ID
|
||
* @request GET:/notifications/threads/{id}
|
||
* @secure
|
||
*/
|
||
notifyGetThread: (id: string, params?: RequestParams) => Promise<HttpResponse<NotificationThread, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags notification
|
||
* @name NotifyReadThread
|
||
* @summary Mark notification thread as read by ID
|
||
* @request PATCH:/notifications/threads/{id}
|
||
* @secure
|
||
*/
|
||
notifyReadThread: (id: string, query?: {
|
||
/**
|
||
* Status to mark notifications as
|
||
* @default "read"
|
||
*/
|
||
'to-status'?: string;
|
||
}, params?: RequestParams) => Promise<HttpResponse<NotificationThread, any>>;
|
||
};
|
||
org: {
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags organization
|
||
* @name CreateOrgRepoDeprecated
|
||
* @summary Create a repository in an organization
|
||
* @request POST:/org/{org}/repos
|
||
* @deprecated
|
||
* @secure
|
||
*/
|
||
createOrgRepoDeprecated: (org: string, body: CreateRepoOption, params?: RequestParams) => Promise<HttpResponse<Repository, any>>;
|
||
};
|
||
orgs: {
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags organization
|
||
* @name OrgGetAll
|
||
* @summary Get list of organizations
|
||
* @request GET:/orgs
|
||
* @secure
|
||
*/
|
||
orgGetAll: (query?: {
|
||
/** page number of results to return (1-based) */
|
||
page?: number;
|
||
/** page size of results */
|
||
limit?: number;
|
||
}, params?: RequestParams) => Promise<HttpResponse<Organization[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags organization
|
||
* @name OrgCreate
|
||
* @summary Create an organization
|
||
* @request POST:/orgs
|
||
* @secure
|
||
*/
|
||
orgCreate: (organization: CreateOrgOption, params?: RequestParams) => Promise<HttpResponse<Organization, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags organization
|
||
* @name OrgGet
|
||
* @summary Get an organization
|
||
* @request GET:/orgs/{org}
|
||
* @secure
|
||
*/
|
||
orgGet: (org: string, params?: RequestParams) => Promise<HttpResponse<Organization, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags organization
|
||
* @name OrgDelete
|
||
* @summary Delete an organization
|
||
* @request DELETE:/orgs/{org}
|
||
* @secure
|
||
*/
|
||
orgDelete: (org: string, params?: RequestParams) => Promise<HttpResponse<any, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags organization
|
||
* @name OrgEdit
|
||
* @summary Edit an organization
|
||
* @request PATCH:/orgs/{org}
|
||
* @secure
|
||
*/
|
||
orgEdit: (org: string, body: EditOrgOption, params?: RequestParams) => Promise<HttpResponse<Organization, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags organization
|
||
* @name OrgGetRunnerRegistrationToken
|
||
* @summary Get an organization's actions runner registration token
|
||
* @request GET:/orgs/{org}/actions/runners/registration-token
|
||
* @secure
|
||
*/
|
||
orgGetRunnerRegistrationToken: (org: string, params?: RequestParams) => Promise<HttpResponse<any, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags organization
|
||
* @name OrgListActionsSecrets
|
||
* @summary List an organization's actions secrets
|
||
* @request GET:/orgs/{org}/actions/secrets
|
||
* @secure
|
||
*/
|
||
orgListActionsSecrets: (org: string, query?: {
|
||
/** page number of results to return (1-based) */
|
||
page?: number;
|
||
/** page size of results */
|
||
limit?: number;
|
||
}, params?: RequestParams) => Promise<HttpResponse<Secret[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags organization
|
||
* @name UpdateOrgSecret
|
||
* @summary Create or Update a secret value in an organization
|
||
* @request PUT:/orgs/{org}/actions/secrets/{secretname}
|
||
* @secure
|
||
*/
|
||
updateOrgSecret: (org: string, secretname: string, body: CreateOrUpdateSecretOption, params?: RequestParams) => Promise<HttpResponse<void, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags organization
|
||
* @name DeleteOrgSecret
|
||
* @summary Delete a secret in an organization
|
||
* @request DELETE:/orgs/{org}/actions/secrets/{secretname}
|
||
* @secure
|
||
*/
|
||
deleteOrgSecret: (org: string, secretname: string, params?: RequestParams) => Promise<HttpResponse<void, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags organization
|
||
* @name GetOrgVariablesList
|
||
* @summary Get an org-level variables list
|
||
* @request GET:/orgs/{org}/actions/variables
|
||
* @secure
|
||
*/
|
||
getOrgVariablesList: (org: string, query?: {
|
||
/** page number of results to return (1-based) */
|
||
page?: number;
|
||
/** page size of results */
|
||
limit?: number;
|
||
}, params?: RequestParams) => Promise<HttpResponse<ActionVariable[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags organization
|
||
* @name GetOrgVariable
|
||
* @summary Get an org-level variable
|
||
* @request GET:/orgs/{org}/actions/variables/{variablename}
|
||
* @secure
|
||
*/
|
||
getOrgVariable: (org: string, variablename: string, params?: RequestParams) => Promise<HttpResponse<ActionVariable, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags organization
|
||
* @name UpdateOrgVariable
|
||
* @summary Update an org-level variable
|
||
* @request PUT:/orgs/{org}/actions/variables/{variablename}
|
||
* @secure
|
||
*/
|
||
updateOrgVariable: (org: string, variablename: string, body: UpdateVariableOption, params?: RequestParams) => Promise<HttpResponse<void, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags organization
|
||
* @name CreateOrgVariable
|
||
* @summary Create an org-level variable
|
||
* @request POST:/orgs/{org}/actions/variables/{variablename}
|
||
* @secure
|
||
*/
|
||
createOrgVariable: (org: string, variablename: string, body: CreateVariableOption, params?: RequestParams) => Promise<HttpResponse<void, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags organization
|
||
* @name DeleteOrgVariable
|
||
* @summary Delete an org-level variable
|
||
* @request DELETE:/orgs/{org}/actions/variables/{variablename}
|
||
* @secure
|
||
*/
|
||
deleteOrgVariable: (org: string, variablename: string, params?: RequestParams) => Promise<HttpResponse<ActionVariable, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags organization
|
||
* @name OrgListActivityFeeds
|
||
* @summary List an organization's activity feeds
|
||
* @request GET:/orgs/{org}/activities/feeds
|
||
* @secure
|
||
*/
|
||
orgListActivityFeeds: (org: string, query?: {
|
||
/**
|
||
* the date of the activities to be found
|
||
* @format date
|
||
*/
|
||
date?: string;
|
||
/** page number of results to return (1-based) */
|
||
page?: number;
|
||
/** page size of results */
|
||
limit?: number;
|
||
}, params?: RequestParams) => Promise<HttpResponse<Activity[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags organization
|
||
* @name OrgUpdateAvatar
|
||
* @summary Update Avatar
|
||
* @request POST:/orgs/{org}/avatar
|
||
* @secure
|
||
*/
|
||
orgUpdateAvatar: (org: string, body: UpdateUserAvatarOption, params?: RequestParams) => Promise<HttpResponse<any, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags organization
|
||
* @name OrgDeleteAvatar
|
||
* @summary Delete Avatar
|
||
* @request DELETE:/orgs/{org}/avatar
|
||
* @secure
|
||
*/
|
||
orgDeleteAvatar: (org: string, params?: RequestParams) => Promise<HttpResponse<any, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags organization
|
||
* @name OrganizationListBlocks
|
||
* @summary List users blocked by the organization
|
||
* @request GET:/orgs/{org}/blocks
|
||
* @secure
|
||
*/
|
||
organizationListBlocks: (org: string, query?: {
|
||
/** page number of results to return (1-based) */
|
||
page?: number;
|
||
/** page size of results */
|
||
limit?: number;
|
||
}, params?: RequestParams) => Promise<HttpResponse<User[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags organization
|
||
* @name OrganizationCheckUserBlock
|
||
* @summary Check if a user is blocked by the organization
|
||
* @request GET:/orgs/{org}/blocks/{username}
|
||
* @secure
|
||
*/
|
||
organizationCheckUserBlock: (org: string, username: string, params?: RequestParams) => Promise<HttpResponse<any, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags organization
|
||
* @name OrganizationBlockUser
|
||
* @summary Block a user
|
||
* @request PUT:/orgs/{org}/blocks/{username}
|
||
* @secure
|
||
*/
|
||
organizationBlockUser: (org: string, username: string, query?: {
|
||
/** optional note for the block */
|
||
note?: string;
|
||
}, params?: RequestParams) => Promise<HttpResponse<any, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags organization
|
||
* @name OrganizationUnblockUser
|
||
* @summary Unblock a user
|
||
* @request DELETE:/orgs/{org}/blocks/{username}
|
||
* @secure
|
||
*/
|
||
organizationUnblockUser: (org: string, username: string, params?: RequestParams) => Promise<HttpResponse<any, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags organization
|
||
* @name OrgListHooks
|
||
* @summary List an organization's webhooks
|
||
* @request GET:/orgs/{org}/hooks
|
||
* @secure
|
||
*/
|
||
orgListHooks: (org: string, query?: {
|
||
/** page number of results to return (1-based) */
|
||
page?: number;
|
||
/** page size of results */
|
||
limit?: number;
|
||
}, params?: RequestParams) => Promise<HttpResponse<Hook[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags organization
|
||
* @name OrgCreateHook
|
||
* @summary Create a hook
|
||
* @request POST:/orgs/{org}/hooks
|
||
* @secure
|
||
*/
|
||
orgCreateHook: (org: string, body: CreateHookOption, params?: RequestParams) => Promise<HttpResponse<Hook, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags organization
|
||
* @name OrgGetHook
|
||
* @summary Get a hook
|
||
* @request GET:/orgs/{org}/hooks/{id}
|
||
* @secure
|
||
*/
|
||
orgGetHook: (org: string, id: number, params?: RequestParams) => Promise<HttpResponse<Hook, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags organization
|
||
* @name OrgDeleteHook
|
||
* @summary Delete a hook
|
||
* @request DELETE:/orgs/{org}/hooks/{id}
|
||
* @secure
|
||
*/
|
||
orgDeleteHook: (org: string, id: number, params?: RequestParams) => Promise<HttpResponse<any, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags organization
|
||
* @name OrgEditHook
|
||
* @summary Update a hook
|
||
* @request PATCH:/orgs/{org}/hooks/{id}
|
||
* @secure
|
||
*/
|
||
orgEditHook: (org: string, id: number, body: EditHookOption, params?: RequestParams) => Promise<HttpResponse<Hook, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags organization
|
||
* @name OrgListLabels
|
||
* @summary List an organization's labels
|
||
* @request GET:/orgs/{org}/labels
|
||
* @secure
|
||
*/
|
||
orgListLabels: (org: string, query?: {
|
||
/** page number of results to return (1-based) */
|
||
page?: number;
|
||
/** page size of results */
|
||
limit?: number;
|
||
}, params?: RequestParams) => Promise<HttpResponse<Label[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags organization
|
||
* @name OrgCreateLabel
|
||
* @summary Create a label for an organization
|
||
* @request POST:/orgs/{org}/labels
|
||
* @secure
|
||
*/
|
||
orgCreateLabel: (org: string, body: CreateLabelOption, params?: RequestParams) => Promise<HttpResponse<Label, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags organization
|
||
* @name OrgGetLabel
|
||
* @summary Get a single label
|
||
* @request GET:/orgs/{org}/labels/{id}
|
||
* @secure
|
||
*/
|
||
orgGetLabel: (org: string, id: number, params?: RequestParams) => Promise<HttpResponse<Label, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags organization
|
||
* @name OrgDeleteLabel
|
||
* @summary Delete a label
|
||
* @request DELETE:/orgs/{org}/labels/{id}
|
||
* @secure
|
||
*/
|
||
orgDeleteLabel: (org: string, id: number, params?: RequestParams) => Promise<HttpResponse<any, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags organization
|
||
* @name OrgEditLabel
|
||
* @summary Update a label
|
||
* @request PATCH:/orgs/{org}/labels/{id}
|
||
* @secure
|
||
*/
|
||
orgEditLabel: (org: string, id: number, body: EditLabelOption, params?: RequestParams) => Promise<HttpResponse<Label, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags organization
|
||
* @name OrgListMembers
|
||
* @summary List an organization's members
|
||
* @request GET:/orgs/{org}/members
|
||
* @secure
|
||
*/
|
||
orgListMembers: (org: string, query?: {
|
||
/** page number of results to return (1-based) */
|
||
page?: number;
|
||
/** page size of results */
|
||
limit?: number;
|
||
}, params?: RequestParams) => Promise<HttpResponse<User[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags organization
|
||
* @name OrgIsMember
|
||
* @summary Check if a user is a member of an organization
|
||
* @request GET:/orgs/{org}/members/{username}
|
||
* @secure
|
||
*/
|
||
orgIsMember: (org: string, username: string, params?: RequestParams) => Promise<HttpResponse<void, void>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags organization
|
||
* @name OrgDeleteMember
|
||
* @summary Remove a member from an organization
|
||
* @request DELETE:/orgs/{org}/members/{username}
|
||
* @secure
|
||
*/
|
||
orgDeleteMember: (org: string, username: string, params?: RequestParams) => Promise<HttpResponse<void, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags organization
|
||
* @name OrgListPublicMembers
|
||
* @summary List an organization's public members
|
||
* @request GET:/orgs/{org}/public_members
|
||
* @secure
|
||
*/
|
||
orgListPublicMembers: (org: string, query?: {
|
||
/** page number of results to return (1-based) */
|
||
page?: number;
|
||
/** page size of results */
|
||
limit?: number;
|
||
}, params?: RequestParams) => Promise<HttpResponse<User[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags organization
|
||
* @name OrgIsPublicMember
|
||
* @summary Check if a user is a public member of an organization
|
||
* @request GET:/orgs/{org}/public_members/{username}
|
||
* @secure
|
||
*/
|
||
orgIsPublicMember: (org: string, username: string, params?: RequestParams) => Promise<HttpResponse<void, void>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags organization
|
||
* @name OrgPublicizeMember
|
||
* @summary Publicize a user's membership
|
||
* @request PUT:/orgs/{org}/public_members/{username}
|
||
* @secure
|
||
*/
|
||
orgPublicizeMember: (org: string, username: string, params?: RequestParams) => Promise<HttpResponse<void, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags organization
|
||
* @name OrgConcealMember
|
||
* @summary Conceal a user's membership
|
||
* @request DELETE:/orgs/{org}/public_members/{username}
|
||
* @secure
|
||
*/
|
||
orgConcealMember: (org: string, username: string, params?: RequestParams) => Promise<HttpResponse<any, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags organization
|
||
* @name OrgListRepos
|
||
* @summary List an organization's repos
|
||
* @request GET:/orgs/{org}/repos
|
||
* @secure
|
||
*/
|
||
orgListRepos: (org: string, query?: {
|
||
/** page number of results to return (1-based) */
|
||
page?: number;
|
||
/** page size of results */
|
||
limit?: number;
|
||
}, params?: RequestParams) => Promise<HttpResponse<Repository[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags organization
|
||
* @name CreateOrgRepo
|
||
* @summary Create a repository in an organization
|
||
* @request POST:/orgs/{org}/repos
|
||
* @secure
|
||
*/
|
||
createOrgRepo: (org: string, body: CreateRepoOption, params?: RequestParams) => Promise<HttpResponse<Repository, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags organization
|
||
* @name OrgListTeams
|
||
* @summary List an organization's teams
|
||
* @request GET:/orgs/{org}/teams
|
||
* @secure
|
||
*/
|
||
orgListTeams: (org: string, query?: {
|
||
/** page number of results to return (1-based) */
|
||
page?: number;
|
||
/** page size of results */
|
||
limit?: number;
|
||
}, params?: RequestParams) => Promise<HttpResponse<Team[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags organization
|
||
* @name OrgCreateTeam
|
||
* @summary Create a team
|
||
* @request POST:/orgs/{org}/teams
|
||
* @secure
|
||
*/
|
||
orgCreateTeam: (org: string, body: CreateTeamOption, params?: RequestParams) => Promise<HttpResponse<Team, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags organization
|
||
* @name TeamSearch
|
||
* @summary Search for teams within an organization
|
||
* @request GET:/orgs/{org}/teams/search
|
||
* @secure
|
||
*/
|
||
teamSearch: (org: string, query?: {
|
||
/** keywords to search */
|
||
q?: string;
|
||
/** include search within team description (defaults to true) */
|
||
include_desc?: boolean;
|
||
/** page number of results to return (1-based) */
|
||
page?: number;
|
||
/** page size of results */
|
||
limit?: number;
|
||
}, params?: RequestParams) => Promise<HttpResponse<{
|
||
data?: Team[] | undefined;
|
||
ok?: boolean | undefined;
|
||
}, any>>;
|
||
};
|
||
packages: {
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags package
|
||
* @name ListPackages
|
||
* @summary Gets all packages of an owner
|
||
* @request GET:/packages/{owner}
|
||
* @secure
|
||
*/
|
||
listPackages: (owner: string, query?: {
|
||
/** page number of results to return (1-based) */
|
||
page?: number;
|
||
/** page size of results */
|
||
limit?: number;
|
||
/** package type filter */
|
||
type?: 'alpine' | 'cargo' | 'chef' | 'composer' | 'conan' | 'conda' | 'container' | 'cran' | 'debian' | 'generic' | 'go' | 'helm' | 'maven' | 'npm' | 'nuget' | 'pub' | 'pypi' | 'rpm' | 'rubygems' | 'swift' | 'vagrant';
|
||
/** name filter */
|
||
q?: string;
|
||
}, params?: RequestParams) => Promise<HttpResponse<Package[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags package
|
||
* @name GetPackage
|
||
* @summary Gets a package
|
||
* @request GET:/packages/{owner}/{type}/{name}/{version}
|
||
* @secure
|
||
*/
|
||
getPackage: (owner: string, type: string, name: string, version: string, params?: RequestParams) => Promise<HttpResponse<Package, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags package
|
||
* @name DeletePackage
|
||
* @summary Delete a package
|
||
* @request DELETE:/packages/{owner}/{type}/{name}/{version}
|
||
* @secure
|
||
*/
|
||
deletePackage: (owner: string, type: string, name: string, version: string, params?: RequestParams) => Promise<HttpResponse<any, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags package
|
||
* @name ListPackageFiles
|
||
* @summary Gets all files of a package
|
||
* @request GET:/packages/{owner}/{type}/{name}/{version}/files
|
||
* @secure
|
||
*/
|
||
listPackageFiles: (owner: string, type: string, name: string, version: string, params?: RequestParams) => Promise<HttpResponse<PackageFile[], any>>;
|
||
};
|
||
repos: {
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags issue
|
||
* @name IssueSearchIssues
|
||
* @summary Search for issues across the repositories that the user has access to
|
||
* @request GET:/repos/issues/search
|
||
* @secure
|
||
*/
|
||
issueSearchIssues: (query?: {
|
||
/**
|
||
* State of the issue
|
||
* @default "open"
|
||
*/
|
||
state?: 'open' | 'closed' | 'all';
|
||
/** Comma-separated list of label names. Fetch only issues that have any of these labels. Non existent labels are discarded. */
|
||
labels?: string;
|
||
/** Comma-separated list of milestone names. Fetch only issues that have any of these milestones. Non existent milestones are discarded. */
|
||
milestones?: string;
|
||
/** Search string */
|
||
q?: string;
|
||
/**
|
||
* Repository ID to prioritize in the results
|
||
* @format int64
|
||
*/
|
||
priority_repo_id?: number;
|
||
/** Filter by issue type */
|
||
type?: 'issues' | 'pulls';
|
||
/**
|
||
* Only show issues updated after the given time (RFC 3339 format)
|
||
* @format date-time
|
||
*/
|
||
since?: string;
|
||
/**
|
||
* Only show issues updated before the given time (RFC 3339 format)
|
||
* @format date-time
|
||
*/
|
||
before?: string;
|
||
/**
|
||
* Filter issues or pulls assigned to the authenticated user
|
||
* @default false
|
||
*/
|
||
assigned?: boolean;
|
||
/**
|
||
* Filter issues or pulls created by the authenticated user
|
||
* @default false
|
||
*/
|
||
created?: boolean;
|
||
/**
|
||
* Filter issues or pulls mentioning the authenticated user
|
||
* @default false
|
||
*/
|
||
mentioned?: boolean;
|
||
/**
|
||
* Filter pull requests where the authenticated user's review was requested
|
||
* @default false
|
||
*/
|
||
review_requested?: boolean;
|
||
/**
|
||
* Filter pull requests reviewed by the authenticated user
|
||
* @default false
|
||
*/
|
||
reviewed?: boolean;
|
||
/** Filter by repository owner */
|
||
owner?: string;
|
||
/** Filter by team (requires organization owner parameter) */
|
||
team?: string;
|
||
/**
|
||
* Page number of results to return (1-based)
|
||
* @min 1
|
||
* @default 1
|
||
*/
|
||
page?: number;
|
||
/**
|
||
* Number of items per page
|
||
* @min 0
|
||
*/
|
||
limit?: number;
|
||
}, params?: RequestParams) => Promise<HttpResponse<Issue[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoMigrate
|
||
* @summary Migrate a remote git repository
|
||
* @request POST:/repos/migrate
|
||
* @secure
|
||
*/
|
||
repoMigrate: (body: MigrateRepoOptions, params?: RequestParams) => Promise<HttpResponse<Repository, void>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoSearch
|
||
* @summary Search for repositories
|
||
* @request GET:/repos/search
|
||
* @secure
|
||
*/
|
||
repoSearch: (query?: {
|
||
/** keyword */
|
||
q?: string;
|
||
/** Limit search to repositories with keyword as topic */
|
||
topic?: boolean;
|
||
/** include search of keyword within repository description */
|
||
includeDesc?: boolean;
|
||
/**
|
||
* search only for repos that the user with the given id owns or contributes to
|
||
* @format int64
|
||
*/
|
||
uid?: number;
|
||
/**
|
||
* repo owner to prioritize in the results
|
||
* @format int64
|
||
*/
|
||
priority_owner_id?: number;
|
||
/**
|
||
* search only for repos that belong to the given team id
|
||
* @format int64
|
||
*/
|
||
team_id?: number;
|
||
/**
|
||
* search only for repos that the user with the given id has starred
|
||
* @format int64
|
||
*/
|
||
starredBy?: number;
|
||
/** include private repositories this user has access to (defaults to true) */
|
||
private?: boolean;
|
||
/** show only pubic, private or all repositories (defaults to all) */
|
||
is_private?: boolean;
|
||
/** include template repositories this user has access to (defaults to true) */
|
||
template?: boolean;
|
||
/** show only archived, non-archived or all repositories (defaults to all) */
|
||
archived?: boolean;
|
||
/** type of repository to search for. Supported values are "fork", "source", "mirror" and "collaborative" */
|
||
mode?: string;
|
||
/** if `uid` is given, search only for repos that the user owns */
|
||
exclusive?: boolean;
|
||
/** sort repos by attribute. Supported values are "alpha", "created", "updated", "size", "git_size", "lfs_size", "stars", "forks" and "id". Default is "alpha" */
|
||
sort?: string;
|
||
/** sort order, either "asc" (ascending) or "desc" (descending). Default is "asc", ignored if "sort" is not specified. */
|
||
order?: string;
|
||
/** page number of results to return (1-based) */
|
||
page?: number;
|
||
/** page size of results */
|
||
limit?: number;
|
||
}, params?: RequestParams) => Promise<HttpResponse<SearchResults, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoGet
|
||
* @summary Get a repository
|
||
* @request GET:/repos/{owner}/{repo}
|
||
* @secure
|
||
*/
|
||
repoGet: (owner: string, repo: string, params?: RequestParams) => Promise<HttpResponse<Repository, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoDelete
|
||
* @summary Delete a repository
|
||
* @request DELETE:/repos/{owner}/{repo}
|
||
* @secure
|
||
*/
|
||
repoDelete: (owner: string, repo: string, params?: RequestParams) => Promise<HttpResponse<any, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoEdit
|
||
* @summary Edit a repository's properties. Only fields that are set will be changed.
|
||
* @request PATCH:/repos/{owner}/{repo}
|
||
* @secure
|
||
*/
|
||
repoEdit: (owner: string, repo: string, body: EditRepoOption, params?: RequestParams) => Promise<HttpResponse<Repository, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoGetRunnerRegistrationToken
|
||
* @summary Get a repository's actions runner registration token
|
||
* @request GET:/repos/{owner}/{repo}/actions/runners/registration-token
|
||
* @secure
|
||
*/
|
||
repoGetRunnerRegistrationToken: (owner: string, repo: string, params?: RequestParams) => Promise<HttpResponse<any, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoListActionsSecrets
|
||
* @summary List an repo's actions secrets
|
||
* @request GET:/repos/{owner}/{repo}/actions/secrets
|
||
* @secure
|
||
*/
|
||
repoListActionsSecrets: (owner: string, repo: string, query?: {
|
||
/** page number of results to return (1-based) */
|
||
page?: number;
|
||
/** page size of results */
|
||
limit?: number;
|
||
}, params?: RequestParams) => Promise<HttpResponse<Secret[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name UpdateRepoSecret
|
||
* @summary Create or Update a secret value in a repository
|
||
* @request PUT:/repos/{owner}/{repo}/actions/secrets/{secretname}
|
||
* @secure
|
||
*/
|
||
updateRepoSecret: (owner: string, repo: string, secretname: string, body: CreateOrUpdateSecretOption, params?: RequestParams) => Promise<HttpResponse<void, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name DeleteRepoSecret
|
||
* @summary Delete a secret in a repository
|
||
* @request DELETE:/repos/{owner}/{repo}/actions/secrets/{secretname}
|
||
* @secure
|
||
*/
|
||
deleteRepoSecret: (owner: string, repo: string, secretname: string, params?: RequestParams) => Promise<HttpResponse<void, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name ListActionTasks
|
||
* @summary List a repository's action tasks
|
||
* @request GET:/repos/{owner}/{repo}/actions/tasks
|
||
* @secure
|
||
*/
|
||
listActionTasks: (owner: string, repo: string, query?: {
|
||
/** page number of results to return (1-based) */
|
||
page?: number;
|
||
/** page size of results, default maximum page size is 50 */
|
||
limit?: number;
|
||
}, params?: RequestParams) => Promise<HttpResponse<ActionTaskResponse, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name GetRepoVariablesList
|
||
* @summary Get repo-level variables list
|
||
* @request GET:/repos/{owner}/{repo}/actions/variables
|
||
* @secure
|
||
*/
|
||
getRepoVariablesList: (owner: string, repo: string, query?: {
|
||
/** page number of results to return (1-based) */
|
||
page?: number;
|
||
/** page size of results */
|
||
limit?: number;
|
||
}, params?: RequestParams) => Promise<HttpResponse<ActionVariable[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name GetRepoVariable
|
||
* @summary Get a repo-level variable
|
||
* @request GET:/repos/{owner}/{repo}/actions/variables/{variablename}
|
||
* @secure
|
||
*/
|
||
getRepoVariable: (owner: string, repo: string, variablename: string, params?: RequestParams) => Promise<HttpResponse<ActionVariable, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name UpdateRepoVariable
|
||
* @summary Update a repo-level variable
|
||
* @request PUT:/repos/{owner}/{repo}/actions/variables/{variablename}
|
||
* @secure
|
||
*/
|
||
updateRepoVariable: (owner: string, repo: string, variablename: string, body: UpdateVariableOption, params?: RequestParams) => Promise<HttpResponse<void, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name CreateRepoVariable
|
||
* @summary Create a repo-level variable
|
||
* @request POST:/repos/{owner}/{repo}/actions/variables/{variablename}
|
||
* @secure
|
||
*/
|
||
createRepoVariable: (owner: string, repo: string, variablename: string, body: CreateVariableOption, params?: RequestParams) => Promise<HttpResponse<void, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name DeleteRepoVariable
|
||
* @summary Delete a repo-level variable
|
||
* @request DELETE:/repos/{owner}/{repo}/actions/variables/{variablename}
|
||
* @secure
|
||
*/
|
||
deleteRepoVariable: (owner: string, repo: string, variablename: string, params?: RequestParams) => Promise<HttpResponse<ActionVariable, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoListActivityFeeds
|
||
* @summary List a repository's activity feeds
|
||
* @request GET:/repos/{owner}/{repo}/activities/feeds
|
||
* @secure
|
||
*/
|
||
repoListActivityFeeds: (owner: string, repo: string, query?: {
|
||
/**
|
||
* the date of the activities to be found
|
||
* @format date
|
||
*/
|
||
date?: string;
|
||
/** page number of results to return (1-based) */
|
||
page?: number;
|
||
/** page size of results */
|
||
limit?: number;
|
||
}, params?: RequestParams) => Promise<HttpResponse<Activity[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoGetArchive
|
||
* @summary Get an archive of a repository
|
||
* @request GET:/repos/{owner}/{repo}/archive/{archive}
|
||
* @secure
|
||
*/
|
||
repoGetArchive: (owner: string, repo: string, archive: string, params?: RequestParams) => Promise<HttpResponse<void, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoGetAssignees
|
||
* @summary Return all users that have write access and can be assigned to issues
|
||
* @request GET:/repos/{owner}/{repo}/assignees
|
||
* @secure
|
||
*/
|
||
repoGetAssignees: (owner: string, repo: string, params?: RequestParams) => Promise<HttpResponse<User[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoUpdateAvatar
|
||
* @summary Update avatar
|
||
* @request POST:/repos/{owner}/{repo}/avatar
|
||
* @secure
|
||
*/
|
||
repoUpdateAvatar: (owner: string, repo: string, body: UpdateRepoAvatarOption, params?: RequestParams) => Promise<HttpResponse<any, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoDeleteAvatar
|
||
* @summary Delete avatar
|
||
* @request DELETE:/repos/{owner}/{repo}/avatar
|
||
* @secure
|
||
*/
|
||
repoDeleteAvatar: (owner: string, repo: string, params?: RequestParams) => Promise<HttpResponse<any, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoListBranchProtection
|
||
* @summary List branch protections for a repository
|
||
* @request GET:/repos/{owner}/{repo}/branch_protections
|
||
* @secure
|
||
*/
|
||
repoListBranchProtection: (owner: string, repo: string, params?: RequestParams) => Promise<HttpResponse<BranchProtection[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoCreateBranchProtection
|
||
* @summary Create a branch protections for a repository
|
||
* @request POST:/repos/{owner}/{repo}/branch_protections
|
||
* @secure
|
||
*/
|
||
repoCreateBranchProtection: (owner: string, repo: string, body: CreateBranchProtectionOption, params?: RequestParams) => Promise<HttpResponse<BranchProtection, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoUpdateBranchProtectionPriories
|
||
* @summary Update the priorities of branch protections for a repository.
|
||
* @request POST:/repos/{owner}/{repo}/branch_protections/priority
|
||
* @secure
|
||
*/
|
||
repoUpdateBranchProtectionPriories: (owner: string, repo: string, body: UpdateBranchProtectionPriories, params?: RequestParams) => Promise<HttpResponse<any, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoGetBranchProtection
|
||
* @summary Get a specific branch protection for the repository
|
||
* @request GET:/repos/{owner}/{repo}/branch_protections/{name}
|
||
* @secure
|
||
*/
|
||
repoGetBranchProtection: (owner: string, repo: string, name: string, params?: RequestParams) => Promise<HttpResponse<BranchProtection, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoDeleteBranchProtection
|
||
* @summary Delete a specific branch protection for the repository
|
||
* @request DELETE:/repos/{owner}/{repo}/branch_protections/{name}
|
||
* @secure
|
||
*/
|
||
repoDeleteBranchProtection: (owner: string, repo: string, name: string, params?: RequestParams) => Promise<HttpResponse<any, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoEditBranchProtection
|
||
* @summary Edit a branch protections for a repository. Only fields that are set will be changed
|
||
* @request PATCH:/repos/{owner}/{repo}/branch_protections/{name}
|
||
* @secure
|
||
*/
|
||
repoEditBranchProtection: (owner: string, repo: string, name: string, body: EditBranchProtectionOption, params?: RequestParams) => Promise<HttpResponse<BranchProtection, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoListBranches
|
||
* @summary List a repository's branches
|
||
* @request GET:/repos/{owner}/{repo}/branches
|
||
* @secure
|
||
*/
|
||
repoListBranches: (owner: string, repo: string, query?: {
|
||
/** page number of results to return (1-based) */
|
||
page?: number;
|
||
/** page size of results */
|
||
limit?: number;
|
||
}, params?: RequestParams) => Promise<HttpResponse<Branch[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoCreateBranch
|
||
* @summary Create a branch
|
||
* @request POST:/repos/{owner}/{repo}/branches
|
||
* @secure
|
||
*/
|
||
repoCreateBranch: (owner: string, repo: string, body: CreateBranchRepoOption, params?: RequestParams) => Promise<HttpResponse<Branch, void>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoGetBranch
|
||
* @summary Retrieve a specific branch from a repository, including its effective branch protection
|
||
* @request GET:/repos/{owner}/{repo}/branches/{branch}
|
||
* @secure
|
||
*/
|
||
repoGetBranch: (owner: string, repo: string, branch: string, params?: RequestParams) => Promise<HttpResponse<Branch, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoDeleteBranch
|
||
* @summary Delete a specific branch from a repository
|
||
* @request DELETE:/repos/{owner}/{repo}/branches/{branch}
|
||
* @secure
|
||
*/
|
||
repoDeleteBranch: (owner: string, repo: string, branch: string, params?: RequestParams) => Promise<HttpResponse<any, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoUpdateBranch
|
||
* @summary Update a branch
|
||
* @request PATCH:/repos/{owner}/{repo}/branches/{branch}
|
||
* @secure
|
||
*/
|
||
repoUpdateBranch: (owner: string, repo: string, branch: string, body: UpdateBranchRepoOption, params?: RequestParams) => Promise<HttpResponse<any, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoListCollaborators
|
||
* @summary List a repository's collaborators
|
||
* @request GET:/repos/{owner}/{repo}/collaborators
|
||
* @secure
|
||
*/
|
||
repoListCollaborators: (owner: string, repo: string, query?: {
|
||
/** page number of results to return (1-based) */
|
||
page?: number;
|
||
/** page size of results */
|
||
limit?: number;
|
||
}, params?: RequestParams) => Promise<HttpResponse<User[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoCheckCollaborator
|
||
* @summary Check if a user is a collaborator of a repository
|
||
* @request GET:/repos/{owner}/{repo}/collaborators/{collaborator}
|
||
* @secure
|
||
*/
|
||
repoCheckCollaborator: (owner: string, repo: string, collaborator: string, params?: RequestParams) => Promise<HttpResponse<any, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoAddCollaborator
|
||
* @summary Add or Update a collaborator to a repository
|
||
* @request PUT:/repos/{owner}/{repo}/collaborators/{collaborator}
|
||
* @secure
|
||
*/
|
||
repoAddCollaborator: (owner: string, repo: string, collaborator: string, body: AddCollaboratorOption, params?: RequestParams) => Promise<HttpResponse<any, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoDeleteCollaborator
|
||
* @summary Delete a collaborator from a repository
|
||
* @request DELETE:/repos/{owner}/{repo}/collaborators/{collaborator}
|
||
* @secure
|
||
*/
|
||
repoDeleteCollaborator: (owner: string, repo: string, collaborator: string, params?: RequestParams) => Promise<HttpResponse<any, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoGetRepoPermissions
|
||
* @summary Get repository permissions for a user
|
||
* @request GET:/repos/{owner}/{repo}/collaborators/{collaborator}/permission
|
||
* @secure
|
||
*/
|
||
repoGetRepoPermissions: (owner: string, repo: string, collaborator: string, params?: RequestParams) => Promise<HttpResponse<RepoCollaboratorPermission, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoGetAllCommits
|
||
* @summary Get a list of all commits from a repository
|
||
* @request GET:/repos/{owner}/{repo}/commits
|
||
* @secure
|
||
*/
|
||
repoGetAllCommits: (owner: string, repo: string, query?: {
|
||
/** SHA or branch to start listing commits from (usually 'master') */
|
||
sha?: string;
|
||
/** filepath of a file/dir */
|
||
path?: string;
|
||
/** include diff stats for every commit (disable for speedup, default 'true') */
|
||
stat?: boolean;
|
||
/** include verification for every commit (disable for speedup, default 'true') */
|
||
verification?: boolean;
|
||
/** include a list of affected files for every commit (disable for speedup, default 'true') */
|
||
files?: boolean;
|
||
/** page number of results to return (1-based) */
|
||
page?: number;
|
||
/** page size of results (ignored if used with 'path') */
|
||
limit?: number;
|
||
/** commits that match the given specifier will not be listed. */
|
||
not?: string;
|
||
}, params?: RequestParams) => Promise<HttpResponse<Commit[], APIError>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoGetCombinedStatusByRef
|
||
* @summary Get a commit's combined status, by branch/tag/commit reference
|
||
* @request GET:/repos/{owner}/{repo}/commits/{ref}/status
|
||
* @secure
|
||
*/
|
||
repoGetCombinedStatusByRef: (owner: string, repo: string, ref: string, query?: {
|
||
/** page number of results to return (1-based) */
|
||
page?: number;
|
||
/** page size of results */
|
||
limit?: number;
|
||
}, params?: RequestParams) => Promise<HttpResponse<CombinedStatus, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoListStatusesByRef
|
||
* @summary Get a commit's statuses, by branch/tag/commit reference
|
||
* @request GET:/repos/{owner}/{repo}/commits/{ref}/statuses
|
||
* @secure
|
||
*/
|
||
repoListStatusesByRef: (owner: string, repo: string, ref: string, query?: {
|
||
/** type of sort */
|
||
sort?: 'oldest' | 'recentupdate' | 'leastupdate' | 'leastindex' | 'highestindex';
|
||
/** type of state */
|
||
state?: 'pending' | 'success' | 'error' | 'failure' | 'warning';
|
||
/** page number of results to return (1-based) */
|
||
page?: number;
|
||
/** page size of results */
|
||
limit?: number;
|
||
}, params?: RequestParams) => Promise<HttpResponse<CommitStatus[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoGetCommitPullRequest
|
||
* @summary Get the merged pull request of the commit
|
||
* @request GET:/repos/{owner}/{repo}/commits/{sha}/pull
|
||
* @secure
|
||
*/
|
||
repoGetCommitPullRequest: (owner: string, repo: string, sha: string, params?: RequestParams) => Promise<HttpResponse<PullRequest, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoCompareDiff
|
||
* @summary Get commit comparison information
|
||
* @request GET:/repos/{owner}/{repo}/compare/{basehead}
|
||
* @secure
|
||
*/
|
||
repoCompareDiff: (owner: string, repo: string, basehead: string, params?: RequestParams) => Promise<HttpResponse<Compare, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoGetContentsList
|
||
* @summary Gets the metadata of all the entries of the root dir
|
||
* @request GET:/repos/{owner}/{repo}/contents
|
||
* @secure
|
||
*/
|
||
repoGetContentsList: (owner: string, repo: string, query?: {
|
||
/** The name of the commit/branch/tag. Default the repository’s default branch (usually master) */
|
||
ref?: string;
|
||
}, params?: RequestParams) => Promise<HttpResponse<ContentsResponse[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoChangeFiles
|
||
* @summary Modify multiple files in a repository
|
||
* @request POST:/repos/{owner}/{repo}/contents
|
||
* @secure
|
||
*/
|
||
repoChangeFiles: (owner: string, repo: string, body: ChangeFilesOptions, params?: RequestParams) => Promise<HttpResponse<FilesResponse, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoGetContents
|
||
* @summary Gets the metadata and contents (if a file) of an entry in a repository, or a list of entries if a dir
|
||
* @request GET:/repos/{owner}/{repo}/contents/{filepath}
|
||
* @secure
|
||
*/
|
||
repoGetContents: (owner: string, repo: string, filepath: string, query?: {
|
||
/** The name of the commit/branch/tag. Default the repository’s default branch (usually master) */
|
||
ref?: string;
|
||
}, params?: RequestParams) => Promise<HttpResponse<ContentsResponse, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoUpdateFile
|
||
* @summary Update a file in a repository
|
||
* @request PUT:/repos/{owner}/{repo}/contents/{filepath}
|
||
* @secure
|
||
*/
|
||
repoUpdateFile: (owner: string, repo: string, filepath: string, body: UpdateFileOptions, params?: RequestParams) => Promise<HttpResponse<FileResponse, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoCreateFile
|
||
* @summary Create a file in a repository
|
||
* @request POST:/repos/{owner}/{repo}/contents/{filepath}
|
||
* @secure
|
||
*/
|
||
repoCreateFile: (owner: string, repo: string, filepath: string, body: CreateFileOptions, params?: RequestParams) => Promise<HttpResponse<FileResponse, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoDeleteFile
|
||
* @summary Delete a file in a repository
|
||
* @request DELETE:/repos/{owner}/{repo}/contents/{filepath}
|
||
* @secure
|
||
*/
|
||
repoDeleteFile: (owner: string, repo: string, filepath: string, body: DeleteFileOptions, params?: RequestParams) => Promise<HttpResponse<FileDeleteResponse, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoApplyDiffPatch
|
||
* @summary Apply diff patch to repository
|
||
* @request POST:/repos/{owner}/{repo}/diffpatch
|
||
* @secure
|
||
*/
|
||
repoApplyDiffPatch: (owner: string, repo: string, body: UpdateFileOptions, params?: RequestParams) => Promise<HttpResponse<FileResponse, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoGetEditorConfig
|
||
* @summary Get the EditorConfig definitions of a file in a repository
|
||
* @request GET:/repos/{owner}/{repo}/editorconfig/{filepath}
|
||
* @secure
|
||
*/
|
||
repoGetEditorConfig: (owner: string, repo: string, filepath: string, query?: {
|
||
/** The name of the commit/branch/tag. Default the repository’s default branch (usually master) */
|
||
ref?: string;
|
||
}, params?: RequestParams) => Promise<HttpResponse<void, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name ListForks
|
||
* @summary List a repository's forks
|
||
* @request GET:/repos/{owner}/{repo}/forks
|
||
* @secure
|
||
*/
|
||
listForks: (owner: string, repo: string, query?: {
|
||
/** page number of results to return (1-based) */
|
||
page?: number;
|
||
/** page size of results */
|
||
limit?: number;
|
||
}, params?: RequestParams) => Promise<HttpResponse<Repository[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name CreateFork
|
||
* @summary Fork a repository
|
||
* @request POST:/repos/{owner}/{repo}/forks
|
||
* @secure
|
||
*/
|
||
createFork: (owner: string, repo: string, body: CreateForkOption, params?: RequestParams) => Promise<HttpResponse<Repository, void>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name GetBlob
|
||
* @summary Gets the blob of a repository.
|
||
* @request GET:/repos/{owner}/{repo}/git/blobs/{sha}
|
||
* @secure
|
||
*/
|
||
getBlob: (owner: string, repo: string, sha: string, params?: RequestParams) => Promise<HttpResponse<GitBlobResponse, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoGetSingleCommit
|
||
* @summary Get a single commit from a repository
|
||
* @request GET:/repos/{owner}/{repo}/git/commits/{sha}
|
||
* @secure
|
||
*/
|
||
repoGetSingleCommit: (owner: string, repo: string, sha: string, query?: {
|
||
/** include diff stats for every commit (disable for speedup, default 'true') */
|
||
stat?: boolean;
|
||
/** include verification for every commit (disable for speedup, default 'true') */
|
||
verification?: boolean;
|
||
/** include a list of affected files for every commit (disable for speedup, default 'true') */
|
||
files?: boolean;
|
||
}, params?: RequestParams) => Promise<HttpResponse<Commit, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoDownloadCommitDiffOrPatch
|
||
* @summary Get a commit's diff or patch
|
||
* @request GET:/repos/{owner}/{repo}/git/commits/{sha}.{diffType}
|
||
* @secure
|
||
*/
|
||
repoDownloadCommitDiffOrPatch: (owner: string, repo: string, sha: string, diffType: 'diff' | 'patch', params?: RequestParams) => Promise<HttpResponse<string, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoGetNote
|
||
* @summary Get a note corresponding to a single commit from a repository
|
||
* @request GET:/repos/{owner}/{repo}/git/notes/{sha}
|
||
* @secure
|
||
*/
|
||
repoGetNote: (owner: string, repo: string, sha: string, query?: {
|
||
/** include verification for every commit (disable for speedup, default 'true') */
|
||
verification?: boolean;
|
||
/** include a list of affected files for every commit (disable for speedup, default 'true') */
|
||
files?: boolean;
|
||
}, params?: RequestParams) => Promise<HttpResponse<Note, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoListAllGitRefs
|
||
* @summary Get specified ref or filtered repository's refs
|
||
* @request GET:/repos/{owner}/{repo}/git/refs
|
||
* @secure
|
||
*/
|
||
repoListAllGitRefs: (owner: string, repo: string, params?: RequestParams) => Promise<HttpResponse<Reference[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoListGitRefs
|
||
* @summary Get specified ref or filtered repository's refs
|
||
* @request GET:/repos/{owner}/{repo}/git/refs/{ref}
|
||
* @secure
|
||
*/
|
||
repoListGitRefs: (owner: string, repo: string, ref: string, params?: RequestParams) => Promise<HttpResponse<Reference[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name GetAnnotatedTag
|
||
* @summary Gets the tag object of an annotated tag (not lightweight tags)
|
||
* @request GET:/repos/{owner}/{repo}/git/tags/{sha}
|
||
* @secure
|
||
*/
|
||
getAnnotatedTag: (owner: string, repo: string, sha: string, params?: RequestParams) => Promise<HttpResponse<AnnotatedTag, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name GetTree
|
||
* @summary Gets the tree of a repository.
|
||
* @request GET:/repos/{owner}/{repo}/git/trees/{sha}
|
||
* @secure
|
||
*/
|
||
getTree: (owner: string, repo: string, sha: string, query?: {
|
||
/** show all directories and files */
|
||
recursive?: boolean;
|
||
/** page number; the 'truncated' field in the response will be true if there are still more items after this page, false if the last page */
|
||
page?: number;
|
||
/** number of items per page */
|
||
per_page?: number;
|
||
}, params?: RequestParams) => Promise<HttpResponse<GitTreeResponse, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoListHooks
|
||
* @summary List the hooks in a repository
|
||
* @request GET:/repos/{owner}/{repo}/hooks
|
||
* @secure
|
||
*/
|
||
repoListHooks: (owner: string, repo: string, query?: {
|
||
/** page number of results to return (1-based) */
|
||
page?: number;
|
||
/** page size of results */
|
||
limit?: number;
|
||
}, params?: RequestParams) => Promise<HttpResponse<Hook[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoCreateHook
|
||
* @summary Create a hook
|
||
* @request POST:/repos/{owner}/{repo}/hooks
|
||
* @secure
|
||
*/
|
||
repoCreateHook: (owner: string, repo: string, body: CreateHookOption, params?: RequestParams) => Promise<HttpResponse<Hook, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoListGitHooks
|
||
* @summary List the Git hooks in a repository
|
||
* @request GET:/repos/{owner}/{repo}/hooks/git
|
||
* @secure
|
||
*/
|
||
repoListGitHooks: (owner: string, repo: string, params?: RequestParams) => Promise<HttpResponse<GitHook[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoGetGitHook
|
||
* @summary Get a Git hook
|
||
* @request GET:/repos/{owner}/{repo}/hooks/git/{id}
|
||
* @secure
|
||
*/
|
||
repoGetGitHook: (owner: string, repo: string, id: string, params?: RequestParams) => Promise<HttpResponse<GitHook, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoDeleteGitHook
|
||
* @summary Delete a Git hook in a repository
|
||
* @request DELETE:/repos/{owner}/{repo}/hooks/git/{id}
|
||
* @secure
|
||
*/
|
||
repoDeleteGitHook: (owner: string, repo: string, id: string, params?: RequestParams) => Promise<HttpResponse<any, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoEditGitHook
|
||
* @summary Edit a Git hook in a repository
|
||
* @request PATCH:/repos/{owner}/{repo}/hooks/git/{id}
|
||
* @secure
|
||
*/
|
||
repoEditGitHook: (owner: string, repo: string, id: string, body: EditGitHookOption, params?: RequestParams) => Promise<HttpResponse<GitHook, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoGetHook
|
||
* @summary Get a hook
|
||
* @request GET:/repos/{owner}/{repo}/hooks/{id}
|
||
* @secure
|
||
*/
|
||
repoGetHook: (owner: string, repo: string, id: number, params?: RequestParams) => Promise<HttpResponse<Hook, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoDeleteHook
|
||
* @summary Delete a hook in a repository
|
||
* @request DELETE:/repos/{owner}/{repo}/hooks/{id}
|
||
* @secure
|
||
*/
|
||
repoDeleteHook: (owner: string, repo: string, id: number, params?: RequestParams) => Promise<HttpResponse<any, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoEditHook
|
||
* @summary Edit a hook in a repository
|
||
* @request PATCH:/repos/{owner}/{repo}/hooks/{id}
|
||
* @secure
|
||
*/
|
||
repoEditHook: (owner: string, repo: string, id: number, body: EditHookOption, params?: RequestParams) => Promise<HttpResponse<Hook, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoTestHook
|
||
* @summary Test a push webhook
|
||
* @request POST:/repos/{owner}/{repo}/hooks/{id}/tests
|
||
* @secure
|
||
*/
|
||
repoTestHook: (owner: string, repo: string, id: number, query?: {
|
||
/** The name of the commit/branch/tag, indicates which commit will be loaded to the webhook payload. */
|
||
ref?: string;
|
||
}, params?: RequestParams) => Promise<HttpResponse<any, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoGetIssueConfig
|
||
* @summary Returns the issue config for a repo
|
||
* @request GET:/repos/{owner}/{repo}/issue_config
|
||
* @secure
|
||
*/
|
||
repoGetIssueConfig: (owner: string, repo: string, params?: RequestParams) => Promise<HttpResponse<IssueConfig, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoValidateIssueConfig
|
||
* @summary Returns the validation information for a issue config
|
||
* @request GET:/repos/{owner}/{repo}/issue_config/validate
|
||
* @secure
|
||
*/
|
||
repoValidateIssueConfig: (owner: string, repo: string, params?: RequestParams) => Promise<HttpResponse<IssueConfigValidation, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoGetIssueTemplates
|
||
* @summary Get available issue templates for a repository
|
||
* @request GET:/repos/{owner}/{repo}/issue_templates
|
||
* @secure
|
||
*/
|
||
repoGetIssueTemplates: (owner: string, repo: string, params?: RequestParams) => Promise<HttpResponse<IssueTemplate[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags issue
|
||
* @name IssueListIssues
|
||
* @summary List a repository's issues
|
||
* @request GET:/repos/{owner}/{repo}/issues
|
||
* @secure
|
||
*/
|
||
issueListIssues: (owner: string, repo: string, query?: {
|
||
/** whether issue is open or closed */
|
||
state?: 'closed' | 'open' | 'all';
|
||
/** comma separated list of labels. Fetch only issues that have any of this labels. Non existent labels are discarded */
|
||
labels?: string;
|
||
/** search string */
|
||
q?: string;
|
||
/** filter by type (issues / pulls) if set */
|
||
type?: 'issues' | 'pulls';
|
||
/** comma separated list of milestone names or ids. It uses names and fall back to ids. Fetch only issues that have any of this milestones. Non existent milestones are discarded */
|
||
milestones?: string;
|
||
/**
|
||
* Only show items updated after the given time. This is a timestamp in RFC 3339 format
|
||
* @format date-time
|
||
*/
|
||
since?: string;
|
||
/**
|
||
* Only show items updated before the given time. This is a timestamp in RFC 3339 format
|
||
* @format date-time
|
||
*/
|
||
before?: string;
|
||
/** Only show items which were created by the given user */
|
||
created_by?: string;
|
||
/** Only show items for which the given user is assigned */
|
||
assigned_by?: string;
|
||
/** Only show items in which the given user was mentioned */
|
||
mentioned_by?: string;
|
||
/** page number of results to return (1-based) */
|
||
page?: number;
|
||
/** page size of results */
|
||
limit?: number;
|
||
}, params?: RequestParams) => Promise<HttpResponse<Issue[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags issue
|
||
* @name IssueCreateIssue
|
||
* @summary Create an issue. If using deadline only the date will be taken into account, and time of day ignored.
|
||
* @request POST:/repos/{owner}/{repo}/issues
|
||
* @secure
|
||
*/
|
||
issueCreateIssue: (owner: string, repo: string, body: CreateIssueOption, params?: RequestParams) => Promise<HttpResponse<Issue, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags issue
|
||
* @name IssueGetRepoComments
|
||
* @summary List all comments in a repository
|
||
* @request GET:/repos/{owner}/{repo}/issues/comments
|
||
* @secure
|
||
*/
|
||
issueGetRepoComments: (owner: string, repo: string, query?: {
|
||
/**
|
||
* if provided, only comments updated since the provided time are returned.
|
||
* @format date-time
|
||
*/
|
||
since?: string;
|
||
/**
|
||
* if provided, only comments updated before the provided time are returned.
|
||
* @format date-time
|
||
*/
|
||
before?: string;
|
||
/** page number of results to return (1-based) */
|
||
page?: number;
|
||
/** page size of results */
|
||
limit?: number;
|
||
}, params?: RequestParams) => Promise<HttpResponse<Comment[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags issue
|
||
* @name IssueGetComment
|
||
* @summary Get a comment
|
||
* @request GET:/repos/{owner}/{repo}/issues/comments/{id}
|
||
* @secure
|
||
*/
|
||
issueGetComment: (owner: string, repo: string, id: number, params?: RequestParams) => Promise<HttpResponse<Comment, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags issue
|
||
* @name IssueDeleteComment
|
||
* @summary Delete a comment
|
||
* @request DELETE:/repos/{owner}/{repo}/issues/comments/{id}
|
||
* @secure
|
||
*/
|
||
issueDeleteComment: (owner: string, repo: string, id: number, params?: RequestParams) => Promise<HttpResponse<any, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags issue
|
||
* @name IssueEditComment
|
||
* @summary Edit a comment
|
||
* @request PATCH:/repos/{owner}/{repo}/issues/comments/{id}
|
||
* @secure
|
||
*/
|
||
issueEditComment: (owner: string, repo: string, id: number, body: EditIssueCommentOption, params?: RequestParams) => Promise<HttpResponse<Comment, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags issue
|
||
* @name IssueListIssueCommentAttachments
|
||
* @summary List comment's attachments
|
||
* @request GET:/repos/{owner}/{repo}/issues/comments/{id}/assets
|
||
* @secure
|
||
*/
|
||
issueListIssueCommentAttachments: (owner: string, repo: string, id: number, params?: RequestParams) => Promise<HttpResponse<Attachment[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags issue
|
||
* @name IssueCreateIssueCommentAttachment
|
||
* @summary Create a comment attachment
|
||
* @request POST:/repos/{owner}/{repo}/issues/comments/{id}/assets
|
||
* @secure
|
||
*/
|
||
issueCreateIssueCommentAttachment: (owner: string, repo: string, id: number, data: {
|
||
/** attachment to upload */
|
||
attachment: File;
|
||
}, query?: {
|
||
/** name of the attachment */
|
||
name?: string;
|
||
}, params?: RequestParams) => Promise<HttpResponse<Attachment, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags issue
|
||
* @name IssueGetIssueCommentAttachment
|
||
* @summary Get a comment attachment
|
||
* @request GET:/repos/{owner}/{repo}/issues/comments/{id}/assets/{attachment_id}
|
||
* @secure
|
||
*/
|
||
issueGetIssueCommentAttachment: (owner: string, repo: string, id: number, attachmentId: number, params?: RequestParams) => Promise<HttpResponse<Attachment, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags issue
|
||
* @name IssueDeleteIssueCommentAttachment
|
||
* @summary Delete a comment attachment
|
||
* @request DELETE:/repos/{owner}/{repo}/issues/comments/{id}/assets/{attachment_id}
|
||
* @secure
|
||
*/
|
||
issueDeleteIssueCommentAttachment: (owner: string, repo: string, id: number, attachmentId: number, params?: RequestParams) => Promise<HttpResponse<any, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags issue
|
||
* @name IssueEditIssueCommentAttachment
|
||
* @summary Edit a comment attachment
|
||
* @request PATCH:/repos/{owner}/{repo}/issues/comments/{id}/assets/{attachment_id}
|
||
* @secure
|
||
*/
|
||
issueEditIssueCommentAttachment: (owner: string, repo: string, id: number, attachmentId: number, body: EditAttachmentOptions, params?: RequestParams) => Promise<HttpResponse<Attachment, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags issue
|
||
* @name IssueGetCommentReactions
|
||
* @summary Get a list of reactions from a comment of an issue
|
||
* @request GET:/repos/{owner}/{repo}/issues/comments/{id}/reactions
|
||
* @secure
|
||
*/
|
||
issueGetCommentReactions: (owner: string, repo: string, id: number, params?: RequestParams) => Promise<HttpResponse<Reaction[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags issue
|
||
* @name IssuePostCommentReaction
|
||
* @summary Add a reaction to a comment of an issue
|
||
* @request POST:/repos/{owner}/{repo}/issues/comments/{id}/reactions
|
||
* @secure
|
||
*/
|
||
issuePostCommentReaction: (owner: string, repo: string, id: number, content: EditReactionOption, params?: RequestParams) => Promise<HttpResponse<Reaction, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags issue
|
||
* @name IssueDeleteCommentReaction
|
||
* @summary Remove a reaction from a comment of an issue
|
||
* @request DELETE:/repos/{owner}/{repo}/issues/comments/{id}/reactions
|
||
* @secure
|
||
*/
|
||
issueDeleteCommentReaction: (owner: string, repo: string, id: number, content: EditReactionOption, params?: RequestParams) => Promise<HttpResponse<any, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoListPinnedIssues
|
||
* @summary List a repo's pinned issues
|
||
* @request GET:/repos/{owner}/{repo}/issues/pinned
|
||
* @secure
|
||
*/
|
||
repoListPinnedIssues: (owner: string, repo: string, params?: RequestParams) => Promise<HttpResponse<Issue[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags issue
|
||
* @name IssueGetIssue
|
||
* @summary Get an issue
|
||
* @request GET:/repos/{owner}/{repo}/issues/{index}
|
||
* @secure
|
||
*/
|
||
issueGetIssue: (owner: string, repo: string, index: number, params?: RequestParams) => Promise<HttpResponse<Issue, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags issue
|
||
* @name IssueDelete
|
||
* @summary Delete an issue
|
||
* @request DELETE:/repos/{owner}/{repo}/issues/{index}
|
||
* @secure
|
||
*/
|
||
issueDelete: (owner: string, repo: string, index: number, params?: RequestParams) => Promise<HttpResponse<any, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags issue
|
||
* @name IssueEditIssue
|
||
* @summary Edit an issue. If using deadline only the date will be taken into account, and time of day ignored.
|
||
* @request PATCH:/repos/{owner}/{repo}/issues/{index}
|
||
* @secure
|
||
*/
|
||
issueEditIssue: (owner: string, repo: string, index: number, body: EditIssueOption, params?: RequestParams) => Promise<HttpResponse<Issue, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags issue
|
||
* @name IssueListIssueAttachments
|
||
* @summary List issue's attachments
|
||
* @request GET:/repos/{owner}/{repo}/issues/{index}/assets
|
||
* @secure
|
||
*/
|
||
issueListIssueAttachments: (owner: string, repo: string, index: number, params?: RequestParams) => Promise<HttpResponse<Attachment[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags issue
|
||
* @name IssueCreateIssueAttachment
|
||
* @summary Create an issue attachment
|
||
* @request POST:/repos/{owner}/{repo}/issues/{index}/assets
|
||
* @secure
|
||
*/
|
||
issueCreateIssueAttachment: (owner: string, repo: string, index: number, data: {
|
||
/** attachment to upload */
|
||
attachment: File;
|
||
}, query?: {
|
||
/** name of the attachment */
|
||
name?: string;
|
||
}, params?: RequestParams) => Promise<HttpResponse<Attachment, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags issue
|
||
* @name IssueGetIssueAttachment
|
||
* @summary Get an issue attachment
|
||
* @request GET:/repos/{owner}/{repo}/issues/{index}/assets/{attachment_id}
|
||
* @secure
|
||
*/
|
||
issueGetIssueAttachment: (owner: string, repo: string, index: number, attachmentId: number, params?: RequestParams) => Promise<HttpResponse<Attachment, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags issue
|
||
* @name IssueDeleteIssueAttachment
|
||
* @summary Delete an issue attachment
|
||
* @request DELETE:/repos/{owner}/{repo}/issues/{index}/assets/{attachment_id}
|
||
* @secure
|
||
*/
|
||
issueDeleteIssueAttachment: (owner: string, repo: string, index: number, attachmentId: number, params?: RequestParams) => Promise<HttpResponse<any, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags issue
|
||
* @name IssueEditIssueAttachment
|
||
* @summary Edit an issue attachment
|
||
* @request PATCH:/repos/{owner}/{repo}/issues/{index}/assets/{attachment_id}
|
||
* @secure
|
||
*/
|
||
issueEditIssueAttachment: (owner: string, repo: string, index: number, attachmentId: number, body: EditAttachmentOptions, params?: RequestParams) => Promise<HttpResponse<Attachment, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags issue
|
||
* @name IssueListBlocks
|
||
* @summary List issues that are blocked by this issue
|
||
* @request GET:/repos/{owner}/{repo}/issues/{index}/blocks
|
||
* @secure
|
||
*/
|
||
issueListBlocks: (owner: string, repo: string, index: string, query?: {
|
||
/** page number of results to return (1-based) */
|
||
page?: number;
|
||
/** page size of results */
|
||
limit?: number;
|
||
}, params?: RequestParams) => Promise<HttpResponse<Issue[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags issue
|
||
* @name IssueCreateIssueBlocking
|
||
* @summary Block the issue given in the body by the issue in path
|
||
* @request POST:/repos/{owner}/{repo}/issues/{index}/blocks
|
||
* @secure
|
||
*/
|
||
issueCreateIssueBlocking: (owner: string, repo: string, index: string, body: IssueMeta, params?: RequestParams) => Promise<HttpResponse<Issue, void>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags issue
|
||
* @name IssueRemoveIssueBlocking
|
||
* @summary Unblock the issue given in the body by the issue in path
|
||
* @request DELETE:/repos/{owner}/{repo}/issues/{index}/blocks
|
||
* @secure
|
||
*/
|
||
issueRemoveIssueBlocking: (owner: string, repo: string, index: string, body: IssueMeta, params?: RequestParams) => Promise<HttpResponse<Issue, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags issue
|
||
* @name IssueGetComments
|
||
* @summary List all comments on an issue
|
||
* @request GET:/repos/{owner}/{repo}/issues/{index}/comments
|
||
* @secure
|
||
*/
|
||
issueGetComments: (owner: string, repo: string, index: number, query?: {
|
||
/**
|
||
* if provided, only comments updated since the specified time are returned.
|
||
* @format date-time
|
||
*/
|
||
since?: string;
|
||
/**
|
||
* if provided, only comments updated before the provided time are returned.
|
||
* @format date-time
|
||
*/
|
||
before?: string;
|
||
}, params?: RequestParams) => Promise<HttpResponse<Comment[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags issue
|
||
* @name IssueCreateComment
|
||
* @summary Add a comment to an issue
|
||
* @request POST:/repos/{owner}/{repo}/issues/{index}/comments
|
||
* @secure
|
||
*/
|
||
issueCreateComment: (owner: string, repo: string, index: number, body: CreateIssueCommentOption, params?: RequestParams) => Promise<HttpResponse<Comment, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags issue
|
||
* @name IssueDeleteCommentDeprecated
|
||
* @summary Delete a comment
|
||
* @request DELETE:/repos/{owner}/{repo}/issues/{index}/comments/{id}
|
||
* @deprecated
|
||
* @secure
|
||
*/
|
||
issueDeleteCommentDeprecated: (owner: string, repo: string, index: number, id: number, params?: RequestParams) => Promise<HttpResponse<any, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags issue
|
||
* @name IssueEditCommentDeprecated
|
||
* @summary Edit a comment
|
||
* @request PATCH:/repos/{owner}/{repo}/issues/{index}/comments/{id}
|
||
* @deprecated
|
||
* @secure
|
||
*/
|
||
issueEditCommentDeprecated: (owner: string, repo: string, index: number, id: number, body: EditIssueCommentOption, params?: RequestParams) => Promise<HttpResponse<Comment, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags issue
|
||
* @name IssueEditIssueDeadline
|
||
* @summary Set an issue deadline. If set to null, the deadline is deleted. If using deadline only the date will be taken into account, and time of day ignored.
|
||
* @request POST:/repos/{owner}/{repo}/issues/{index}/deadline
|
||
* @secure
|
||
*/
|
||
issueEditIssueDeadline: (owner: string, repo: string, index: number, body: EditDeadlineOption, params?: RequestParams) => Promise<HttpResponse<IssueDeadline, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags issue
|
||
* @name IssueListIssueDependencies
|
||
* @summary List an issue's dependencies, i.e all issues that block this issue.
|
||
* @request GET:/repos/{owner}/{repo}/issues/{index}/dependencies
|
||
* @secure
|
||
*/
|
||
issueListIssueDependencies: (owner: string, repo: string, index: string, query?: {
|
||
/** page number of results to return (1-based) */
|
||
page?: number;
|
||
/** page size of results */
|
||
limit?: number;
|
||
}, params?: RequestParams) => Promise<HttpResponse<Issue[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags issue
|
||
* @name IssueCreateIssueDependencies
|
||
* @summary Make the issue in the url depend on the issue in the form.
|
||
* @request POST:/repos/{owner}/{repo}/issues/{index}/dependencies
|
||
* @secure
|
||
*/
|
||
issueCreateIssueDependencies: (owner: string, repo: string, index: string, body: IssueMeta, params?: RequestParams) => Promise<HttpResponse<Issue, void>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags issue
|
||
* @name IssueRemoveIssueDependencies
|
||
* @summary Remove an issue dependency
|
||
* @request DELETE:/repos/{owner}/{repo}/issues/{index}/dependencies
|
||
* @secure
|
||
*/
|
||
issueRemoveIssueDependencies: (owner: string, repo: string, index: string, body: IssueMeta, params?: RequestParams) => Promise<HttpResponse<Issue, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags issue
|
||
* @name IssueGetLabels
|
||
* @summary Get an issue's labels
|
||
* @request GET:/repos/{owner}/{repo}/issues/{index}/labels
|
||
* @secure
|
||
*/
|
||
issueGetLabels: (owner: string, repo: string, index: number, params?: RequestParams) => Promise<HttpResponse<Label[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags issue
|
||
* @name IssueReplaceLabels
|
||
* @summary Replace an issue's labels
|
||
* @request PUT:/repos/{owner}/{repo}/issues/{index}/labels
|
||
* @secure
|
||
*/
|
||
issueReplaceLabels: (owner: string, repo: string, index: number, body: IssueLabelsOption, params?: RequestParams) => Promise<HttpResponse<Label[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags issue
|
||
* @name IssueAddLabel
|
||
* @summary Add a label to an issue
|
||
* @request POST:/repos/{owner}/{repo}/issues/{index}/labels
|
||
* @secure
|
||
*/
|
||
issueAddLabel: (owner: string, repo: string, index: number, body: IssueLabelsOption, params?: RequestParams) => Promise<HttpResponse<Label[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags issue
|
||
* @name IssueClearLabels
|
||
* @summary Remove all labels from an issue
|
||
* @request DELETE:/repos/{owner}/{repo}/issues/{index}/labels
|
||
* @secure
|
||
*/
|
||
issueClearLabels: (owner: string, repo: string, index: number, params?: RequestParams) => Promise<HttpResponse<any, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags issue
|
||
* @name IssueRemoveLabel
|
||
* @summary Remove a label from an issue
|
||
* @request DELETE:/repos/{owner}/{repo}/issues/{index}/labels/{id}
|
||
* @secure
|
||
*/
|
||
issueRemoveLabel: (owner: string, repo: string, index: number, id: number, params?: RequestParams) => Promise<HttpResponse<any, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags issue
|
||
* @name PinIssue
|
||
* @summary Pin an Issue
|
||
* @request POST:/repos/{owner}/{repo}/issues/{index}/pin
|
||
* @secure
|
||
*/
|
||
pinIssue: (owner: string, repo: string, index: number, params?: RequestParams) => Promise<HttpResponse<any, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags issue
|
||
* @name UnpinIssue
|
||
* @summary Unpin an Issue
|
||
* @request DELETE:/repos/{owner}/{repo}/issues/{index}/pin
|
||
* @secure
|
||
*/
|
||
unpinIssue: (owner: string, repo: string, index: number, params?: RequestParams) => Promise<HttpResponse<any, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags issue
|
||
* @name MoveIssuePin
|
||
* @summary Moves the Pin to the given Position
|
||
* @request PATCH:/repos/{owner}/{repo}/issues/{index}/pin/{position}
|
||
* @secure
|
||
*/
|
||
moveIssuePin: (owner: string, repo: string, index: number, position: number, params?: RequestParams) => Promise<HttpResponse<any, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags issue
|
||
* @name IssueGetIssueReactions
|
||
* @summary Get a list reactions of an issue
|
||
* @request GET:/repos/{owner}/{repo}/issues/{index}/reactions
|
||
* @secure
|
||
*/
|
||
issueGetIssueReactions: (owner: string, repo: string, index: number, query?: {
|
||
/** page number of results to return (1-based) */
|
||
page?: number;
|
||
/** page size of results */
|
||
limit?: number;
|
||
}, params?: RequestParams) => Promise<HttpResponse<Reaction[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags issue
|
||
* @name IssuePostIssueReaction
|
||
* @summary Add a reaction to an issue
|
||
* @request POST:/repos/{owner}/{repo}/issues/{index}/reactions
|
||
* @secure
|
||
*/
|
||
issuePostIssueReaction: (owner: string, repo: string, index: number, content: EditReactionOption, params?: RequestParams) => Promise<HttpResponse<Reaction, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags issue
|
||
* @name IssueDeleteIssueReaction
|
||
* @summary Remove a reaction from an issue
|
||
* @request DELETE:/repos/{owner}/{repo}/issues/{index}/reactions
|
||
* @secure
|
||
*/
|
||
issueDeleteIssueReaction: (owner: string, repo: string, index: number, content: EditReactionOption, params?: RequestParams) => Promise<HttpResponse<any, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags issue
|
||
* @name IssueDeleteStopWatch
|
||
* @summary Delete an issue's existing stopwatch.
|
||
* @request DELETE:/repos/{owner}/{repo}/issues/{index}/stopwatch/delete
|
||
* @secure
|
||
*/
|
||
issueDeleteStopWatch: (owner: string, repo: string, index: number, params?: RequestParams) => Promise<HttpResponse<any, void>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags issue
|
||
* @name IssueStartStopWatch
|
||
* @summary Start stopwatch on an issue.
|
||
* @request POST:/repos/{owner}/{repo}/issues/{index}/stopwatch/start
|
||
* @secure
|
||
*/
|
||
issueStartStopWatch: (owner: string, repo: string, index: number, params?: RequestParams) => Promise<HttpResponse<any, void>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags issue
|
||
* @name IssueStopStopWatch
|
||
* @summary Stop an issue's existing stopwatch.
|
||
* @request POST:/repos/{owner}/{repo}/issues/{index}/stopwatch/stop
|
||
* @secure
|
||
*/
|
||
issueStopStopWatch: (owner: string, repo: string, index: number, params?: RequestParams) => Promise<HttpResponse<any, void>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags issue
|
||
* @name IssueSubscriptions
|
||
* @summary Get users who subscribed on an issue.
|
||
* @request GET:/repos/{owner}/{repo}/issues/{index}/subscriptions
|
||
* @secure
|
||
*/
|
||
issueSubscriptions: (owner: string, repo: string, index: number, query?: {
|
||
/** page number of results to return (1-based) */
|
||
page?: number;
|
||
/** page size of results */
|
||
limit?: number;
|
||
}, params?: RequestParams) => Promise<HttpResponse<User[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags issue
|
||
* @name IssueCheckSubscription
|
||
* @summary Check if user is subscribed to an issue
|
||
* @request GET:/repos/{owner}/{repo}/issues/{index}/subscriptions/check
|
||
* @secure
|
||
*/
|
||
issueCheckSubscription: (owner: string, repo: string, index: number, params?: RequestParams) => Promise<HttpResponse<WatchInfo, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags issue
|
||
* @name IssueAddSubscription
|
||
* @summary Subscribe user to issue
|
||
* @request PUT:/repos/{owner}/{repo}/issues/{index}/subscriptions/{user}
|
||
* @secure
|
||
*/
|
||
issueAddSubscription: (owner: string, repo: string, index: number, user: string, params?: RequestParams) => Promise<HttpResponse<void, void>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags issue
|
||
* @name IssueDeleteSubscription
|
||
* @summary Unsubscribe user from issue
|
||
* @request DELETE:/repos/{owner}/{repo}/issues/{index}/subscriptions/{user}
|
||
* @secure
|
||
*/
|
||
issueDeleteSubscription: (owner: string, repo: string, index: number, user: string, params?: RequestParams) => Promise<HttpResponse<void, void>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags issue
|
||
* @name IssueGetCommentsAndTimeline
|
||
* @summary List all comments and events on an issue
|
||
* @request GET:/repos/{owner}/{repo}/issues/{index}/timeline
|
||
* @secure
|
||
*/
|
||
issueGetCommentsAndTimeline: (owner: string, repo: string, index: number, query?: {
|
||
/**
|
||
* if provided, only comments updated since the specified time are returned.
|
||
* @format date-time
|
||
*/
|
||
since?: string;
|
||
/** page number of results to return (1-based) */
|
||
page?: number;
|
||
/** page size of results */
|
||
limit?: number;
|
||
/**
|
||
* if provided, only comments updated before the provided time are returned.
|
||
* @format date-time
|
||
*/
|
||
before?: string;
|
||
}, params?: RequestParams) => Promise<HttpResponse<TimelineComment[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags issue
|
||
* @name IssueTrackedTimes
|
||
* @summary List an issue's tracked times
|
||
* @request GET:/repos/{owner}/{repo}/issues/{index}/times
|
||
* @secure
|
||
*/
|
||
issueTrackedTimes: (owner: string, repo: string, index: number, query?: {
|
||
/** optional filter by user (available for issue managers) */
|
||
user?: string;
|
||
/**
|
||
* Only show times updated after the given time. This is a timestamp in RFC 3339 format
|
||
* @format date-time
|
||
*/
|
||
since?: string;
|
||
/**
|
||
* Only show times updated before the given time. This is a timestamp in RFC 3339 format
|
||
* @format date-time
|
||
*/
|
||
before?: string;
|
||
/** page number of results to return (1-based) */
|
||
page?: number;
|
||
/** page size of results */
|
||
limit?: number;
|
||
}, params?: RequestParams) => Promise<HttpResponse<TrackedTime[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags issue
|
||
* @name IssueAddTime
|
||
* @summary Add tracked time to a issue
|
||
* @request POST:/repos/{owner}/{repo}/issues/{index}/times
|
||
* @secure
|
||
*/
|
||
issueAddTime: (owner: string, repo: string, index: number, body: AddTimeOption, params?: RequestParams) => Promise<HttpResponse<TrackedTime, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags issue
|
||
* @name IssueResetTime
|
||
* @summary Reset a tracked time of an issue
|
||
* @request DELETE:/repos/{owner}/{repo}/issues/{index}/times
|
||
* @secure
|
||
*/
|
||
issueResetTime: (owner: string, repo: string, index: number, params?: RequestParams) => Promise<HttpResponse<any, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags issue
|
||
* @name IssueDeleteTime
|
||
* @summary Delete specific tracked time
|
||
* @request DELETE:/repos/{owner}/{repo}/issues/{index}/times/{id}
|
||
* @secure
|
||
*/
|
||
issueDeleteTime: (owner: string, repo: string, index: number, id: number, params?: RequestParams) => Promise<HttpResponse<any, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoListKeys
|
||
* @summary List a repository's keys
|
||
* @request GET:/repos/{owner}/{repo}/keys
|
||
* @secure
|
||
*/
|
||
repoListKeys: (owner: string, repo: string, query?: {
|
||
/** the key_id to search for */
|
||
key_id?: number;
|
||
/** fingerprint of the key */
|
||
fingerprint?: string;
|
||
/** page number of results to return (1-based) */
|
||
page?: number;
|
||
/** page size of results */
|
||
limit?: number;
|
||
}, params?: RequestParams) => Promise<HttpResponse<DeployKey[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoCreateKey
|
||
* @summary Add a key to a repository
|
||
* @request POST:/repos/{owner}/{repo}/keys
|
||
* @secure
|
||
*/
|
||
repoCreateKey: (owner: string, repo: string, body: CreateKeyOption, params?: RequestParams) => Promise<HttpResponse<DeployKey, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoGetKey
|
||
* @summary Get a repository's key by id
|
||
* @request GET:/repos/{owner}/{repo}/keys/{id}
|
||
* @secure
|
||
*/
|
||
repoGetKey: (owner: string, repo: string, id: number, params?: RequestParams) => Promise<HttpResponse<DeployKey, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoDeleteKey
|
||
* @summary Delete a key from a repository
|
||
* @request DELETE:/repos/{owner}/{repo}/keys/{id}
|
||
* @secure
|
||
*/
|
||
repoDeleteKey: (owner: string, repo: string, id: number, params?: RequestParams) => Promise<HttpResponse<any, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags issue
|
||
* @name IssueListLabels
|
||
* @summary Get all of a repository's labels
|
||
* @request GET:/repos/{owner}/{repo}/labels
|
||
* @secure
|
||
*/
|
||
issueListLabels: (owner: string, repo: string, query?: {
|
||
/** page number of results to return (1-based) */
|
||
page?: number;
|
||
/** page size of results */
|
||
limit?: number;
|
||
}, params?: RequestParams) => Promise<HttpResponse<Label[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags issue
|
||
* @name IssueCreateLabel
|
||
* @summary Create a label
|
||
* @request POST:/repos/{owner}/{repo}/labels
|
||
* @secure
|
||
*/
|
||
issueCreateLabel: (owner: string, repo: string, body: CreateLabelOption, params?: RequestParams) => Promise<HttpResponse<Label, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags issue
|
||
* @name IssueGetLabel
|
||
* @summary Get a single label
|
||
* @request GET:/repos/{owner}/{repo}/labels/{id}
|
||
* @secure
|
||
*/
|
||
issueGetLabel: (owner: string, repo: string, id: number, params?: RequestParams) => Promise<HttpResponse<Label, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags issue
|
||
* @name IssueDeleteLabel
|
||
* @summary Delete a label
|
||
* @request DELETE:/repos/{owner}/{repo}/labels/{id}
|
||
* @secure
|
||
*/
|
||
issueDeleteLabel: (owner: string, repo: string, id: number, params?: RequestParams) => Promise<HttpResponse<any, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags issue
|
||
* @name IssueEditLabel
|
||
* @summary Update a label
|
||
* @request PATCH:/repos/{owner}/{repo}/labels/{id}
|
||
* @secure
|
||
*/
|
||
issueEditLabel: (owner: string, repo: string, id: number, body: EditLabelOption, params?: RequestParams) => Promise<HttpResponse<Label, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoGetLanguages
|
||
* @summary Get languages and number of bytes of code written
|
||
* @request GET:/repos/{owner}/{repo}/languages
|
||
* @secure
|
||
*/
|
||
repoGetLanguages: (owner: string, repo: string, params?: RequestParams) => Promise<HttpResponse<Record<string, number>, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoGetLicenses
|
||
* @summary Get repo licenses
|
||
* @request GET:/repos/{owner}/{repo}/licenses
|
||
* @secure
|
||
*/
|
||
repoGetLicenses: (owner: string, repo: string, params?: RequestParams) => Promise<HttpResponse<string[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoGetRawFileOrLfs
|
||
* @summary Get a file or it's LFS object from a repository
|
||
* @request GET:/repos/{owner}/{repo}/media/{filepath}
|
||
* @secure
|
||
*/
|
||
repoGetRawFileOrLfs: (owner: string, repo: string, filepath: string, query?: {
|
||
/** The name of the commit/branch/tag. Default the repository’s default branch */
|
||
ref?: string;
|
||
}, params?: RequestParams) => Promise<HttpResponse<File, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoMergeUpstream
|
||
* @summary Merge a branch from upstream
|
||
* @request POST:/repos/{owner}/{repo}/merge-upstream
|
||
* @secure
|
||
*/
|
||
repoMergeUpstream: (owner: string, repo: string, body: MergeUpstreamRequest, params?: RequestParams) => Promise<HttpResponse<MergeUpstreamResponse, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags issue
|
||
* @name IssueGetMilestonesList
|
||
* @summary Get all of a repository's opened milestones
|
||
* @request GET:/repos/{owner}/{repo}/milestones
|
||
* @secure
|
||
*/
|
||
issueGetMilestonesList: (owner: string, repo: string, query?: {
|
||
/** Milestone state, Recognized values are open, closed and all. Defaults to "open" */
|
||
state?: string;
|
||
/** filter by milestone name */
|
||
name?: string;
|
||
/** page number of results to return (1-based) */
|
||
page?: number;
|
||
/** page size of results */
|
||
limit?: number;
|
||
}, params?: RequestParams) => Promise<HttpResponse<Milestone[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags issue
|
||
* @name IssueCreateMilestone
|
||
* @summary Create a milestone
|
||
* @request POST:/repos/{owner}/{repo}/milestones
|
||
* @secure
|
||
*/
|
||
issueCreateMilestone: (owner: string, repo: string, body: CreateMilestoneOption, params?: RequestParams) => Promise<HttpResponse<Milestone, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags issue
|
||
* @name IssueGetMilestone
|
||
* @summary Get a milestone
|
||
* @request GET:/repos/{owner}/{repo}/milestones/{id}
|
||
* @secure
|
||
*/
|
||
issueGetMilestone: (owner: string, repo: string, id: string, params?: RequestParams) => Promise<HttpResponse<Milestone, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags issue
|
||
* @name IssueDeleteMilestone
|
||
* @summary Delete a milestone
|
||
* @request DELETE:/repos/{owner}/{repo}/milestones/{id}
|
||
* @secure
|
||
*/
|
||
issueDeleteMilestone: (owner: string, repo: string, id: string, params?: RequestParams) => Promise<HttpResponse<any, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags issue
|
||
* @name IssueEditMilestone
|
||
* @summary Update a milestone
|
||
* @request PATCH:/repos/{owner}/{repo}/milestones/{id}
|
||
* @secure
|
||
*/
|
||
issueEditMilestone: (owner: string, repo: string, id: string, body: EditMilestoneOption, params?: RequestParams) => Promise<HttpResponse<Milestone, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoMirrorSync
|
||
* @summary Sync a mirrored repository
|
||
* @request POST:/repos/{owner}/{repo}/mirror-sync
|
||
* @secure
|
||
*/
|
||
repoMirrorSync: (owner: string, repo: string, params?: RequestParams) => Promise<HttpResponse<any, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoNewPinAllowed
|
||
* @summary Returns if new Issue Pins are allowed
|
||
* @request GET:/repos/{owner}/{repo}/new_pin_allowed
|
||
* @secure
|
||
*/
|
||
repoNewPinAllowed: (owner: string, repo: string, params?: RequestParams) => Promise<HttpResponse<NewIssuePinsAllowed, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags notification
|
||
* @name NotifyGetRepoList
|
||
* @summary List users's notification threads on a specific repo
|
||
* @request GET:/repos/{owner}/{repo}/notifications
|
||
* @secure
|
||
*/
|
||
notifyGetRepoList: (owner: string, repo: string, query?: {
|
||
/** If true, show notifications marked as read. Default value is false */
|
||
all?: boolean;
|
||
/** Show notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread & pinned */
|
||
'status-types'?: string[];
|
||
/** filter notifications by subject type */
|
||
'subject-type'?: ('issue' | 'pull' | 'commit' | 'repository')[];
|
||
/**
|
||
* Only show notifications updated after the given time. This is a timestamp in RFC 3339 format
|
||
* @format date-time
|
||
*/
|
||
since?: string;
|
||
/**
|
||
* Only show notifications updated before the given time. This is a timestamp in RFC 3339 format
|
||
* @format date-time
|
||
*/
|
||
before?: string;
|
||
/** page number of results to return (1-based) */
|
||
page?: number;
|
||
/** page size of results */
|
||
limit?: number;
|
||
}, params?: RequestParams) => Promise<HttpResponse<NotificationThread[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags notification
|
||
* @name NotifyReadRepoList
|
||
* @summary Mark notification threads as read, pinned or unread on a specific repo
|
||
* @request PUT:/repos/{owner}/{repo}/notifications
|
||
* @secure
|
||
*/
|
||
notifyReadRepoList: (owner: string, repo: string, query?: {
|
||
/** If true, mark all notifications on this repo. Default value is false */
|
||
all?: string;
|
||
/** Mark notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread. */
|
||
'status-types'?: string[];
|
||
/** Status to mark notifications as. Defaults to read. */
|
||
'to-status'?: string;
|
||
/**
|
||
* Describes the last point that notifications were checked. Anything updated since this time will not be updated.
|
||
* @format date-time
|
||
*/
|
||
last_read_at?: string;
|
||
}, params?: RequestParams) => Promise<HttpResponse<NotificationThread[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoListPullRequests
|
||
* @summary List a repo's pull requests
|
||
* @request GET:/repos/{owner}/{repo}/pulls
|
||
* @secure
|
||
*/
|
||
repoListPullRequests: (owner: string, repo: string, query?: {
|
||
/**
|
||
* State of pull request
|
||
* @default "open"
|
||
*/
|
||
state?: 'open' | 'closed' | 'all';
|
||
/** Type of sort */
|
||
sort?: 'oldest' | 'recentupdate' | 'leastupdate' | 'mostcomment' | 'leastcomment' | 'priority';
|
||
/**
|
||
* ID of the milestone
|
||
* @format int64
|
||
*/
|
||
milestone?: number;
|
||
/** Label IDs */
|
||
labels?: number[];
|
||
/** Filter by pull request author */
|
||
poster?: string;
|
||
/**
|
||
* Page number of results to return (1-based)
|
||
* @min 1
|
||
* @default 1
|
||
*/
|
||
page?: number;
|
||
/**
|
||
* Page size of results
|
||
* @min 0
|
||
*/
|
||
limit?: number;
|
||
}, params?: RequestParams) => Promise<HttpResponse<PullRequest[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoCreatePullRequest
|
||
* @summary Create a pull request
|
||
* @request POST:/repos/{owner}/{repo}/pulls
|
||
* @secure
|
||
*/
|
||
repoCreatePullRequest: (owner: string, repo: string, body: CreatePullRequestOption, params?: RequestParams) => Promise<HttpResponse<PullRequest, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoListPinnedPullRequests
|
||
* @summary List a repo's pinned pull requests
|
||
* @request GET:/repos/{owner}/{repo}/pulls/pinned
|
||
* @secure
|
||
*/
|
||
repoListPinnedPullRequests: (owner: string, repo: string, params?: RequestParams) => Promise<HttpResponse<PullRequest[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoGetPullRequestByBaseHead
|
||
* @summary Get a pull request by base and head
|
||
* @request GET:/repos/{owner}/{repo}/pulls/{base}/{head}
|
||
* @secure
|
||
*/
|
||
repoGetPullRequestByBaseHead: (owner: string, repo: string, base: string, head: string, params?: RequestParams) => Promise<HttpResponse<PullRequest, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoGetPullRequest
|
||
* @summary Get a pull request
|
||
* @request GET:/repos/{owner}/{repo}/pulls/{index}
|
||
* @secure
|
||
*/
|
||
repoGetPullRequest: (owner: string, repo: string, index: number, params?: RequestParams) => Promise<HttpResponse<PullRequest, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoEditPullRequest
|
||
* @summary Update a pull request. If using deadline only the date will be taken into account, and time of day ignored.
|
||
* @request PATCH:/repos/{owner}/{repo}/pulls/{index}
|
||
* @secure
|
||
*/
|
||
repoEditPullRequest: (owner: string, repo: string, index: number, body: EditPullRequestOption, params?: RequestParams) => Promise<HttpResponse<PullRequest, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoDownloadPullDiffOrPatch
|
||
* @summary Get a pull request diff or patch
|
||
* @request GET:/repos/{owner}/{repo}/pulls/{index}.{diffType}
|
||
* @secure
|
||
*/
|
||
repoDownloadPullDiffOrPatch: (owner: string, repo: string, index: number, diffType: 'diff' | 'patch', query?: {
|
||
/** whether to include binary file changes. if true, the diff is applicable with `git apply` */
|
||
binary?: boolean;
|
||
}, params?: RequestParams) => Promise<HttpResponse<string, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoGetPullRequestCommits
|
||
* @summary Get commits for a pull request
|
||
* @request GET:/repos/{owner}/{repo}/pulls/{index}/commits
|
||
* @secure
|
||
*/
|
||
repoGetPullRequestCommits: (owner: string, repo: string, index: number, query?: {
|
||
/** page number of results to return (1-based) */
|
||
page?: number;
|
||
/** page size of results */
|
||
limit?: number;
|
||
/** include verification for every commit (disable for speedup, default 'true') */
|
||
verification?: boolean;
|
||
/** include a list of affected files for every commit (disable for speedup, default 'true') */
|
||
files?: boolean;
|
||
}, params?: RequestParams) => Promise<HttpResponse<Commit[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoGetPullRequestFiles
|
||
* @summary Get changed files for a pull request
|
||
* @request GET:/repos/{owner}/{repo}/pulls/{index}/files
|
||
* @secure
|
||
*/
|
||
repoGetPullRequestFiles: (owner: string, repo: string, index: number, query?: {
|
||
/** skip to given file */
|
||
'skip-to'?: string;
|
||
/** whitespace behavior */
|
||
whitespace?: 'ignore-all' | 'ignore-change' | 'ignore-eol' | 'show-all';
|
||
/** page number of results to return (1-based) */
|
||
page?: number;
|
||
/** page size of results */
|
||
limit?: number;
|
||
}, params?: RequestParams) => Promise<HttpResponse<ChangedFile[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoPullRequestIsMerged
|
||
* @summary Check if a pull request has been merged
|
||
* @request GET:/repos/{owner}/{repo}/pulls/{index}/merge
|
||
* @secure
|
||
*/
|
||
repoPullRequestIsMerged: (owner: string, repo: string, index: number, params?: RequestParams) => Promise<HttpResponse<void, void>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoMergePullRequest
|
||
* @summary Merge a pull request
|
||
* @request POST:/repos/{owner}/{repo}/pulls/{index}/merge
|
||
* @secure
|
||
*/
|
||
repoMergePullRequest: (owner: string, repo: string, index: number, body: MergePullRequestOption, params?: RequestParams) => Promise<HttpResponse<any, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoCancelScheduledAutoMerge
|
||
* @summary Cancel the scheduled auto merge for the given pull request
|
||
* @request DELETE:/repos/{owner}/{repo}/pulls/{index}/merge
|
||
* @secure
|
||
*/
|
||
repoCancelScheduledAutoMerge: (owner: string, repo: string, index: number, params?: RequestParams) => Promise<HttpResponse<any, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoCreatePullReviewRequests
|
||
* @summary create review requests for a pull request
|
||
* @request POST:/repos/{owner}/{repo}/pulls/{index}/requested_reviewers
|
||
* @secure
|
||
*/
|
||
repoCreatePullReviewRequests: (owner: string, repo: string, index: number, body: PullReviewRequestOptions, params?: RequestParams) => Promise<HttpResponse<PullReview[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoDeletePullReviewRequests
|
||
* @summary cancel review requests for a pull request
|
||
* @request DELETE:/repos/{owner}/{repo}/pulls/{index}/requested_reviewers
|
||
* @secure
|
||
*/
|
||
repoDeletePullReviewRequests: (owner: string, repo: string, index: number, body: PullReviewRequestOptions, params?: RequestParams) => Promise<HttpResponse<any, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoListPullReviews
|
||
* @summary List all reviews for a pull request
|
||
* @request GET:/repos/{owner}/{repo}/pulls/{index}/reviews
|
||
* @secure
|
||
*/
|
||
repoListPullReviews: (owner: string, repo: string, index: number, query?: {
|
||
/** page number of results to return (1-based) */
|
||
page?: number;
|
||
/** page size of results */
|
||
limit?: number;
|
||
}, params?: RequestParams) => Promise<HttpResponse<PullReview[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoCreatePullReview
|
||
* @summary Create a review to an pull request
|
||
* @request POST:/repos/{owner}/{repo}/pulls/{index}/reviews
|
||
* @secure
|
||
*/
|
||
repoCreatePullReview: (owner: string, repo: string, index: number, body: CreatePullReviewOptions, params?: RequestParams) => Promise<HttpResponse<PullReview, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoGetPullReview
|
||
* @summary Get a specific review for a pull request
|
||
* @request GET:/repos/{owner}/{repo}/pulls/{index}/reviews/{id}
|
||
* @secure
|
||
*/
|
||
repoGetPullReview: (owner: string, repo: string, index: number, id: number, params?: RequestParams) => Promise<HttpResponse<PullReview, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoSubmitPullReview
|
||
* @summary Submit a pending review to an pull request
|
||
* @request POST:/repos/{owner}/{repo}/pulls/{index}/reviews/{id}
|
||
* @secure
|
||
*/
|
||
repoSubmitPullReview: (owner: string, repo: string, index: number, id: number, body: SubmitPullReviewOptions, params?: RequestParams) => Promise<HttpResponse<PullReview, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoDeletePullReview
|
||
* @summary Delete a specific review from a pull request
|
||
* @request DELETE:/repos/{owner}/{repo}/pulls/{index}/reviews/{id}
|
||
* @secure
|
||
*/
|
||
repoDeletePullReview: (owner: string, repo: string, index: number, id: number, params?: RequestParams) => Promise<HttpResponse<any, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoGetPullReviewComments
|
||
* @summary Get a specific review for a pull request
|
||
* @request GET:/repos/{owner}/{repo}/pulls/{index}/reviews/{id}/comments
|
||
* @secure
|
||
*/
|
||
repoGetPullReviewComments: (owner: string, repo: string, index: number, id: number, params?: RequestParams) => Promise<HttpResponse<PullReviewComment[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoDismissPullReview
|
||
* @summary Dismiss a review for a pull request
|
||
* @request POST:/repos/{owner}/{repo}/pulls/{index}/reviews/{id}/dismissals
|
||
* @secure
|
||
*/
|
||
repoDismissPullReview: (owner: string, repo: string, index: number, id: number, body: DismissPullReviewOptions, params?: RequestParams) => Promise<HttpResponse<PullReview, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoUnDismissPullReview
|
||
* @summary Cancel to dismiss a review for a pull request
|
||
* @request POST:/repos/{owner}/{repo}/pulls/{index}/reviews/{id}/undismissals
|
||
* @secure
|
||
*/
|
||
repoUnDismissPullReview: (owner: string, repo: string, index: number, id: number, params?: RequestParams) => Promise<HttpResponse<PullReview, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoUpdatePullRequest
|
||
* @summary Merge PR's baseBranch into headBranch
|
||
* @request POST:/repos/{owner}/{repo}/pulls/{index}/update
|
||
* @secure
|
||
*/
|
||
repoUpdatePullRequest: (owner: string, repo: string, index: number, query?: {
|
||
/** how to update pull request */
|
||
style?: 'merge' | 'rebase';
|
||
}, params?: RequestParams) => Promise<HttpResponse<any, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoListPushMirrors
|
||
* @summary Get all push mirrors of the repository
|
||
* @request GET:/repos/{owner}/{repo}/push_mirrors
|
||
* @secure
|
||
*/
|
||
repoListPushMirrors: (owner: string, repo: string, query?: {
|
||
/** page number of results to return (1-based) */
|
||
page?: number;
|
||
/** page size of results */
|
||
limit?: number;
|
||
}, params?: RequestParams) => Promise<HttpResponse<PushMirror[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoAddPushMirror
|
||
* @summary add a push mirror to the repository
|
||
* @request POST:/repos/{owner}/{repo}/push_mirrors
|
||
* @secure
|
||
*/
|
||
repoAddPushMirror: (owner: string, repo: string, body: CreatePushMirrorOption, params?: RequestParams) => Promise<HttpResponse<PushMirror, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoPushMirrorSync
|
||
* @summary Sync all push mirrored repository
|
||
* @request POST:/repos/{owner}/{repo}/push_mirrors-sync
|
||
* @secure
|
||
*/
|
||
repoPushMirrorSync: (owner: string, repo: string, params?: RequestParams) => Promise<HttpResponse<any, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoGetPushMirrorByRemoteName
|
||
* @summary Get push mirror of the repository by remoteName
|
||
* @request GET:/repos/{owner}/{repo}/push_mirrors/{name}
|
||
* @secure
|
||
*/
|
||
repoGetPushMirrorByRemoteName: (owner: string, repo: string, name: string, params?: RequestParams) => Promise<HttpResponse<PushMirror, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoDeletePushMirror
|
||
* @summary deletes a push mirror from a repository by remoteName
|
||
* @request DELETE:/repos/{owner}/{repo}/push_mirrors/{name}
|
||
* @secure
|
||
*/
|
||
repoDeletePushMirror: (owner: string, repo: string, name: string, params?: RequestParams) => Promise<HttpResponse<any, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoGetRawFile
|
||
* @summary Get a file from a repository
|
||
* @request GET:/repos/{owner}/{repo}/raw/{filepath}
|
||
* @secure
|
||
*/
|
||
repoGetRawFile: (owner: string, repo: string, filepath: string, query?: {
|
||
/** The name of the commit/branch/tag. Default the repository’s default branch */
|
||
ref?: string;
|
||
}, params?: RequestParams) => Promise<HttpResponse<File, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoListReleases
|
||
* @summary List a repo's releases
|
||
* @request GET:/repos/{owner}/{repo}/releases
|
||
* @secure
|
||
*/
|
||
repoListReleases: (owner: string, repo: string, query?: {
|
||
/** filter (exclude / include) drafts, if you dont have repo write access none will show */
|
||
draft?: boolean;
|
||
/** filter (exclude / include) pre-releases */
|
||
'pre-release'?: boolean;
|
||
/** page number of results to return (1-based) */
|
||
page?: number;
|
||
/** page size of results */
|
||
limit?: number;
|
||
}, params?: RequestParams) => Promise<HttpResponse<Release[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoCreateRelease
|
||
* @summary Create a release
|
||
* @request POST:/repos/{owner}/{repo}/releases
|
||
* @secure
|
||
*/
|
||
repoCreateRelease: (owner: string, repo: string, body: CreateReleaseOption, params?: RequestParams) => Promise<HttpResponse<Release, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoGetLatestRelease
|
||
* @summary Gets the most recent non-prerelease, non-draft release of a repository, sorted by created_at
|
||
* @request GET:/repos/{owner}/{repo}/releases/latest
|
||
* @secure
|
||
*/
|
||
repoGetLatestRelease: (owner: string, repo: string, params?: RequestParams) => Promise<HttpResponse<Release, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoGetReleaseByTag
|
||
* @summary Get a release by tag name
|
||
* @request GET:/repos/{owner}/{repo}/releases/tags/{tag}
|
||
* @secure
|
||
*/
|
||
repoGetReleaseByTag: (owner: string, repo: string, tag: string, params?: RequestParams) => Promise<HttpResponse<Release, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoDeleteReleaseByTag
|
||
* @summary Delete a release by tag name
|
||
* @request DELETE:/repos/{owner}/{repo}/releases/tags/{tag}
|
||
* @secure
|
||
*/
|
||
repoDeleteReleaseByTag: (owner: string, repo: string, tag: string, params?: RequestParams) => Promise<HttpResponse<any, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoGetRelease
|
||
* @summary Get a release
|
||
* @request GET:/repos/{owner}/{repo}/releases/{id}
|
||
* @secure
|
||
*/
|
||
repoGetRelease: (owner: string, repo: string, id: number, params?: RequestParams) => Promise<HttpResponse<Release, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoDeleteRelease
|
||
* @summary Delete a release
|
||
* @request DELETE:/repos/{owner}/{repo}/releases/{id}
|
||
* @secure
|
||
*/
|
||
repoDeleteRelease: (owner: string, repo: string, id: number, params?: RequestParams) => Promise<HttpResponse<any, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoEditRelease
|
||
* @summary Update a release
|
||
* @request PATCH:/repos/{owner}/{repo}/releases/{id}
|
||
* @secure
|
||
*/
|
||
repoEditRelease: (owner: string, repo: string, id: number, body: EditReleaseOption, params?: RequestParams) => Promise<HttpResponse<Release, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoListReleaseAttachments
|
||
* @summary List release's attachments
|
||
* @request GET:/repos/{owner}/{repo}/releases/{id}/assets
|
||
* @secure
|
||
*/
|
||
repoListReleaseAttachments: (owner: string, repo: string, id: number, params?: RequestParams) => Promise<HttpResponse<Attachment[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoCreateReleaseAttachment
|
||
* @summary Create a release attachment
|
||
* @request POST:/repos/{owner}/{repo}/releases/{id}/assets
|
||
* @secure
|
||
*/
|
||
repoCreateReleaseAttachment: (owner: string, repo: string, id: number, data: {
|
||
/** attachment to upload */
|
||
attachment?: File;
|
||
}, query?: {
|
||
/** name of the attachment */
|
||
name?: string;
|
||
}, params?: RequestParams) => Promise<HttpResponse<Attachment, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoGetReleaseAttachment
|
||
* @summary Get a release attachment
|
||
* @request GET:/repos/{owner}/{repo}/releases/{id}/assets/{attachment_id}
|
||
* @secure
|
||
*/
|
||
repoGetReleaseAttachment: (owner: string, repo: string, id: number, attachmentId: number, params?: RequestParams) => Promise<HttpResponse<Attachment, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoDeleteReleaseAttachment
|
||
* @summary Delete a release attachment
|
||
* @request DELETE:/repos/{owner}/{repo}/releases/{id}/assets/{attachment_id}
|
||
* @secure
|
||
*/
|
||
repoDeleteReleaseAttachment: (owner: string, repo: string, id: number, attachmentId: number, params?: RequestParams) => Promise<HttpResponse<any, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoEditReleaseAttachment
|
||
* @summary Edit a release attachment
|
||
* @request PATCH:/repos/{owner}/{repo}/releases/{id}/assets/{attachment_id}
|
||
* @secure
|
||
*/
|
||
repoEditReleaseAttachment: (owner: string, repo: string, id: number, attachmentId: number, body: EditAttachmentOptions, params?: RequestParams) => Promise<HttpResponse<Attachment, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoGetReviewers
|
||
* @summary Return all users that can be requested to review in this repo
|
||
* @request GET:/repos/{owner}/{repo}/reviewers
|
||
* @secure
|
||
*/
|
||
repoGetReviewers: (owner: string, repo: string, params?: RequestParams) => Promise<HttpResponse<User[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoSigningKey
|
||
* @summary Get signing-key.gpg for given repository
|
||
* @request GET:/repos/{owner}/{repo}/signing-key.gpg
|
||
* @secure
|
||
*/
|
||
repoSigningKey: (owner: string, repo: string, params?: RequestParams) => Promise<HttpResponse<string, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoListStargazers
|
||
* @summary List a repo's stargazers
|
||
* @request GET:/repos/{owner}/{repo}/stargazers
|
||
* @secure
|
||
*/
|
||
repoListStargazers: (owner: string, repo: string, query?: {
|
||
/** page number of results to return (1-based) */
|
||
page?: number;
|
||
/** page size of results */
|
||
limit?: number;
|
||
}, params?: RequestParams) => Promise<HttpResponse<User[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoListStatuses
|
||
* @summary Get a commit's statuses
|
||
* @request GET:/repos/{owner}/{repo}/statuses/{sha}
|
||
* @secure
|
||
*/
|
||
repoListStatuses: (owner: string, repo: string, sha: string, query?: {
|
||
/** type of sort */
|
||
sort?: 'oldest' | 'recentupdate' | 'leastupdate' | 'leastindex' | 'highestindex';
|
||
/** type of state */
|
||
state?: 'pending' | 'success' | 'error' | 'failure' | 'warning';
|
||
/** page number of results to return (1-based) */
|
||
page?: number;
|
||
/** page size of results */
|
||
limit?: number;
|
||
}, params?: RequestParams) => Promise<HttpResponse<CommitStatus[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoCreateStatus
|
||
* @summary Create a commit status
|
||
* @request POST:/repos/{owner}/{repo}/statuses/{sha}
|
||
* @secure
|
||
*/
|
||
repoCreateStatus: (owner: string, repo: string, sha: string, body: CreateStatusOption, params?: RequestParams) => Promise<HttpResponse<CommitStatus, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoListSubscribers
|
||
* @summary List a repo's watchers
|
||
* @request GET:/repos/{owner}/{repo}/subscribers
|
||
* @secure
|
||
*/
|
||
repoListSubscribers: (owner: string, repo: string, query?: {
|
||
/** page number of results to return (1-based) */
|
||
page?: number;
|
||
/** page size of results */
|
||
limit?: number;
|
||
}, params?: RequestParams) => Promise<HttpResponse<User[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name UserCurrentCheckSubscription
|
||
* @summary Check if the current user is watching a repo
|
||
* @request GET:/repos/{owner}/{repo}/subscription
|
||
* @secure
|
||
*/
|
||
userCurrentCheckSubscription: (owner: string, repo: string, params?: RequestParams) => Promise<HttpResponse<WatchInfo, void>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name UserCurrentPutSubscription
|
||
* @summary Watch a repo
|
||
* @request PUT:/repos/{owner}/{repo}/subscription
|
||
* @secure
|
||
*/
|
||
userCurrentPutSubscription: (owner: string, repo: string, params?: RequestParams) => Promise<HttpResponse<WatchInfo, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name UserCurrentDeleteSubscription
|
||
* @summary Unwatch a repo
|
||
* @request DELETE:/repos/{owner}/{repo}/subscription
|
||
* @secure
|
||
*/
|
||
userCurrentDeleteSubscription: (owner: string, repo: string, params?: RequestParams) => Promise<HttpResponse<any, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoListTagProtection
|
||
* @summary List tag protections for a repository
|
||
* @request GET:/repos/{owner}/{repo}/tag_protections
|
||
* @secure
|
||
*/
|
||
repoListTagProtection: (owner: string, repo: string, params?: RequestParams) => Promise<HttpResponse<TagProtection[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoCreateTagProtection
|
||
* @summary Create a tag protections for a repository
|
||
* @request POST:/repos/{owner}/{repo}/tag_protections
|
||
* @secure
|
||
*/
|
||
repoCreateTagProtection: (owner: string, repo: string, body: CreateTagProtectionOption, params?: RequestParams) => Promise<HttpResponse<TagProtection, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoGetTagProtection
|
||
* @summary Get a specific tag protection for the repository
|
||
* @request GET:/repos/{owner}/{repo}/tag_protections/{id}
|
||
* @secure
|
||
*/
|
||
repoGetTagProtection: (owner: string, repo: string, id: number, params?: RequestParams) => Promise<HttpResponse<TagProtection, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoDeleteTagProtection
|
||
* @summary Delete a specific tag protection for the repository
|
||
* @request DELETE:/repos/{owner}/{repo}/tag_protections/{id}
|
||
* @secure
|
||
*/
|
||
repoDeleteTagProtection: (owner: string, repo: string, id: number, params?: RequestParams) => Promise<HttpResponse<any, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoEditTagProtection
|
||
* @summary Edit a tag protections for a repository. Only fields that are set will be changed
|
||
* @request PATCH:/repos/{owner}/{repo}/tag_protections/{id}
|
||
* @secure
|
||
*/
|
||
repoEditTagProtection: (owner: string, repo: string, id: number, body: EditTagProtectionOption, params?: RequestParams) => Promise<HttpResponse<TagProtection, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoListTags
|
||
* @summary List a repository's tags
|
||
* @request GET:/repos/{owner}/{repo}/tags
|
||
* @secure
|
||
*/
|
||
repoListTags: (owner: string, repo: string, query?: {
|
||
/** page number of results to return (1-based) */
|
||
page?: number;
|
||
/** page size of results, default maximum page size is 50 */
|
||
limit?: number;
|
||
}, params?: RequestParams) => Promise<HttpResponse<Tag[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoCreateTag
|
||
* @summary Create a new git tag in a repository
|
||
* @request POST:/repos/{owner}/{repo}/tags
|
||
* @secure
|
||
*/
|
||
repoCreateTag: (owner: string, repo: string, body: CreateTagOption, params?: RequestParams) => Promise<HttpResponse<Tag, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoGetTag
|
||
* @summary Get the tag of a repository by tag name
|
||
* @request GET:/repos/{owner}/{repo}/tags/{tag}
|
||
* @secure
|
||
*/
|
||
repoGetTag: (owner: string, repo: string, tag: string, params?: RequestParams) => Promise<HttpResponse<Tag, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoDeleteTag
|
||
* @summary Delete a repository's tag by name
|
||
* @request DELETE:/repos/{owner}/{repo}/tags/{tag}
|
||
* @secure
|
||
*/
|
||
repoDeleteTag: (owner: string, repo: string, tag: string, params?: RequestParams) => Promise<HttpResponse<any, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoListTeams
|
||
* @summary List a repository's teams
|
||
* @request GET:/repos/{owner}/{repo}/teams
|
||
* @secure
|
||
*/
|
||
repoListTeams: (owner: string, repo: string, params?: RequestParams) => Promise<HttpResponse<Team[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoCheckTeam
|
||
* @summary Check if a team is assigned to a repository
|
||
* @request GET:/repos/{owner}/{repo}/teams/{team}
|
||
* @secure
|
||
*/
|
||
repoCheckTeam: (owner: string, repo: string, team: string, params?: RequestParams) => Promise<HttpResponse<Team, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoAddTeam
|
||
* @summary Add a team to a repository
|
||
* @request PUT:/repos/{owner}/{repo}/teams/{team}
|
||
* @secure
|
||
*/
|
||
repoAddTeam: (owner: string, repo: string, team: string, params?: RequestParams) => Promise<HttpResponse<any, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoDeleteTeam
|
||
* @summary Delete a team from a repository
|
||
* @request DELETE:/repos/{owner}/{repo}/teams/{team}
|
||
* @secure
|
||
*/
|
||
repoDeleteTeam: (owner: string, repo: string, team: string, params?: RequestParams) => Promise<HttpResponse<any, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoTrackedTimes
|
||
* @summary List a repo's tracked times
|
||
* @request GET:/repos/{owner}/{repo}/times
|
||
* @secure
|
||
*/
|
||
repoTrackedTimes: (owner: string, repo: string, query?: {
|
||
/** optional filter by user (available for issue managers) */
|
||
user?: string;
|
||
/**
|
||
* Only show times updated after the given time. This is a timestamp in RFC 3339 format
|
||
* @format date-time
|
||
*/
|
||
since?: string;
|
||
/**
|
||
* Only show times updated before the given time. This is a timestamp in RFC 3339 format
|
||
* @format date-time
|
||
*/
|
||
before?: string;
|
||
/** page number of results to return (1-based) */
|
||
page?: number;
|
||
/** page size of results */
|
||
limit?: number;
|
||
}, params?: RequestParams) => Promise<HttpResponse<TrackedTime[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name UserTrackedTimes
|
||
* @summary List a user's tracked times in a repo
|
||
* @request GET:/repos/{owner}/{repo}/times/{user}
|
||
* @deprecated
|
||
* @secure
|
||
*/
|
||
userTrackedTimes: (owner: string, repo: string, user: string, params?: RequestParams) => Promise<HttpResponse<TrackedTime[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoListTopics
|
||
* @summary Get list of topics that a repository has
|
||
* @request GET:/repos/{owner}/{repo}/topics
|
||
* @secure
|
||
*/
|
||
repoListTopics: (owner: string, repo: string, query?: {
|
||
/** page number of results to return (1-based) */
|
||
page?: number;
|
||
/** page size of results */
|
||
limit?: number;
|
||
}, params?: RequestParams) => Promise<HttpResponse<TopicName, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoUpdateTopics
|
||
* @summary Replace list of topics for a repository
|
||
* @request PUT:/repos/{owner}/{repo}/topics
|
||
* @secure
|
||
*/
|
||
repoUpdateTopics: (owner: string, repo: string, body: RepoTopicOptions, params?: RequestParams) => Promise<HttpResponse<any, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoAddTopic
|
||
* @summary Add a topic to a repository
|
||
* @request PUT:/repos/{owner}/{repo}/topics/{topic}
|
||
* @secure
|
||
*/
|
||
repoAddTopic: (owner: string, repo: string, topic: string, params?: RequestParams) => Promise<HttpResponse<any, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoDeleteTopic
|
||
* @summary Delete a topic from a repository
|
||
* @request DELETE:/repos/{owner}/{repo}/topics/{topic}
|
||
* @secure
|
||
*/
|
||
repoDeleteTopic: (owner: string, repo: string, topic: string, params?: RequestParams) => Promise<HttpResponse<any, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoTransfer
|
||
* @summary Transfer a repo ownership
|
||
* @request POST:/repos/{owner}/{repo}/transfer
|
||
* @secure
|
||
*/
|
||
repoTransfer: (owner: string, repo: string, body: TransferRepoOption, params?: RequestParams) => Promise<HttpResponse<Repository, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name AcceptRepoTransfer
|
||
* @summary Accept a repo transfer
|
||
* @request POST:/repos/{owner}/{repo}/transfer/accept
|
||
* @secure
|
||
*/
|
||
acceptRepoTransfer: (owner: string, repo: string, params?: RequestParams) => Promise<HttpResponse<Repository, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RejectRepoTransfer
|
||
* @summary Reject a repo transfer
|
||
* @request POST:/repos/{owner}/{repo}/transfer/reject
|
||
* @secure
|
||
*/
|
||
rejectRepoTransfer: (owner: string, repo: string, params?: RequestParams) => Promise<HttpResponse<Repository, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoCreateWikiPage
|
||
* @summary Create a wiki page
|
||
* @request POST:/repos/{owner}/{repo}/wiki/new
|
||
* @secure
|
||
*/
|
||
repoCreateWikiPage: (owner: string, repo: string, body: CreateWikiPageOptions, params?: RequestParams) => Promise<HttpResponse<WikiPage, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoGetWikiPage
|
||
* @summary Get a wiki page
|
||
* @request GET:/repos/{owner}/{repo}/wiki/page/{pageName}
|
||
* @secure
|
||
*/
|
||
repoGetWikiPage: (owner: string, repo: string, pageName: string, params?: RequestParams) => Promise<HttpResponse<WikiPage, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoDeleteWikiPage
|
||
* @summary Delete a wiki page
|
||
* @request DELETE:/repos/{owner}/{repo}/wiki/page/{pageName}
|
||
* @secure
|
||
*/
|
||
repoDeleteWikiPage: (owner: string, repo: string, pageName: string, params?: RequestParams) => Promise<HttpResponse<any, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoEditWikiPage
|
||
* @summary Edit a wiki page
|
||
* @request PATCH:/repos/{owner}/{repo}/wiki/page/{pageName}
|
||
* @secure
|
||
*/
|
||
repoEditWikiPage: (owner: string, repo: string, pageName: string, body: CreateWikiPageOptions, params?: RequestParams) => Promise<HttpResponse<WikiPage, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoGetWikiPages
|
||
* @summary Get all wiki pages
|
||
* @request GET:/repos/{owner}/{repo}/wiki/pages
|
||
* @secure
|
||
*/
|
||
repoGetWikiPages: (owner: string, repo: string, query?: {
|
||
/** page number of results to return (1-based) */
|
||
page?: number;
|
||
/** page size of results */
|
||
limit?: number;
|
||
}, params?: RequestParams) => Promise<HttpResponse<WikiPageMetaData[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoGetWikiPageRevisions
|
||
* @summary Get revisions of a wiki page
|
||
* @request GET:/repos/{owner}/{repo}/wiki/revisions/{pageName}
|
||
* @secure
|
||
*/
|
||
repoGetWikiPageRevisions: (owner: string, repo: string, pageName: string, query?: {
|
||
/** page number of results to return (1-based) */
|
||
page?: number;
|
||
}, params?: RequestParams) => Promise<HttpResponse<WikiCommitList, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name GenerateRepo
|
||
* @summary Create a repository using a template
|
||
* @request POST:/repos/{template_owner}/{template_repo}/generate
|
||
* @secure
|
||
*/
|
||
generateRepo: (templateOwner: string, templateRepo: string, body: GenerateRepoOption, params?: RequestParams) => Promise<HttpResponse<Repository, void>>;
|
||
};
|
||
repositories: {
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name RepoGetById
|
||
* @summary Get a repository by id
|
||
* @request GET:/repositories/{id}
|
||
* @secure
|
||
*/
|
||
repoGetById: (id: number, params?: RequestParams) => Promise<HttpResponse<Repository, any>>;
|
||
};
|
||
settings: {
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags settings
|
||
* @name GetGeneralApiSettings
|
||
* @summary Get instance's global settings for api
|
||
* @request GET:/settings/api
|
||
* @secure
|
||
*/
|
||
getGeneralApiSettings: (params?: RequestParams) => Promise<HttpResponse<GeneralAPISettings, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags settings
|
||
* @name GetGeneralAttachmentSettings
|
||
* @summary Get instance's global settings for Attachment
|
||
* @request GET:/settings/attachment
|
||
* @secure
|
||
*/
|
||
getGeneralAttachmentSettings: (params?: RequestParams) => Promise<HttpResponse<GeneralAttachmentSettings, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags settings
|
||
* @name GetGeneralRepositorySettings
|
||
* @summary Get instance's global settings for repositories
|
||
* @request GET:/settings/repository
|
||
* @secure
|
||
*/
|
||
getGeneralRepositorySettings: (params?: RequestParams) => Promise<HttpResponse<GeneralRepoSettings, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags settings
|
||
* @name GetGeneralUiSettings
|
||
* @summary Get instance's global settings for ui
|
||
* @request GET:/settings/ui
|
||
* @secure
|
||
*/
|
||
getGeneralUiSettings: (params?: RequestParams) => Promise<HttpResponse<GeneralUISettings, any>>;
|
||
};
|
||
signingKeyGpg: {
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags miscellaneous
|
||
* @name GetSigningKey
|
||
* @summary Get default signing-key.gpg
|
||
* @request GET:/signing-key.gpg
|
||
* @secure
|
||
*/
|
||
getSigningKey: (params?: RequestParams) => Promise<HttpResponse<string, any>>;
|
||
};
|
||
teams: {
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags organization
|
||
* @name OrgGetTeam
|
||
* @summary Get a team
|
||
* @request GET:/teams/{id}
|
||
* @secure
|
||
*/
|
||
orgGetTeam: (id: number, params?: RequestParams) => Promise<HttpResponse<Team, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags organization
|
||
* @name OrgDeleteTeam
|
||
* @summary Delete a team
|
||
* @request DELETE:/teams/{id}
|
||
* @secure
|
||
*/
|
||
orgDeleteTeam: (id: number, params?: RequestParams) => Promise<HttpResponse<void, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags organization
|
||
* @name OrgEditTeam
|
||
* @summary Edit a team
|
||
* @request PATCH:/teams/{id}
|
||
* @secure
|
||
*/
|
||
orgEditTeam: (id: number, body: EditTeamOption, params?: RequestParams) => Promise<HttpResponse<Team, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags organization
|
||
* @name OrgListTeamActivityFeeds
|
||
* @summary List a team's activity feeds
|
||
* @request GET:/teams/{id}/activities/feeds
|
||
* @secure
|
||
*/
|
||
orgListTeamActivityFeeds: (id: number, query?: {
|
||
/**
|
||
* the date of the activities to be found
|
||
* @format date
|
||
*/
|
||
date?: string;
|
||
/** page number of results to return (1-based) */
|
||
page?: number;
|
||
/** page size of results */
|
||
limit?: number;
|
||
}, params?: RequestParams) => Promise<HttpResponse<Activity[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags organization
|
||
* @name OrgListTeamMembers
|
||
* @summary List a team's members
|
||
* @request GET:/teams/{id}/members
|
||
* @secure
|
||
*/
|
||
orgListTeamMembers: (id: number, query?: {
|
||
/** page number of results to return (1-based) */
|
||
page?: number;
|
||
/** page size of results */
|
||
limit?: number;
|
||
}, params?: RequestParams) => Promise<HttpResponse<User[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags organization
|
||
* @name OrgListTeamMember
|
||
* @summary List a particular member of team
|
||
* @request GET:/teams/{id}/members/{username}
|
||
* @secure
|
||
*/
|
||
orgListTeamMember: (id: number, username: string, params?: RequestParams) => Promise<HttpResponse<User, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags organization
|
||
* @name OrgAddTeamMember
|
||
* @summary Add a team member
|
||
* @request PUT:/teams/{id}/members/{username}
|
||
* @secure
|
||
*/
|
||
orgAddTeamMember: (id: number, username: string, params?: RequestParams) => Promise<HttpResponse<any, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags organization
|
||
* @name OrgRemoveTeamMember
|
||
* @summary Remove a team member
|
||
* @request DELETE:/teams/{id}/members/{username}
|
||
* @secure
|
||
*/
|
||
orgRemoveTeamMember: (id: number, username: string, params?: RequestParams) => Promise<HttpResponse<any, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags organization
|
||
* @name OrgListTeamRepos
|
||
* @summary List a team's repos
|
||
* @request GET:/teams/{id}/repos
|
||
* @secure
|
||
*/
|
||
orgListTeamRepos: (id: number, query?: {
|
||
/** page number of results to return (1-based) */
|
||
page?: number;
|
||
/** page size of results */
|
||
limit?: number;
|
||
}, params?: RequestParams) => Promise<HttpResponse<Repository[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags organization
|
||
* @name OrgListTeamRepo
|
||
* @summary List a particular repo of team
|
||
* @request GET:/teams/{id}/repos/{org}/{repo}
|
||
* @secure
|
||
*/
|
||
orgListTeamRepo: (id: number, org: string, repo: string, params?: RequestParams) => Promise<HttpResponse<Repository, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags organization
|
||
* @name OrgAddTeamRepository
|
||
* @summary Add a repository to a team
|
||
* @request PUT:/teams/{id}/repos/{org}/{repo}
|
||
* @secure
|
||
*/
|
||
orgAddTeamRepository: (id: number, org: string, repo: string, params?: RequestParams) => Promise<HttpResponse<any, any>>;
|
||
/**
|
||
* @description This does not delete the repository, it only removes the repository from the team.
|
||
*
|
||
* @tags organization
|
||
* @name OrgRemoveTeamRepository
|
||
* @summary Remove a repository from a team
|
||
* @request DELETE:/teams/{id}/repos/{org}/{repo}
|
||
* @secure
|
||
*/
|
||
orgRemoveTeamRepository: (id: number, org: string, repo: string, params?: RequestParams) => Promise<HttpResponse<any, any>>;
|
||
};
|
||
topics: {
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository
|
||
* @name TopicSearch
|
||
* @summary search topics via keyword
|
||
* @request GET:/topics/search
|
||
* @secure
|
||
*/
|
||
topicSearch: (query: {
|
||
/** keywords to search */
|
||
q: string;
|
||
/** page number of results to return (1-based) */
|
||
page?: number;
|
||
/** page size of results */
|
||
limit?: number;
|
||
}, params?: RequestParams) => Promise<HttpResponse<TopicResponse[], any>>;
|
||
};
|
||
user: {
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags user
|
||
* @name UserGetCurrent
|
||
* @summary Get the authenticated user
|
||
* @request GET:/user
|
||
* @secure
|
||
*/
|
||
userGetCurrent: (params?: RequestParams) => Promise<HttpResponse<User, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags user
|
||
* @name UserGetRunnerRegistrationToken
|
||
* @summary Get an user's actions runner registration token
|
||
* @request GET:/user/actions/runners/registration-token
|
||
* @secure
|
||
*/
|
||
userGetRunnerRegistrationToken: (params?: RequestParams) => Promise<HttpResponse<any, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags user
|
||
* @name UpdateUserSecret
|
||
* @summary Create or Update a secret value in a user scope
|
||
* @request PUT:/user/actions/secrets/{secretname}
|
||
* @secure
|
||
*/
|
||
updateUserSecret: (secretname: string, body: CreateOrUpdateSecretOption, params?: RequestParams) => Promise<HttpResponse<void, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags user
|
||
* @name DeleteUserSecret
|
||
* @summary Delete a secret in a user scope
|
||
* @request DELETE:/user/actions/secrets/{secretname}
|
||
* @secure
|
||
*/
|
||
deleteUserSecret: (secretname: string, params?: RequestParams) => Promise<HttpResponse<void, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags user
|
||
* @name GetUserVariablesList
|
||
* @summary Get the user-level list of variables which is created by current doer
|
||
* @request GET:/user/actions/variables
|
||
* @secure
|
||
*/
|
||
getUserVariablesList: (query?: {
|
||
/** page number of results to return (1-based) */
|
||
page?: number;
|
||
/** page size of results */
|
||
limit?: number;
|
||
}, params?: RequestParams) => Promise<HttpResponse<ActionVariable[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags user
|
||
* @name GetUserVariable
|
||
* @summary Get a user-level variable which is created by current doer
|
||
* @request GET:/user/actions/variables/{variablename}
|
||
* @secure
|
||
*/
|
||
getUserVariable: (variablename: string, params?: RequestParams) => Promise<HttpResponse<ActionVariable, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags user
|
||
* @name UpdateUserVariable
|
||
* @summary Update a user-level variable which is created by current doer
|
||
* @request PUT:/user/actions/variables/{variablename}
|
||
* @secure
|
||
*/
|
||
updateUserVariable: (variablename: string, body: UpdateVariableOption, params?: RequestParams) => Promise<HttpResponse<void, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags user
|
||
* @name CreateUserVariable
|
||
* @summary Create a user-level variable
|
||
* @request POST:/user/actions/variables/{variablename}
|
||
* @secure
|
||
*/
|
||
createUserVariable: (variablename: string, body: CreateVariableOption, params?: RequestParams) => Promise<HttpResponse<void, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags user
|
||
* @name DeleteUserVariable
|
||
* @summary Delete a user-level variable which is created by current doer
|
||
* @request DELETE:/user/actions/variables/{variablename}
|
||
* @secure
|
||
*/
|
||
deleteUserVariable: (variablename: string, params?: RequestParams) => Promise<HttpResponse<void, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags user
|
||
* @name UserGetOauth2Application
|
||
* @summary List the authenticated user's oauth2 applications
|
||
* @request GET:/user/applications/oauth2
|
||
* @secure
|
||
*/
|
||
userGetOauth2Application: (query?: {
|
||
/** page number of results to return (1-based) */
|
||
page?: number;
|
||
/** page size of results */
|
||
limit?: number;
|
||
}, params?: RequestParams) => Promise<HttpResponse<OAuth2Application[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags user
|
||
* @name UserCreateOAuth2Application
|
||
* @summary creates a new OAuth2 application
|
||
* @request POST:/user/applications/oauth2
|
||
* @secure
|
||
*/
|
||
userCreateOAuth2Application: (body: CreateOAuth2ApplicationOptions, params?: RequestParams) => Promise<HttpResponse<OAuth2Application, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags user
|
||
* @name UserGetOAuth2Application
|
||
* @summary get an OAuth2 Application
|
||
* @request GET:/user/applications/oauth2/{id}
|
||
* @secure
|
||
*/
|
||
userGetOAuth2Application: (id: number, params?: RequestParams) => Promise<HttpResponse<OAuth2Application, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags user
|
||
* @name UserDeleteOAuth2Application
|
||
* @summary delete an OAuth2 Application
|
||
* @request DELETE:/user/applications/oauth2/{id}
|
||
* @secure
|
||
*/
|
||
userDeleteOAuth2Application: (id: number, params?: RequestParams) => Promise<HttpResponse<any, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags user
|
||
* @name UserUpdateOAuth2Application
|
||
* @summary update an OAuth2 Application, this includes regenerating the client secret
|
||
* @request PATCH:/user/applications/oauth2/{id}
|
||
* @secure
|
||
*/
|
||
userUpdateOAuth2Application: (id: number, body: CreateOAuth2ApplicationOptions, params?: RequestParams) => Promise<HttpResponse<OAuth2Application, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags user
|
||
* @name UserUpdateAvatar
|
||
* @summary Update Avatar
|
||
* @request POST:/user/avatar
|
||
* @secure
|
||
*/
|
||
userUpdateAvatar: (body: UpdateUserAvatarOption, params?: RequestParams) => Promise<HttpResponse<any, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags user
|
||
* @name UserDeleteAvatar
|
||
* @summary Delete Avatar
|
||
* @request DELETE:/user/avatar
|
||
* @secure
|
||
*/
|
||
userDeleteAvatar: (params?: RequestParams) => Promise<HttpResponse<any, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags user
|
||
* @name UserListBlocks
|
||
* @summary List users blocked by the authenticated user
|
||
* @request GET:/user/blocks
|
||
* @secure
|
||
*/
|
||
userListBlocks: (query?: {
|
||
/** page number of results to return (1-based) */
|
||
page?: number;
|
||
/** page size of results */
|
||
limit?: number;
|
||
}, params?: RequestParams) => Promise<HttpResponse<User[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags user
|
||
* @name UserCheckUserBlock
|
||
* @summary Check if a user is blocked by the authenticated user
|
||
* @request GET:/user/blocks/{username}
|
||
* @secure
|
||
*/
|
||
userCheckUserBlock: (username: string, params?: RequestParams) => Promise<HttpResponse<any, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags user
|
||
* @name UserBlockUser
|
||
* @summary Block a user
|
||
* @request PUT:/user/blocks/{username}
|
||
* @secure
|
||
*/
|
||
userBlockUser: (username: string, query?: {
|
||
/** optional note for the block */
|
||
note?: string;
|
||
}, params?: RequestParams) => Promise<HttpResponse<any, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags user
|
||
* @name UserUnblockUser
|
||
* @summary Unblock a user
|
||
* @request DELETE:/user/blocks/{username}
|
||
* @secure
|
||
*/
|
||
userUnblockUser: (username: string, params?: RequestParams) => Promise<HttpResponse<any, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags user
|
||
* @name UserListEmails
|
||
* @summary List the authenticated user's email addresses
|
||
* @request GET:/user/emails
|
||
* @secure
|
||
*/
|
||
userListEmails: (params?: RequestParams) => Promise<HttpResponse<Email[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags user
|
||
* @name UserAddEmail
|
||
* @summary Add email addresses
|
||
* @request POST:/user/emails
|
||
* @secure
|
||
*/
|
||
userAddEmail: (body: CreateEmailOption, params?: RequestParams) => Promise<HttpResponse<Email[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags user
|
||
* @name UserDeleteEmail
|
||
* @summary Delete email addresses
|
||
* @request DELETE:/user/emails
|
||
* @secure
|
||
*/
|
||
userDeleteEmail: (body: DeleteEmailOption, params?: RequestParams) => Promise<HttpResponse<any, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags user
|
||
* @name UserCurrentListFollowers
|
||
* @summary List the authenticated user's followers
|
||
* @request GET:/user/followers
|
||
* @secure
|
||
*/
|
||
userCurrentListFollowers: (query?: {
|
||
/** page number of results to return (1-based) */
|
||
page?: number;
|
||
/** page size of results */
|
||
limit?: number;
|
||
}, params?: RequestParams) => Promise<HttpResponse<User[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags user
|
||
* @name UserCurrentListFollowing
|
||
* @summary List the users that the authenticated user is following
|
||
* @request GET:/user/following
|
||
* @secure
|
||
*/
|
||
userCurrentListFollowing: (query?: {
|
||
/** page number of results to return (1-based) */
|
||
page?: number;
|
||
/** page size of results */
|
||
limit?: number;
|
||
}, params?: RequestParams) => Promise<HttpResponse<User[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags user
|
||
* @name UserCurrentCheckFollowing
|
||
* @summary Check whether a user is followed by the authenticated user
|
||
* @request GET:/user/following/{username}
|
||
* @secure
|
||
*/
|
||
userCurrentCheckFollowing: (username: string, params?: RequestParams) => Promise<HttpResponse<any, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags user
|
||
* @name UserCurrentPutFollow
|
||
* @summary Follow a user
|
||
* @request PUT:/user/following/{username}
|
||
* @secure
|
||
*/
|
||
userCurrentPutFollow: (username: string, params?: RequestParams) => Promise<HttpResponse<any, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags user
|
||
* @name UserCurrentDeleteFollow
|
||
* @summary Unfollow a user
|
||
* @request DELETE:/user/following/{username}
|
||
* @secure
|
||
*/
|
||
userCurrentDeleteFollow: (username: string, params?: RequestParams) => Promise<HttpResponse<any, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags user
|
||
* @name GetVerificationToken
|
||
* @summary Get a Token to verify
|
||
* @request GET:/user/gpg_key_token
|
||
* @secure
|
||
*/
|
||
getVerificationToken: (params?: RequestParams) => Promise<HttpResponse<string, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags user
|
||
* @name UserVerifyGpgKey
|
||
* @summary Verify a GPG key
|
||
* @request POST:/user/gpg_key_verify
|
||
* @secure
|
||
*/
|
||
userVerifyGpgKey: (params?: RequestParams) => Promise<HttpResponse<GPGKey, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags user
|
||
* @name UserCurrentListGpgKeys
|
||
* @summary List the authenticated user's GPG keys
|
||
* @request GET:/user/gpg_keys
|
||
* @secure
|
||
*/
|
||
userCurrentListGpgKeys: (query?: {
|
||
/** page number of results to return (1-based) */
|
||
page?: number;
|
||
/** page size of results */
|
||
limit?: number;
|
||
}, params?: RequestParams) => Promise<HttpResponse<GPGKey[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags user
|
||
* @name UserCurrentPostGpgKey
|
||
* @summary Create a GPG key
|
||
* @request POST:/user/gpg_keys
|
||
* @secure
|
||
*/
|
||
userCurrentPostGpgKey: (Form: CreateGPGKeyOption, params?: RequestParams) => Promise<HttpResponse<GPGKey, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags user
|
||
* @name UserCurrentGetGpgKey
|
||
* @summary Get a GPG key
|
||
* @request GET:/user/gpg_keys/{id}
|
||
* @secure
|
||
*/
|
||
userCurrentGetGpgKey: (id: number, params?: RequestParams) => Promise<HttpResponse<GPGKey, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags user
|
||
* @name UserCurrentDeleteGpgKey
|
||
* @summary Remove a GPG key
|
||
* @request DELETE:/user/gpg_keys/{id}
|
||
* @secure
|
||
*/
|
||
userCurrentDeleteGpgKey: (id: number, params?: RequestParams) => Promise<HttpResponse<any, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags user
|
||
* @name UserListHooks
|
||
* @summary List the authenticated user's webhooks
|
||
* @request GET:/user/hooks
|
||
* @secure
|
||
*/
|
||
userListHooks: (query?: {
|
||
/** page number of results to return (1-based) */
|
||
page?: number;
|
||
/** page size of results */
|
||
limit?: number;
|
||
}, params?: RequestParams) => Promise<HttpResponse<Hook[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags user
|
||
* @name UserCreateHook
|
||
* @summary Create a hook
|
||
* @request POST:/user/hooks
|
||
* @secure
|
||
*/
|
||
userCreateHook: (body: CreateHookOption, params?: RequestParams) => Promise<HttpResponse<Hook, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags user
|
||
* @name UserGetHook
|
||
* @summary Get a hook
|
||
* @request GET:/user/hooks/{id}
|
||
* @secure
|
||
*/
|
||
userGetHook: (id: number, params?: RequestParams) => Promise<HttpResponse<Hook, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags user
|
||
* @name UserDeleteHook
|
||
* @summary Delete a hook
|
||
* @request DELETE:/user/hooks/{id}
|
||
* @secure
|
||
*/
|
||
userDeleteHook: (id: number, params?: RequestParams) => Promise<HttpResponse<any, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags user
|
||
* @name UserEditHook
|
||
* @summary Update a hook
|
||
* @request PATCH:/user/hooks/{id}
|
||
* @secure
|
||
*/
|
||
userEditHook: (id: number, body: EditHookOption, params?: RequestParams) => Promise<HttpResponse<Hook, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags user
|
||
* @name UserCurrentListKeys
|
||
* @summary List the authenticated user's public keys
|
||
* @request GET:/user/keys
|
||
* @secure
|
||
*/
|
||
userCurrentListKeys: (query?: {
|
||
/** fingerprint of the key */
|
||
fingerprint?: string;
|
||
/** page number of results to return (1-based) */
|
||
page?: number;
|
||
/** page size of results */
|
||
limit?: number;
|
||
}, params?: RequestParams) => Promise<HttpResponse<PublicKey[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags user
|
||
* @name UserCurrentPostKey
|
||
* @summary Create a public key
|
||
* @request POST:/user/keys
|
||
* @secure
|
||
*/
|
||
userCurrentPostKey: (body: CreateKeyOption, params?: RequestParams) => Promise<HttpResponse<PublicKey, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags user
|
||
* @name UserCurrentGetKey
|
||
* @summary Get a public key
|
||
* @request GET:/user/keys/{id}
|
||
* @secure
|
||
*/
|
||
userCurrentGetKey: (id: number, params?: RequestParams) => Promise<HttpResponse<PublicKey, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags user
|
||
* @name UserCurrentDeleteKey
|
||
* @summary Delete a public key
|
||
* @request DELETE:/user/keys/{id}
|
||
* @secure
|
||
*/
|
||
userCurrentDeleteKey: (id: number, params?: RequestParams) => Promise<HttpResponse<any, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags organization
|
||
* @name OrgListCurrentUserOrgs
|
||
* @summary List the current user's organizations
|
||
* @request GET:/user/orgs
|
||
* @secure
|
||
*/
|
||
orgListCurrentUserOrgs: (query?: {
|
||
/** page number of results to return (1-based) */
|
||
page?: number;
|
||
/** page size of results */
|
||
limit?: number;
|
||
}, params?: RequestParams) => Promise<HttpResponse<Organization[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags user
|
||
* @name UserCurrentListRepos
|
||
* @summary List the repos that the authenticated user owns
|
||
* @request GET:/user/repos
|
||
* @secure
|
||
*/
|
||
userCurrentListRepos: (query?: {
|
||
/** page number of results to return (1-based) */
|
||
page?: number;
|
||
/** page size of results */
|
||
limit?: number;
|
||
}, params?: RequestParams) => Promise<HttpResponse<Repository[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags repository, user
|
||
* @name CreateCurrentUserRepo
|
||
* @summary Create a repository
|
||
* @request POST:/user/repos
|
||
* @secure
|
||
*/
|
||
createCurrentUserRepo: (body: CreateRepoOption, params?: RequestParams) => Promise<HttpResponse<Repository, void>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags user
|
||
* @name GetUserSettings
|
||
* @summary Get user settings
|
||
* @request GET:/user/settings
|
||
* @secure
|
||
*/
|
||
getUserSettings: (params?: RequestParams) => Promise<HttpResponse<UserSettings, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags user
|
||
* @name UpdateUserSettings
|
||
* @summary Update user settings
|
||
* @request PATCH:/user/settings
|
||
* @secure
|
||
*/
|
||
updateUserSettings: (body: UserSettingsOptions, params?: RequestParams) => Promise<HttpResponse<UserSettings, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags user
|
||
* @name UserCurrentListStarred
|
||
* @summary The repos that the authenticated user has starred
|
||
* @request GET:/user/starred
|
||
* @secure
|
||
*/
|
||
userCurrentListStarred: (query?: {
|
||
/** page number of results to return (1-based) */
|
||
page?: number;
|
||
/** page size of results */
|
||
limit?: number;
|
||
}, params?: RequestParams) => Promise<HttpResponse<Repository[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags user
|
||
* @name UserCurrentCheckStarring
|
||
* @summary Whether the authenticated is starring the repo
|
||
* @request GET:/user/starred/{owner}/{repo}
|
||
* @secure
|
||
*/
|
||
userCurrentCheckStarring: (owner: string, repo: string, params?: RequestParams) => Promise<HttpResponse<any, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags user
|
||
* @name UserCurrentPutStar
|
||
* @summary Star the given repo
|
||
* @request PUT:/user/starred/{owner}/{repo}
|
||
* @secure
|
||
*/
|
||
userCurrentPutStar: (owner: string, repo: string, params?: RequestParams) => Promise<HttpResponse<any, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags user
|
||
* @name UserCurrentDeleteStar
|
||
* @summary Unstar the given repo
|
||
* @request DELETE:/user/starred/{owner}/{repo}
|
||
* @secure
|
||
*/
|
||
userCurrentDeleteStar: (owner: string, repo: string, params?: RequestParams) => Promise<HttpResponse<any, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags user
|
||
* @name UserGetStopWatches
|
||
* @summary Get list of all existing stopwatches
|
||
* @request GET:/user/stopwatches
|
||
* @secure
|
||
*/
|
||
userGetStopWatches: (query?: {
|
||
/** page number of results to return (1-based) */
|
||
page?: number;
|
||
/** page size of results */
|
||
limit?: number;
|
||
}, params?: RequestParams) => Promise<HttpResponse<StopWatch[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags user
|
||
* @name UserCurrentListSubscriptions
|
||
* @summary List repositories watched by the authenticated user
|
||
* @request GET:/user/subscriptions
|
||
* @secure
|
||
*/
|
||
userCurrentListSubscriptions: (query?: {
|
||
/** page number of results to return (1-based) */
|
||
page?: number;
|
||
/** page size of results */
|
||
limit?: number;
|
||
}, params?: RequestParams) => Promise<HttpResponse<Repository[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags user
|
||
* @name UserListTeams
|
||
* @summary List all the teams a user belongs to
|
||
* @request GET:/user/teams
|
||
* @secure
|
||
*/
|
||
userListTeams: (query?: {
|
||
/** page number of results to return (1-based) */
|
||
page?: number;
|
||
/** page size of results */
|
||
limit?: number;
|
||
}, params?: RequestParams) => Promise<HttpResponse<Team[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags user
|
||
* @name UserCurrentTrackedTimes
|
||
* @summary List the current user's tracked times
|
||
* @request GET:/user/times
|
||
* @secure
|
||
*/
|
||
userCurrentTrackedTimes: (query?: {
|
||
/** page number of results to return (1-based) */
|
||
page?: number;
|
||
/** page size of results */
|
||
limit?: number;
|
||
/**
|
||
* Only show times updated after the given time. This is a timestamp in RFC 3339 format
|
||
* @format date-time
|
||
*/
|
||
since?: string;
|
||
/**
|
||
* Only show times updated before the given time. This is a timestamp in RFC 3339 format
|
||
* @format date-time
|
||
*/
|
||
before?: string;
|
||
}, params?: RequestParams) => Promise<HttpResponse<TrackedTime[], any>>;
|
||
};
|
||
users: {
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags user
|
||
* @name UserSearch
|
||
* @summary Search for users
|
||
* @request GET:/users/search
|
||
* @secure
|
||
*/
|
||
userSearch: (query?: {
|
||
/** keyword */
|
||
q?: string;
|
||
/**
|
||
* ID of the user to search for
|
||
* @format int64
|
||
*/
|
||
uid?: number;
|
||
/** page number of results to return (1-based) */
|
||
page?: number;
|
||
/** page size of results */
|
||
limit?: number;
|
||
}, params?: RequestParams) => Promise<HttpResponse<{
|
||
data?: User[] | undefined;
|
||
ok?: boolean | undefined;
|
||
}, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags user
|
||
* @name UserGet
|
||
* @summary Get a user
|
||
* @request GET:/users/{username}
|
||
* @secure
|
||
*/
|
||
userGet: (username: string, params?: RequestParams) => Promise<HttpResponse<User, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags user
|
||
* @name UserListActivityFeeds
|
||
* @summary List a user's activity feeds
|
||
* @request GET:/users/{username}/activities/feeds
|
||
* @secure
|
||
*/
|
||
userListActivityFeeds: (username: string, query?: {
|
||
/** if true, only show actions performed by the requested user */
|
||
'only-performed-by'?: boolean;
|
||
/**
|
||
* the date of the activities to be found
|
||
* @format date
|
||
*/
|
||
date?: string;
|
||
/** page number of results to return (1-based) */
|
||
page?: number;
|
||
/** page size of results */
|
||
limit?: number;
|
||
}, params?: RequestParams) => Promise<HttpResponse<Activity[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags user
|
||
* @name UserListFollowers
|
||
* @summary List the given user's followers
|
||
* @request GET:/users/{username}/followers
|
||
* @secure
|
||
*/
|
||
userListFollowers: (username: string, query?: {
|
||
/** page number of results to return (1-based) */
|
||
page?: number;
|
||
/** page size of results */
|
||
limit?: number;
|
||
}, params?: RequestParams) => Promise<HttpResponse<User[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags user
|
||
* @name UserListFollowing
|
||
* @summary List the users that the given user is following
|
||
* @request GET:/users/{username}/following
|
||
* @secure
|
||
*/
|
||
userListFollowing: (username: string, query?: {
|
||
/** page number of results to return (1-based) */
|
||
page?: number;
|
||
/** page size of results */
|
||
limit?: number;
|
||
}, params?: RequestParams) => Promise<HttpResponse<User[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags user
|
||
* @name UserCheckFollowing
|
||
* @summary Check if one user is following another user
|
||
* @request GET:/users/{username}/following/{target}
|
||
* @secure
|
||
*/
|
||
userCheckFollowing: (username: string, target: string, params?: RequestParams) => Promise<HttpResponse<any, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags user
|
||
* @name UserListGpgKeys
|
||
* @summary List the given user's GPG keys
|
||
* @request GET:/users/{username}/gpg_keys
|
||
* @secure
|
||
*/
|
||
userListGpgKeys: (username: string, query?: {
|
||
/** page number of results to return (1-based) */
|
||
page?: number;
|
||
/** page size of results */
|
||
limit?: number;
|
||
}, params?: RequestParams) => Promise<HttpResponse<GPGKey[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags user
|
||
* @name UserGetHeatmapData
|
||
* @summary Get a user's heatmap
|
||
* @request GET:/users/{username}/heatmap
|
||
* @secure
|
||
*/
|
||
userGetHeatmapData: (username: string, params?: RequestParams) => Promise<HttpResponse<UserHeatmapData, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags user
|
||
* @name UserListKeys
|
||
* @summary List the given user's public keys
|
||
* @request GET:/users/{username}/keys
|
||
* @secure
|
||
*/
|
||
userListKeys: (username: string, query?: {
|
||
/** fingerprint of the key */
|
||
fingerprint?: string;
|
||
/** page number of results to return (1-based) */
|
||
page?: number;
|
||
/** page size of results */
|
||
limit?: number;
|
||
}, params?: RequestParams) => Promise<HttpResponse<PublicKey[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags organization
|
||
* @name OrgListUserOrgs
|
||
* @summary List a user's organizations
|
||
* @request GET:/users/{username}/orgs
|
||
* @secure
|
||
*/
|
||
orgListUserOrgs: (username: string, query?: {
|
||
/** page number of results to return (1-based) */
|
||
page?: number;
|
||
/** page size of results */
|
||
limit?: number;
|
||
}, params?: RequestParams) => Promise<HttpResponse<Organization[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags organization
|
||
* @name OrgGetUserPermissions
|
||
* @summary Get user permissions in organization
|
||
* @request GET:/users/{username}/orgs/{org}/permissions
|
||
* @secure
|
||
*/
|
||
orgGetUserPermissions: (username: string, org: string, params?: RequestParams) => Promise<HttpResponse<OrganizationPermissions, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags user
|
||
* @name UserListRepos
|
||
* @summary List the repos owned by the given user
|
||
* @request GET:/users/{username}/repos
|
||
* @secure
|
||
*/
|
||
userListRepos: (username: string, query?: {
|
||
/** page number of results to return (1-based) */
|
||
page?: number;
|
||
/** page size of results */
|
||
limit?: number;
|
||
}, params?: RequestParams) => Promise<HttpResponse<Repository[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags user
|
||
* @name UserListStarred
|
||
* @summary The repos that the given user has starred
|
||
* @request GET:/users/{username}/starred
|
||
* @secure
|
||
*/
|
||
userListStarred: (username: string, query?: {
|
||
/** page number of results to return (1-based) */
|
||
page?: number;
|
||
/** page size of results */
|
||
limit?: number;
|
||
}, params?: RequestParams) => Promise<HttpResponse<Repository[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags user
|
||
* @name UserListSubscriptions
|
||
* @summary List the repositories watched by a user
|
||
* @request GET:/users/{username}/subscriptions
|
||
* @secure
|
||
*/
|
||
userListSubscriptions: (username: string, query?: {
|
||
/** page number of results to return (1-based) */
|
||
page?: number;
|
||
/** page size of results */
|
||
limit?: number;
|
||
}, params?: RequestParams) => Promise<HttpResponse<Repository[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags user
|
||
* @name UserGetTokens
|
||
* @summary List the authenticated user's access tokens
|
||
* @request GET:/users/{username}/tokens
|
||
* @secure
|
||
*/
|
||
userGetTokens: (username: string, query?: {
|
||
/** page number of results to return (1-based) */
|
||
page?: number;
|
||
/** page size of results */
|
||
limit?: number;
|
||
}, params?: RequestParams) => Promise<HttpResponse<AccessToken[], any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags user
|
||
* @name UserCreateToken
|
||
* @summary Create an access token
|
||
* @request POST:/users/{username}/tokens
|
||
* @secure
|
||
*/
|
||
userCreateToken: (username: string, body: CreateAccessTokenOption, params?: RequestParams) => Promise<HttpResponse<AccessToken, any>>;
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags user
|
||
* @name UserDeleteAccessToken
|
||
* @summary delete an access token
|
||
* @request DELETE:/users/{username}/tokens/{token}
|
||
* @secure
|
||
*/
|
||
userDeleteAccessToken: (username: string, token: string, params?: RequestParams) => Promise<HttpResponse<any, any>>;
|
||
};
|
||
version: {
|
||
/**
|
||
* No description
|
||
*
|
||
* @tags miscellaneous
|
||
* @name GetVersion
|
||
* @summary Returns the version of the Gitea application
|
||
* @request GET:/version
|
||
* @secure
|
||
*/
|
||
getVersion: (params?: RequestParams) => Promise<HttpResponse<ServerVersion, any>>;
|
||
};
|
||
}
|
||
|
||
declare function giteaApi<SecurityDataType = unknown>(baseUrl: string, options?: ApiConfig<SecurityDataType> & {
|
||
token?: string;
|
||
}): Api<SecurityDataType>;
|
||
|
||
export { APIError, AccessToken, ActionTask, ActionTaskResponse, ActionVariable, Activity, ActivityPub, AddCollaboratorOption, AddTimeOption, AnnotatedTag, AnnotatedTagObject, Api, ApiConfig, Attachment, Badge, Branch, BranchProtection, ChangeFileOperation, ChangeFilesOptions, ChangedFile, CombinedStatus, Comment, Commit, CommitAffectedFiles, CommitDateOptions, CommitMeta, CommitStats, CommitStatus, CommitStatusState, CommitUser, Compare, ContentType, ContentsResponse, CreateAccessTokenOption, CreateBranchProtectionOption, CreateBranchRepoOption, CreateEmailOption, CreateFileOptions, CreateForkOption, CreateGPGKeyOption, CreateHookOption, CreateHookOptionConfig, CreateIssueCommentOption, CreateIssueOption, CreateKeyOption, CreateLabelOption, CreateMilestoneOption, CreateOAuth2ApplicationOptions, CreateOrUpdateSecretOption, CreateOrgOption, CreatePullRequestOption, CreatePullReviewComment, CreatePullReviewOptions, CreatePushMirrorOption, CreateReleaseOption, CreateRepoOption, CreateStatusOption, CreateTagOption, CreateTagProtectionOption, CreateTeamOption, CreateUserOption, CreateVariableOption, CreateWikiPageOptions, Cron, DeleteEmailOption, DeleteFileOptions, DeployKey, DismissPullReviewOptions, EditAttachmentOptions, EditBranchProtectionOption, EditDeadlineOption, EditGitHookOption, EditHookOption, EditIssueCommentOption, EditIssueOption, EditLabelOption, EditMilestoneOption, EditOrgOption, EditPullRequestOption, EditReactionOption, EditReleaseOption, EditRepoOption, EditTagProtectionOption, EditTeamOption, EditUserOption, Email, ExternalTracker, ExternalWiki, FileCommitResponse, FileDeleteResponse, FileLinksResponse, FileResponse, FilesResponse, FullRequestParams, GPGKey, GPGKeyEmail, GeneralAPISettings, GeneralAttachmentSettings, GeneralRepoSettings, GeneralUISettings, GenerateRepoOption, GitBlobResponse, GitEntry, GitHook, GitObject, GitTreeResponse, GitignoreTemplateInfo, Hook, HttpClient, HttpResponse, Identity, InternalTracker, Issue, IssueConfig, IssueConfigContactLink, IssueConfigValidation, IssueDeadline, IssueFormField, IssueFormFieldType, IssueFormFieldVisible, IssueLabelsOption, IssueMeta, IssueTemplate, IssueTemplateStringSlice, Label, LabelTemplate, LicenseTemplateInfo, LicensesTemplateListEntry, MarkdownOption, MarkupOption, MergePullRequestOption, MergeUpstreamRequest, MergeUpstreamResponse, MigrateRepoOptions, Milestone, NewIssuePinsAllowed, NodeInfo, NodeInfoServices, NodeInfoSoftware, NodeInfoUsage, NodeInfoUsageUsers, Note, NotificationCount, NotificationSubject, NotificationThread, NotifySubjectType, OAuth2Application, Organization, OrganizationPermissions, PRBranchInfo, Package, PackageFile, PayloadCommit, PayloadCommitVerification, PayloadUser, Permission, PublicKey, PullRequest, PullRequestMeta, PullReview, PullReviewComment, PullReviewRequestOptions, PushMirror, QueryParamsType, Reaction, Reference, Release, RenameUserOption, RepoCollaboratorPermission, RepoCommit, RepoTopicOptions, RepoTransfer, Repository, RepositoryMeta, RequestParams, ResponseFormat, ReviewStateType, SearchResults, Secret, ServerVersion, StateType, StopWatch, SubmitPullReviewOptions, Tag, TagProtection, Team, TimeStamp, TimelineComment, TopicName, TopicResponse, TrackedTime, TransferRepoOption, UpdateBranchProtectionPriories, UpdateBranchRepoOption, UpdateFileOptions, UpdateRepoAvatarOption, UpdateUserAvatarOption, UpdateVariableOption, User, UserBadgeOption, UserHeatmapData, UserSettings, UserSettingsOptions, WatchInfo, WikiCommit, WikiCommitList, WikiPage, WikiPageMetaData, giteaApi };
|